slack-ruby-bot-server 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 405235dc495bea8024cf67229a77d93511c5b88e
-  data.tar.gz: 0034902639a9d5e9bcc9bffb6cf8b1c62c007873
+  metadata.gz: 5b91c82bc0a49452c0b3871786fb739b763c8a25
+  data.tar.gz: 12e73c3db13dcaba4da39f499f0acb797e2db122
 SHA512:
-  metadata.gz: 93bf915299dd2309ce6b2a817273f95483c1a4b37a3624cf843b22646890eff29fa0e26365baf8f9326a740d9e8e2302d87fbc5a92dc8cd953d0af02e1203e6d
-  data.tar.gz: d69d616b93a479aee8401cdc24dd790405ef48b21d8ae986bd1b01d3e2b5c1931747b7ed2b17fa7935da172e30b5257b7a7f39d0335ac0ccd45988659a652afb
+  metadata.gz: bbf49bff1a3f7723468cc5841c68df08de3598451f1868ba4084262faa89a5a044ccbd1ea5a6a57cbbc8aadce2841681fb4e31c82a3d25c151af4099e13c3a5c
+  data.tar.gz: d9a0fa731ec1b9da48f4ef0e73189ebd6acf473e2f3bb5416e39acc5c1c0385aeea922b1e6d99d137cf2d8101a32356100822741f835b50df7a67a9e0062ba21

data/.travis.yml

@@ -2,22 +2,24 @@ language: ruby
 
 cache: bundler
 
-services:
-  - mongodb
-
 matrix:
   include:
     - rvm: 2.3.1
       script:
         - bundle exec danger
     - rvm: 2.3.1
-    - rvm: 2.3.0
-    - rvm: ruby-head
-    - rvm: jruby-head
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
+      env: DATABASE_ADAPTER=activerecord
+      services:
+        - postgresql
+    - rvm: 2.3.1
+      env: DATABASE_ADAPTER=mongoid
+      services:
+        - mongodb
 
 before_install:
   - "export DISPLAY=:99.0"
   - "sh -e /etc/init.d/xvfb start"
+
+script:
+  - bundle exec rake
+  - BUNDLE_GEMFILE=Gemfile && cd sample_apps/sample_app_$DATABASE_ADAPTER && bundle && bundle exec rake

data/CHANGELOG.md

@@ -1,9 +1,15 @@
 ### Changelog
 
+#### 0.6.0 (3/12/2017)
+
+* [#38](https://github.com/slack-ruby/slack-ruby-bot-server/issues/7): Added ActiveRecord support - [@zachfeldman](https://github.com/zachfeldman), [@spencerldixon](https://github.com/spencerldixon), [@dblock](https://github.com/dblock).
+* [#45](https://github.com/slack-ruby/slack-ruby-bot-server/pull/45): Updated grape-roar to 0.4.0 - [@swalberg](https://github.com/swalberg).
+* [#49](https://github.com/slack-ruby/slack-ruby-bot-server/pull/49): Run tests in the sample apps part of CI - [@dblock](https://github.com/dblock).
+
 #### 0.5.0 (2/9/2017)
 
 * [#43](https://github.com/slack-ruby/slack-ruby-bot-server/pull/43): Fix: `cannot load kaminari/grape` - [@dblock](https://github.com/dblock).
-* [#43](https://github.com/slack-ruby/slack-ruby-bot-server/pull/43): Fix: `undefined method `[]' for nil:NilClass` in APIs - [@dblock](https://github.com/dblock).
+* [#43](https://github.com/slack-ruby/slack-ruby-bot-server/pull/43): Fix: `undefined method '[]' for nil:NilClass` in APIs - [@dblock](https://github.com/dblock).
 * [#28](https://github.com/slack-ruby/slack-ruby-bot-server/pull/28): Use slack-ruby-danger gem - [@dblock](https://github.com/dblock).
 * [#31](https://github.com/slack-ruby/slack-ruby-bot-server/pull/31): Adds MONGODB_URI as environment variable for MongoDB - [@corprew](https://github.com/corprew).
 

data/Gemfile

@@ -1,5 +1,21 @@
 source 'https://rubygems.org'
 
+case ENV['DATABASE_ADAPTER']
+when 'mongoid' then
+  gem 'mongoid'
+  gem 'kaminari-mongoid'
+  gem 'mongoid-scroll'
+when 'activerecord' then
+  gem 'pg'
+  gem 'activerecord'
+  gem 'otr-activerecord'
+  gem 'cursor_pagination'
+when nil then
+  warn "Missing ENV['DATABASE_ADAPTER']."
+else
+  warn "Invalid ENV['DATABASE_ADAPTER']: #{ENV['DATABASE_ADAPTER']}."
+end
+
 gemspec
 
 group :development, :test do

data/README.md

@@ -13,11 +13,11 @@ A library that contains a [Grape](http://github.com/ruby-grape/grape) API servin
 
 ### Stable Release
 
-You're reading the documentation for the **stable** release of slack-ruby-bot-server, 0.5.0. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+You're reading the documentation for the **stable** release of slack-ruby-bot-server, 0.6.0. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
 
 ### Try Me
 
-A demo version of the [sample app](sample_app) is running on Heroku at [slack-ruby-bot-server.herokuapp.com](https://slack-ruby-bot-server.herokuapp.com). Use the _Add to Slack_ button. The bot will join your team as _@slackbotserver_.
+A demo version of the [sample app with mongoid](sample_apps/sample_app_mongoid) is running on Heroku at [slack-ruby-bot-server.herokuapp.com](https://slack-ruby-bot-server.herokuapp.com). Use the _Add to Slack_ button. The bot will join your team as _@slackbotserver_.
 
 ![](images/slackbutton.gif)
 
@@ -27,9 +27,36 @@ Once a bot is registered, you can invite to a channel with `/invite @slackbotser
 
 ### Run Your Own
 
-You can use the [sample application](sample_app) to bootstrap your project and start adding slack command handlers on top of this code.
+You can use one of the [sample applications](sample_apps) to bootstrap your project and start adding slack command handlers on top of this code. A database is required to store teams.
 
-Install [MongoDB](https://www.mongodb.org/downloads), required to store teams. We would like your help with [supporting other databases](https://github.com/slack-ruby/slack-ruby-bot-server/issues/12).
+### MongoDB
+
+Use MongoDB with [Mongoid](https://github.com/mongodb/mongoid) as ODM. Configure the database connection in `mongoid.yml`. Add the `mongoid` gem in your Gemfile.
+
+```
+gem 'mongoid'
+gem 'kaminari-mongoid'
+gem 'mongoid-scroll'
+gem 'slack-ruby-bot-server'
+```
+
+See the [sample app using Mongoid](sample_apps/sample_app_mongoid) for more information.
+
+### ActiveRecord
+
+Use ActiveRecord with, for example, PostgreSQL via [pg](https://github.com/ged/ruby-pg). Configure the database connection in `postgresql.yml`. Add the `activerecord`, `pg`, `otr-activerecord` and `cursor_pagination` gems to your Gemfile.
+
+```
+gem 'pg'
+gem 'activerecord', require: 'active_record'
+gem 'slack-ruby-bot-server'
+gem 'otr-activerecord'
+gem 'cursor_pagination'
+```
+
+See the [sample app using ActiveRecord](sample_apps/sample_app_activerecord) for more information.
+
+### Usage
 
 [Create a New Application](https://api.slack.com/applications/new) on Slack.
 

data/UPGRADING.md

@@ -1,6 +1,31 @@
 Upgrading Slack-Ruby-Bot-Server
 ===============================
 
+### Upgrading to >= 0.6.0
+
+#### Mongoid and ActiveRecord support
+
+Version 0.6.0 supports both Mongoid and ActiveRecord. The `mongoid` gem is no longer a dependency, so you must manually add the gems in your Gemfile.
+
+##### Mongoid
+
+```
+gem 'mongoid'
+gem 'slack-ruby-bot-server'
+```
+
+##### ActiveRecord (with PostgreSQL)
+
+```
+gem 'pg'
+gem 'activerecord', require: 'active_record'
+gem 'slack-ruby-bot-server'
+```
+
+The order matters, and the driver is required _first_, otherwise you will get a `One of "mongoid" or "activerecord" is required.` error.
+
+See [#48](https://github.com/slack-ruby/slack-ruby-bot-server/pull/48) for more information.
+
 ### Upgrading to >= 0.4.0
 
 #### Add giphy to your Gemfile for GIF support

data/lib/slack-ruby-bot-server.rb

@@ -1,15 +1,16 @@
 require 'celluloid/current'
-require 'kaminari/grape'
-require 'mongoid-scroll'
+
 require 'grape-swagger'
 require 'slack-ruby-bot'
+require 'slack-ruby-bot-server/server'
+require 'slack-ruby-bot-server/config'
 
 require 'slack-ruby-bot-server/ext'
 require 'slack-ruby-bot-server/version'
 require 'slack-ruby-bot-server/info'
-require 'slack-ruby-bot-server/models'
+
+require "slack-ruby-bot-server/config/database_adapters/#{SlackRubyBotServer::Config.database_adapter}.rb"
+
 require 'slack-ruby-bot-server/api'
 require 'slack-ruby-bot-server/app'
-require 'slack-ruby-bot-server/server'
-require 'slack-ruby-bot-server/config'
 require 'slack-ruby-bot-server/service'

data/lib/slack-ruby-bot-server/api/endpoints/teams_endpoint.rb

@@ -26,7 +26,7 @@ module SlackRubyBotServer
           get do
             teams = Team.all
             teams = teams.active if params[:active]
-            teams = paginate_and_sort_by_cursor(teams, default_sort_order: '-_id')
+            teams = paginate_and_sort_by_cursor(teams, default_sort_order: '-id')
             present teams, with: Presenters::TeamsPresenter
           end
 

data/lib/slack-ruby-bot-server/api/helpers/cursor_helpers.rb

@@ -8,28 +8,41 @@ module SlackRubyBotServer
         # returns a hash:
         #   results: (paginated collection subset)
         #   next: (cursor to the next page)
-        def paginate_by_cursor(coll, &_block)
-          raise 'Both cursor and offset parameters are present, these are mutually exclusive.' if params.key?(:offset) && params.key?(:cursor)
-          results = { results: [], next: nil }
-          size = (params[:size] || 10).to_i
-          if params.key?(:offset)
-            skip = params[:offset].to_i
-            coll = coll.skip(skip)
+        if SlackRubyBotServer::Config.mongoid?
+          def paginate_by_cursor(coll, _options)
+            raise 'Both cursor and offset parameters are present, these are mutually exclusive.' if params.key?(:offset) && params.key?(:cursor)
+            results = { results: [], next: nil }
+            coll = coll.skip(params[:offset].to_i) if params.key?(:offset)
+            size = (params[:size] || 10).to_i
+            coll = coll.limit(size)
+            coll.scroll(params[:cursor]) do |record, next_cursor|
+              results[:results] << record if record
+              results[:next] = next_cursor.to_s
+              break if results[:results].count >= size
+            end
+            results[:total_count] = coll.count if params[:total_count] && coll.respond_to?(:count)
+            results
           end
-          # some items may be skipped with a block
-          query = block_given? ? coll : coll.limit(size)
-          query.scroll(params[:cursor]) do |record, next_cursor|
-            record = yield(record) if block_given?
-            results[:results] << record if record
-            results[:next] = next_cursor.to_s
-            break if results[:results].count >= size
+        elsif SlackRubyBotServer::Config.activerecord?
+          def paginate_by_cursor(coll, options)
+            raise 'Both cursor and offset parameters are present, these are mutually exclusive.' if params.key?(:offset) && params.key?(:cursor)
+            results = { results: [], next: nil }
+            size = (params[:size] || 10).to_i
+            results[:total_count] = coll.count(:all) if params[:total_count]
+            coll = coll.offset(params[:offset].to_i) if params.key?(:offset)
+            sort_options = {}
+            sort_order(options).each do |order|
+              sort_options[order[:column]] = { reverse: true } if order[:direction] == :desc
+            end
+            coll = coll.cursor(params[:cursor], columns: sort_options).per(size)
+            results[:results] = coll.to_a
+            results[:next] = coll.next_cursor.to_s unless coll.last_page?
+            results
           end
-          results[:total_count] = coll.count if params[:total_count] && coll.respond_to?(:count)
-          results
         end
 
-        def paginate_and_sort_by_cursor(coll, options = {}, &block)
-          Hashie::Mash.new(paginate_by_cursor(sort(coll, options), &block))
+        def paginate_and_sort_by_cursor(coll, options = {})
+          Hashie::Mash.new(paginate_by_cursor(sort(coll, options), options))
         end
       end
     end

data/lib/slack-ruby-bot-server/api/helpers/error_helpers.rb

@@ -13,16 +13,18 @@ module SlackRubyBotServer
             rack_response(error.to_json, 400)
           end
           # rescue document validation errors into detail json
-          rescue_from Mongoid::Errors::Validations do |e|
-            backtrace = e.backtrace[0..5].join("\n  ")
-            Middleware.logger.warn "#{e.class.name}: #{e.message}\n  #{backtrace}"
-            rack_response({
-              type: 'param_error',
-              message: e.document.errors.full_messages.uniq.join(', ') + '.',
-              detail: e.document.errors.messages.each_with_object({}) do |(k, v), h|
-                h[k] = v.uniq
-              end
-            }.to_json, 400)
+          if SlackRubyBotServer::Config.mongoid?
+            rescue_from Mongoid::Errors::Validations do |e|
+              backtrace = e.backtrace[0..5].join("\n  ")
+              Middleware.logger.warn "#{e.class.name}: #{e.message}\n  #{backtrace}"
+              rack_response({
+                type: 'param_error',
+                message: e.document.errors.full_messages.uniq.join(', ') + '.',
+                detail: e.document.errors.messages.each_with_object({}) do |(k, v), h|
+                  h[k] = v.uniq
+                end
+              }.to_json, 400)
+            end
           end
           rescue_from Grape::Exceptions::Validation do |e|
             backtrace = e.backtrace[0..5].join("\n  ")

data/lib/slack-ruby-bot-server/api/helpers/sort_helpers.rb

@@ -37,7 +37,11 @@ module SlackRubyBotServer
         def sort(coll, options = {})
           sort_order = sort_order(options)
           unless sort_order.empty?
-            if coll.respond_to?(:asc) && coll.respond_to?(:desc)
+            if coll.respond_to?(:order)
+              sort_order.each do |s|
+                coll = coll.order(s[:column] => s[:direction])
+              end
+            elsif coll.respond_to?(:asc) && coll.respond_to?(:desc)
               sort_order.each do |s|
                 coll = coll.send(s[:direction], s[:column])
               end

data/lib/slack-ruby-bot-server/api/middleware.rb

@@ -1,4 +1,7 @@
-%w(rack/cors rack-rewrite rack-server-pages).each { |l| require l }
+require 'rack/cors'
+require 'rack-rewrite'
+require 'rack-server-pages'
+require 'otr-activerecord' if SlackRubyBotServer::Config.activerecord?
 
 module SlackRubyBotServer
   module Api
@@ -12,6 +15,8 @@ module SlackRubyBotServer
 
       def self.instance
         @instance ||= Rack::Builder.new do
+          use OTR::ActiveRecord::ConnectionManagement if SlackRubyBotServer::Config.activerecord?
+
           use Rack::Cors do
             allow do
               origins '*'

data/lib/slack-ruby-bot-server/api/presenters/status_presenter.rb

@@ -14,10 +14,14 @@ module SlackRubyBotServer
         property :active_teams_count
         property :ping
 
-        private
-
         def ping
-          team = Team.asc(:_id).first
+          if SlackRubyBotServer::Config.mongoid?
+            team = Team.asc(:_id).first
+          elsif SlackRubyBotServer::Config.activerecord?
+            team = Team.last
+          else
+            raise 'Unsupported database driver.'
+          end
           return unless team
           team.ping!
         end

data/lib/slack-ruby-bot-server/app.rb

@@ -1,10 +1,8 @@
 module SlackRubyBotServer
   class App
     def prepare!
-      silence_loggers!
-      check_mongodb_provider!
       check_database!
-      create_indexes!
+      init_database!
       mark_teams_active!
       migrate_from_single_team!
       update_team_name_and_id!
@@ -25,29 +23,12 @@ module SlackRubyBotServer
       end
     end
 
-    def silence_loggers!
-      Mongoid.logger.level = Logger::INFO
-      Mongo::Logger.logger.level = Logger::INFO
-    end
-
-    def check_mongodb_provider!
-      return unless ENV['RACK_ENV'] == 'production'
-      unless ENV['MONGO_URL'] || ENV['MONGOHQ_URI'] || ENV['MONGODB_URI'] || ENV['MONGOLAB_URI']
-        raise "Missing ENV['MONGO_URL'], ENV['MONGOHQ_URI'], ENV['MONGODB_URI'], or ENV['MONGOLAB_URI']."
-      end
-    end
-
     def check_database!
-      rc = Mongoid.default_client.command(ping: 1)
-      return if rc && rc.ok?
-      raise rc.documents.first['error'] || 'Unexpected error.'
-    rescue Exception => e
-      warn "Error connecting to MongoDB: #{e.message}"
-      raise e
+      SlackRubyBotServer::DatabaseAdapter.check!
     end
 
-    def create_indexes!
-      ::Mongoid::Tasks::Database.create_indexes
+    def init_database!
+      SlackRubyBotServer::DatabaseAdapter.init!
     end
 
     def mark_teams_active!

data/lib/slack-ruby-bot-server/config.rb

@@ -3,9 +3,25 @@ module SlackRubyBotServer
     extend self
 
     attr_accessor :server_class
+    attr_accessor :database_adapter
 
     def reset!
       self.server_class = SlackRubyBotServer::Server
+      self.database_adapter = if defined?(::Mongoid)
+                                :mongoid
+                              elsif defined?(::ActiveRecord)
+                                :activerecord
+                              else
+                                raise 'One of "mongoid" or "activerecord" is required.'
+                              end
+    end
+
+    def activerecord?
+      database_adapter == :activerecord
+    end
+
+    def mongoid?
+      database_adapter == :mongoid
     end
 
     reset!

data/lib/slack-ruby-bot-server/config/database_adapters/activerecord.rb

@@ -0,0 +1,27 @@
+require 'slack-ruby-bot-server/models/team/activerecord.rb'
+
+module SlackRubyBotServer
+  module DatabaseAdapter
+    def self.check!
+      ActiveRecord::Base.connection_pool.with_connection(&:active?)
+      raise 'Unexpected error.' unless ActiveRecord::Base.connected?
+    rescue StandardError => e
+      warn "Error connecting to PostgreSQL: #{e.message}"
+      raise e
+    end
+
+    def self.init!
+      return if ActiveRecord::Base.connection.tables.include?('teams')
+      ActiveRecord::Base.connection.create_table :teams do |t|
+        t.string :team_id
+        t.string :name
+        t.string :domain
+        t.string :token
+        t.boolean :active, default: true
+        t.timestamps
+      end
+    end
+  end
+end
+
+::Boolean = Virtus::Attribute::Boolean

data/lib/slack-ruby-bot-server/config/database_adapters/mongoid.rb

@@ -0,0 +1,24 @@
+require 'slack-ruby-bot-server/models/team/mongoid.rb'
+require 'kaminari/grape'
+require 'mongoid-scroll'
+
+module SlackRubyBotServer
+  module DatabaseAdapter
+    def self.check!
+      rc = Mongoid.default_client.command(ping: 1)
+      return if rc && rc.ok?
+      raise rc.documents.first['error'] || 'Unexpected error.'
+    rescue StandardError => e
+      warn "Error connecting to MongoDB: #{e.message}"
+      raise e
+    end
+
+    def self.init!
+      # create indexes
+      ::Mongoid::Tasks::Database.create_indexes
+      # silence loggers
+      Mongoid.logger.level = Logger::INFO
+      Mongo::Logger.logger.level = Logger::INFO
+    end
+  end
+end