merge

.codeclimate.yml

@@ -0,0 +1,4 @@
+exclude_paths:
+- "lib/assets/**/*"
+- "app/controllers/admin/**/*"
+- "public/api-doc/**/*"

.gitignore

@@ -1,11 +1,42 @@
 .bundle
+tmp/
+coverage/
 db/*.sqlite3
+tmp/
 log/*.log
+log/*.log*
 tmp/**/*
+.sass-cache/
+.yardoc/
+public/assets/
 config/database.yml
+config/mongoid.yml
 config/config.yml
+config/thin.yml
+config/redis.yml
+config/mailer_daemon.yml
+config/secrets.yml
+public/photo/**/*
+public/user/**/*
 public/uploads/**/*
-public/javascripts/cached_*
-public/stylesheets/cached_*
+public/system/**/*
 public/topics
 public/topics/**/*
+public/doc
+.redcar
+.DS_Store
+*.swp
+*.swo
+*.sublime-workspace
+.rvmrc
+vendor/ruby
+doc/wiki_repo
+solr/data/
+solr/pids/
+tags
+chromedriver.log
+.idea/
+spec/examples.txt
+.vagrant
+.byebug_history
+.ruby-version

.rspec

@@ -0,0 +1,3 @@
+--color
+-f progress
+--require spec_helper

.rubocop.yml

@@ -0,0 +1,93 @@
+AllCops:
+  Exclude:
+    - 'vendor/**/*'
+    - 'lib/templates/**/*'
+    - 'lib/tasks/release.rake'
+    - 'spec/**/*'
+    - 'app/models/cache_version.rb'
+    - 'Gemfile'
+    - 'db/**/*'
+    - 'config/**/*'
+  TargetRubyVersion: 2.4
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/UnneededPercentQ:
+  Enabled: true
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/NumericPredicate:
+  EnforcedStyle: comparison
+
+Style/PredicateName:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/RedundantSelf:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/MutableConstant:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 1200
+
+Metrics/ClassLength:
+  Max: 1200
+
+Metrics/MethodLength:
+  Max: 1200
+
+Metrics/ModuleLength:
+  Max: 1200
+
+Metrics/BlockLength:
+  Max: 1200
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Rails/TimeZone:
+  Enabled: false
+
+Style/GlobalVars:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Rails/FindBy:
+  Enabled: false
+
+Rails/HasAndBelongsToMany:
+  Enabled: false
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/LambdaCall:
+  Enabled: false

.travis.yml

@@ -0,0 +1,37 @@
+language: ruby
+
+addons:
+  postgresql: "9.4"
+
+services:
+  - postgresql
+  - memcached
+  - redis-server
+  - elasticsearch
+
+rvm:
+  - 2.4.0
+
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: ruby-head
+
+before_install:
+  - sed -i "s/gems.ruby-china.org/rubygems.org/g" Gemfile.lock
+  - psql -c "CREATE USER \"admin\" WITH CREATEDB PASSWORD 'admin';" -U postgres
+  - psql -c "create database \"homeland-test\" WITH OWNER=\"admin\";" -U postgres
+  - cp config/config.yml.default config/config.yml
+  - cp config/database.yml.default config/database.yml
+  - cp config/redis.yml.default config/redis.yml
+  - cp config/elasticsearch.yml.default config/elasticsearch.yml
+  - cp config/secrets.yml.default config/secrets.yml
+  - sed -i "s/SETUP_REDIS_HOST/127.0.0.1/g" config/redis.yml
+  - sed -i "s/SETUP_REDIS_PORT/6379/g" config/redis.yml
+
+before_script:
+  - RAILS_ENV=test bundle exec rake db:migrate
+
+script:
+  - bundle exec rubocop .
+  - RAILS_ENV=test bundle exec rake

API.md

