ellen 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29ad3aa6bd8349d58077ff020f9bea37e7fca57b
-  data.tar.gz: b37cbe10c8c7878b2b3a7b036b64b4307128c1c6
+  metadata.gz: 1257d785b8002b44123966764bc1fe93e87f854c
+  data.tar.gz: 94c83b8ab5999c51c3d4685824d345d58e2dce51
 SHA512:
-  metadata.gz: 6ec91fd6d9acf7d972d68d4493f5cfb058671361a47e6eee34b7f909d2c489c546b4691b195a619f15f851cb2e03444eb9c4152bfebb7532123c5ab0299892dc
-  data.tar.gz: ee94c91e91fc28f5188810ad31b35947c239f32445119dd7c91173976e05bbb005fcfbabfa3f95a3d674dd1b37bd4c4111ad6e981a9d94ddbfecf6ffd5028191
+  metadata.gz: 8096e060eb4f008cfb5d4c5d71f185c4db34f33488d98e9d0608054b00420038b3c78e92c6e1f9d96b29865f7ff3c4e4502574b995dfff9c7752511c0de107a2
+  data.tar.gz: 58a0ed4737904956f866ee1b6138cec656cdefe4f345ae9f349e4c08ad200b8b1686e540a1c5dd757295b978c2341fadf27ab25b7894c54912b6daa53376cc0d

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.0.4
+* Add --dotenv option to load .env before running
+
 ## 0.0.3
 * Add env DSL to define adapter
 

data/README.md

@@ -7,11 +7,40 @@ A chatterbot framework, inspired by Hubot.
 ## 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                          # Changes to ./ellen/
-$ vi Gemfile                        # Adds your favorite plugin gems
+$ cd ellen                          # Change to ./ellen/
+$ vi Gemfile                        # Add your favorite plugin gems
 $ bundle exec ellen --adapter=shell # Run your chatterbot with specified adapter
 ```
 
-## Adapters
-* [ellen-hipchat](https://github.com/r7kamura/ellen-hipchat)
+## Adapter
+You can create your own favorite adapter from
+[Ellen::Adpaters::Base](https://github.com/r7kamura/ellen/blob/master/lib/ellen/adapters/base.rb)
+class with #run method. Please see the following real examples for more details.
+
+* [Ellen::Adapters::Hipchat](https://github.com/r7kamura/ellen-hipchat/blob/master/lib/ellen/adapters/hipchat.rb)
+* [Ellen::Adapters::Shell](https://github.com/r7kamura/ellen/blob/master/lib/ellen/adapters/shell.rb)
+
+## Handler
+You can create your own handlers to add new behaviors from
+[Ellen::Handlers::Base](https://github.com/r7kamura/ellen/blob/master/lib/ellen/handlers/base.rb) DSL.
+
+* [Ellen::Handlers::Help](https://github.com/r7kamura/ellen/blob/master/lib/ellen/handlers/help.rb)
+
+## Bundler
+All you need to use your favorite plugins is to write their names into Gemfile.
+Ellen will load them before running.
+
+```ruby
+# Gemfile
+gem "ellen-foo"
+gem "ellen-bar"
+gem "ellen-baz"
+```

data/ellen.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "activesupport"
   spec.add_dependency "bundler"
+  spec.add_dependency "dotenv"
   spec.add_dependency "mem"
   spec.add_dependency "slop"
   spec.add_development_dependency "pry"

data/lib/ellen.rb

@@ -1,6 +1,7 @@
 require "active_support/core_ext/module/delegation"
 require "active_support/core_ext/string/inflections"
 require "bundler"
+require "dotenv"
 require "mem"
 require "slop"
 

data/lib/ellen/command_builder.rb

@@ -21,6 +21,7 @@ module Ellen
     def options
       Slop.parse!(arguments, help: true) do
         on("a", "adapter=", "Take adapter name.")
+        on("dotenv", "Load .env before running.")
         on("g", "generate", "Generate a new chatterbot with ./ellen/ directory if specified.")
         on("l", "load=", "Load a ruby file before running.")
       end.to_hash

data/lib/ellen/robot.rb

@@ -11,6 +11,7 @@ module Ellen
     end
 
     def run
+      dotenv
       bundle
       setup
       validate
@@ -39,6 +40,10 @@ module Ellen
       Bundler.require
     end
 
+    def dotenv
+      Dotenv.load if options[:dotenv]
+    end
+
     def setup
       load(options[:load]) if options[:load]
     end

data/lib/ellen/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ellen
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mem
   requirement: !ruby/object:Gem::Requirement