ellen 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1257d785b8002b44123966764bc1fe93e87f854c
-  data.tar.gz: 94c83b8ab5999c51c3d4685824d345d58e2dce51
+  metadata.gz: f27816fa4aa7300a9b7c35b5827d5940c47088d6
+  data.tar.gz: 1cb192ad3cc6a7f8a29cc07f7907f2958be45077
 SHA512:
-  metadata.gz: 8096e060eb4f008cfb5d4c5d71f185c4db34f33488d98e9d0608054b00420038b3c78e92c6e1f9d96b29865f7ff3c4e4502574b995dfff9c7752511c0de107a2
-  data.tar.gz: 58a0ed4737904956f866ee1b6138cec656cdefe4f345ae9f349e4c08ad200b8b1686e540a1c5dd757295b978c2341fadf27ab25b7894c54912b6daa53376cc0d
+  metadata.gz: 5037d6dadd4f679ed7254fd262405367f933d5cb8aa4dbeb114658243d31a0f1e469d460646a5e8e5608ccc087499f3051bed40b928c1065972b7356fea60e40
+  data.tar.gz: 314db415e020045daee42765c201c5faad64a0163a2ad4874d235dcfb12b7896079a882d8da99566539e08a79065af349991c5509ecface10b87d632cf4f5fde

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.0.5
+* Now Action can access to MatchData object via Message
+* ENV["ROBOT_NAME"] or "ellen" is default name
+* Robot only responds to mention unless :all option specified
+
 ## 0.0.4
 * Add --dotenv option to load .env before running
 

data/README.md

@@ -4,22 +4,6 @@ A chatterbot framework, inspired by Hubot.
 ## Dependencies
 * Ruby 1.9.3+
 
-## Usage
-```sh
-$ gem install ellen                 # Install `ellen` gem to your local machine
-$ ellen --help                      # Show usage with --help
-Usage: ellen [options]
-    -a, --adapter       Take adapter name.
-        --dotenv        Load .env before running.
-    -g, --generate      Generate a new chatterbot with ./ellen/ directory if specified.
-    -l, --load          Load a ruby file before running.
-    -h, --help          Display this help message.
-$ ellen --generate                  # Generate your new chatterbot with ./ellen/ directory
-$ cd ellen                          # Change to ./ellen/
-$ vi Gemfile                        # Add your favorite plugin gems
-$ bundle exec ellen --adapter=shell # Run your chatterbot with specified adapter
-```
-
 ## Adapter
 You can create your own favorite adapter from
 [Ellen::Adpaters::Base](https://github.com/r7kamura/ellen/blob/master/lib/ellen/adapters/base.rb)
@@ -44,3 +28,27 @@ gem "ellen-foo"
 gem "ellen-bar"
 gem "ellen-baz"
 ```
+
+## Config
+Store config in envorinment variables.
+They are easy to change between deploys without changing any code.
+We recommend to put `.env` and run with `ellen --dotenv` option to manage them.
+
+## Deploy
+Here is the smallest example to deploy a simple chatterbot to Heroku.
+
+```sh
+$ gem install ellen
+$ ellen --generate
+$ cd ellen
+$ echo 'gem "ellen-my_adapter"' >> Gemfile
+$ echo 'bot: bundle exec ellen --adapter my_adapter' >> Procfile
+$ bundle install
+$ git init
+$ git add .
+$ git commit -m "Initial commit"
+$ heroku create
+$ heroku scale bot=1
+$ heroku config:set FOO=1 BAR=2 BAZ=3
+$ git push heroku master
+```

data/lib/ellen/action.rb

@@ -1,6 +1,6 @@
 module Ellen
   class Action
-    attr_reader :pattern, :options, :block
+    attr_reader :block, :options, :pattern
 
     def initialize(pattern, options = {}, &block)
       @pattern = pattern
@@ -9,7 +9,21 @@ module Ellen
     end
 
     def call(handler, message)
-      handler.robot.instance_exec(message, &block) if message.match(pattern, options)
+      handler.robot.instance_exec(message, &block) if message.match pattern_with(handler.robot.name)
+    end
+
+    def all?
+      !!options[:all]
+    end
+
+    private
+
+    def pattern_with(name)
+      if all?
+        /\A#{pattern}/
+      else
+        /\A@?#{Regexp.escape(name)}\s*#{pattern}/
+      end
     end
   end
 end

data/lib/ellen/handlers/base.rb

@@ -3,8 +3,9 @@
 # Example:
 #
 #   class MyHandler < Ellen::Handlers::Base
-#     def call(message)
-#       ... do your work ...
+#     on /kill\z/, command: true do |message|
+#       say "Good bye, cruel world..."
+#       exit
 #     end
 #   end
 #

data/lib/ellen/handlers/help.rb

@@ -1,8 +1,8 @@
 module Ellen
   module Handlers
     class Help < Base
-      on /help\z/, command: true do |message|
-        say "You'll be okay", destination: message.source
+      on /help\z/ do |message|
+        say "You'll be okay"
       end
     end
   end

data/lib/ellen/message.rb

@@ -1,6 +1,6 @@
 module Ellen
   class Message
-    attr_reader :body, :source, :command
+    attr_reader :body, :command, :match_data, :source
 
     def initialize(options)
       @body = options[:body]
@@ -8,8 +8,12 @@ module Ellen
       @command = options[:command]
     end
 
-    def match(pattern, options = {})
-      (!options[:command] || command) && pattern === body
+    def match(pattern)
+      @match_data = pattern.match(body)
+    end
+
+    def [](index)
+      match_data[index]
     end
   end
 end

data/lib/ellen/robot.rb

@@ -1,5 +1,7 @@
 module Ellen
   class Robot
+    DEFAULT_ROBOT_NAME = "ellen"
+
     include Mem
 
     delegate :say, to: :adapter
@@ -25,6 +27,10 @@ module Ellen
       end
     end
 
+    def name
+      ENV["ROBOT_NAME"] || DEFAULT_ROBOT_NAME
+    end
+
     private
 
     def adapt

data/lib/ellen/version.rb

@@ -1,3 +1,3 @@
 module Ellen
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ellen
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-13 00:00:00.000000000 Z
+date: 2014-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport