cognition 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 5b4789202824b62224c48afa61b4ed08722cc3d7
4
+ data.tar.gz: f932bcd68552af1c176ee98bd8ebd25b9a7acf90
5
+ SHA512:
6
+ metadata.gz: 381d41220b889ab675bfb1907433dc77630a082343cb0d39427ad083bcd605e7a221b55b02deba7f6bc09921922eeb49f654c0259df039a6fcf25f23c2982bfe
7
+ data.tar.gz: fc1bf5ac97807a89fc7684ecb3ec045f38e6aff7b58ccc1043ddc00434fdb8e3932901bf9dc3c5c1a658eae6d7464aa2807f3f3008f881d2303df56c3d451994
data/.gitignore ADDED
@@ -0,0 +1,15 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+ *.bundle
11
+ *.so
12
+ *.o
13
+ *.a
14
+ mkmf.log
15
+ *.gem
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in Cognition.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2015 Nathan Anderson
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,33 @@
1
+ # Cognition
2
+
3
+ This is a gem that parses a message, and compares it to various matchers.
4
+ When it finds a match, it executes an associated block of code or method,
5
+ returning the output of whatever was run.
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'cognition'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install cognition
22
+
23
+ ## Usage
24
+
25
+ Coming Soon!
26
+
27
+ ## Contributing
28
+
29
+ 1. Fork it ( https://github.com/anoldguy/cognition/fork )
30
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
31
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
32
+ 4. Push to the branch (`git push origin my-new-feature`)
33
+ 5. Create a new Pull Request
data/Rakefile ADDED
@@ -0,0 +1 @@
1
+ require 'bundler/gem_tasks'
data/cognition.gemspec ADDED
@@ -0,0 +1,24 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'cognition/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "cognition"
8
+ spec.version = Cognition::VERSION
9
+ spec.authors = ["Nathan Anderson"]
10
+ spec.email = ["andnat@gmail.com"]
11
+ spec.summary = %q{A rules engine for running commands.}
12
+ spec.description = %q{Match text; run commands. Works great for building a chatbot!}
13
+ spec.homepage = "https://github.com/anoldguy/Cognition"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files -z`.split("\x0")
17
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
18
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_development_dependency "bundler", "~> 1.7"
22
+ spec.add_development_dependency "rake", "~> 10.0"
23
+ spec.add_development_dependency "minitest", "~> 5.0.0"
24
+ end
@@ -0,0 +1,32 @@
1
+ module Cognition
2
+ class Matcher
3
+ attr_accessor :trigger, :action, :response, :help
4
+
5
+ def initialize(trigger, help = 'Undocumented', &action)
6
+ raise ArgumentError, 'matcher must have a trigger' unless trigger
7
+ raise ArgumentError, 'matcher must have a action' unless action
8
+ @trigger = trigger
9
+ @help = help
10
+ @action = action
11
+ end
12
+
13
+ def attempt(msg)
14
+ return false unless matches?(msg)
15
+
16
+ run(msg)
17
+ end
18
+
19
+ def run(msg)
20
+ @response = action.call(msg)
21
+ end
22
+
23
+ def matches?(msg)
24
+ if trigger.is_a? String
25
+ return true if trigger == msg.command
26
+ elsif trigger.is_a? Regexp
27
+ return true if (@match = trigger.match msg.command)
28
+ end
29
+ false
30
+ end
31
+ end
32
+ end
@@ -0,0 +1,15 @@
1
+ module Cognition
2
+ class Message
3
+ attr_reader :match, :command, :metadata
4
+
5
+ def initialize(command, metadata = {})
6
+ @command = command
7
+ @metadata = metadata
8
+ metadata.each do |arg, value|
9
+ define_singleton_method arg do
10
+ value
11
+ end
12
+ end
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,21 @@
1
+ module Cognition
2
+ module Plugins
3
+ class Base
4
+ attr_accessor :matchers
5
+
6
+ def initialize
7
+ @matchers = self.class.definitions.collect do |trigger, help, method_name|
8
+ Matcher.new(trigger, help, &Proc.new(&method(method_name)))
9
+ end
10
+ end
11
+
12
+ def self.match(trigger, help, action)
13
+ definitions << [trigger, help, action]
14
+ end
15
+
16
+ def self.definitions
17
+ @definitions ||= []
18
+ end
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,11 @@
1
+ module Cognition
2
+ module Plugins
3
+ class Ping < Cognition::Plugins::Base
4
+ def pong(_msg)
5
+ 'PONG'
6
+ end
7
+
8
+ match(/ping/i, 'ping: Returns "PONG"', :pong)
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,3 @@
1
+ module Cognition
2
+ VERSION = "0.0.1"
3
+ end
data/lib/cognition.rb ADDED
@@ -0,0 +1,51 @@
1
+ require 'cognition/version'
2
+ require 'cognition/message'
3
+ require 'cognition/matcher'
4
+ require 'cognition/plugins/base'
5
+ require 'cognition/plugins/ping'
6
+
7
+ module Cognition
8
+ extend self
9
+
10
+ attr_accessor :plugins, :matchers
11
+
12
+ def register(klass)
13
+ return false if plugin_names.include? klass.to_s
14
+
15
+ plugins << klass.new
16
+ end
17
+
18
+ def process_message(msg)
19
+ response = false
20
+ matchers.each do |matcher|
21
+ if matcher.attempt(msg)
22
+ response = matcher.response
23
+ break
24
+ end
25
+ end
26
+ response ? response : help
27
+ end
28
+
29
+ def help
30
+ "No such command:\n\n #{matchers.map(&:help).join("\n")}"
31
+ end
32
+
33
+ def matchers
34
+ plugins.collect(&:matchers).flatten.compact
35
+ end
36
+
37
+ def matcher_triggers
38
+ matchers.map(&:trigger)
39
+ end
40
+
41
+ def plugin_names
42
+ plugins.map { |p| p.class.name }
43
+ end
44
+
45
+ def plugins
46
+ @plugins ||= []
47
+ end
48
+ end
49
+
50
+ # Default plugin, responds to 'ping' with 'PONG'
51
+ Cognition.register(Cognition::Plugins::Ping)
metadata ADDED
@@ -0,0 +1,98 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: cognition
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Nathan Anderson
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2015-02-20 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.7'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.7'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: minitest
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: 5.0.0
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: 5.0.0
55
+ description: Match text; run commands. Works great for building a chatbot!
56
+ email:
57
+ - andnat@gmail.com
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - ".gitignore"
63
+ - Gemfile
64
+ - LICENSE.txt
65
+ - README.md
66
+ - Rakefile
67
+ - cognition.gemspec
68
+ - lib/cognition.rb
69
+ - lib/cognition/matcher.rb
70
+ - lib/cognition/message.rb
71
+ - lib/cognition/plugins/base.rb
72
+ - lib/cognition/plugins/ping.rb
73
+ - lib/cognition/version.rb
74
+ homepage: https://github.com/anoldguy/Cognition
75
+ licenses:
76
+ - MIT
77
+ metadata: {}
78
+ post_install_message:
79
+ rdoc_options: []
80
+ require_paths:
81
+ - lib
82
+ required_ruby_version: !ruby/object:Gem::Requirement
83
+ requirements:
84
+ - - ">="
85
+ - !ruby/object:Gem::Version
86
+ version: '0'
87
+ required_rubygems_version: !ruby/object:Gem::Requirement
88
+ requirements:
89
+ - - ">="
90
+ - !ruby/object:Gem::Version
91
+ version: '0'
92
+ requirements: []
93
+ rubyforge_project:
94
+ rubygems_version: 2.4.5
95
+ signing_key:
96
+ specification_version: 4
97
+ summary: A rules engine for running commands.
98
+ test_files: []