bot_mob 0.1.10 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b4ac52b9e58932d7a1f3b67621cc368ed2dbb25
-  data.tar.gz: ced498a9261d93c8a3ced4baa47cd4152e8d4ebd
+  metadata.gz: b5068a2c5397972fdc3dcf0e07945c19ee94d6f7
+  data.tar.gz: cefecbe976056706a7a26cb54d2c81795042d4ec
 SHA512:
-  metadata.gz: 321de0b69949d7aac245db16b992272313f6f4c699841b8760658839ab4ec0e8e30c53d8dc6ac0206b4a251f5dc1bd4d36ab860fe40cb78fff69ad4c18dd189f
-  data.tar.gz: a1f8864999ec86a775f87a8fb46169da67b86895aa966f36be4c78f0dc280b87ed9224b5db83ace70ce62de7f02b864bc1880b6d4f642880764637e64b7944ee
+  metadata.gz: ff9962b41566397c1b8faf8379caaf1d978733755184fdc6dfdd88dee66a801fe1f4cea4b2533c87f62d9297dc75a1224a29f0f29616342b2580b768f1440c4f
+  data.tar.gz: b83796a1a6922871f8ac0a98b2d1f199f9724fa221e35822350fbdcccf5912385d5bc774785af063af879ce56b72735b40db88fc2887f59bc83d270027ad4fcc

data/.env.test

@@ -0,0 +1,2 @@
+SLACK_CLIENT_ID=client_id
+SLACK_CLIENT_SECRET=client_secret

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.env

data/bin/console

@@ -1,6 +1,11 @@
 #!/usr/bin/env ruby
 
 require 'bundler/setup'
+require 'dotenv'
+Dotenv.load
+
 require 'bot_mob'
+require File.join(BotMob.root, 'spec/script/active_record')
+require File.join(BotMob.root, 'spec/support/mock_bot')
 require 'irb'
 IRB.start

data/bot_mob.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.2'
 
   spec.add_dependency 'bunny', '~> 2.5'
   spec.add_dependency 'crypt_keeper', '~> 0.21'
@@ -27,10 +28,14 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'celluloid-io', '~> 0.17'
   spec.add_dependency 'activerecord', '~> 4.2'
 
+  spec.add_development_dependency 'dotenv'
   spec.add_development_dependency 'bundler', '~> 1.12'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rubocop', '~> 0.40'
+  spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'simplecov', '~> 0.12'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'webmock'
   spec.add_development_dependency 'sqlite3', '~> 1.3'
 end

data/lib/bot_mob/ambassador.rb

@@ -1,6 +1,4 @@
 module BotMob
-  class InvalidNetworkError < StandardError; end
-
   class Ambassador
     NETWORKS = [:slack]
 
@@ -9,10 +7,14 @@ module BotMob
       send("setup_#{network}", code)
     end
 
+    def auth
+      { external_id: external_id, token: token }
+    end
+
     private
 
     def self.setup_slack(code)
-      BotMob::Ambassadors::Slack.new(code)
+      BotMob::Slack::Ambassador.new(code)
     end
   end
 end

data/lib/bot_mob/application.rb

@@ -8,35 +8,45 @@ module BotMob
     def initialize(bot_class)
       @bot_class = bot_class
       @bots = {}
-
-      Install.all.each { |install| register(install) }
     end
 
     def start!
       BotMob.logger.info("=> BotMob #{BotMob::VERSION} application starting")
-      wire.connect(self)
-      loop { sleep(10) }
-    end
+      load_registry
+      wire.connect { |auth| connect(auth) }
 
-    def add_bot(external_id)
-      BotMob.logger.info "Adding bot: #{external_id}"
-      install = Install.find_by_external_id(external_id)
-      if install.nil?
-        BotMob.logger.info "Could not find bot: #{external_id}"
-        return
+      loop do
+        sleep(10)
+        # Avoid polling at all for the time being
+        # load_registry if registry_available? && !wire.available?
       end
+    end
 
-      register install
+    def connect(auth)
+      external_id, token = auth['external_id'], auth['token']
+      BotMob.logger.info "Register bot: #{external_id}"
+      bot = bot_class.new(external_id, token)
+      @bots[external_id] ||= bot
+      @bots[external_id].refresh
     end
 
