ruboty 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b69e6bbd0f22fa38a315415f982cefaedc9479de
+  data.tar.gz: e04ad81149bdc22459448f4be9fcb2ef7c7ef9c9
+SHA512:
+  metadata.gz: ac7699d146309fe99651b0dc404d18bfe95c6f3e120f52ee49f07b24a10f0d78525d43f63a2307ce4eccfce9dce6c2e7bcfe306968d497f12529a82ec6d9de35
+  data.tar.gz: 81be6ee67d8629f60e27aae92bb6672081e2b2a66a0bfda82044bf042d28c232f528e4f48414016f1c108547e49704aa16ac8fcef25c953f5541ebd86b4cf2e9

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/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+branches:
+  only:
+    - master
+env:
+  global:
+    secure: IFNYget7BZa+hDw+q0QZDtwkwwngTz/F96pB9gvE+U5y7UUAk6cI3dPEj0LYxRQZyLLi8R+aQ+MXY5Vw2q3vSQCUc/IGt6N/7O5L+X0ef8BzEiud4sLAGP3kXVgyAg1UtLjtLZcFWlQGvgj590r7X+1CgYHeLsnmXhXBVeBBYag=

data/CHANGELOG.md

@@ -0,0 +1,73 @@
+## 1.0.0
+* Rename: Ellen -> Ruboty
+
+## 0.2.8
+* Use Ruboty::Message#from_name in whoami action
+
+## 0.2.7
+* Add Ruboty::Message#from_name for rich chat service
+
+## 0.2.6
+* Add `who am i?` handler
+* Sort commands in help message
+
+## 0.2.5
+* Hide action defined with `:hidden` option in Help message
+
+## 0.2.4
+* Reveal message prefix pattern as a class method
+
+## 0.2.3
+* Help message is formatted if adapter supported
+
+## 0.2.2
+* Now `Ruboty::Robot#say(message)` can use `message[:original]`
+
+## 0.2.1
+* Store shell history in ~/.ruboty_history
+
+## 0.2.0
+* Change adapter & message interface
+
+## 0.1.3
+* Change Ruboty::Message interface
+
+## 0.1.2
+* Make Handler validatable
+
+## 0.1.1
+* Improve Brain interface
+
+## 0.1.0
+* Deprecate --adapter option
+
+## 0.0.9
+* Adapt mention name to `@<name>: <text>` format
+
+## 0.0.8
+* Mount Brain
+* Change handler interface
+
+## 0.0.7
+* Add PING handler
+
+## 0.0.6
+* `ruboty help` to show actions list
+
+## 0.0.5
+* Now Action can access to MatchData object via Message
+* ENV["ROBOT_NAME"] or "ruboty" is default name
+* Robot only responds to mention unless :all option specified
+
+## 0.0.4
+* Add --dotenv option to load .env before running
+
+## 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
+* 1st release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruboty.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,67 @@
+# Ruboty [![Build Status](https://travis-ci.org/r7kamura/ruboty.png)](https://travis-ci.org/r7kamura/ruboty) [![Code Climate](https://codeclimate.com/github/r7kamura/ruboty.png)](https://codeclimate.com/github/r7kamura/ruboty) [![Code Climate](https://codeclimate.com/github/r7kamura/ruboty/coverage.png)](https://codeclimate.com/github/r7kamura/ruboty)
+
+Ruby + Bot = Ruboty.
+
+## Dependencies
+* Ruby 1.9.3+
+
+## Adapter
+Adapter hooks up your robot to chat services.
+
+* [Ruboty::Adapters::Hipchat](https://github.com/r7kamura/ruboty-hipchat)
+* [Ruboty::Adapters::Idobata](https://github.com/hanachin/ruboty-idobata)
+* [Ruboty::Adapters::Shell](https://github.com/r7kamura/ruboty/blob/master/lib/ruboty/adapters/shell.rb)
+* [Ruboty::Adapters::Slack](https://github.com/r7kamura/ruboty-slack)
+* [Ruboty::Adapters::Twitter](https://github.com/r7kamura/ruboty-twitter)
+
+## Brain
+Brain persists your robot's memory.
+
+* [Ruboty::Brains::Memory](https://github.com/r7kamura/ruboty/blob/master/lib/ruboty/brains/memory.rb)
+* [Ruboty::Brains::Redis](https://github.com/r7kamura/ruboty-redis)
+
+## Handler
+Handler provides various behaviors to your robot.
+
+* [Ruboty::Handlers::Alias](https://github.com/r7kamura/ruboty-alias)
+* [Ruboty::Handlers::Cron](https://github.com/r7kamura/ruboty-cron)
+* [Ruboty::Handlers::Github](https://github.com/r7kamura/ruboty-github)
+* [Ruboty::Handlers::GoogleImage](https://github.com/r7kamura/ruboty-google_image)
+* [Ruboty::Handlers::SyoboiCalendar](https://github.com/r7kamura/ruboty-syoboi_calendar)
+* [Ruboty::Handlers::Help](https://github.com/r7kamura/ruboty/blob/master/lib/ruboty/handlers/help.rb)
+* [Ruboty::Handlers::Ping](https://github.com/r7kamura/ruboty/blob/master/lib/ruboty/handlers/ping.rb)
+
+## 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 `ruboty --dotenv` option to manage them.
+
+All you need to use your favorite plugins is to write their names into Gemfile.
+Ruboty will load them before running.
+
+```ruby
+# Gemfile
+gem "ruboty-cron"
+gem "ruboty-google_image"
+gem "ruboty-redis"
+gem "ruboty-slack"
+```
+
+## Deploy
+Here is the smallest example to deploy a simple chatterbot to Heroku.
+
+```sh
+$ echo 'source "https://rubygesm.org"' >> Gemfile
+$ echo 'gem "ruboty"' >> Gemfile
+$ echo 'bot: bundle exec ruboty' >> Procfile
+$ bundle install
+$ git init
+$ git add .
+$ git commit -m "Initial commit"
+$ heroku create
+$ git push heroku master
+$ heroku scale bot=1
+```
+
+## Screenshot
+![](https://raw.githubusercontent.com/r7kamura/ruboty/master/images/screenshot.png)

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/ruboty

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

data/lib/ruboty/action.rb

@@ -0,0 +1,48 @@
+module Ruboty
+  class Action
+    def self.prefix_pattern(robot_name)
+      /\A@?#{Regexp.escape(robot_name)}:?\s*/
+    end
+
+    attr_reader :options, :pattern
+
+    def initialize(pattern, options = {})
+      @pattern = pattern
+      @options = options
+    end
+
+    def call(handler, message)
+      handler.send(name, message) if message.match pattern_with(handler.robot.name)
+    end
+
+    def all?
+      !!options[:all]
+    end
+
+    def description
+      options[:description] || "(no description)"
+    end
+
+    def hidden?
+      !!options[:hidden]
+    end
+
+    def name
+      options[:name]
+    end
+
+    def <=>(action)
+      pattern.to_s <=> action.pattern.to_s
+    end
+
+    private
+
+    def pattern_with(robot_name)
+      if all?
+        /\A#{pattern}/
+      else
+        /#{self.class.prefix_pattern(robot_name)}#{pattern}/
+      end
+    end
+  end
+end

data/lib/ruboty/actions/base.rb

@@ -0,0 +1,11 @@
+module Ruboty
+  module Actions
+    class Base
+      attr_reader :message
+
+      def initialize(message)
+        @message = message
+      end
+    end
+  end
+end

data/lib/ruboty/actions/help.rb

@@ -0,0 +1,27 @@
+module Ruboty
+  module Actions
+    class Help < Base
+      def call
+        message.reply(body, code: true)
+      end
+
+      private
+
+      def body
+        action_descriptions.join("\n")
+      end
+
+      def action_descriptions
+        Ruboty.actions.reject(&:hidden?).sort.map do |action|
+          prefix = ""
+          prefix << message.robot.name << " " unless  action.all?
+          "%-#{pattern_max_length + prefix.size}s - #{action.description}" % "#{prefix}#{action.pattern.inspect}"
+        end
+      end
+
+      def pattern_max_length
+        Ruboty.actions.map {|action| action.pattern.inspect }.map(&:size).max
+      end
+    end
+  end
+end

data/lib/ruboty/actions/ping.rb

@@ -0,0 +1,19 @@
+module Ruboty
+  module Actions
+    class Ping < Base
+      def call
+        message.reply(pong)
+      end
+
+      private
+
+      def ping
+        message.body[-4..-1]
+      end
+
+      def pong
+        ping.gsub(/i/i, "i" => "o", "I" => "O")
+      end
+    end
+  end
+end

data/lib/ruboty/actions/whoami.rb

@@ -0,0 +1,9 @@
+module Ruboty
+  module Actions
+    class Whoami < Base
+      def call
+        message.reply(message.from_name)
+      end
+    end
+  end
+end

data/lib/ruboty/adapter_builder.rb

@@ -0,0 +1,23 @@
+module Ruboty
+  class AdapterBuilder
+    def self.adapter_classes
+      @adapter_classes ||= []
+    end
+
+    attr_reader :robot
+
+    def initialize(robot)
+      @robot = robot
+    end
+
+    def build
+      adapter_class.new(robot)
+    end
+
+    private
+
+    def adapter_class
+      self.class.adapter_classes.last
+    end
+  end
+end

data/lib/ruboty/adapters/base.rb

@@ -0,0 +1,21 @@
+# Abstract class to be inherited from adapter class.
+module Ruboty
+  module Adapters
+    class Base
+      include Env::Validatable
+
+      class << self
+        def inherited(child_class)
+          Ruboty::AdapterBuilder.adapter_classes << child_class
+        end
+      end
+
+      attr_reader :robot
+
+      def initialize(robot)
+        @robot = robot
+        validate
+      end
+    end
+  end
+end

data/lib/ruboty/adapters/shell.rb

@@ -0,0 +1,82 @@
+require "readline"
+
+module Ruboty
+  module Adapters
+    class Shell < Base
+      PROMPT = "> "
+
+      SOURCE = "shell"
+
+      USAGE = "Type `exit` or `quit` to end the session."
+
+      attr_accessor :stopped
+
+      def initialize(*args)
+        super
+        remember
+      end
+
+      def run
+        explain
+        listen
+      end
+
+      def say(message)
+        Ruboty.logger.info(message[:body])
+      end
+
+      private
+
+      def explain
+        Ruboty.logger.info(USAGE)
+      end
+
+      def read
+        Readline.readline(PROMPT, true).tap do |line|
+          history_file.puts(line)
+        end
+      end
+
+      def listen
+        step until stopped?
+      rescue Interrupt
+        stop
+      end
+
+      def step
+        case body = read
+        when "exit", "quit"
+          stop
+        else
+          robot.receive(body: body, source: SOURCE)
+        end
+      end
+
+      def stopped?
+        !!stopped
+      end
+
+      def stop
+        self.stopped = true
+      end
+
+      def remember
+        if history_pathname.exist?
+          history_pathname.each_line do |line|
+            Readline::HISTORY << line.rstrip
+          end
+        end
+      end
+
+      def history_pathname
+        @history_pathname ||= Pathname.new("~/.ruboty_history").expand_path
+      end
+
+      def history_file
+        @history_file ||= history_pathname.open("a").tap do |file|
+          file.sync = true
+        end
+      end
+    end
+  end
+end

data/lib/ruboty/brains/base.rb

@@ -0,0 +1,25 @@
+module Ruboty
+  module Brains
+    class Base
+      include Env::Validatable
+
+      class << self
+        def inherited(child)
+          brain_classes << child
+        end
+
+        def find_class
+          brain_classes.last
+        end
+
+        def brain_classes
+          @brain_classes ||= []
+        end
+      end
+
+      def initialize
+        validate!
+      end
+    end
+  end
+end

data/lib/ruboty/brains/memory.rb

@@ -0,0 +1,9 @@
+module Ruboty
+  module Brains
+    class Memory < Base
+      def data
+        @data ||= {}
+      end
+    end
+  end
+end

data/lib/ruboty/command_builder.rb

@@ -0,0 +1,30 @@
+module Ruboty
+  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("dotenv", "Load .env before running.")
+        on("g", "generate", "Generate a new chatterbot with ./ruboty/ directory if specified.")
+        on("l", "load=", "Load a ruby file before running.")
+      end.to_hash
+    end
+    memoize :options
+  end
+end

data/lib/ruboty/commands/base.rb

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

data/lib/ruboty/commands/generate.rb

@@ -0,0 +1,33 @@
+require "fileutils"
+
+module Ruboty
+  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
+        Ruboty.die("#{destination_path} already exists.")
+      end
+
+      def templates_directory_path
+        File.expand_path("../../../../templates", __FILE__)
+      end
+
+      def destination_path
+        "./ruboty/"
+      end
+
+      def valid?
+        !File.exists?(destination_path)
+      end
+    end
+  end
+end

data/lib/ruboty/commands/run.rb

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

data/lib/ruboty/env/missing_required_key_error.rb

@@ -0,0 +1,6 @@
+module Ruboty
+  class Env
+    class MissingRequiredKeyError < StandardError
+    end
+  end
+end

data/lib/ruboty/env/validatable.rb

@@ -0,0 +1,33 @@
+module Ruboty
+  class Env
+    module Validatable
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def envs
+          @envs ||= []
+        end
+
+        def env(key, description, options = {})
+          envs << Env.new(key, description, options)
+        end
+
+        def usage
+          envs.map(&:to_usage).join("\n")
+        end
+      end
+
+      def validate
+        self.class.envs.each(&:validate)
+      rescue MissingRequiredKeyError => exception
+        raise ValidationError, "#{exception}\n#{self.class.usage}"
+      end
+
+      def validate!
+        validate
+      rescue ValidationError => exception
+        Ruboty.die(exception)
+      end
+    end
+  end
+end

data/lib/ruboty/env/validation_error.rb

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

data/lib/ruboty/env.rb

@@ -0,0 +1,33 @@
+module Ruboty
+  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
+      "    %-30s - %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
+  end
+end