bot 0.0.1 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73903dfd956f72bd8b5027f5fc0f426167781940
-  data.tar.gz: 88d59d632dc0ec52bd5a1ebc5b4d1e8a1ed812e8
+  metadata.gz: 07f61d84f72deea7fe40bb6f1780276a64cd7460
+  data.tar.gz: 1c24da37fa185a9003c4b8bd8bd4fcc5c6667cca
 SHA512:
-  metadata.gz: e917449bdf62fe2588fae9af8b625bc7ace0b2965fa27436db6c3f07bed00e3f2ed2f6f6d20476d81af048832b0f600e9d20bf60a58d902791bb0895a0baf7a1
-  data.tar.gz: 21ca504f96bed73e007506cb00e5399c9522195d358e468513ecab73a8b1afea57bf8edc3946b7003b5c0a20062dcadadae7087f44c1dd6803acb18f74b7cfd2
+  metadata.gz: 518171c0bb723d1a2f5f427aae51ea30da0b8cab462ab533042e58e3672ca8af67d83e339af6cf00d9c942759823941cf4f97d800f142af4e452cc519a20a124
+  data.tar.gz: a8083b8140a65a80b628cad46e5f16f1c59bf0f0cea3002716d177dff7d2fb93b23a24914359358145518813d4d156874a1acc4aed1e60e0cf23b2cbc7b95f9a

data/app/controllers/bot/bot_controller.rb

@@ -0,0 +1,23 @@
+class Bot::BotController < ActionController::Base
+  def notify
+    @responses = bot_handler.handle(messages).compact
+
+    adapter.send_messages(@responses) if @responses.present?
+
+    render json: []
+  end
+
+  private
+
+  def messages
+    Array.wrap(params[:messages])
+  end
+
+  def adapter
+    Bot.configuration.adapter
+  end
+
+  def bot_handler
+    params[:bot]
+  end
+end

data/lib/bot.rb

@@ -1,5 +1,11 @@
 require "bot/engine"
-require "bot/message_handler"
+require "bot/handler"
+require "bot/responder"
+require "bot/route_extensions"
+require "bot/adapter"
+require "bot/configuration"
+require "bot/responder_chain"
+require "bot/rspec.rb"
 
 module Bot
 end

data/lib/bot/adapter.rb

@@ -0,0 +1,8 @@
+require "bot/adapters/base"
+require "bot/adapters/kik"
+require "bot/adapters/test"
+
+module Bot
+  module Adapter
+  end
+end

data/lib/bot/adapters/base.rb

@@ -0,0 +1,15 @@
+module Bot
+  module Adapter
+    class Base
+      attr_reader :config
+
+      def initialize(config=nil)
+        @config = config
+      end
+
+      def send_messages(messages)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/bot/adapters/kik.rb

@@ -0,0 +1,26 @@
+require 'rest-client'
+
+module Bot
+  module Adapter
+    class Kik < Base
+
+      AUTH_URL = "https://auth.kik.com/verification/v1/check"
+      MESSAGING_URL = "https://engine.apikik.com/api/v1/message"
+
+      def send_messages(messages)
+        Rails.logger.error "\n\n\nSending:\n"
+        Rails.logger.error messages.to_json
+        Rails.logger.error "\n\n\n"
+
+        RestClient::Request.execute({
+          method: :post,
+          user: config[:bot_user],
+          password: config[:bot_token],
+          url: MESSAGING_URL,
+          payload: { messages: messages }.to_json,
+          headers: { content_type: :json }
+        })
+      end
+    end
+  end
+end

data/lib/bot/adapters/test.rb

@@ -0,0 +1,19 @@
+module Bot
+  module Adapter
+    class Test < Base
+      @@sent_messages = []
+
+      def send_messages(messages)
+        @@sent_messages += Array.wrap(messages)
+      end
+
+      def self.sent_messages
+        @@sent_messages
+      end
+
+      def self.empty_messages
+        @@sent_messages = []
+      end
+    end
+  end
+end

data/lib/bot/configuration.rb

@@ -0,0 +1,21 @@
+module Bot
+  @@configuration = nil
+
+  def self.configure
+    @@configuration = Configuration.new
+
+    if block_given?
+      yield configuration
+    end
+
+    configuration
+  end
+
+  def self.configuration
+    @@configuration || configure
+  end
+
+  class Configuration
+    attr_accessor :adapter
+  end
+end