-    def register(install)
-      bot = bot_class.new(install.external_id, install.token)
-      @bots[install.external_id] ||= bot
-      @bots[install.external_id].refresh
+    def registry_available?
+      @registry_available.nil? || @registry_available
     end
 
     private
 
+    def load_registry
+      begin
+        BotMob::Install.all.each { |install| connect(install.auth) }
+        BotMob.logger.info '=> Registry loaded'
+        @registry_available = true
+      rescue ActiveRecord::ConnectionNotEstablished => e
+        @registry_available = false
+        BotMob.logger.info "=> Database unavailable, skipping registry"
+      end
+    end
+
     def wire
       @wire ||= BotMob::Wire.new
     end

data/lib/bot_mob/authority.rb

@@ -13,9 +13,8 @@ module BotMob
     def process
       return unless ambassador.success?
 
-      install = BotMob::Install.create_with_ambassador(ambassador)
-      # check for install's success
-      wire.publish(external_id: install.external_id)
+      install = BotMob::Install.create_with_auth(ambassador.auth)
+      wire.publish(external_id: install.external_id, token: install.token)
     end
 
     private

data/lib/bot_mob/bot.rb

@@ -1,64 +1,31 @@
+require 'forwardable'
+
 module BotMob
   # ## BotMob::Bot
   #
   # This is the base for all bots that will connect
   # to Slack.
   class Bot
-    attr_reader :external_id, :state
+    attr_reader :external_id
+
+    extend Forwardable
+    def_delegators :connection, :connect, :reconnect, :refresh, :client
 
     def initialize(external_id, token)
       @external_id = external_id
-
-      if token.nil?
-        @state = :inactive
-      else
-        @token = token
-        setup
-      end
-    end
-
-    def establish_connection
-      client.start_async
-    rescue Slack::Web::Api::Error => e
-      logger.info e.message
-      set_state :inactive
-    end
-
-    def connect
-      set_state :connecting
-      establish_connection
-    end
-
-    def reconnect
-      set_state :reconnecting
-      @client = Slack::RealTime::Client.new(token: @token)
-      setup
-      establish_connection
+      @token = token
     end
 
     def api_post(args = {})
-      logger.info("  Sending \"#{args.inspect}\"\n")
+      BotMob.logger.info("  Sending \"#{args.inspect}\"\n")
       client.web_client.chat_postMessage(args)
     end
 
     def realtime_post(args = {})
-      logger.info("  Sending \"#{args[:text]}\"\n")
+      BotMob.logger.info("  Sending \"#{args[:text]}\"\n")
       client.message(args)
     end
 
-    def refresh
-      return unless active?
-
-      case true
-      when waiting?
-        connect
-      when disconnected?
-        reconnect
-      else
-        logger.info "State[#{external_id}] - No Change"
-      end
-    end
-
     def handle(message)
       # noop
     end
@@ -67,61 +34,8 @@ module BotMob
       false
     end
 
-    def active?
-      @state != :inactive
-    end
-
-    def waiting?
-      @state == :waiting
-    end
-
-    def disconnected?
-      @state != :connected
-    end
-
-    def connected?
-      @state == :connected
-    end
-
-    def closed?
-      @state == :closed
-    end
-
-    private
-
-    def setup
-      @state = :waiting
-
-      client.on(:hello) { set_state(:connected) }
-      client.on(:close) { set_state(:disconnecting) }
-      client.on(:closed) { set_state(:closed) }
-
-      client.on :message do |data|
-        message = BotMob::InboundMessage.new(:websocket, data)
-
-        if respond?(message)
-          logger.info("Received message at #{Time.now}")
-          logger.info("  Parameters: #{message.data}")
-          handle(message)
-        end
-      end
-    end
-
-    def set_state(state)
-      if state == :connected
-        logger.info "Successfully connected, '#{client.team.name}' team at https://#{client.team.domain}.slack.com."
-      end
-
-      logger.info "State[#{external_id}] - #{state}"
-      @state = state
-    end
-
-    def client
-      @client ||= Slack::RealTime::Client.new(token: @token)
-    end
-
-    def logger
-      @logger ||= BotMob.logger
+    def connection
+      @connection ||= BotMob::Connection.new(:slack, self, @token)
     end
   end
 end

