slack-ruby-bot-server 0.1.0

data/config/initializers/grape/sort_extension.rb

@@ -0,0 +1,8 @@
+module Grape
+  class API
+    def self.sort(value)
+      route_setting :sort, sort: value
+      value
+    end
+  end
+end

data/config/initializers/slack-ruby-bot/client.rb

@@ -0,0 +1,17 @@
+module SlackRubyBot
+  class Client
+    # keep track of the team that the client is connected to
+    attr_accessor :owner
+  end
+end
+
+Slack.configure do |config|
+  config.logger = Logger.new(STDOUT)
+  config.logger.level = Logger::WARN
+end
+
+SlackRubyBot::Client.logger.level = Logger::WARN
+
+Slack::RealTime::Client.configure do |config|
+  config.store_class = Slack::RealTime::Stores::Starter
+end

data/config/initializers/slack-ruby-bot/commands/base.rb

@@ -0,0 +1,21 @@
+module SlackRubyBot
+  module Commands
+    class Base
+      class << self
+        alias_method :_invoke, :invoke
+
+        def invoke(client, data)
+          _invoke client, data
+        rescue Mongoid::Errors::Validations => e
+          logger.info "#{name.demodulize.upcase}: #{client.owner}, error - #{e.document.class}, #{e.document.errors.to_hash}"
+          client.say(channel: data.channel, text: e.document.errors.first[1], gif: 'error')
+          true
+        rescue StandardError => e
+          logger.info "#{name.demodulize.upcase}: #{client.owner}, #{e.class}: #{e}"
+          client.say(channel: data.channel, text: e.message, gif: 'error')
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+require 'celluloid/current'
+require 'kaminari/grape'
+require 'mongoid-scroll'
+require 'grape-swagger'
+require 'slack-ruby-bot'
+
+Dir[File.expand_path('../config/initializers', __dir__) + '/**/*.rb'].each do |file|
+  require file
+end
+
+require 'slack-ruby-bot-server/version'
+require 'slack-ruby-bot-server/info'
+require 'slack-ruby-bot-server/models'
+require 'slack-ruby-bot-server/api'
+require 'slack-ruby-bot-server/app'
+require 'slack-ruby-bot-server/server'
+require 'slack-ruby-bot-server/service'

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

@@ -0,0 +1,8 @@
+require 'grape'
+require 'roar'
+require 'grape-roar'
+
+require 'slack-ruby-bot-server/api/helpers'
+require 'slack-ruby-bot-server/api/presenters'
+require 'slack-ruby-bot-server/api/endpoints'
+require 'slack-ruby-bot-server/api/middleware'

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

@@ -0,0 +1,3 @@
+require 'slack-ruby-bot-server/api/endpoints/teams_endpoint'
+require 'slack-ruby-bot-server/api/endpoints/status_endpoint'
+require 'slack-ruby-bot-server/api/endpoints/root_endpoint'

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

@@ -0,0 +1,22 @@
+module SlackRubyBotServer
+  module Api
+    module Endpoints
+      class RootEndpoint < Grape::API
+        include Helpers::ErrorHelpers
+
+        prefix 'api'
+
+        format :json
+        formatter :json, Grape::Formatter::Roar
+        get do
+          present self, with: Presenters::RootPresenter
+        end
+
+        mount StatusEndpoint
+        mount TeamsEndpoint
+
+        add_swagger_documentation
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module SlackRubyBotServer
+  module Api
+    module Endpoints
+      class StatusEndpoint < Grape::API
+        format :json
+
+        namespace :status do
+          desc 'Get system status.'
+          get do
+            present self, with: Presenters::StatusPresenter
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+module SlackRubyBotServer
+  module Api
+    module Endpoints
+      class TeamsEndpoint < Grape::API
+        format :json
+        helpers Helpers::CursorHelpers
+        helpers Helpers::SortHelpers
+        helpers Helpers::PaginationParameters
+
+        namespace :teams do
+          desc 'Get a team.'
+          params do
+            requires :id, type: String, desc: 'Team ID.'
+          end
+          get ':id' do
+            team = Team.find(params[:id]) || error!('Not Found', 404)
+            present team, with: Presenters::TeamPresenter
+          end
+
+          desc 'Get all the teams.'
+          params do
+            optional :active, type: Boolean, desc: 'Return active teams only.'
+            use :pagination
+          end
+          sort Team::SORT_ORDERS
+          get do
+            teams = Team.all
+            teams = teams.active if params[:active]
+            teams = paginate_and_sort_by_cursor(teams, default_sort_order: '-_id')
+            present teams, with: Presenters::TeamsPresenter
+          end
+
+          desc 'Create a team using an OAuth token.'
+          params do
+            requires :code, type: String
+          end
+          post do
+            client = Slack::Web::Client.new
+
+            fail 'Missing SLACK_CLIENT_ID or SLACK_CLIENT_SECRET.' unless ENV.key?('SLACK_CLIENT_ID') && ENV.key?('SLACK_CLIENT_SECRET')
+
+            rc = client.oauth_access(
+              client_id: ENV['SLACK_CLIENT_ID'],
+              client_secret: ENV['SLACK_CLIENT_SECRET'],
+              code: params[:code]
+            )
+
+            token = rc['bot']['bot_access_token']
+            team = Team.where(token: token).first
+            team ||= Team.where(team_id: rc['team_id']).first
+            if team && !team.active?
+              team.activate!(token)
+            elsif team
+              fail "Team #{team.name} is already registered."
+            else
+              team = Team.create!(
+                token: token,
+                team_id: rc['team_id'],
+                name: rc['team_name']
+              )
+            end
+
+            Service.instance.start!(team)
+            present team, with: Presenters::TeamPresenter
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,4 @@
+require 'slack-ruby-bot-server/api/helpers/cursor_helpers'
+require 'slack-ruby-bot-server/api/helpers/pagination_parameters'
+require 'slack-ruby-bot-server/api/helpers/sort_helpers'
+require 'slack-ruby-bot-server/api/helpers/error_helpers'

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