data/lib/bot/engine.rb

@@ -1,5 +1,9 @@
 module Bot
   class Engine < ::Rails::Engine
     isolate_namespace Bot
+
+    initializer 'bot.routes', after: 'action_dispatch.prepare_dispatcher' do |app|
+      ActionDispatch::Routing::Mapper.send :include, ::Bot::RouteExtensions
+    end
   end
 end

data/lib/bot/handler.rb

@@ -0,0 +1,46 @@
+module Bot
+  class Handler
+    @@responder_chain = nil
+
+    def self.use(responder)
+      responder_chain.add(responder)
+    end
+
+    def self.handle(messages)
+      new.handle(messages)
+    end
+
+    def handle(messages)
+      messages.flat_map { |m| handle_message(m) }
+    end
+
+    def execute_chain(message, responses, user)
+      responder_chain.responders.each do |responder|
+        responder = responder.new(message, user, responses, self)
+        if responder.can_respond_to_type?(message['type']) && responder.can_handle?
+          responses << responder.handle
+          break
+        end
+      end
+      responses
+    end
+
+    def responder_chain
+      @@responder_chain ||= Bot::ResponderChain.new
+    end
+
+    def self.responder_chain
+      @@responder_chain ||= Bot::ResponderChain.new
+    end
+
+  protected
+
+    def handle_message(message)
+      user = user_for(message)
+      execute_chain(message, [], user).flatten
+    end
+
+    def user_for(message)
+    end
+  end
+end

data/lib/bot/responder.rb

@@ -0,0 +1,96 @@
+module Bot
+  class Responder
+    include ActionView::Helpers::TextHelper
+    include ActionView::Helpers::DateHelper
+
+    class_attribute :respond_to_types
+
+    attr_reader :message, :user, :responses, :handler
+
+    def self.respond_to(*types)
+      new_types = (respond_to_types || []).dup
+      types.each { |type| new_types << type.to_s }.uniq
+      self.respond_to_types = new_types.freeze
+    end
+
+    def initialize(message, user, responses, handler)
+      @message = message
+      @user = user
+      @responses = responses
+      @handler = handler
+    end
+
+    def can_respond_to_type?(type)
+      valid_message_types = self.class.respond_to_types || ['text']
+      valid_message_types.include?(type)
+    end
+
+    def can_handle?
+      !responses.count
+    end
+
+    def handle
+      raise NotImplementedError
+    end
+
+  protected
+
+    def text_response(message_text, suggested_responses=false)
+      text_response = {
+        'type'  => 'text',
+        'to'    => message['from'],
+        'body'  => message_text,
+        'typeTime' => 0
+      }
+      text_response['suggestedResponses'] = suggested_responses if suggested_responses
+      text_response
+    end
+
+    def photo_response(photo_url, suggested_responses=false)
+      photo_response = {
+        'type'  => 'gallery',
+        'to'    => message['from'],
+        'picUrl' => photo_url
+      }
+      photo_response['suggestedResponses'] = suggested_responses if suggested_responses
+      photo_response
+    end
+
+    def video_response(video_id, suggested_responses=false)
+      video_response = {
+        'type'     => 'video',
+        'to'       => message['from'],
+        'videoId' => video_id,
+        'muted' => true,
+        'autoplay' => true
+      }
+      video_response['suggestedResponses'] = suggested_responses if suggested_responses
+      video_response
+    end
+
+    def delay(message, delay)
+      message['delay'] = delay
+      message
+    end
+
+    def match_message(match)
+      if match.is_a?(Regexp)
+        match.match(message['body'])
+      else
+        message['body'].upcase == match.upcase
+      end
+    end
+
+    def no_responses?
+      responses.empty?
+    end
+
+    def reexecute_with(current_response, new_message=false)
+      handler.execute_chain(new_message || message, Array.wrap(current_response), user)
+    end
+
+    def scan_data
+      JSON.parse(message['data'])
+    end
+  end
+end

data/lib/bot/responder_chain.rb

@@ -0,0 +1,15 @@
+module Bot
+  class ResponderChain
+    def initialize
+      @responders = []
+    end
+
+    def add(responder)
+      @responders += Array.wrap(responder)
+    end
+
+    def responders
+      @responders.map {|r| r.to_s.constantize }
+    end
+  end
+end

