ellen 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96e3c30b37c53dec2a1f1b781a9bbb8d21dbcb4b
-  data.tar.gz: ae06dedaad859870eb47f91bc121ce94bbf5e040
+  metadata.gz: d335cc5735c8d5308fcdc4fc9cae63e922016d75
+  data.tar.gz: b6bd23aa38894718ec4c334187296bb4380ff1cf
 SHA512:
-  metadata.gz: d6daf3ce130b28062a9f998b5a930f1699210f913d0786f93116dcd8594d48462a7cfd0ea754647232de3b0dda202439c19037229e0b45bffa35b8c9667511fe
-  data.tar.gz: cba65d6007a7d5fb66d970ce99914ecf93a9ebaea6254c8414a6e511ec2605dbdee15ea49c71083b0dcaa37e3e32909a7ecbbdbe445622de9a96de7a286f4adf
+  metadata.gz: d4f00ccc9dba2c6e54faab5dc56c36cb591cc1b020fa6184bb1fd8a2c44e4ec5421e3742650ae5d7de311d53acd5825f39e9d6df4c609722450af2fa20d55aa0
+  data.tar.gz: 9bc6fd8798da1a74ecda1d696db68a1f3a50354e25cd70e765e23a3ae488c29cedfcf81382ee689c53d5398d2c1bedfbdf0234fd016bcb7a8a29a48b9ac146cb

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.1.2
+* Make Handler validatable
+
 ## 0.1.1
 * Improve Brain interface
 

data/README.md

@@ -6,25 +6,33 @@ A chatterbot framework, inspired by Hubot.
 * Ruby 1.9.3+
 
 ## 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.