data/lib/bot_mob/connection.rb

@@ -0,0 +1,109 @@
+module BotMob
+  # ## BotMob::Connection
+  #
+  # The Connection is the point of contact
+  # between the Bot and the specified network
+  class Connection
+    attr_reader :bot
+
+    def initialize(_network, bot, token)
+      @bot = bot
+      @token = token
+      token.nil? ? set_state(:inactive) : setup
+    end
+
+    def connect
+      return unless active?
+      set_state(:connecting)
+      establish
+    end
+
+    def reconnect
+      return unless active?
+      set_state(:reconnecting)
+      renew_client
+      setup
+      establish
+    end
+
+    def refresh
+      return unless active?
+
+      case true
+      when waiting?
+        connect
+      when disconnected?
+        reconnect
+      else
+        logger.info "State[#{bot.external_id}] - No Change"
+      end
+    end
+
+    def client
+      @client ||= renew_client
+    end
+
+    private
+
+    def establish
+      client.start_async
+    rescue ::Slack::Web::Api::Error => e
+      logger.info e.message
+      set_state(:inactive)
+    end
+
+    def active?
+      @state != :inactive
+    end
+
+    def waiting?
+      @state == :waiting
+    end
+
+    def disconnected?
+      @state != :connected
+    end
+
+    def connected?
+      @state == :connected
+    end
+
+    def closed?
+      @state == :closed
+    end
+
+    def set_state(state)
+      if state == :connected
+        logger.info "Successfully connected, '#{client.team.name}' team at https://#{client.team.domain}.slack.com."
+      end
+
+      logger.info "State[#{bot.external_id}] - #{state}"
+      @state = state
+    end
+
+    def setup
+      set_state(:waiting)
+      client.on(:hello) { set_state(:connected) }
+      client.on(:close) { set_state(:disconnecting) }
+      client.on(:closed) { set_state(:closed) }
+
+      client.on :message do |data|
+        message = BotMob::InboundMessage.new(:websocket, data)
+
+        if bot.respond?(message)
+          logger.info("Received message at #{Time.now}")
+          logger.info("  Parameters: #{message.data}")
+          bot.handle(message)
+        end
+      end
+    end
+
+    def renew_client
+      @client = ::Slack::RealTime::Client.new(token: @token)
+    end
+
+    def logger
+      @logger ||= BotMob.logger
+    end
+  end
+end

data/lib/bot_mob/install.rb

@@ -3,11 +3,15 @@ module BotMob
     crypt_keeper :token, encryptor: :postgres_pgp, key: ENV['BOTMOB_SECRET'], salt: ENV['BOTMOB_SALT']
     self.table_name = "botmob_installs"
 
-    def self.create_with_ambassador(auth)
-      where(external_id: auth.external_id).first_or_initialize.tap do |i|
-        i.token = auth.token
+    def self.create_with_auth(auth)
+      where(external_id: auth[:external_id]).first_or_initialize.tap do |i|
+        i.token = auth[:token]
         i.save!
       end
     end
+
+    def auth
+      { external_id: external_id, token: token }
+    end
   end
 end

data/lib/bot_mob/{ambassadors/slack.rb → slack/ambassador.rb}

@@ -1,20 +1,20 @@
 module BotMob
-  module Ambassadors
-    class Slack
+  module Slack
+    class Ambassador
       def initialize(code)
         @code = code
       end
 
       def token
-        oauth_response && oauth_response.bot_access_token
+        oauth_response.bot_access_token
       end
 
       def external_id
-        oauth_response && oauth_response.bot_user_id
+        oauth_response.bot_user_id
       end
 
       def success?
-        external_id && token
+        !!(external_id && token)
       end
 
       private
@@ -30,8 +30,16 @@ module BotMob
 
         @oauth_response = response.bot
       rescue ::Slack::Web::Api::Error => e
-        puts e.message
-        nil
+        case e.message
+        when 'invalid_client_id'
+          raise BotMob::InvalidClientIdError, 'Invalid SLACK_CLIENT_ID environment variable'
+        when 'bad_client_secret'
+          raise BotMob::InvalidClientSecretError, 'Invalid SLACK_CLIENT_SECRET environment variable'
+        when 'invalid_code'
+          raise BotMob::InvalidCodeError, 'Invalid access code'
+        else
+          raise e
+        end
       end
 
       def client