data/lib/bot/route_extensions.rb

@@ -0,0 +1,7 @@
+module Bot
+  module RouteExtensions
+    def mount_bot(mount_point='/bot/notify', handler=ApplicationHandler)
+      post mount_point, to: 'bot/bot#notify', bot: handler
+    end
+  end
+end

data/lib/bot/rspec.rb

@@ -0,0 +1,23 @@
+require "bot/rspec/syntax.rb"
+require "bot/rspec/matchers.rb"
+require "bot/rspec/fixnum_helper.rb"
+
+module Bot
+  module Rspec
+    include Syntax
+    include Matchers
+
+    Fixnum.send(:include, FixnumHelper)
+
+    def self.included(base)
+      if base.metadata[:type] == :responder
+        base.let(:username) { "user" } unless base.respond_to? :username
+        base.let(:user) { create(:user) } unless base.respond_to? :user
+        base.let(:message) { incoming_message(user.username) } unless base.respond_to? :message
+        base.let(:handler) { class_double("Handler") } unless base.respond_to? :handler
+        base.let(:responses) { [] } unless base.respond_to? :responses
+        base.let(:responder) { base.described_class.new(message, user, responses, handler) } unless base.respond_to? :responder
+      end
+    end
+  end
+end

data/lib/bot/rspec/fixnum_helper.rb

@@ -0,0 +1,13 @@
+module Bot
+  module Rspec
+    module FixnumHelper
+      def message
+        self
+      end
+
+      def messages
+        self
+      end
+    end
+  end
+end

data/lib/bot/rspec/matchers.rb

@@ -0,0 +1,41 @@
+require 'rspec/expectations'
+
+module Bot
+  module Rspec
+    module Matchers
+      RSpec::Matchers.define :be_to do |to_user|
+        match do |sent_messages|
+          Array.wrap(sent_messages).flatten.any? { |msg| msg["to"] == to_user }
+        end
+      end
+
+      RSpec::Matchers.define :say do |body|
+        match do |sent_messages|
+          Array.wrap(sent_messages).flatten.any? { |msg| msg["body"] == body }
+        end
+      end
+
+      RSpec::Matchers.define :match_message do |body|
+        match do |sent_messages|
+          Array.wrap(sent_messages).flatten.any? { |msg| msg["body"].match(body).present? }
+        end
+      end
+
+      RSpec::Matchers.define :send_a_message_like do |expected_message|
+        match do |sent_messages|
+          Array.wrap(sent_messages).flatten.keep_if { |msg| matches_expected?(msg, expected_message) }.present?
+        end
+
+        def matches_expected?(sent, expected)
+          !expected.reject { |k, v| sent[k] == v }.present?
+        end
+      end
+
+      RSpec::Matchers.define :send do |expected_count|
+        match do |sent_messages|
+          Array.wrap(sent_messages).flatten.count == expected_count
+        end
+      end
+    end
+  end
+end

data/lib/bot/rspec/syntax.rb

@@ -0,0 +1,39 @@
+module Bot
+  module Rspec
+    module Syntax
+      def incoming_message(from, options={})
+        {
+          "from" => from,
+          "body" => "No Message",
+          "readReceiptRequested" => true,
+          "timestamp" => Time.now.to_i * 1000,
+          "type" => "text",
+          "id" => "07c6eb77-e01c-439a-80e7-3583dd784de1"
+        }.merge(options.stringify_keys)
+      end
+
+      def incoming_scan(from, options={})
+        {
+          "from" => from,
+          "timestamp" => 1457449114952,
+          "data" => "{}",
+          "mention" => nil,
+          "participants" => [from],
+          "readReceiptRequested" => false,
+          "type" => "scan-data",
+          "id" => "e6303158-ca60-4332-a600-236c5de4fedb",
+          "chatId" => "d68a7ab10a1526ac9682b764e2784080bb1cb52fc82c8f9c10c7d0534741fc93"
+        }.merge(options.stringify_keys)
+      end
+
+      def outgoing_message(to, options={})
+        {
+          "to" => to,
+          "body" => "No Message",
+          "type" => "text",
+          "typeTime" => 0
+        }.merge(options.stringify_keys)
+      end
+    end
+  end
+end