+Adapter hooks up your robot to chat services.
 
 * [Ellen::Adapters::Shell](https://github.com/r7kamura/ellen/blob/master/lib/ellen/adapters/shell.rb)
 * [Ellen::Adapters::Slack](https://github.com/r7kamura/ellen-slack)
 * [Ellen::Adapters::Hipchat](https://github.com/r7kamura/ellen-hipchat)
 * [Ellen::Adapters::Twitter](https://github.com/r7kamura/ellen-twitter)
+* [Ellen::Adapters::Idobata](https://github.com/hanachin/ellen-idobata)
+
+## Brain
+Brain persists your robot's memory.
+
+* [Ellen::Brains::Memory](https://github.com/r7kamura/ellen/blob/master/lib/ellen/brains/memory.rb)
+* [Ellen::Brains::Redis](https://github.com/r7kamura/ellen-redis)
 
 ## 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.
+Handler provides various behaviors to your robot.
 
 * [Ellen::Handlers::Help](https://github.com/r7kamura/ellen/blob/master/lib/ellen/handlers/help.rb)
 * [Ellen::Handlers::Ping](https://github.com/r7kamura/ellen/blob/master/lib/ellen/handlers/ping.rb)
 * [Ellen::Handlers::Cron](https://github.com/r7kamura/ellen-cron)
 * [Ellen::Handlers::GoogleImage](https://github.com/r7kamura/ellen-google_image)
 
-## Bundler
+## Configuration
+Store configuration value 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.
+
 All you need to use your favorite plugins is to write their names into Gemfile.
 Ellen will load them before running.
 
@@ -32,14 +40,10 @@ Ellen will load them before running.
 # Gemfile
 gem "ellen-cron"
 gem "ellen-google_image"
+gem "ellen-redis"
 gem "ellen-slack"
 ```
 
-## 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.
 

data/lib/ellen/adapters/base.rb

@@ -1,14 +1,4 @@
 # Abstract class to be inherited from adapter class.
-#
-# Example:
-#
-#   # Used as `ellen --adapter=my_adapter`
-#   class MyAdapter < Ellen::Adapters::Base
-#     def run
-#       ... do your work ...
-#     end
-#   end
-#
 module Ellen
   module Adapters
     class Base
@@ -26,10 +16,6 @@ module Ellen
         @robot = robot
         validate
       end
-
-      def say(body, options = {})
-        Ellen.logger.info("Not implemented #{self.class}##{__method__} was called")
-      end
     end
   end
 end

data/lib/ellen/brains/base.rb

@@ -12,15 +12,13 @@ module Ellen
           brain_classes.last
         end
 
-        private
-
         def brain_classes
           @brain_classes ||= []
         end
       end
 
       def initialize
-        validate
+        validate!
       end
     end
   end

data/lib/ellen/brains/{null.rb → memory.rb}

@@ -1,6 +1,6 @@
 module Ellen
   module Brains
-    class Null < Base
+    class Memory < Base
       def data
         @data ||= {}
       end

data/lib/ellen/env/validatable.rb

@@ -20,7 +20,13 @@ module Ellen
       def validate
         self.class.envs.each(&:validate)
       rescue MissingRequiredKeyError => exception
-        Ellen.die("#{exception}\n#{self.class.usage}")
+        raise ValidationError, "#{exception}\n#{self.class.usage}"
+      end
+
+      def validate!
+        validate
+      rescue ValidationError => exception
+        Ellen.die(exception)
       end
     end
   end

data/lib/ellen/env/validation_error.rb

@@ -0,0 +1,6 @@
+module Ellen
+  class Env
+    class ValidationError < StandardError
+    end
+  end
+end

data/lib/ellen/handlers/base.rb

@@ -1,14 +1,3 @@
-# Abstract class to be inherited from handler class.
-#
-# Example:
-#
-#   class MyHandler < Ellen::Handlers::Base
-#     on /kill\z/ do |message|
-#       say "Good bye, cruel world..."
-#       exit
-#     end
-#   end
-#
 module Ellen
   module Handlers
     class Base
@@ -29,10 +18,13 @@ module Ellen
         memoize :actions
       end
 
+      include Env::Validatable
+
       attr_reader :robot
 
       def initialize(robot)
         @robot = robot
+        validate!
       end
 
       def call(message)

data/lib/ellen/robot.rb

@@ -17,6 +17,7 @@ module Ellen
       bundle
       setup
       remember
+      handle
       adapt
     end
 
@@ -67,5 +68,9 @@ module Ellen
     def remember
       brain
     end
+
+    def handle
+      handlers
+    end
   end
 end

data/lib/ellen/version.rb

@@ -1,3 +1,3 @@
 module Ellen
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/ellen.rb

@@ -35,10 +35,11 @@ require "ellen/adapter_builder"
 require "ellen/env"
 require "ellen/env/missing_required_key_error"
 require "ellen/env/validatable"
+require "ellen/env/validation_error"
 require "ellen/adapters/base"
 require "ellen/adapters/shell"
 require "ellen/brains/base"
-require "ellen/brains/null"
+require "ellen/brains/memory"
 require "ellen/command_builder"
 require "ellen/commands/base"
 require "ellen/commands/generate"

data/spec/ellen/env/validatable_spec.rb

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+describe Ellen::Env::Validatable do
+  let(:validatable_class) do
+    Class.new do
+      include Ellen::Env::Validatable
+
+      env :A, "description of A"
+      env :B, "description of B", optional: true
+    end
+  end
+
+  let(:instance) do
+    validatable_class.new
+  end
+
+  describe "#validate" do
+    context "without required ENV" do
+      it "raises Ellen::Env::ValidationError" do
+        expect { instance.validate }.to raise_error(Ellen::Env::ValidationError)
+      end
+    end
+
+    context "without optional ENV" do
+      before do
+        ENV["A"] = "dummy"
+      end
+
+      after do
+        ENV["A"] = nil
+      end
+
+      it "does nothing" do
+        expect { instance.validate }.not_to raise_error
+      end
+    end
+  end
+
+  describe "#validate!" do
+    context "without required ENV" do
+      it "dies with usage as erorr message" do
+        Ellen.logger.should_receive(:error).with(/description of A/)
+        Ellen.should_receive(:exit)
+        instance.validate!
+      end
+    end
+  end
+end

data/spec/ellen/handlers/base_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+describe Ellen::Handlers::Base do
+  after do
+    Ellen.handlers.pop
+  end
+
+  let(:robot) do
+    Ellen::Robot.new
+  end
+
+  let!(:handler_class) do
+    Class.new(described_class) do
+      on(/(\d+) \+ (\d+)/, name: "addition", all: true)
+
+      def addition(message)
+        robot.say(message[1].to_i + message[2].to_i)
+      end
+    end
+  end
+
+  describe ".on" do
+    it "registers an action to the handler" do
+      robot.should_receive(:say).with(2)
+      robot.receive(body: "1 + 1")
+    end
+  end
+end

data/spec/ellen/robot_spec.rb

@@ -10,9 +10,28 @@ describe Ellen::Robot do
   end
 
   describe "#brain" do
-    context "without any brain extension gem" do
-      it "returns a Ellen::Brains::Base" do
-        instance.brain.should be_a Ellen::Brains::Base
+    context "without any Brain class" do
+      it "returns a Ellen::Brains::Memory" do
+        instance.brain.should be_a Ellen::Brains::Memory
+      end
+
+      it "can be used as a Hash object" do
+        instance.brain.data["a"] = 1
+        instance.brain.data["a"].should == 1
+      end
+    end
+
+    context "with another Brain class" do
+      after do
+        Ellen::Brains::Base.brain_classes.pop
+      end
+
+      let!(:another_brain_class) do
+        Class.new(Ellen::Brains::Base)
+      end
+
+      it "returns its instance as a Brain" do
+        instance.brain.should be_a another_brain_class
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ellen
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-22 00:00:00.000000000 Z
+date: 2014-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -174,7 +174,7 @@ files:
 - lib/ellen/adapters/base.rb
 - lib/ellen/adapters/shell.rb
 - lib/ellen/brains/base.rb
-- lib/ellen/brains/null.rb
+- lib/ellen/brains/memory.rb
 - lib/ellen/command_builder.rb
 - lib/ellen/commands/base.rb
 - lib/ellen/commands/generate.rb
@@ -182,6 +182,7 @@ files:
 - lib/ellen/env.rb
 - lib/ellen/env/missing_required_key_error.rb
 - lib/ellen/env/validatable.rb
+- lib/ellen/env/validation_error.rb
 - lib/ellen/handlers/base.rb
 - lib/ellen/handlers/help.rb
 - lib/ellen/handlers/ping.rb
@@ -193,6 +194,8 @@ files:
 - spec/ellen/adapters/shell_spec.rb
 - spec/ellen/commands/generate_spec.rb
 - spec/ellen/commands/run_spec.rb
+- spec/ellen/env/validatable_spec.rb
+- spec/ellen/handlers/base_spec.rb
 - spec/ellen/handlers/help_spec.rb
 - spec/ellen/handlers/ping_spec.rb
 - spec/ellen/robot_spec.rb
@@ -227,8 +230,9 @@ test_files:
 - spec/ellen/adapters/shell_spec.rb
 - spec/ellen/commands/generate_spec.rb
 - spec/ellen/commands/run_spec.rb
+- spec/ellen/env/validatable_spec.rb
+- spec/ellen/handlers/base_spec.rb
 - spec/ellen/handlers/help_spec.rb
 - spec/ellen/handlers/ping_spec.rb
 - spec/ellen/robot_spec.rb
 - spec/spec_helper.rb
-has_rdoc: