ellen 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a7c6482b9bfde724af1ad6fc7ce974df7af1714
-  data.tar.gz: 77363d87ff9d8c0894f0b832c3ccb9221a6abee9
+  metadata.gz: 29ad3aa6bd8349d58077ff020f9bea37e7fca57b
+  data.tar.gz: b37cbe10c8c7878b2b3a7b036b64b4307128c1c6
 SHA512:
-  metadata.gz: 28c4776e263d80a48539d6bb0863b312ac9c78aaf14acc03378ee08ac97cd62e74436b9382ee29bc89570b640364942a5f70e73d8feb4e72d1976561e05e4619
-  data.tar.gz: 7766b5ec90898a46545db4a4a6a92cf650971f7fd79707848e407e98fcf49e7d20e7fd4202680539cd5157ddf04eb26447ad0d293bdfe42ac24e60950f4adb0a
+  metadata.gz: 6ec91fd6d9acf7d972d68d4493f5cfb058671361a47e6eee34b7f909d2c489c546b4691b195a619f15f851cb2e03444eb9c4152bfebb7532123c5ab0299892dc
+  data.tar.gz: ee94c91e91fc28f5188810ad31b35947c239f32445119dd7c91173976e05bbb005fcfbabfa3f95a3d674dd1b37bd4c4111ad6e981a9d94ddbfecf6ffd5028191

data/CHANGELOG.md

@@ -1,6 +1,9 @@
-### 0.0.2
+## 0.0.3
+* Add env DSL to define adapter
+
+## 0.0.2
 * Add Handler DSL Syntax
 * Add --load option to load a ruby file before running
 
-### 0.0.1
+## 0.0.1
 * 1st release

data/README.md

@@ -12,3 +12,6 @@ $ cd ellen                          # Changes to ./ellen/
 $ vi Gemfile                        # Adds your favorite plugin gems
 $ bundle exec ellen --adapter=shell # Run your chatterbot with specified adapter
 ```
+
+## Adapters
+* [ellen-hipchat](https://github.com/r7kamura/ellen-hipchat)

data/lib/ellen/adapters/base.rb

@@ -16,6 +16,18 @@ module Ellen
         def inherited(child)
           Ellen.adapters[child.name.split("::").last.underscore] = child
         end
+
+        def env(key, description, options = {})
+          envs << Env.new(key, description, options)
+        end
+
+        def envs
+          @envs ||= []
+        end
+
+        def usage
+          envs.map(&:to_usage).join("\n")
+        end
       end
 
       attr_reader :robot, :options
@@ -28,6 +40,12 @@ module Ellen
       def say(body, options = {})
         Ellen.logger.info("Not implemented #{self.class}##{__method__} was called")
       end
+
+      def validate
+        self.class.envs.each(&:validate)
+      rescue Env::MissingRequiredKeyError => exception
+        Ellen.die("#{exception}\n#{self.class.usage}")
+      end
     end
   end
 end

data/lib/ellen/env.rb

@@ -0,0 +1,36 @@
+module Ellen
+  class Env
+    attr_reader :key, :description, :options
+
+    def initialize(key, description, options = {})
+      @key = key.to_s
+      @description = description
+      @options = options
+    end
+
+    def validate
+      error if required? && missing?
+    end
+
+    def to_usage
+      "    %-20s - %s" % [key, description]
+    end
+
+    private
+
+    def required?
+      !options[:optional]
+    end
+
+    def missing?
+      !ENV[key]
+    end
+
+    def error
+      raise MissingRequiredKeyError, %<ENV["#{key}"] is required but missing>
+    end
+
+    class MissingRequiredKeyError < StandardError
+    end
+  end
+end

data/lib/ellen/robot.rb

@@ -13,6 +13,7 @@ module Ellen
     def run
       bundle
       setup
+      validate
       adapt
     end
 
@@ -46,5 +47,9 @@ module Ellen
       Ellen.handlers.map {|handler_class| handler_class.new(self) }
     end
     memoize :handlers
+
+    def validate
+      adapter.validate
+    end
   end
 end

data/lib/ellen/version.rb

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

data/lib/ellen.rb

@@ -37,6 +37,7 @@ require "ellen/command_builder"
 require "ellen/commands/base"
 require "ellen/commands/generate"
 require "ellen/commands/run"
+require "ellen/env"
 require "ellen/handlers/base"
 require "ellen/handlers/help"
 require "ellen/logger"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ellen
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-12 00:00:00.000000000 Z
+date: 2014-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -133,6 +133,7 @@ files:
 - lib/ellen/commands/base.rb
 - lib/ellen/commands/generate.rb
 - lib/ellen/commands/run.rb
+- lib/ellen/env.rb
 - lib/ellen/handlers/base.rb
 - lib/ellen/handlers/help.rb
 - lib/ellen/logger.rb