bot_mob 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6c06b15e2ece464e52b403fd36bd610487da2b8
-  data.tar.gz: 34dfe52f53892d31d918aae0611dcc347f571ab7
+  metadata.gz: 6463fee5649865aa2f59e0e19b7b3670ff5e20c8
+  data.tar.gz: e96b710afa365c7b9152a2fd6b5af76dec618a0f
 SHA512:
-  metadata.gz: 34c4efc4364f76889ea9968669b3bcf7c3c5c8b85c6715dff07f138dbaa8bd3c1dd6a57416761251ccc7ba81244e9c054acb8cb6b084b69503ac6c9a8938fa58
-  data.tar.gz: 2c4d05434f48c330d51f426404e7170fd63b410e7e09f67d532d05aa2ab78ef92171d617d75958c584a339f978b6e9988d84655530fb46ad42383e7c103550b6
+  metadata.gz: a7172822c373e804dfe65fb589ddf12bd78403f8416e2b91ce2bf9269268cce4f36039d452d1a9ee5c880ae30372eecb8d8caea8c953e40956fc6ac94ca8faa3
+  data.tar.gz: 2c70c6c01e9bb1d4c6a6537ce889e5774bf486c2feac444bc75c64a61eeb1375b20c74e056c9efa046b0aae87f6fa34b3c55550e61380132cbc2741e31954163

data/.env

@@ -0,0 +1 @@
+SLACK_TOKEN=xoxb-119874907665-RPEF89Sv0MaEnGyKUHCl11qz

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  Exclude:
+    - 'bot_mob.gemspec'
+    - 'lib/bot_mob/core_ext/*.rb'
+
+Style/RegexpLiteral:
+  Enabled: False
+
+Style/PerlBackrefs:
+  Enabled: False
+
+Style/BlockDelimiters:
+  Enabled: False
+
+Metrics/LineLength:
+  Max: 110

data/.travis.yml

@@ -1,5 +1,5 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3.1
+  - 2.1.8
 before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -1,4 +1,2 @@
 source 'https://rubygems.org'
-
-# Specify your gem's dependencies in bot-mob.gemspec
 gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Matthew Werner
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,9 +1,5 @@
 # BotMob
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/bot_mob`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -34,3 +30,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bot_mob. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/bin/console

@@ -1,12 +1,16 @@
 #!/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'
 
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
 IRB.start

data/bin/mob

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'bot_mob'
+BotMob::Command.new.handle(ARGV)

data/bot_mob.gemspec

@@ -9,32 +9,26 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Matthew Werner']
   spec.email         = ['m@mjw.io']
 
-  spec.summary       = 'Build your bots'
-  spec.description   = 'Easily create your own bot mob'
+  spec.summary       = 'The bot mob framework'
+  spec.description   = 'Easily create and manage bots'
   spec.homepage      = 'https://github.com/mwerner/bot_mob'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-
   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 'sinatra', '~> 1.4'
   spec.add_dependency 'slack-ruby-client', '~> 0.7'
-  spec.add_dependency 'celluloid-io', '~> 0.17'
-  spec.add_dependency 'activerecord', '>= 4.1'
 
-  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'
+  spec.add_development_dependency 'dotenv', '~> 2.1'
+  spec.add_development_dependency 'rubocop', '~> 0.45'
+  spec.add_development_dependency 'simplecov', '~> 0.12'
+  spec.add_development_dependency 'webmock', '~> 1.22'
 end

data/examples/fizz_buzz_bot.rb

@@ -0,0 +1,30 @@
+require 'bot_mob'
+
+# FizzBuzz Bot Usage:
+#
+#    FizzBuzzBot.new.receive('15') #=> "FizzBuzz"
+class FizzBuzzBot < BotMob::Bot
+  def respond?(message)
+    message.body.to_i.to_s == message.body
+  end
+
+  def respond(message)
+    fizz_buzz(message.body.to_i)
+  end
+
+  private
+
+  def fizz_buzz(number)
+    if multiple?(number, 3) && multiple?(number, 5)
+      'FizzBuzz'
+    elsif multiple?(number, 3)
+      'Fizz'
+    elsif multiple?(number, 5)
+      'Buzz'
+    end
+  end
+
+  def multiple?(number, n)
+    (number % n).zero?
+  end
+end

data/examples/hello_bot.rb

@@ -0,0 +1,14 @@
+require 'bot_mob'
+
+# HellobBot
+class HelloBot < BotMob::Bot
+  command :bye
+
+  def bye
+    'NOOOO!'
+  end
+
+  def respond(message)
+    "Hello #{message.body}!"
+  end
+end

data/examples/server.rb

@@ -0,0 +1,7 @@
+require_relative 'fizz_buzz_bot'
+require_relative 'hello_bot'
+
+BotMob.start! do |app|
+  app.register FizzBuzzBot
+  app.register HelloBot.new(network: :slack, token: ENV['SLACK_TOKEN'])
+end

data/lib/bot_mob.rb

@@ -1,56 +1,70 @@
-$LOAD_PATH.unshift File.dirname(__FILE__)
-require 'bot_mob/errors'
+require 'logger'
+require 'slack-ruby-client'
+require 'bot_mob/core_ext/hash'
+require 'bot_mob/core_ext/string'
 require 'bot_mob/version'
 
-# ## BotMob
+# # BotMob
 #
-# BotMob provides all the tools you need to easily
-# connect multiple bots to chat networks
+# BotMob base module namespace
 module BotMob
-  autoload :Ambassador,       'bot_mob/ambassador'
-  autoload :Application,      'bot_mob/application'
-  autoload :Authority,        'bot_mob/authority'
+  class InvalidNetworkError < StandardError; end
+  class UnspecifiedTargetNetworkError < StandardError; end
+  class UnconnectedTargetNetworkError < StandardError; end
+  class UndefinedResponseError < StandardError; end
+  class NetworkConnectionError < StandardError; end
+
   autoload :Bot,              'bot_mob/bot'
+  autoload :Environment,      'bot_mob/environment'
+  autoload :Command,          'bot_mob/command'
   autoload :Connection,       'bot_mob/connection'
   autoload :InboundMessage,   'bot_mob/inbound_message'
-  autoload :Install,          'bot_mob/install'
-  autoload :NilConnection,    'bot_mob/nil_connection'
   autoload :OutboundMessage,  'bot_mob/outbound_message'
   autoload :Roster,           'bot_mob/roster'
-  autoload :Wire,             'bot_mob/wire'
-
-  module Development
-    autoload :Ambassador,     'bot_mob/development/ambassador'
-    autoload :Connection,     'bot_mob/development/connection'
-    autoload :InboundMessage, 'bot_mob/development/inbound_message'
-  end
+  autoload :Server,           'bot_mob/server'
 
-  @@networks = {
-    dev: BotMob::Development
-  }
-
-  def self.networks
-    @@networks
-  end
+  # Networks
+  require 'bot_mob/networks/roaming'
+  require 'bot_mob/networks/slack'
 
-  def self.mount(network_map)
-    @@networks.merge!(network_map)
-  end
-
-  def self.valid_network?(network)
-    networks.include?(network.to_s.to_sym) && BotMob.networks[network]
+  # ## `start!`
+  #
+  # Start the bot mob server
+  #
+  # Usage:
+  #
+  #    BotMob.start! do |app|
+  #      app.register MyBot
+  #    end
+  def self.start!
+    roster = BotMob::Roster.new
+    yield(roster)
+    BotMob::Server.run! roster: roster
   end
 
+  # ## `root`
+  #
+  # Provide the base root path of the gem directory
   def self.root
     File.expand_path('../..', __FILE__)
   end
 
+  # ## `env`
+  #
+  # The specified environment for your bot's runtime
+  def self.env
+    @environment ||= BotMob::Environment.new(ENV['MOB_ENV'])
+  end
+
+  # ## `logger`
+  #
+  # Provide a logger for the BotMob gem, silences test env output by default
   def self.logger
     @logger ||= begin
-      buffer = Logger.new(ENV['RACK_ENV'] == 'test' ? '/dev/null' : STDOUT)
+      buffer = Logger.new(ENV['MOB_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" }
+        buffer.formatter = proc { |_s, _d, _p, msg| "#{msg}\n" }
       end
       buffer
     end

data/lib/bot_mob/bot.rb

@@ -1,53 +1,170 @@
-require 'forwardable'
-
 module BotMob
   # ## BotMob::Bot
   #
   # This is the base for all bots that will connect
   # to respond to messages received by your application.
   class Bot
-    attr_accessor :id, :network
-    attr_reader :options
+    attr_reader :network, :options
 
-    extend Forwardable
-    def_delegators :connection, :connect, :reconnect, :refresh, :client, :deliver
+    class << self
+      def commands
+        @commands ||= []
+      end
 
-    def initialize(*args)
-      @network, @id, @options = *args
+      def command(method_name)
+        @commands ||= []
+        @commands << method_name.to_sym
+      end
     end
 
-    def key
-      "#{network}.#{id}"
+    # A bot does not require any params to be initialized
+    def initialize(**options)
+      @connections = {}
+      @options = options
+      options[:slack] ? connect!(:slack, options[:slack]) : connect!(:roaming)
     end
 
-    def receive(message)
-      inbound_message = message.is_a?(String) ? BotMob::InboundMessage.new(message) : message
-      return unless respond?(inbound_message)
+    # ## `connect`
+    # `connect` allows you to specify a network to which
+    # you are intending to connect your bot
+    def connect!(network, options = {})
+      if @connections[network.to_sym]
+        BotMob.logger.warn "#{name} is already connected to #{network}"
+        return
+      end
 
-      BotMob.logger.info("Received message at #{Time.now}")
-      BotMob.logger.info("  Parameters: #{inbound_message.params}")
-      respond(inbound_message)
-    end
+      connection = BotMob::Connection.setup network, self, @options.merge(options)
+      return false if connection.nil?
 
-    def respond(inbound_message)
-      outbound = BotMob::OutboundMessage.new(text: "#{self.class} ACK! #{inbound_message.text}")
-      deliver(outbound)
+      @connections[network.to_sym] = connection
     end
 
-    def respond?(inbound_message)
-      true
+    # ## `connected?`
+    # Simple assessment to determine if a given network has been connected
+    def connected?(network = nil)
+      network.nil? ? @connections.keys.empty? : !@connections[network.to_sym].nil?
     end
 
-    private
+    # ## `receive`
+    # Receive a message from an implementation of this bot. This is the primary
+    # entry point for your bot to accept input.
+    #
+    #    bot = BotMob.new
+    #    bot.receive('foo')
+    #
+    # Specify *message* as the received data
+    def receive(message, options = {})
+      inbound_message = BotMob::InboundMessage.prepare(message, options)
 
-    def connection
-      @connection ||= begin
-        if BotMob.valid_network?(network)
-          BotMob::Connection.setup(network, self, options)
-        else
-          BotMob::NilConnection.new(self)
+      warrant_response = respond?(inbound_message)
+      log_message(inbound_message) if warrant_response || log_responseless_activity?
+      unless warrant_response
+        if log_responseless_activity?
+          BotMob.logger.info('  > Does not warrant response')
         end
+
+        return
       end
+
+      process_response(inbound_message)
+    end
+
+    # ## `receive_command`
+    # Receive a message from an implementation of this bot. This is the primary
+    # entry point for your bot to accept input.
+    #
+    #    bot = BotMob.new
+    #    bot.receive('foo')
+    #
+    # Specify *message* as the received data
+    def receive_command(command)
+      BotMob.logger.info("#{name} received command at #{Time.now}")
+      BotMob.logger.info("  Parameters: {:text => \"#{command}\"}")
+
+      send(command) if valid_command?(command)
+    end
+
+    # ## `valid_command?`
+    # A bot must respond to the given name explicitly
+    # declared in the class definition.
+    def valid_command?(name)
+      self.class.commands.include?(name.to_sym) && respond_to?(name.to_sym)
+    end
+
+    # ## `name`
+    # Convenience method to get the class name for the current bot class
+    def name
+      self.class.to_s
+    end
+
+    private
+
+    # ## `respond?`
+    #
+    # `respond?` is the determining method of the involvement of a bot.
+    # It should be a lightweight check of it's own logic against the
+    # contents of the inbound message. Commonly used for checking language
+    # used or regex matching of the inbound messages' contents.
+    #
+    # Defaults to true
+    def respond?(_inbound_message)
+      true
+    end
+
+    # ## `respond`
+    #
+    # `respond` accepts an inbound message, does whatever processing it
+    # needs, generates an outbound message and passes the message to the
+    # `deliver` method, which delegates to the currently assigned network.
+    #
+    # A respond method that is not overloaded will return the outbound message
+    def respond(inbound_message)
+      raise BotMob::UndefinedResponseError if BotMob.env.production?
+
+      BotMob::OutboundMessage.new(
+        body: "ACK - #{inbound_message.body}",
+        network: inbound_message.network
+      )
+    end
+
+    # ## `process_response`
+    #
+    # Begin the process of responding to a given message
+    def process_response(message)
+      response = respond(message)
+      outbound_message = BotMob::OutboundMessage.prepare(response, inbound: message)
+      deliver(outbound_message)
+    end
+
+    # ## `deliver`
+    #
+    # `deliver` takes the provided outbound message and executes the
+    # necessary actions to ensure the message arrives to the bot's network
+    def deliver(outbound_message)
+      outbound_network = outbound_message.network
+
+      # Assume they want the only connected network if only one exists
+      outbound_network ||= @connections.values.first if @connections.values.one?
+      raise BotMob::UnspecifiedTargetNetworkError if outbound_network.nil?
+
+      connection = @connections[outbound_network.to_sym]
+      raise BotMob::UnconnectedTargetNetworkError if connection.nil?
+
+      connection.deliver(outbound_message)
+    end
+
+    # ## `log_responseless_activity?`
+    #
+    # Log all received messages regardless of the result of `respond?`
+    #
+    # Defaults to true in development
+    def log_responseless_activity?
+      BotMob.env.development?
+    end
+
+    def log_message(message)
+      BotMob.logger.info("#{name} received message at #{Time.now}")
+      BotMob.logger.info("  Parameters: #{message.params}")
     end
   end
 end