cognition 1.2.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9cf8b8eab5eee3318c21ef862aee4b4d9b509e3e
-  data.tar.gz: ab9a34f493162655e20f027fefb7760958363e8e
+  metadata.gz: 3da7685b2dd87abbbb4700e49844520a5cc78e69
+  data.tar.gz: 16ed1c2b9b0b02544e322e65c245b1befcd62821
 SHA512:
-  metadata.gz: aea4ad3b0b5bf8719ba3aa83be20ac23ceb6c46de384f5ed635f15fb3ac8abe0342dcd73099b28d38a0a7eb51cf2a5a111d2813041d626a2fdf61374f59187aa
-  data.tar.gz: d55bab9be99fff93027edb9b23cbfcd3ffd3c689a1191aea9e85385498ffd466d72225aa3c8fa8cb7f04abf47a730b25480bd53e90e897b1853e31e2edf121a4
+  metadata.gz: 276a3ef0f303cc54354a69be7b7a541d2e8e6e54a5abd7fd742538d64d5dc4fa5518b364685560c071f0116f18478dfa953cb8a34e1c06f37fe2ebfdb4ebec7a
+  data.tar.gz: eb2379fee7ea23e0f4de7a9f0f0c2ffd05378efa9a5599aba5e262987f65c4e3fc85998c387379c5846c0ca24ec6893c5177162ec1b10e3c934180a801fddb65

data/README.md

@@ -22,14 +22,19 @@ Or install it yourself as:
 
 ## Usage
 
+Instantiate:
+```ruby
+bot = Cognition::Bot.new
+```
+
 Process your message:
 ```ruby
-result = Cognition.process('command I need to process')
+result = bot.process('command I need to process')
 ```
 
 You can also include metadata with your message, like user info, or whatever:
 ```ruby
-result = Cognition.process('another command', {user_id: 15, name: 'Bob'})
+result = bot.process('another command', {user_id: 15, name: 'Bob'})
 ```
 
 Internally, `Cognition` will turn your values into a `Cognition::Message` so
@@ -83,10 +88,10 @@ end
 
 After you've done that, you will be able to do:
 ```ruby
-Cognition.register(Hello)
-Cognition.process("help hello")  # "hello <name> - Greets you by name!"
-Cognition.process("hello")       # "Hello World"
-Cognition.process("hello foo")   # "Hello foo"
+bot.register(Hello)
+bot.process("help hello")  # "hello <name> - Greets you by name!"
+bot.process("hello")       # "Hello World"
+bot.process("hello foo")   # "Hello foo"
 ```
 
 ## Contributing

data/lib/cognition.rb

@@ -1,71 +1,5 @@
 require 'cognition/version'
-require 'cognition/message'
-require 'cognition/matcher'
-require 'cognition/responder'
-require 'cognition/plugins/base'
-require 'cognition/plugins/default'
+require 'cognition/bot'
 
 module Cognition
-  extend self
-
-  attr_accessor :plugins, :matchers
-
-  def process(msg, metadata = {})
-    if msg.respond_to? :command
-      process_msg(msg)
-    else
-      process_string(msg.to_s, metadata)
-    end
-  end
-
-  def register(klass)
-    return false if plugin_names.include? klass.to_s
-    plugins << klass.new
-  end
-
-  def reset
-    @matchers = []
-    @plugins = []
-    register(Cognition::Plugins::Default)
-  end
-
-  def plugin_names
-    plugins.map { |p| p.class.name }
-  end
-
-  def help
-    matchers.flat_map(&:help)
-  end
-
-  private
-
-    def process_msg(msg)
-      response = false
-      matchers.each do |matcher|
-        if matcher.attempt(msg)
-          response = matcher.response
-          break
-        end
-      end
-      response ? response : not_found(msg.command)
-    end
-
-    def process_string(message, metadata = {})
-      process_msg(Cognition::Message.new(message.strip, metadata))
-    end
-
-    def matchers
-      plugins.flat_map(&:matchers).compact
-    end
-
-    def plugins
-      @plugins ||= []
-    end
-
-    def not_found(message)
-      "No such command: #{message}\nUse 'help' for available commands!"
-    end
 end
-
-# Default plugin, responds to 'ping' with 'PONG' and provides help text
-Cognition.register(Cognition::Plugins::Default)

data/lib/cognition/bot.rb

@@ -0,0 +1,72 @@
+require 'cognition/message'
+require 'cognition/matcher'
+require 'cognition/responder'
+require 'cognition/plugins/base'
+require 'cognition/plugins/default'
+
+module Cognition
+  class Bot
+    attr_accessor :plugins, :matchers
+
+    def initialize
+      # Default plugin, responds to 'ping' with 'PONG' and provides help text
+      register(Cognition::Plugins::Default)
+    end
+
+    def process(msg, metadata = {})
+      if msg.respond_to? :command
+        process_msg(msg)
+      else
+        process_string(msg.to_s, metadata)
+      end
+    end
+
+    def register(klass)
+      return false if plugin_names.include? klass.to_s
+      plugins << klass.new(self)
+    end
+
+    def reset
+      @matchers = []
+      @plugins = []
+      register(Cognition::Plugins::Default)
+    end
+
+    def plugin_names
+      plugins.map { |p| p.class.name }
+    end
+
+    def help
+      matchers.flat_map(&:help)
+    end
+
+    private
+
+      def process_msg(msg)
+        response = false
+        matchers.each do |matcher|
+          if matcher.attempt(msg)
+            response = matcher.response
+            break
+          end
+        end
+        response ? response : not_found(msg.command)
+      end
+
+      def process_string(message, metadata = {})
+        process_msg(Cognition::Message.new(message.strip, metadata))
+      end
+
+      def matchers
+        plugins.flat_map(&:matchers).compact
+      end
+
+      def plugins
+        @plugins ||= []
+      end
+
+      def not_found(message)
+        "No such command: #{message}\nUse 'help' for available commands!"
+      end
+  end
+end

