cognition 2.0.4 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b37fef34af5c88fc16e34dd5855d50d6c214ec4
-  data.tar.gz: aab660a7e21a9324369638de7fd663d39c32efda
+  metadata.gz: 9f69c16258ad17a29dd1f7ee7353d331b36c9a37
+  data.tar.gz: c4c31934035e95b8ce435bc7fd885e892e22c08a
 SHA512:
-  metadata.gz: 5b34e06406f19030648972a5b1fa157b33fde810306d11a948f74ae8f306edb5a99552d06df855387f327b96f49b91ea8464ca1769c0596abbbe7380a8cf1943
-  data.tar.gz: 793bab140adef11717fba95d70d6cc625b6c20ea5f2d89b0628931288d231b8fab91a80892116615300d77a8815b2b5e17ebb946fc0ca4f6fd1710f2ac0747a2
+  metadata.gz: 8f5d6226701ffe0397d560df2dd3ba32d4979cb04e216f6164d65120bcd7e16804dee9bbc7ded759cb07a698d785554ea6fd74ace914662d17a07022bd46c916
+  data.tar.gz: 383bfa407321bd36ab89f1bfb692aceed77f9ae917c2a36220c031dd08182e59347187aba4a8ce9375bcd31f79558ad52eee784f4f31cbad5b65b10ae8a62ce6

data/Gemfile

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

data/README.md

@@ -66,7 +66,7 @@ matches and logic that should be run:
 ```ruby
 class Hello < Cognition::Plugins::Base
   # Simple string based matcher. Must match *EXACTLY*
-  match 'hello', 'hello: Returns Hello World', :hello
+  match 'hello', :hello, help: { 'hello' => 'Returns Hello World' }
 
   # Advanced Regexp based matcher. Capture groups are made available
   # via MatchData in the matches method
@@ -74,7 +74,6 @@ class Hello < Cognition::Plugins::Base
     'hello <name>' => 'Greets you by name!'
   }
 
-
   def hello(*)
     'Hello World'
   end

data/Rakefile

@@ -1,9 +1,9 @@
-require 'bundler/gem_tasks'
-require 'rake/testtask'
+require "bundler/gem_tasks"
+require "rake/testtask"
 
 Rake::TestTask.new do |t|
-  t.libs << 'test'
+  t.libs << "test"
 end
 
-desc 'Run tests'
+desc "Run tests"
 task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cognition"
+
+puts "Get started with your Cognition bot by registering the 'Hello' test plugin!"
+puts "> test_bot = Cognition::Bot.new"
+puts '> require_relative "../test/fixtures/hello"'
+puts "> test_bot.register(Hello)\n\n"
+puts "Process commands with: "
+puts "> test_bot.process('message')\n\n"
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/cognition.gemspec

@@ -1,16 +1,16 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'cognition/version'
+require "cognition/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "cognition"
   spec.version       = Cognition::VERSION
   spec.authors       = ["Nathan Anderson"]
   spec.email         = ["andnat@gmail.com"]
-  spec.summary       = %q{A rules engine for running commands.}
-  spec.description   = %q{Match text; run commands. Works great for building a chatbot!}
-  spec.homepage      = "https://github.com/anoldguy/Cognition"
+  spec.summary       = "A rules engine for running commands."
+  spec.description   = "Match text; run commands. Works great for building a chatbot!"
+  spec.homepage      = "https://github.com/basecamp/cognition"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/cognition/bot.rb

@@ -1,15 +1,15 @@
-require 'cognition/message'
-require 'cognition/matcher'
-require 'cognition/responder'
-require 'cognition/plugins/base'
-require 'cognition/plugins/default'
+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
+      # Default plugin, responds to "ping" with "PONG" and provides help text
       register(Cognition::Plugins::Default)
     end
 
@@ -42,31 +42,31 @@ module Cognition
 
     private
 
-      def process_msg(msg)
-        response = false
-        matchers.each do |matcher|
-          if matcher.attempt(msg)
-            response = matcher.response
-            break
-          end
+    def process_msg(msg)
+      response = false
+      matchers.each do |matcher|
+        if matcher.attempt(msg)
+          response = matcher.response
+          break
         end
-        response ? response : not_found(msg.command)
       end
+      response ? response : not_found(msg.command)
+    end
 
-      def process_string(message, metadata = {})
-        process_msg(Cognition::Message.new(message.strip, metadata))
-      end
+    def process_string(message, metadata = {})
+      process_msg(Cognition::Message.new(message.strip, metadata))
+    end
 
-      def matchers
-        plugins.flat_map(&:matchers).compact
-      end
+    def matchers
+      plugins.flat_map(&:matchers).compact
+    end
 
-      def plugins
-        @plugins ||= []
-      end
+    def plugins
+      @plugins ||= []
+    end
 
-      def not_found(message)
-        "No such command: #{message}\nUse 'help' for available commands!"
-      end
+    def not_found(message)
+      "No such command: #{message}\nUse 'help' for available commands!"
+    end
   end
 end

data/lib/cognition/matcher.rb

@@ -3,8 +3,8 @@ module Cognition
     attr_reader :trigger, :action, :response, :help, :match_data
 
     def initialize(trigger, options = {}, &action)
-      raise ArgumentError, 'matcher must have a trigger' unless trigger
-      raise ArgumentError, 'matcher must have a action' unless action
+      fail ArgumentError, "matcher must have a trigger" unless trigger
+      fail ArgumentError, "matcher must have a action" unless action
       @trigger = trigger
       @help = options[:help] ||= {}
       @action = action

data/lib/cognition/message.rb

@@ -5,11 +5,11 @@ module Cognition
     def initialize(command, metadata = {})
       @command = command
       @metadata = metadata
-      @responder = Cognition::Responder.new(metadata['callback_url']) if metadata['callback_url']
+      @responder = Cognition::Responder.new(metadata["callback_url"]) if metadata["callback_url"]
     end
 
     def reply(text)
-      return 'No Callback URL provided' unless @responder
+      return "No Callback URL provided" unless @responder
       @responder.reply(text)
     end
   end

data/lib/cognition/plugins/base.rb

@@ -1,6 +1,6 @@
-require 'erb'
-require 'tilt'
-require 'cgi'
+require "erb"
+require "tilt"
+require "cgi"
 
 module Cognition
   module Plugins
@@ -20,7 +20,7 @@ module Cognition
       # subclass, since we can't use __FILE__ here, and have it use the
       # subclass's location.
       def self.inherited(plugin)
-        plugin.view_root = File.dirname(caller[0].split(':',2).first)
+        plugin.view_root = File.dirname(caller[0].split(":", 2).first)
       end
 
       attr_accessor :matchers, :bot
@@ -51,23 +51,23 @@ module Cognition
 
       private
 
-        def template_file(name, type, extension)
-          # Defaults to html ERB for now. Override when calling #render(path_to_file)
-          File.join(templates_path, "#{name}.#{type}.#{extension}")
-        end
+      def template_file(name, type, extension)
+        # Defaults to html ERB for now. Override when calling #render(path_to_file)
+        File.join(templates_path, "#{name}.#{type}.#{extension}")
+      end
 
-        def underscore(string)
-          word = string.to_s.gsub(/::/, '/')
-          word.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
-          word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
-          word.tr!("-", "_")
-          word.downcase!
-          word
-        end
+      def underscore(string)
+        word = string.to_s.gsub(/::/, "/")
+        word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, "\1_\2")
+        word.gsub!(/([a-z\d])([A-Z])/, "\1_\2")
+        word.tr!("-", "_")
+        word.downcase!
+        word
+      end
 
-        def templates_path
-          File.expand_path("#{underscore(self.class.name)}/views", self.class.view_root)
-        end
+      def templates_path
+        File.expand_path("#{underscore(self.class.name)}/views", self.class.view_root)
+      end
     end
   end
 end

data/lib/cognition/plugins/default.rb

@@ -1,17 +1,19 @@
 module Cognition
   module Plugins
     class Default < Cognition::Plugins::Base
+      # rubocop:disable Lint/AmbiguousRegexpLiteral
       match /^ping/i, :pong, help: {
-        'ping' => 'Test if the endpoint is responding. Returns PONG.'
+        "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>'
+        "help" => "Lists all commands with help",
+        "help <command>" => "Lists help for <command>"
       }
+      # rubocop:enable Lint/AmbiguousRegexpLiteral
 
-      def pong(msg, match_data = nil)
-        'PONG'
+      def pong(*)
+        "PONG"
       end
 
       def help(msg, match_data = nil)

data/lib/cognition/responder.rb

@@ -1,4 +1,4 @@
-require 'httparty'
+require "httparty"
 module Cognition
   class Responder
     include HTTParty
@@ -11,7 +11,7 @@ module Cognition
 
     def reply(text)
       self.class.post(@uri, @options.merge(body: { content: text }))
-    rescue Timeout::Error => e
+    rescue Timeout::Error
       "Request to #{@uri} timed out."
     end
   end

data/lib/cognition/version.rb

@@ -1,3 +1,3 @@
 module Cognition
-  VERSION = "2.0.4"
+  VERSION = "2.0.5"
 end

data/lib/cognition.rb

@@ -1,5 +1,5 @@
-require 'cognition/version'
-require 'cognition/bot'
+require "cognition/version"
+require "cognition/bot"
 
 module Cognition
 end

data/test/fixtures/hello.rb

@@ -1,37 +1,37 @@
-require 'tilt/haml'
-require 'tilt/erb'
-require 'haml'
+require "tilt/haml"
+require "tilt/erb"
+require "haml"
 class Hello < Cognition::Plugins::Base
-  match 'hello', :hello, help: {
-    'hello' => 'Returns Hello World'
+  match "hello", :hello, help: {
+    "hello" => "Returns Hello World"
   }
 
-  def hello(msg, match_data = nil)
-    'Hello World'
+  def hello(*)
+    "Hello World"
   end
 
-  def hi(msg, match_data = nil)
-    @message = 'Hi'
+  def hi(*)
+    @message = "Hi"
     render
   end
 
-  def hola(msg, match_data = nil)
-    @message = 'Hola'
-    render(template: File.expand_path('../hello/views/hola.haml', __FILE__))
+  def hola(*)
+    @message = "Hola"
+    render(template: File.expand_path("../hello/views/hola.haml", __FILE__))
   end
 
-  def bonjour(msg, match_data = nil)
-    @message = 'Bonjour'
+  def bonjour(*)
+    @message = "Bonjour"
     render(type: "text")
   end
 
-  def hey(msg, match_data = nil)
-    @message = 'Hey'
+  def hey(*)
+    @message = "Hey"
     render(extension: "haml")
   end
 
-  def yo(msg, match_data = nil)
-    @message = 'Yo'
-    render(locals: {num_yos: 3})
+  def yo(*)
+    @message = "Yo"
+    render(locals: { num_yos: 3 })
   end
 end

data/test/test_cognition.rb

@@ -1,6 +1,6 @@
-require 'minitest/autorun'
-require 'cognition'
-require_relative 'fixtures/hello'
+require "minitest/autorun"
+require "cognition"
+require_relative "fixtures/hello"
 
 class CognitionTest < Minitest::Test
   def setup
@@ -21,21 +21,21 @@ class CognitionTest < Minitest::Test
   end
 
   def test_processes_messages
-    msg = Cognition::Message.new('ping')
-    assert_equal 'PONG', @bot.process(msg)
+    msg = Cognition::Message.new("ping")
+    assert_equal "PONG", @bot.process(msg)
   end
 
   def test_processes_strings
-    assert_equal 'PONG', @bot.process('ping')
+    assert_equal "PONG", @bot.process("ping")
   end
 
   def test_processes_strings_with_metadata
-    assert_equal 'PONG', @bot.process('ping', foo: 'bar')
+    assert_equal "PONG", @bot.process("ping", foo: "bar")
   end
 
   def test_shows_help_if_no_matches
     @bot.register(Hello)
-    msg = Cognition::Message.new('pong')
+    msg = Cognition::Message.new("pong")
     output = @bot.process(msg)
     assert_match "No such command: pong\nUse 'help' for available commands!", output
   end

data/test/test_default_plugin.rb

@@ -1,5 +1,5 @@
-require 'minitest/autorun'
-require 'cognition'
+require "minitest/autorun"
+require "cognition"
 
 class DefaultPluginTest < Minitest::Test
   def setup

data/test/test_helper.rb

@@ -1,5 +1,7 @@
-require 'webmock/minitest'
+require "webmock/minitest"
 
-class Minitest::Test
-  include WebMock::API
+module Minitest
+  class Test
+    include WebMock::API
+  end
 end

data/test/test_matcher.rb

@@ -1,88 +1,88 @@
-require 'minitest/autorun'
-require 'cognition'
+require "minitest/autorun"
+require "cognition"
 
 class MatcherTest < Minitest::Test
   def test_raises_error_without_a_trigger
     assert_raises ArgumentError do
-      _ = Cognition::Matcher.new(action: 'foo')
+      _ = Cognition::Matcher.new(action: "foo")
     end
   end
 
   def test_raises_error_without_an_action
     assert_raises ArgumentError do
-      _ = Cognition::Matcher.new(trigger: 'foo')
+      _ = Cognition::Matcher.new(trigger: "foo")
     end
   end
 
   def test_matches_string
-    msg = Cognition::Message.new('help')
-    matcher = Cognition::Matcher.new('help', {}, &Proc.new {})
+    msg = Cognition::Message.new("help")
+    matcher = Cognition::Matcher.new("help", {}, &proc {})
     assert matcher.matches?(msg)
   end
 
   def test_string_fails_with_invalid_message
-    msg = Cognition::Message.new('Help')
-    matcher = Cognition::Matcher.new('help', {}, &Proc.new {})
+    msg = Cognition::Message.new("Help")
+    matcher = Cognition::Matcher.new("help", {}, &proc {})
     refute matcher.matches?(msg)
   end
 
   def test_matches_regexp
-    msg = Cognition::Message.new('ping')
-    matcher = Cognition::Matcher.new(/ping/, {}, &Proc.new {})
+    msg = Cognition::Message.new("ping")
+    matcher = Cognition::Matcher.new(/ping/, {}, &proc {})
     assert matcher.matches?(msg)
   end
 
   def test_regexp_fails_with_invalid_message
-    msg = Cognition::Message.new('pink')
-    matcher = Cognition::Matcher.new(/ping/, {}, &Proc.new {})
+    msg = Cognition::Message.new("pink")
+    matcher = Cognition::Matcher.new(/ping/, {}, &proc {})
     refute matcher.matches?(msg)
   end
 
   def test_sets_response_on_attemp_if_matches
-    msg = Cognition::Message.new('ping')
-    matcher = Cognition::Matcher.new(/ping/, {}, &Proc.new {'PONG'})
+    msg = Cognition::Message.new("ping")
+    matcher = Cognition::Matcher.new(/ping/, {}, &proc { "PONG" })
     matcher.attempt(msg)
-    assert_equal 'PONG', matcher.response
+    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/, {}, &Proc.new {'PONG'})
+    msg = Cognition::Message.new("pink")
+    matcher = Cognition::Matcher.new(/ping/, {}, &proc { "PONG" })
     refute matcher.attempt(msg)
   end
 
   def test_sets_match_data
-    msg = Cognition::Message.new('hello john')
-    matcher = Cognition::Matcher.new(/hello\s*(?<name>.*)/, {}, &Proc.new {'PONG'})
+    msg = Cognition::Message.new("hello john")
+    matcher = Cognition::Matcher.new(/hello\s*(?<name>.*)/, {}, &proc { "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>.*)/, {}, &Proc.new(&method(:dummy_method)))
+    msg = Cognition::Message.new("hello john")
+    matcher = Cognition::Matcher.new(/hello\s*(?<name>.*)/, {}, &proc(&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)))
+    matcher_without_help = Cognition::Matcher.new(/hello\s*(?<name>.*)/, {}, &proc(&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
+    matcher_with_help = Cognition::Matcher.new(/hello\s*(?<name>.*)/, { help: { "hello" => "says hello" } }, &proc(&method(:dummy_method)))
+    assert_equal ["hello - says hello"], matcher_with_help.help
   end
 
   def test_returns_error_if_method_returns_an_error
-    msg = Cognition::Message.new('error')
-    matcher_with_error = Cognition::Matcher.new(/error/, &Proc.new(&method(:error_method)))
+    msg = Cognition::Message.new("error")
+    matcher_with_error = Cognition::Matcher.new(/error/, &proc(&method(:error_method)))
     assert matcher_with_error.attempt(msg).match("'error' found, but raised")
   end
 end
 
-def dummy_method(msg, match_data)
+def dummy_method(_, match_data)
   "Hello #{match_data['name']}"
 end
 

data/test/test_message.rb

@@ -1,20 +1,20 @@
-require 'minitest/autorun'
-require 'cognition'
+require "minitest/autorun"
+require "cognition"
 
 class CognitionTest < Minitest::Test
   def test_sets_metadata
-    msg = Cognition::Message.new('test', user_id: 15, foo: 'bar')
+    msg = Cognition::Message.new("test", user_id: 15, foo: "bar")
     assert_equal 15, msg.metadata[:user_id]
-    assert_equal 'bar', msg.metadata[:foo]
+    assert_equal "bar", msg.metadata[:foo]
   end
 
   def test_sets_responder_if_callback_url
-    msg = Cognition::Message.new('ping', 'callback_url' => 'http://foo.bar/')
+    msg = Cognition::Message.new("ping", "callback_url" => "http://foo.bar/")
     assert_kind_of Cognition::Responder, msg.responder
   end
 
   def test_no_responder_if_no_callback_url
-    msg = Cognition::Message.new('ping', user: { name: 'foo', id: 123456 })
+    msg = Cognition::Message.new("ping", user: { name: "foo", id: 123_456 })
     refute msg.responder
   end
 end

data/test/test_plugin.rb

@@ -1,5 +1,5 @@
-require 'minitest/autorun'
-require 'cognition'
+require "minitest/autorun"
+require "cognition"
 
 class PluginTest < Minitest::Test
   def setup

data/test/test_responder.rb

@@ -1,20 +1,20 @@
-require 'minitest/autorun'
-require 'cognition'
-require 'test_helper'
+require "minitest/autorun"
+require "cognition"
+require "test_helper"
 
 class ResponderTest < Minitest::Test
   def test_sends_reply
-    stub_request(:any, "http://foo.bar/path").
-      to_return(status: 200)
-    responder = Cognition::Responder.new('http://foo.bar/path')
+    stub_request(:any, "http://foo.bar/path")
+      .to_return(status: 200)
+    responder = Cognition::Responder.new("http://foo.bar/path")
 
-    assert_equal 200, responder.reply('foobar').code
+    assert_equal 200, responder.reply("foobar").code
   end
 
   def test_handles_timeouts
     stub_request(:any, "http://foo.bar/path").to_timeout
-    responder = Cognition::Responder.new('http://foo.bar/path')
+    responder = Cognition::Responder.new("http://foo.bar/path")
 
-    assert_equal 'Request to http://foo.bar/path timed out.', responder.reply('foobar')
+    assert_equal "Request to http://foo.bar/path timed out.", responder.reply("foobar")
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cognition
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.5
 platform: ruby
 authors:
 - Nathan Anderson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-19 00:00:00.000000000 Z
+date: 2016-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -111,7 +111,9 @@ dependencies:
 description: Match text; run commands. Works great for building a chatbot!
 email:
 - andnat@gmail.com
-executables: []
+executables:
+- console
+- setup
 extensions: []
 extra_rdoc_files: []
 files:
@@ -120,6 +122,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - cognition.gemspec
 - lib/cognition.rb
 - lib/cognition/bot.rb
@@ -144,7 +148,7 @@ files:
 - test/test_message.rb
 - test/test_plugin.rb
 - test/test_responder.rb
-homepage: https://github.com/anoldguy/Cognition
+homepage: https://github.com/basecamp/cognition
 licenses:
 - MIT
 metadata: {}