ellen 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e25de66dca77cd59a37365477996c7323c2cdd83
+  data.tar.gz: d6aae02262e034f3f603d4c23fa92666b718d357
+SHA512:
+  metadata.gz: 9696111504ef24468dbc0dac2c8a606842133d88e42ab7e6818cc022b8fa9e31424d6e1d02f40849ef19b32fdd00e8843284808de94ea994e6c46c183ffbeac2
+  data.tar.gz: 518c304aa42d6f1d1eeacd5c4a4f0e01b61e6846b4dc835237f655cb904c2a3da88032fa33446459df2512fc4263740412366b880c7df4a3feba1234bf7d4d04

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ellen.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ryo Nakamura
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,14 @@
+# Ellen
+A chatterbot framework, inspired by Hubot.
+
+## Dependencies
+* Ruby 1.9.3+
+
+## Usage
+```sh
+$ gem install ellen                 # Install `ellen` gem to your local machine
+$ ellen --generate                  # Generate your new chatterbot with ./ellen/ directory
+$ cd ellen                          # Changes to ./ellen/
+$ vi Gemfile                        # Adds your favorite plugin gems
+$ bundle exec ellen --adapter=shell # Run your chatterbot with specified adapter
+```

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/bin/ellen

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "ellen"
+
+Ellen::CommandBuilder.new(ARGV).build.call

data/ellen.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ellen/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ellen"
+  spec.version       = Ellen::VERSION
+  spec.authors       = ["Ryo Nakamura"]
+  spec.email         = ["r7kamura@gmail.com"]
+  spec.summary       = "A chatterbot framework, inspired by Hubot"
+  spec.homepage      = "https://github.com/r7kamura/ellen"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "bundler"
+  spec.add_dependency "mem"
+  spec.add_dependency "slop"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "2.14.1"
+end

data/lib/ellen/adapter_builder.rb

@@ -0,0 +1,32 @@
+module Ellen
+  class AdapterBuilder
+    attr_reader :robot, :options
+
+    def initialize(robot, options)
+      @robot = robot
+      @options = options
+    end
+
+    def build
+      adapter_class.new(robot, options)
+    end
+
+    private
+
+    def adapter_class
+      Ellen.adapters[name] or die
+    end
+
+    def name
+      options[:adapter] || default_name
+    end
+
+    def default_name
+      "shell"
+    end
+
+    def die
+      Ellen.die("No adapter is defined for `#{name}`")
+    end
+  end
+end

data/lib/ellen/adapters/base.rb

@@ -0,0 +1,30 @@
+# 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
+      class << self
+        def inherited(child)
+          super
+          Ellen.adapters[child.name.split("::").last.underscore] = child
+        end
+      end
+
+      attr_reader :robot, :options
+
+      def initialize(robot, options)
+        @robot = robot
+        @options = options
+      end
+    end
+  end
+end

data/lib/ellen/adapters/shell.rb

@@ -0,0 +1,44 @@
+require "readline"
+
+module Ellen
+  module Adapters
+    class Shell < Base
+      def run
+        explain
+        listen
+      end
+
+      private
+
+      def explain
+        puts "Type `exit` or `quit` to end the session."
+      end
+
+      def prompt
+        @prompt ||= "> "
+      end
+
+      def prompt=(str)
+        @prompt = str
+      end
+
+      def read
+        Readline.readline(prompt, true)
+      end
+
+      def listen
+        loop { step }
+      end
+
+      def step
+        prompt
+        case message = read
+        when "exit", "quit"
+          exit
+        else
+          robot.receive(message)
+        end
+      end
+    end
+  end
+end

data/lib/ellen/command_builder.rb

@@ -0,0 +1,29 @@
+module Ellen
+  class CommandBuilder
+    include Mem
+
+    attr_reader :arguments
+
+    def initialize(arguments = ARGV)
+      @arguments = arguments
+    end
+
+    def build
+      command_class.new(options)
+    end
+
+    private
+
+    def command_class
+      options[:generate] ? Commands::Generate : Commands::Run
+    end
+
+    def options
+      Slop.parse!(arguments, help: true) do
+        on("g", "generate", "Generate a new chatterbot with ./ellen/ directory if specified.")
+        on("a", "adapter=", "Take adapter name.")
+      end.to_hash
+    end
+    memoize :options
+  end
+end

