cognition 1.1.4 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d830169bf46e5d46d3a405eacf69b5d4a7701046
-  data.tar.gz: 2193e7f57a5ab8f558a09455970c8b0bbc26a364
+  metadata.gz: e017dfacd05b7a99e572b9cdb40b2308513ce8bf
+  data.tar.gz: 839dc462b29e765ccd608511fc077e0ceeef03be
 SHA512:
-  metadata.gz: 67846e449b3b3e2f4edb693ea3cdb779a40c54b820f659b6c033dd11d9e317d91ae65377175e9066914f95452b834c3b32c67b4fa7e69ce2ea2045996e6d469b
-  data.tar.gz: 60764cd759ba2afa744be491655efbf73f068b0851ab647d84fe6e550102959aa8dff3140cd375d7b573edb23106d9189a29907bc57ec983685da1c54486ab43
+  metadata.gz: b4f926880513e1ec548ab07f2ea67244b51cdf92fb6db7aa735b011c9ef3e65c58732cb0d87e0aa86a0c659fd46905a2ea2e52d6ea148f46ecbf31f79054b8da
+  data.tar.gz: ac0d2c027685b9ad15eb532a4a1d9a5243241af4cc13ed73367f8146663cbda688bfc6b09da85929327304d020a7b5cc453de80e89203617067785cd4309ddf1

data/README.md