data/lib/cognition/plugins/base.rb

@@ -1,12 +1,13 @@
 module Cognition
   module Plugins
     class Base
-      attr_accessor :matchers
+      attr_accessor :matchers, :bot
 
-      def initialize
+      def initialize(bot = nil)
         @matchers = self.class.definitions.collect do |trigger, method_name, options|
           Matcher.new(trigger, options, &Proc.new(&method(method_name)))
         end
+        @bot = bot
       end
 
       def self.match(trigger, action, options = {})

data/lib/cognition/plugins/default.rb

@@ -16,9 +16,9 @@ module Cognition
 
       def help(msg, match_data = nil)
         if match_data['command'].empty?
-          Cognition.help.join("\n")
+          bot.help.join("\n")
         else
-          Cognition.help.find_all { |text| text.match match_data[:command] }.join("\n")
+          bot.help.find_all { |text| text.match match_data[:command] }.join("\n")
         end
       end
     end

data/lib/cognition/version.rb

@@ -1,3 +1,3 @@
 module Cognition
-  VERSION = "1.2.1"
+  VERSION = "2.0.0"
 end

data/test/test_cognition.rb

@@ -4,39 +4,39 @@ require_relative 'fixtures/hello'
 
 class CognitionTest < Minitest::Test
   def setup
-    Cognition.reset
+    @bot = Cognition::Bot.new
   end
 
   def test_registers_plugins
-    Cognition.register(Hello)
+    @bot.register(Hello)
 
-    assert_equal 2, Cognition.plugin_names.count
+    assert_equal 2, @bot.plugin_names.count
   end
 
   def test_does_not_register_duplicate_plugins
-    Cognition.register(Hello)
-    Cognition.register(Hello)
+    @bot.register(Hello)
+    @bot.register(Hello)
 
-    assert_equal 2, Cognition.plugin_names.count
+    assert_equal 2, @bot.plugin_names.count
   end
 
   def test_processes_messages
     msg = Cognition::Message.new('ping')
-    assert_equal 'PONG', Cognition.process(msg)
+    assert_equal 'PONG', @bot.process(msg)
   end
 
   def test_processes_strings
-    assert_equal 'PONG', Cognition.process('ping')
+    assert_equal 'PONG', @bot.process('ping')
   end
 
   def test_processes_strings_with_metadata
-    assert_equal 'PONG', Cognition.process('ping', foo: 'bar')
+    assert_equal 'PONG', @bot.process('ping', foo: 'bar')
   end
 
   def test_shows_help_if_no_matches
-    Cognition.register(Hello)
+    @bot.register(Hello)
     msg = Cognition::Message.new('pong')
-    output = Cognition.process(msg)
+    output = @bot.process(msg)
     assert_match "No such command: pong\nUse 'help' for available commands!", output
   end
 end

data/test/test_default_plugin.rb

@@ -3,16 +3,16 @@ require 'cognition'
 
 class DefaultPluginTest < Minitest::Test
   def setup
-    Cognition.reset
+    @bot = Cognition::Bot.new
   end
 
   def test_returns_help
-    help = "ping - Test if the endpoint is responding. Returns PONG.\\nhelp - Lists all commands with help\\nhelp <command> - Lists help for <command>"
-    assert_equal help, Cognition.process("help")
+    help = "ping - Test if the endpoint is responding. Returns PONG.\nhelp - Lists all commands with help\nhelp <command> - Lists help for <command>"
+    assert_equal help, @bot.process("help")
   end
 
   def test_returns_filtered_help
     help = "ping - Test if the endpoint is responding. Returns PONG."
-    assert_equal help, Cognition.process("help ping")
+    assert_equal help, @bot.process("help ping")
   end
 end

data/test/test_plugin.rb

@@ -4,7 +4,8 @@ require 'cognition'
 class PluginTest < Minitest::Test
   def test_sets_matchers
     require_relative "fixtures/hello"
-    hello = Hello.new
+    bot = Cognition::Bot.new
+    hello = Hello.new(bot)
 
     assert_equal 1, hello.matchers.count
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cognition
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Nathan Anderson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-02 00:00:00.000000000 Z
+date: 2015-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -94,6 +94,7 @@ files:
 - Rakefile
 - cognition.gemspec
 - lib/cognition.rb
+- lib/cognition/bot.rb
 - lib/cognition/matcher.rb
 - lib/cognition/message.rb
 - lib/cognition/plugins/base.rb