data/lib/bot_mob/version.rb

@@ -1,3 +1,3 @@
 module BotMob
-  VERSION = '0.1.10'.freeze
+  VERSION = '0.1.12'.freeze
 end

data/lib/bot_mob/wire.rb

@@ -10,33 +10,41 @@ module BotMob
       queue.publish(message.to_json, routing_key: queue.name)
     end
 
-    def connect(app)
+    def connect
+      return if !block_given? || queue.nil?
+
       queue.subscribe do |_info, _props, body|
-        app.add_bot(JSON.parse(body)['external_id'])
+        yield(JSON.parse(body))
       end
     rescue Bunny::PreconditionFailed => e
       BotMob.logger.info "#{e.channel_close.reply_code}, message: #{e.channel_close.reply_text}"
     end
 
+    def available?
+      @available
+    end
+
     private
 
     def channel
-      @channel ||= connection.create_channel
+      @channel ||= connection && connection.create_channel
     end
 
     def queue
-      @queue ||= channel.queue('wire.notifications')
+      @queue ||= channel && channel.queue('wire.notifications')
     end
 
     def connection
       @connection ||= begin
         Bunny.new.tap do |conn|
-          Rails.logger.info('=> Connecting BotMob Wire')
           conn.start
+          @available = true
+          BotMob.logger.info('=> Wire connected')
         end
       rescue Bunny::TCPConnectionFailedForAllHosts => e
-        puts "No RabbitMQ Server"
-        raise
+        @available = false
+        BotMob.logger.info('=> RabbitMQ unavailable, skipping wire')
+        nil
       end
     end
   end

data/lib/bot_mob.rb

@@ -13,21 +13,28 @@ module BotMob
   autoload :Application,    'bot_mob/application'
   autoload :Authority,      'bot_mob/authority'
   autoload :Bot,            'bot_mob/bot'
+  autoload :Connection,     'bot_mob/connection'
   autoload :InboundMessage, 'bot_mob/inbound_message'
   autoload :Install,        'bot_mob/install'
   autoload :Wire,           'bot_mob/wire'
 
-  module Ambassadors
-    autoload :Slack,        'bot_mob/ambassadors/slack'
+  module Slack
+    autoload :Ambassador,        'bot_mob/slack/ambassador'
   end
 
+  class InvalidNetworkError < StandardError; end
+  class InvalidClientIdError < StandardError; end
+  class InvalidClientSecretError < StandardError; end
+  class InvalidCodeError < StandardError; end
+  class ConnectionNotEstablished < StandardError; end
+
   def self.root
     File.expand_path('../..', __FILE__)
   end
 
   def self.logger
     @logger ||= begin
-      buffer = Logger.new(STDOUT)
+      buffer = Logger.new(ENV['RACK_ENV'] == 'test' ? '/dev/null' : STDOUT)
       if buffer
         buffer.level = ($PROGRAM_NAME == 'irb' ? Logger::DEBUG : Logger::INFO)
         buffer.formatter = proc { |severity, datetime, progname, msg| "#{msg}\n" }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bot_mob
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.12
 platform: ruby
 authors:
 - Matthew Werner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-11 00:00:00.000000000 Z
+date: 2016-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.40'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +178,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -171,6 +227,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.test"
 - ".gitignore"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
@@ -182,12 +239,13 @@ files:
 - bot_mob.gemspec
 - lib/bot_mob.rb
 - lib/bot_mob/ambassador.rb
-- lib/bot_mob/ambassadors/slack.rb
 - lib/bot_mob/application.rb
 - lib/bot_mob/authority.rb
 - lib/bot_mob/bot.rb
+- lib/bot_mob/connection.rb
 - lib/bot_mob/inbound_message.rb
 - lib/bot_mob/install.rb
+- lib/bot_mob/slack/ambassador.rb
 - lib/bot_mob/version.rb
 - lib/bot_mob/wire.rb
 homepage: https://github.com/mwerner/bot_mob
@@ -201,7 +259,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="