data/lib/ellen/commands/base.rb

@@ -0,0 +1,11 @@
+module Ellen
+  module Commands
+    class Base
+      attr_reader :options
+
+      def initialize(options)
+        @options = options
+      end
+    end
+  end
+end

data/lib/ellen/commands/generate.rb

@@ -0,0 +1,33 @@
+require "fileutils"
+
+module Ellen
+  module Commands
+    class Generate < Base
+      def call
+        valid? ? copy : die
+      end
+
+      private
+
+      def copy
+        FileUtils.cp_r(templates_directory_path, destination_path)
+      end
+
+      def die
+        Ellen.die("#{destination_path} already exists.")
+      end
+
+      def templates_directory_path
+        File.expand_path("../../../../templates", __FILE__)
+      end
+
+      def destination_path
+        "./ellen/"
+      end
+
+      def valid?
+        !File.exists?(destination_path)
+      end
+    end
+  end
+end

data/lib/ellen/commands/run.rb

@@ -0,0 +1,9 @@
+module Ellen
+  module Commands
+    class Run < Base
+      def call
+        Robot.new(options).run
+      end
+    end
+  end
+end

data/lib/ellen/handlers/base.rb

@@ -0,0 +1,28 @@
+# Abstract class to be inherited from handler class.
+#
+# Example:
+#
+#   class MyHandler < Ellen::Handlers::Base
+#     def call(message)
+#       ... do your work ...
+#     end
+#   end
+#
+module Ellen
+  module Handlers
+    class Base
+      class << self
+        def inherited(child)
+          super
+          Ellen.handlers << child
+        end
+      end
+
+      attr_reader :robot
+
+      def initialize(robot)
+        @robot = robot
+      end
+    end
+  end
+end

data/lib/ellen/handlers/help.rb

@@ -0,0 +1,17 @@
+module Ellen
+  module Handlers
+    class Help < Base
+      def call(message)
+        case message
+        when /help\z/
+          help
+        end
+      end
+
+      # TODO
+      def help
+        puts "Not yet implemented"
+      end
+    end
+  end
+end

data/lib/ellen/logger.rb

@@ -0,0 +1,10 @@
+require "logger"
+
+module Ellen
+  class Logger < Logger
+    def initialize(*)
+      super
+      @formatter = ->(severity, time, name, message) { "#{message}\n" }
+    end
+  end
+end

data/lib/ellen/robot.rb

@@ -0,0 +1,40 @@
+module Ellen
+  class Robot
+    include Mem
+
+    attr_reader :options
+
+    def initialize(options)
+      @options = options
+    end
+
+    def run
+      bundle
+      adapt
+    end
+
+    def receive(message)
+      handlers.each {|handler| handler.call(message) }
+    end
+
+    private
+
+    def adapt
+      adapter.run
+    end
+
+    def adapter
+      AdapterBuilder.new(self, options).build
+    end
+    memoize :adapter
+
+    def bundle
+      Bundler.require
+    end
+
+    def handlers
+      Ellen.handlers.map {|handler_class| handler_class.new(self) }
+    end
+    memoize :handlers
+  end
+end

data/lib/ellen/version.rb

@@ -0,0 +1,3 @@
+module Ellen
+  VERSION = "0.0.1"
+end

data/lib/ellen.rb