@@ -40,6 +40,21 @@ msg = Cognition::Message('another command', {user_id: 15, name: 'Bob'})
 msg.metadata   # Returns { user_id: 15, name: 'Bob' }
 ```
 
+### Special metadata
+If you include a `callback_url` key in your metadata, we'll give you a
+convenience method to reply to it using the `reply` method.  This will
+invoke a HTTParty POST back to the URL with your text sent as the
+`content` variable.
+```ruby
+msg = Cognition::Message('another command', {
+  callback_url: "http://foo.bar/baz",
+  user_id: 15,
+  name: 'Bob'
+})
+
+msg.reply("foo")   # Posts 'content=foo' to http://foo.bar/baz
+```
+
 ## Creating a Plugin
 Creating plugins is easy. Subclass `Cognition::Plugins::Base` and setup your
 matches and logic that should be run:
@@ -50,20 +65,30 @@ class Hello < Cognition::Plugins::Base
 
   # Advanced Regexp based matcher. Capture groups are made available
   # via MatchData in the matches method
-  match /hello\s*(?<name>.*)/, 'hello <name>', :hello_person
+  match /hello\s*(?<name>.*)/, :hello_person, help: {
+    'hello <name>' => 'Greets you by name!'
+  }
 
 
   def hello(*)
     'Hello World'
   end
 
-  def hello_person(msg)
-    name = msg.matches[:name]
+  def hello_person(msg, match_data = nil)
+    name = match_data[:name]
     "Hello #{name}"
   end
 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"
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/anoldguy/cognition/fork )

data/lib/cognition.rb

@@ -34,7 +34,7 @@ module Cognition
   end
 
   def help
-    matchers.map(&:help)
+    matchers.flat_map(&:help)
   end
 
   private

data/lib/cognition/matcher.rb

@@ -2,14 +2,20 @@ module Cognition
   class Matcher
     attr_reader :trigger, :action, :response, :help, :match_data
 
-    def initialize(trigger, help = 'Undocumented', &action)
+    def initialize(trigger, options = {}, &action)
       raise ArgumentError, 'matcher must have a trigger' unless trigger
       raise ArgumentError, 'matcher must have a action' unless action
       @trigger = trigger
-      @help = help
+      @help = options[:help] ||= {}
       @action = action
     end
 
+    def help
+      @help.map do |command, description|
+        "#{command} - #{description}"
+      end
+    end
+
     def attempt(msg)
       return false unless matches?(msg)
 

data/lib/cognition/plugins/base.rb

@@ -4,13 +4,13 @@ module Cognition
       attr_accessor :matchers
 
       def initialize
-        @matchers = self.class.definitions.collect do |trigger, help, method_name|
-          Matcher.new(trigger, help, &Proc.new(&method(method_name)))
+        @matchers = self.class.definitions.collect do |trigger, method_name, options|
+          Matcher.new(trigger, options, &Proc.new(&method(method_name)))
         end
       end
 
-      def self.match(trigger, help, action)
-        definitions << [trigger, help, action]
+      def self.match(trigger, action, options = {})
+        definitions << [trigger, action, options]
       end
 
       def self.definitions

data/lib/cognition/plugins/default.rb

@@ -1,18 +1,24 @@
 module Cognition
   module Plugins
     class Default < Cognition::Plugins::Base
-      match(/^ping/i, 'ping: Returns "PONG"', :pong)
-      match(/^help\s*(?<command>.*)/i, 'help: Returns help text for registered plugins', :help)
+      match /^ping/i, :pong, help: {
+        'ping' => 'Test if the endpoint is responding. Returns PONG.'
+      }
+
+      match /^help\s*(?<command>.*)/i, :help, help: {
+        'help' => 'Lists all commands with help',
+        'help <command>' => 'Lists help for <command>'
+      }
 
       def pong(msg, match_data = nil)
         'PONG'
       end
 
       def help(msg, match_data = nil)
-        if match_data["command"].empty?
-          Cognition.help.join("\n")
+        if match_data['command'].empty?
+          Cognition.help.join('\n')
         else
-          Cognition.help.find_all { |text| text.match msg.matches[:command] }.join("\n")
+          Cognition.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.1.4"
+  VERSION = "1.2.0"
 end

data/test/fixtures/hello.rb

@@ -1,7 +1,9 @@
 class Hello < Cognition::Plugins::Base
-  match 'hello', 'hello: Returns Hello World', :hello
+  match 'hello', :hello, help: {
+    'hello' => 'Returns Hello World'
+  }
 
-  def hello(msg)
+  def hello(msg, match_data = nil)
     'Hello World'
   end
 end

data/test/test_default_plugin.rb

@@ -0,0 +1,18 @@
+require 'minitest/autorun'
+require 'cognition'
+
+class DefaultPluginTest < Minitest::Test
+  def setup
+    Cognition.reset
+  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")
+  end
+
+  def test_returns_filtered_help
+    help = "ping - Test if the endpoint is responding. Returns PONG."
+    assert_equal help, Cognition.process("help ping")
+  end
+end

data/test/test_matcher.rb

@@ -16,54 +16,64 @@ class MatcherTest < Minitest::Test
 
   def test_matches_string
     msg = Cognition::Message.new('help')
-    matcher = Cognition::Matcher.new('help', 'test', &Proc.new {})
+    matcher = Cognition::Matcher.new('help', {}, &Proc.new {})
     assert matcher.matches?(msg)
   end
 
   def test_string_fails_with_invalid_message
     msg = Cognition::Message.new('Help')
-    matcher = Cognition::Matcher.new('help', 'test', &Proc.new {})
+    matcher = Cognition::Matcher.new('help', {}, &Proc.new {})
     refute matcher.matches?(msg)
   end
 
   def test_matches_regexp
     msg = Cognition::Message.new('ping')
-    matcher = Cognition::Matcher.new(/ping/, 'test', &Proc.new {})
+    matcher = Cognition::Matcher.new(/ping/, {}, &Proc.new {})
     assert matcher.matches?(msg)
   end
 
   def test_regexp_fails_with_invalid_message
     msg = Cognition::Message.new('pink')
-    matcher = Cognition::Matcher.new(/ping/, 'test', &Proc.new {})
+    matcher = Cognition::Matcher.new(/ping/, {}, &Proc.new {})
     refute matcher.matches?(msg)
   end
 
   def test_sets_response_on_attemp_if_matches
     msg = Cognition::Message.new('ping')
-    matcher = Cognition::Matcher.new(/ping/, 'test', &Proc.new {'PONG'})
+    matcher = Cognition::Matcher.new(/ping/, {}, &Proc.new {'PONG'})
     matcher.attempt(msg)
     assert_equal 'PONG', matcher.response
   end
 
   def test_returns_false_on_attemp_if_no_match
     msg = Cognition::Message.new('pink')
-    matcher = Cognition::Matcher.new(/ping/, 'test', &Proc.new {'PONG'})
+    matcher = Cognition::Matcher.new(/ping/, {}, &Proc.new {'PONG'})
     refute matcher.attempt(msg)
   end
 
   def test_sets_match_data
     msg = Cognition::Message.new('hello john')
-    matcher = Cognition::Matcher.new(/hello\s*(?<name>.*)/, 'test', &Proc.new {'PONG'})
+    matcher = Cognition::Matcher.new(/hello\s*(?<name>.*)/, {}, &Proc.new {'PONG'})
     matcher.matches?(msg)
     assert_equal "john", matcher.match_data[:name]
   end
 
   def test_captures_response
     msg = Cognition::Message.new('hello john')
-    matcher = Cognition::Matcher.new(/hello\s*(?<name>.*)/, 'test', &Proc.new(&method(:dummy_method)))
+    matcher = Cognition::Matcher.new(/hello\s*(?<name>.*)/, {}, &Proc.new(&method(:dummy_method)))
     matcher.attempt(msg)
     assert_equal "Hello john", matcher.response
   end
+
+  def test_only_sets_help_when_help_provided
+    matcher_without_help = Cognition::Matcher.new(/hello\s*(?<name>.*)/, {}, &Proc.new(&method(:dummy_method)))
+    assert_equal [], matcher_without_help.help
+  end
+
+  def test_sets_help
+    matcher_with_help = Cognition::Matcher.new(/hello\s*(?<name>.*)/, {help: {'hello' => 'says hello'}}, &Proc.new(&method(:dummy_method)))
+    assert_equal ['hello - says hello'], matcher_with_help.help
+  end
 end
 
 def dummy_method(msg, match_data)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cognition
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.2.0
 platform: ruby
 authors:
 - Nathan Anderson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-23 00:00:00.000000000 Z
+date: 2015-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -102,6 +102,7 @@ files:
 - lib/cognition/version.rb
 - test/fixtures/hello.rb
 - test/test_cognition.rb
+- test/test_default_plugin.rb
 - test/test_helper.rb
 - test/test_matcher.rb
 - test/test_message.rb
@@ -134,6 +135,7 @@ summary: A rules engine for running commands.
 test_files:
 - test/fixtures/hello.rb
 - test/test_cognition.rb
+- test/test_default_plugin.rb
 - test/test_helper.rb
 - test/test_matcher.rb
 - test/test_message.rb