added namespace for Team

leechou · leechou · commit b082ba98e290 · 2018-11-14T22:29:36.000+08:00
diff --git a/DEBUGGING.md b/DEBUGGING.md
@@ -20,6 +20,6 @@ heroku run script/console --app=...
 
 Running `script/console` attached to terminal... up, run.7593
 
-2.2.1 > Team.count
+2.2.1 > SlackRubyBotServer::Team.count
 => 3
 ```
diff --git a/README.md b/README.md
@@ -84,7 +84,7 @@ class MyApp < SlackRubyBotServer::App
   private
 
   def deactivate_sleepy_teams!
-    Team.active.each do |team|
+    SlackRubyBotServer::Team.active.each do |team|
       next unless team.sleepy?
       team.deactivate!
     end
diff --git a/UPGRADING.md b/UPGRADING.md
@@ -91,7 +91,7 @@ class MyApp < SlackRubyBotServer::App
   private
 
   def deactivate_sleepy_teams!
-    Team.active.each do |team|
+    SlackRubyBotServer::Team.active.each do |team|
       next unless team.sleepy?
       team.deactivate!
     end
diff --git a/lib/slack-ruby-bot-server/api/endpoints/teams_endpoint.rb b/lib/slack-ruby-bot-server/api/endpoints/teams_endpoint.rb
@@ -13,7 +13,7 @@ class TeamsEndpoint < Grape::API
             requires :id, type: String, desc: 'Team ID.'
           end
           get ':id' do
-            team = Team.find(params[:id]) || error!('Not Found', 404)
+            team = SlackRubyBotServer::Team.find(params[:id]) || error!('Not Found', 404)
             present team, with: Presenters::TeamPresenter
           end
 
@@ -22,9 +22,9 @@ class TeamsEndpoint < Grape::API
             optional :active, type: Boolean, desc: 'Return active teams only.'
             use :pagination
           end
-          sort Team::SORT_ORDERS
+          sort SlackRubyBotServer::Team::SORT_ORDERS
           get do
-            teams = Team.all
+            teams = SlackRubyBotServer::Team.all
             teams = teams.active if params[:active]
             teams = paginate_and_sort_by_cursor(teams, default_sort_order: '-id')
             present teams, with: Presenters::TeamsPresenter
@@ -46,14 +46,14 @@ class TeamsEndpoint < Grape::API
             )
 
             token = rc['bot']['bot_access_token']
-            team = Team.where(token: token).first
-            team ||= Team.where(team_id: rc['team_id']).first
+            team = SlackRubyBotServer::Team.where(token: token).first
+            team ||= SlackRubyBotServer::Team.where(team_id: rc['team_id']).first
             if team && !team.active?
               team.activate!(token)
             elsif team
               raise "Team #{team.name} is already registered."
             else
-              team = Team.create!(
+              team = SlackRubyBotServer::Team.create!(
                 token: token,
                 team_id: rc['team_id'],
                 name: rc['team_name']
diff --git a/lib/slack-ruby-bot-server/api/presenters/status_presenter.rb b/lib/slack-ruby-bot-server/api/presenters/status_presenter.rb
@@ -16,9 +16,9 @@ module StatusPresenter
 
         def ping
           if SlackRubyBotServer::Config.mongoid?
-            team = Team.asc(:_id).first
+            team = SlackRubyBotServer::Team.asc(:_id).first
           elsif SlackRubyBotServer::Config.activerecord?
-            team = Team.last
+            team = SlackRubyBotServer::Team.last
           else
             raise 'Unsupported database driver.'
           end
@@ -27,11 +27,11 @@ def ping
         end
 
         def teams_count
-          Team.count
+          SlackRubyBotServer::Team.count
         end
 
         def active_teams_count
-          Team.active.count
+          SlackRubyBotServer::Team.active.count
         end
 
         def base_url(opts)
diff --git a/lib/slack-ruby-bot-server/app.rb b/lib/slack-ruby-bot-server/app.rb
@@ -32,11 +32,11 @@ def init_database!
     end
 
     def mark_teams_active!
-      Team.where(active: nil).update_all(active: true)
+      SlackRubyBotServer::Team.where(active: nil).update_all(active: true)
     end
 
     def update_team_name_and_id!
-      Team.active.where(team_id: nil).each do |team|
+      SlackRubyBotServer::Team.active.where(team_id: nil).each do |team|
         begin
           auth = team.ping![:auth]
           team.update_attributes!(team_id: auth['team_id'], name: auth['team'])
@@ -50,13 +50,13 @@ def update_team_name_and_id!
     def migrate_from_single_team!
       return unless ENV.key?('SLACK_API_TOKEN')
       logger.info 'Migrating from env SLACK_API_TOKEN ...'
-      team = Team.find_or_create_from_env!
+      team = SlackRubyBotServer::Team.find_or_create_from_env!
       logger.info "Automatically migrated team: #{team}."
       logger.warn "You should unset ENV['SLACK_API_TOKEN']."
     end
 
     def purge_inactive_teams!
-      Team.purge!
+      SlackRubyBotServer::Team.purge!
     end
 
     def configure_global_aliases!
diff --git a/lib/slack-ruby-bot-server/models/team/activerecord.rb b/lib/slack-ruby-bot-server/models/team/activerecord.rb
@@ -1,13 +1,15 @@
 require_relative 'methods'
 
-class Team < ActiveRecord::Base
-  include Methods
+module SlackRubyBotServer
+  class Team < ActiveRecord::Base
+    include Methods
 
-  def self.purge!
-    # destroy teams inactive for two weeks
-    Team.where(active: false).where('updated_at <= ?', 2.weeks.ago).each do |team|
-      puts "Destroying #{team}, inactive since #{team.updated_at}, over two weeks ago."
-      team.destroy
+    def self.purge!
+      # destroy teams inactive for two weeks
+      SlackRubyBotServer::Team.where(active: false).where('updated_at <= ?', 2.weeks.ago).each do |team|
+        puts "Destroying #{team}, inactive since #{team.updated_at}, over two weeks ago."
+        team.destroy
+      end
     end
   end
 end
diff --git a/lib/slack-ruby-bot-server/models/team/methods.rb b/lib/slack-ruby-bot-server/models/team/methods.rb
@@ -42,8 +42,8 @@ def ping!
     def self.find_or_create_from_env!
       token = ENV['SLACK_API_TOKEN']
       return unless token
-      team = Team.where(token: token).first
-      team ||= Team.new(token: token)
+      team = SlackRubyBotServer::Team.where(token: token).first
+      team ||= SlackRubyBotServer::Team.new(token: token)
       info = Slack::Web::Client.new(token: token).team_info
       team.team_id = info['team']['id']
       team.name = info['team']['name']
diff --git a/lib/slack-ruby-bot-server/models/team/mongoid.rb b/lib/slack-ruby-bot-server/models/team/mongoid.rb
@@ -1,22 +1,24 @@
 require_relative 'methods'
 
-class Team
-  include Mongoid::Document
-  include Mongoid::Timestamps
+module SlackRubyBotServer
+  class Team
+    include Mongoid::Document
+    include Mongoid::Timestamps
 
-  field :team_id, type: String
-  field :name, type: String
-  field :domain, type: String
-  field :token, type: String
-  field :active, type: Boolean, default: true
+    field :team_id, type: String
+    field :name, type: String
+    field :domain, type: String
+    field :token, type: String
+    field :active, type: Boolean, default: true
 
-  include Methods
+    include Methods
 
-  def self.purge!
-    # destroy teams inactive for two weeks
-    Team.where(active: false, :updated_at.lte => 2.weeks.ago).each do |team|
-      Mongoid.logger.info "Destroying #{team}, inactive since #{team.updated_at}, over two weeks ago."
-      team.destroy
+    def self.purge!
+      # destroy teams inactive for two weeks
+      SlackRubyBotServer::Team.where(active: false, :updated_at.lte => 2.weeks.ago).each do |team|
+        Mongoid.logger.info "Destroying #{team}, inactive since #{team.updated_at}, over two weeks ago."
+        team.destroy
+      end
     end
   end
-end
+end
diff --git a/lib/slack-ruby-bot-server/rspec/fabricators/team.rb b/lib/slack-ruby-bot-server/rspec/fabricators/team.rb
@@ -1,4 +1,4 @@
-Fabricator(:team) do
+Fabricator(:team, from: 'SlackRubyBotServer::Team') do
   token { Fabricate.sequence(:team_token) { |i| "abc-#{i}" } }
   team_id { Fabricate.sequence(:team_id) { |i| "T#{i}" } }
   name { Faker::Lorem.word }
diff --git a/lib/slack-ruby-bot-server/service.rb b/lib/slack-ruby-bot-server/service.rb
@@ -60,7 +60,7 @@ def stop!(team)
     end
 
     def start_from_database!
-      Team.active.each do |team|
+      SlackRubyBotServer::Team.active.each do |team|
         run_callbacks :booting, team
         start!(team)
         run_callbacks :booted, team
diff --git a/spec/api/endpoints/status_endpoint_spec.rb b/spec/api/endpoints/status_endpoint_spec.rb
@@ -4,7 +4,7 @@
   include SlackRubyBotServer::Api::Test::EndpointTest
 
   before do
-    allow_any_instance_of(Team).to receive(:ping!).and_return(ok: 1)
+    allow_any_instance_of(SlackRubyBotServer::Team).to receive(:ping!).and_return(ok: 1)
   end
 
   context 'status' do
diff --git a/spec/api/endpoints/teams_endpoint_spec.rb b/spec/api/endpoints/teams_endpoint_spec.rb
@@ -3,7 +3,7 @@
 describe SlackRubyBotServer::Api::Endpoints::TeamsEndpoint do
   include SlackRubyBotServer::Api::Test::EndpointTest
 
-  it_behaves_like 'a cursor api', Team
+  it_behaves_like 'a cursor api', SlackRubyBotServer::Team
 
   context 'team' do
     let(:existing_team) { Fabricate(:team) }
@@ -68,9 +68,9 @@
           team = client.teams._post(code: 'code')
           expect(team.team_id).to eq 'team_id'
           expect(team.name).to eq 'team_name'
-          team = Team.find(team.id)
+          team = SlackRubyBotServer::Team.find(team.id)
           expect(team.token).to eq 'token'
-        end.to change(Team, :count).by(1)
+        end.to change(SlackRubyBotServer::Team, :count).by(1)
       end
       it 'reactivates a deactivated team' do
         expect(SlackRubyBotServer::Service.instance).to receive(:start!)
@@ -80,10 +80,10 @@
           expect(team.team_id).to eq existing_team.team_id
           expect(team.name).to eq existing_team.name
           expect(team.active).to be true
-          team = Team.find(team.id)
+          team = SlackRubyBotServer::Team.find(team.id)
           expect(team.token).to eq 'token'
           expect(team.active).to be true
-        end.to_not change(Team, :count)
+        end.to_not change(SlackRubyBotServer::Team, :count)
       end
       it 'returns a useful error when team already exists' do
         existing_team = Fabricate(:team, token: 'token')
@@ -100,10 +100,10 @@
           expect(team.team_id).to eq existing_team.team_id
           expect(team.name).to eq existing_team.name
           expect(team.active).to be true
-          team = Team.find(team.id)
+          team = SlackRubyBotServer::Team.find(team.id)
           expect(team.token).to eq 'token'
           expect(team.active).to be true
-        end.to_not change(Team, :count)
+        end.to_not change(SlackRubyBotServer::Team, :count)
       end
     end
   end
diff --git a/spec/integration/teams_spec.rb b/spec/integration/teams_spec.rb
@@ -11,14 +11,14 @@
   end
   context 'oauth', vcr: { cassette_name: 'auth_test' } do
     it 'registers a team' do
-      allow_any_instance_of(Team).to receive(:ping!).and_return(ok: true)
+      allow_any_instance_of(SlackRubyBotServer::Team).to receive(:ping!).and_return(ok: true)
       expect(SlackRubyBotServer::Service.instance).to receive(:start!)
       oauth_access = { 'bot' => { 'bot_access_token' => 'token' }, 'team_id' => 'team_id', 'team_name' => 'team_name' }
       allow_any_instance_of(Slack::Web::Client).to receive(:oauth_access).with(hash_including(code: 'code')).and_return(oauth_access)
       expect do
         visit '/?code=code'
         expect(page.find('#messages')).to have_content 'Team successfully registered!'
-      end.to change(Team, :count).by(1)
+      end.to change(SlackRubyBotServer::Team, :count).by(1)
     end
   end
   context 'homepage' do
diff --git a/spec/models/team_spec.rb b/spec/models/team_spec.rb
@@ -1,14 +1,14 @@
 require 'spec_helper'
 
-describe Team do
+describe SlackRubyBotServer::Team do
   context '#find_or_create_from_env!' do
     before do
       ENV['SLACK_API_TOKEN'] = 'token'
     end
     context 'team', vcr: { cassette_name: 'team_info' } do
       it 'creates a team' do
-        expect { Team.find_or_create_from_env! }.to change(Team, :count).by(1)
-        team = Team.first
+        expect { SlackRubyBotServer::Team.find_or_create_from_env! }.to change(SlackRubyBotServer::Team, :count).by(1)
+        team = SlackRubyBotServer::Team.first
         expect(team.team_id).to eq 'T04KB5WQH'
         expect(team.name).to eq 'dblock'
         expect(team.domain).to eq 'dblockdotorg'
@@ -27,13 +27,13 @@
     let!(:inactive_team_a_month_ago) { Fabricate(:team, updated_at: 1.month.ago, active: false) }
     it 'destroys teams inactive for two weeks' do
       expect do
-        Team.purge!
-      end.to change(Team, :count).by(-2)
-      expect(Team.where(id: active_team.id).first).to eq active_team
-      expect(Team.where(id: inactive_team.id).first).to eq inactive_team
-      expect(Team.where(id: inactive_team_a_week_ago.id).first).to eq inactive_team_a_week_ago
-      expect(Team.where(id: inactive_team_two_weeks_ago.id).first).to be nil
-      expect(Team.where(id: inactive_team_a_month_ago.id).first).to be nil
+        SlackRubyBotServer::Team.purge!
+      end.to change(SlackRubyBotServer::Team, :count).by(-2)
+      expect(SlackRubyBotServer::Team.where(id: active_team.id).first).to eq active_team
+      expect(SlackRubyBotServer::Team.where(id: inactive_team.id).first).to eq inactive_team
+      expect(SlackRubyBotServer::Team.where(id: inactive_team_a_week_ago.id).first).to eq inactive_team_a_week_ago
+      expect(SlackRubyBotServer::Team.where(id: inactive_team_two_weeks_ago.id).first).to be nil
+      expect(SlackRubyBotServer::Team.where(id: inactive_team_a_month_ago.id).first).to be nil
     end
   end
 end
diff --git a/spec/slack-ruby-bot-server/app_spec.rb b/spec/slack-ruby-bot-server/app_spec.rb
@@ -13,7 +13,7 @@
   end
   context '#purge_inactive_teams!' do
     it 'purges teams' do
-      expect(Team).to receive(:purge!)
+      expect(SlackRubyBotServer::Team).to receive(:purge!)
       subject.send(:purge_inactive_teams!)
     end
   end
diff --git a/spec/slack-ruby-bot-server/ping_spec.rb b/spec/slack-ruby-bot-server/ping_spec.rb
@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe SlackRubyBotServer::Ping do
-  let(:team) { Team.new(token: 'token') }
+  let(:team) { SlackRubyBotServer::Team.new(token: 'token') }
   let(:options) { {} }
   let(:server) { SlackRubyBotServer::Server.new({ team: team }.merge(options)) }
   let(:client) { server.send(:client) }
diff --git a/spec/slack-ruby-bot-server/server_spec.rb b/spec/slack-ruby-bot-server/server_spec.rb
@@ -2,7 +2,7 @@
 
 describe SlackRubyBotServer::Server do
   let(:logger) { subject.send :logger }
-  let(:team) { Team.new(token: 'token') }
+  let(:team) { SlackRubyBotServer::Team.new(token: 'token') }
   context 'with options' do
     subject do
       SlackRubyBotServer::Server.new(
diff --git a/spec/support/api/endpoints/it_behaves_like_a_cursor_api.rb b/spec/support/api/endpoints/it_behaves_like_a_cursor_api.rb
@@ -1,6 +1,6 @@
 shared_examples_for 'a cursor api' do |model|
-  let(:model_s) { model.name.underscore.to_sym }
-  let(:model_ps) { model.name.underscore.pluralize.to_sym }
+  let(:model_s) { :team }
+  let(:model_ps) { :teams }
   context model.name do
     let(:cursor_params) { @cursor_params || {} }
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-Fabricator(:team) do`
	`1`	`+Fabricator(:team, from: 'SlackRubyBotServer::Team') do`
`2`	`2`	`token { Fabricate.sequence(:team_token) { \|i\| "abc-#{i}" } }`
`3`	`3`	`team_id { Fabricate.sequence(:team_id) { \|i\| "T#{i}" } }`
`4`	`4`	`name { Faker::Lorem.word }`