@@ -0,0 +1,72 @@
+# API 文档
+
+## OAuth 2 / API 认证
+
+在使用 API 之前，你需要 [注册应用](/oauth/applications/new) 并获得可以 **OAuth App** 信息。并使用标准的 OAuth 2 实现登录，获得 `access_token` 信息。
+
+### OAuth 路径
+
+- /oauth/authorize
+- /oauth/token
+- /oauth/revoke
+
+### Response 说明
+
+所有 Response 采用 JSON 格式返回，请求状态通过 HTTP Status 返回。
+
+### HTTP Status
+
+错误的情况 Response Body 一定会是这样的格式: `{ "error" : "Error message" }`
+
+- 200, 201 - 请求成功，或执行成功。
+- 400 - 参数不符合 API 的要求、或者数据格式验证没有通过，请配合 Response Body 里面的 error 信息确定问题。
+- 401 - 用户认证失败，或缺少认证信息，比如 access_token 过期，或没传，可以尝试用 refresh_token 方式获得新的 access_token。
+- 403 - 当前用户对资源没有操作权限。
+- 404 - 资源不存在。
+- 500 - 服务器异常。
+
+#### 资源权限描述
+
+在部分 API 的 response 内容里面你会看到 `abilities` 节点，这是特别标识当前 `access_token` 对应的用户对此资源的权限。
+
+请参考源代码，确定那些路径是需要用户认证的，需要用户认证的路径，你需要带上 `access_token=?` 参数。
+
+**例如**
+
+```json
+{
+  "topic": {
+    "id": 256170,
+    ....,
+    "abilities": { "update": true, "destroy": true }
+  }
+}
+```
+
+- update 是否有权限修改
+- destroy 是否有权限删除
+
+## API 路由
+
+API 的详细文档，请访问 [Api::V3](/api-doc/Api/V3.html) 阅读。
+
+## 演示
+
+我们用 Ruby 演示一下访问 [/api/v3/hello.json](/api-doc/Api/V3/RootController.html#hello-instance_method) 这个路径，其中包含 OAuth 2 的流程。
+
+_这里用到 RubyGem [oauth2](https://github.com/intridea/oauth2)_
+
+```rb
+require "oauth2"
+client = OAuth2::Client.new('client id', 'secret', site: 'https://ruby-china.org')
+access_token = client.password.get_token('username', 'password')
+res = Faraday.get("https://ruby-china.org/api/v3/hello.json?access_token=#{access_token.token}")
+puts res.status
+puts res.body
+```
+
+最后输出
+
+```rb
+{ 'current_user' : 'username' }
+```

Benchmarks.md

@@ -0,0 +1,20 @@
+# 页面响应时间记录
+
+要点，所有统计都得基于有 cache 的情况，生产环境。
+
+## 2015-5-28
+
+- /                   = 36ms
+- /topics             = 45ms
+- /topics/19436       = 67ms
+- /wiki               = 26ms
+- /notifications      = 39ms
+- /huacnlee           = 100ms
+- /huacnlee/topics    = 95ms
+- /huacnlee/favorites = 50ms
+- /huacnlee/followers = 85ms
+- /wiki/about         = 37ms
+- /jobs               = 68ms
+- /topics/new         = 84ms
+- /sites              = 25ms
+- /account/edit       = 73ms

CONTRIBUTE.md

@@ -0,0 +1,75 @@
+Contribute Guide
+----------------
+
+## Requirements
+
+* Ruby 2.4.0 +
+* PostgreSQL 9.4 +
+* Redis 2.8 +
+* Memcached 1.4 +
+* Elasticsearch 2.0 +
+
+## Install in development
+
+### Mac OS X, use Homebrew
+
+```bash
+$ brew install memcached redis postgresql imagemagick gs elasticsearch
+```
+
+### Ubuntu
+
+```bash
+$ sudo apt-get install memcached postgresql postgresql-contrib redis-server imagemagick ghostscript
+```
+
+Install Elasticsearch
+
+```bash
+curl -sSL https://git.io/vVHhm | bash
+```
+
+```bash
+$ git clone https://github.com/ruby-china/homeland.git
+$ cd homeland
+$ ./bin/setup
+Checking Package Dependencies...
+--------------------------------------------------------------------------------
+Redis 2.0+                                                                 [Yes]
+Memcached 1.4+                                                             [Yes]
+ImageMagick 6.5+                                                           [Yes]
+--------------------------------------------------------------------------------
+
+Installing dependencies
+--------------------------------------------------------------------------------
+The Gemfile's dependencies are satisfied
+--------------------------------------------------------------------------------
+
+Configure
+--------------------------------------------------------------------------------
+Your Redis host (default: 127.0.0.1:6379):
+Your Elasticsearch host (default: 127.0.0.1:9200):
+--------------------------------------------------------------------------------
+
+Seed default data...                                                      [Done]
+
+== Removing old logs and tempfiles ==
+
+Homeland Successfully Installed.
+
+$ rails s
+```
+
+## Testing
+
+```bash
+bundle exec rake
+```
+
+## Reindex ElasticSearch
+
+```bash
+rails environment elasticsearch:import:model CLASS=Page FORCE=y
+rails environment elasticsearch:import:model CLASS=Topic FORCE=y
+rails environment elasticsearch:import:model CLASS=User FORCE=y
+```