@@ -0,0 +1,37 @@
+module SlackRubyBotServer
+  module Api
+    module Helpers
+      module CursorHelpers
+        extend ActiveSupport::Concern
+
+        # apply cursor-based pagination to a collection
+        # returns a hash:
+        #   results: (paginated collection subset)
+        #   next: (cursor to the next page)
+        def paginate_by_cursor(coll, &_block)
+          fail '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)
+          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
+          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))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+module SlackRubyBotServer
+  module Api
+    module Helpers
+      module ErrorHelpers
+        extend ActiveSupport::Concern
+
+        included do
+          rescue_from :all, backtrace: true do |e|
+            backtrace = e.backtrace[0..5].join("\n  ")
+            Middleware.logger.error "#{e.class.name}: #{e.message}\n  #{backtrace}"
+            error = { type: 'other_error', message: e.message }
+            error[:backtrace] = backtrace
+            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)
+          end
+          rescue_from Grape::Exceptions::Validation 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: 'Invalid parameters.',
+              detail: { e.params.join(', ') => [e.message] }
+            }.to_json, 400)
+          end
+          rescue_from Grape::Exceptions::ValidationErrors 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: 'Invalid parameters.',
+              detail: e.errors.each_with_object({}) do |(k, v), h|
+                # JSON does not permit having a key of type Array
+                h[k.count == 1 ? k.first : k.join(', ')] = v
+              end
+            }.to_json, 400)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module SlackRubyBotServer
+  module Api
+    module Helpers
+      module PaginationParameters
+        extend Grape::API::Helpers
+
+        params :pagination do
+          optional :offset, type: Integer, desc: 'Offset from which to retrieve.'
+          optional :size, type: Integer, desc: 'Number of items to retrieve for this page or from the current offset.'
+          optional :cursor, type: String, desc: 'Cursor for pagination.'
+          optional :total_count, desc: 'Include total count in the response.'
+          mutually_exclusive :offset, :cursor
+        end
+
+        ALL = %w(cursor size sort offset total_count)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+module SlackRubyBotServer
+  module Api
+    module Helpers
+      module SortHelpers
+        extend ActiveSupport::Concern
+
+        def sort_order(options = {})
+          params[:sort] = options[:default_sort_order] unless params[:sort]
+          return [] unless params[:sort]
+          sort_order = params[:sort].to_s
+          unless options[:default_sort_order] == sort_order
+            supported_sort_orders = route_sort
+            error!("This API doesn't support sorting", 400) if supported_sort_orders.blank?
+            unless supported_sort_orders.include?(sort_order)
+              error!("Invalid sort order: #{sort_order}, must be#{supported_sort_orders.count == 1 ? '' : ' one of'} '#{supported_sort_orders.join("', '")}'", 400)
+            end
+          end
+          sort_order = sort_order.split(',').map do |sort_entry|
+            sort_order = {}
+            if sort_entry[0] == '-'
+              sort_order[:direction] = :desc
+              sort_order[:column] = sort_entry[1..-1]
+            else
+              sort_order[:direction] = :asc
+              sort_order[:column] = sort_entry
+            end
+            error!("Invalid sort: #{sort_entry}", 400) if sort_order[:column].blank?
+            sort_order
+          end
+          sort_order
+        end
+
+        def route_sort
+          (env['api.endpoint'].route_setting(:sort) || {})[:sort]
+        end
+
+        def sort(coll, options = {})
+          sort_order = sort_order(options)
+          unless sort_order.empty?
+            if coll.respond_to?(:asc) && coll.respond_to?(:desc)
+              sort_order.each do |s|
+                coll = coll.send(s[:direction], s[:column])
+              end
+            else
+              error!("Cannot sort #{coll.class.name}", 500)
+            end
+          end
+          coll = coll.is_a?(Module) && coll.respond_to?(:all) ? coll.all : coll
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+%w(rack/cors rack-rewrite rack-server-pages).each { |l| require l }
+
+module SlackRubyBotServer
+  module Api
+    class Middleware
+      def self.logger
+        @logger ||= begin
+          $stdout.sync = true
+          Logger.new(STDOUT)
+        end
+      end
+
+      def self.instance
+        @instance ||= Rack::Builder.new do
+          use Rack::Cors do
+            allow do
+              origins '*'
+              resource '*', headers: :any, methods: [:get, :post]
+            end
+          end
+
+          # rewrite HAL links to make them clickable in a browser
+          use Rack::Rewrite do
+            r302 %r{(\/[\w\/]*\/)(%7B|\{)?(.*)(%7D|\})}, '$1'
+          end
+
+          use Rack::ServerPages do |config|
+            config.view_path = [
+              'views', # relative to Dir.pwd
+              'public', # relative to Dir.pwd
+              File.expand_path(File.join(__dir__, '../../../public')) # built-in fallback
+            ]
+          end
+
+          run Middleware.new
+        end.to_app
+      end
+
+      def call(env)
+        Endpoints::RootEndpoint.call(env)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+require 'roar/representer'
+require 'roar/json'
+require 'roar/json/hal'
+
+require 'slack-ruby-bot-server/api/presenters/paginated_presenter'
+require 'slack-ruby-bot-server/api/presenters/status_presenter'
+require 'slack-ruby-bot-server/api/presenters/team_presenter'
+require 'slack-ruby-bot-server/api/presenters/teams_presenter'
+require 'slack-ruby-bot-server/api/presenters/root_presenter'

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

@@ -0,0 +1,38 @@
+module SlackRubyBotServer
+  module Api
+    module Presenters
+      module PaginatedPresenter
+        include Roar::JSON::HAL
+        include Roar::Hypermedia
+        include Grape::Roar::Representer
+
+        property :total_count
+
+        link :self do |opts|
+          "#{request_url(opts)}#{query_string_for_cursor(nil, opts)}"
+        end
+
+        link :next do |opts|
+          "#{request_url(opts)}#{query_string_for_cursor(represented.next, opts)}" if represented.next
+        end
+
+        private
+
+        def request_url(opts)
+          request = Grape::Request.new(opts[:env])
+          "#{request.base_url}#{opts[:env]['PATH_INFO']}"
+        end
+
+        # replace the page and offset parameters in the query string
+        def query_string_for_cursor(cursor, opts)
+          qs = Hashie::Mash.new(Rack::Utils.parse_nested_query(opts[:env]['QUERY_STRING']))
+          if cursor
+            qs.merge!(cursor: cursor)
+            qs.delete(:offset)
+          end
+          "?#{qs.to_query}" unless qs.empty?
+        end
+      end
+    end
+  end
+end