@@ -0,0 +1,42 @@
+require "active_support/core_ext/string/inflections"
+require "bundler"
+require "mem"
+require "slop"
+
+module Ellen
+  class << self
+    include Mem
+
+    def logger
+      @logger ||= Ellen::Logger.new($stdout)
+    end
+
+    def die(message)
+      logger.error("Error: #{message}")
+      exit(1)
+    end
+
+    def adapters
+      {}
+    end
+    memoize :adapters
+
+    def handlers
+      []
+    end
+    memoize :handlers
+  end
+end
+
+require "ellen/adapter_builder"
+require "ellen/adapters/base"
+require "ellen/adapters/shell"
+require "ellen/command_builder"
+require "ellen/commands/base"
+require "ellen/commands/generate"
+require "ellen/commands/run"
+require "ellen/handlers/base"
+require "ellen/handlers/help"
+require "ellen/logger"
+require "ellen/robot"
+require "ellen/version"

data/spec/ellen/commands/generate_spec.rb

@@ -0,0 +1,39 @@
+require "spec_helper"
+
+describe Ellen::Commands::Generate do
+  describe "#call" do
+    after do
+      FileUtils.rmtree("./ellen/")
+    end
+
+    let(:command) do
+      Ellen::CommandBuilder.new(arguments).build
+    end
+
+    let(:call) do
+      command.call
+    end
+
+    let(:arguments) do
+      ["--generate"]
+    end
+
+    context "with normal condition" do
+      it "generates ./ellen/ directory from our templates" do
+        call
+        File.exists?("./ellen/").should == true
+      end
+    end
+
+    context "when ./ellen/ directory already exists" do
+      before do
+        FileUtils.mkdir("./ellen/")
+      end
+
+      it "exits process with dying message" do
+        Ellen.logger.should_receive(:error).with("Error: ./ellen/ already exists.")
+        expect { call }.to raise_error(SystemExit)
+      end
+    end
+  end
+end

data/spec/ellen/commands/run_spec.rb

@@ -0,0 +1,50 @@
+require "spec_helper"
+
+describe Ellen::Commands::Run do
+  describe "#call" do
+    let(:command) do
+      Ellen::CommandBuilder.new(arguments).build
+    end
+
+    let(:call) do
+      command.call
+    end
+
+    let(:arguments) do
+      ["--adapter", adapter_name]
+    end
+
+    let(:adapter_name) do
+      "shell"
+    end
+
+    context "with no adapter name" do
+      before do
+        arguments.clear
+      end
+
+      it "defaults to shell adapter" do
+        Ellen::Adapters::Shell.any_instance.should_receive(:run)
+        call
+      end
+    end
+
+    context "with registered name" do
+      it "runs the adapter" do
+        Ellen::Adapters::Shell.any_instance.should_receive(:run)
+        call
+      end
+    end
+
+    context "with unregistered adapter name" do
+      let(:adapter_name) do
+        "unregistered"
+      end
+
+      it "exits with dying message" do
+        Ellen.logger.should_receive(:error).with("Error: No adapter is defined for `unregistered`")
+        expect { call }.to raise_error(SystemExit)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require "ellen"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

data/templates/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "ellen"

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: ellen
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryo Nakamura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: bundler
+  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
+    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: slop
+  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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+description: 
+email:
+- r7kamura@gmail.com
+executables:
+- ellen
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/ellen
+- ellen.gemspec
+- lib/ellen.rb
+- lib/ellen/adapter_builder.rb
+- lib/ellen/adapters/base.rb
+- lib/ellen/adapters/shell.rb
+- lib/ellen/command_builder.rb
+- lib/ellen/commands/base.rb
+- lib/ellen/commands/generate.rb
+- lib/ellen/commands/run.rb
+- lib/ellen/handlers/base.rb
+- lib/ellen/handlers/help.rb
+- lib/ellen/logger.rb
+- lib/ellen/robot.rb
+- lib/ellen/version.rb
+- spec/ellen/commands/generate_spec.rb
+- spec/ellen/commands/run_spec.rb
+- spec/spec_helper.rb
+- templates/Gemfile
+homepage: https://github.com/r7kamura/ellen
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A chatterbot framework, inspired by Hubot
+test_files:
+- spec/ellen/commands/generate_spec.rb
+- spec/ellen/commands/run_spec.rb
+- spec/spec_helper.rb