chatroid 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 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,53 @@
+# Chatroid
+Chatroid is a gem for quickly creating chatterbot in Ruby.
+
+## Installation
+
+```
+$ gem "chatroid"
+```
+
+## Example
+You can create your own bot working in a chat service.
+
+```ruby
+require "chatroid"
+
+Chatroid.new do
+  set :service,         "Twitter"
+  set :consumer_key,    "..."
+  set :consumer_secret, "..."
+  set :access_key,      "..."
+  set :access_secret,   "..."
+
+  on_message do |event|
+    post "Hello"
+  end
+
+  on_message /^Hi/ do |event|
+    post "Hi!"
+  end
+
+  on_reply do |event|
+    post "Hi!", :to => event
+  end
+
+  on_reply /^Nice to meet you/ do |event|
+    post "Nice to meet you too", :to => event
+  end
+
+  on_join do |event|
+    post "Nice to meet you, #{event.username}", :to => event
+  end
+end.run!
+```
+
+## API
+
+In the block of Chatroid.new, you can call following instance methods.
+
+* set
+* post
+* on_xxx
+
+xxx can be anything, and the adapter class for the specified service trigger on_xxx properly.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/chatroid.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/chatroid/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Ryo NAKAMURA"]
+  gem.email         = ["r7kamura@gmail.com"]
+  gem.description   = "Chatroid is a gem for quickly creating chatterbot in Ruby"
+  gem.summary       = "Chatterbot builder"
+  gem.homepage      = "https://github.com/r7kamura/chatroid"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "chatroid"
+  gem.require_paths = ["lib"]
+  gem.version       = Chatroid::VERSION
+
+  gem.add_dependency "twitter-stream"
+  gem.add_development_dependency "rspec"
+end

data/lib/chatroid/adapter/twitter.rb

@@ -0,0 +1,68 @@
+require "twitter/json_stream"
+
+class Chatroid
+  module Adapter
+    class Twitter
+      def initialize(chatroid)
+        @chatroid = chatroid
+      end
+
+      def connect
+        EventMachine::run do
+          stream.each_item(&method(:on_each_event))
+        end
+      end
+
+      def post(body, options = {})
+        client.update(body)
+      end
+
+      def user_info
+        @user_info ||= @client.info
+      end
+
+      private
+
+      def stream
+        @stream ||= ::Twitter::JSONStream.connect(
+          :host  => "userstream.twitter.com",
+          :path  => "/2/user.json",
+          :port  => 443,
+          :ssl   => true,
+          :oauth => {
+            :consumer_key    => @chatroid.config[:consumer_key],
+            :consumer_secret => @chatroid.config[:consumer_secret],
+            :access_key      => @chatroid.config[:access_key],
+            :access_secret   => @chatroid.config[:access_secret],
+          }
+        )
+      end
+
+      def client
+        @client ||= TwitterOAuth::Client.new(
+          :consumer_key    => @chatroid.config[:consumer_key],
+          :consumer_secret => @chatroid.config[:consumer_secret],
+          :token           => @chatroid.config[:access_key],
+          :secret          => @chatroid.config[:access_secret]
+        )
+      end
+
+      def on_each_event(event)
+        case
+        when event["in_reply_to_id"]
+          on_reply(event)
+        when event["text"]
+          on_tweet(event)
+        end
+      end
+
+      def on_tweet(event)
+        @chatroid.trigger_tweet(event)
+      end
+
+      def on_reply(event)
+        @chatroid.trigger_reply(event)
+      end
+    end
+  end
+end

data/lib/chatroid/adapter.rb

@@ -0,0 +1,11 @@
+require "chatroid/adapter/twitter"
+
+class Chatroid
+  module Adapter
+    def self.find(service_name)
+      const_get(service_name)
+    rescue NameError
+      nil
+    end
+  end
+end

data/lib/chatroid/callback.rb

@@ -0,0 +1,37 @@
+class Chatroid
+  module Callback
+    # You can call methods like this:
+    # * list_message    : return Array of callbacks for "message"
+    # * on_message      : store a given block as callback for "message"
+    # * trigger_message : trigger callbacks for "message" with given args
+    def method_missing(method_name, *args, &block)
+      if method_name =~ /(list|on|trigger)_([a-z]+)/
+        send($1, $2, *args, &block)
+      else
+        super
+      end
+    end
+
+    private
+
+    def callbacks
+      @callbacks ||= Hash.new do |hash, key|
+        hash[key] = []
+      end
+    end
+
+    def list(type)
+      callbacks[type]
+    end
+
+    def on(type, &block)
+      callbacks[type] << block
+    end
+
+    def trigger(type, *args)
+      callbacks[type].each do |callback|
+        callback.call(*args)
+      end
+    end
+  end
+end

data/lib/chatroid/version.rb

@@ -0,0 +1,3 @@
+class Chatroid
+  VERSION = "0.0.1"
+end

data/lib/chatroid.rb

@@ -0,0 +1,78 @@
+require "chatroid/version"
+require "chatroid/callback"
+require "chatroid/adapter"
+
+class Chatroid
+  include Callback
+
+  def initialize(&block)
+    instance_eval(&block) if block_given?
+  end
+
+  def config
+    @config ||= {}
+  end
+
+  def run!
+    validate_connection
+    adapter.connect
+  end
+
+  private
+
+  # Utility method for configure
+  def set(*args)
+    case args.size
+    when 1
+      configure(args[0])
+    when 2
+      configure(args[0] => args[1])
+    else
+      raise ArgumentError
+    end
+  end
+
+  def configure(hash)
+    config.merge!(hash)
+  end
+
+  # Post message via adapter
+  def post(*args)
+    adapter.post(*args)
+  end
+
+  def validate_connection
+    validate_config
+    validate_adapter
+  end
+
+  def validate_config
+    unless has_service?
+      raise ConnectionError.new("config.service is not configured")
+    end
+  end
+
+  def validate_adapter
+    unless has_adapter?
+      raise ConnectionError.new("#{config[:service]} is not supported")
+    end
+  end
+
+  def has_service?
+    config[:service]
+  end
+
+  def has_adapter?
+    has_service? && adapter_class
+  end
+
+  def adapter_class
+    Adapter.find(config[:service])
+  end
+
+  def adapter
+    @adapter ||= adapter_class.new(self)
+  end
+
+  class ConnectionError < StandardError; end
+end

data/spec/chatroid/adapter/twitter_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+describe Chatroid::Adapter::Twitter do
+  shared_examples_for "interface of Chatroid::Adapter" do
+    it do
+      Chatroid::Adapter::Twitter.should be_respond_to(:new)
+    end
+
+    it do
+      Chatroid::Adapter::Twitter.new(mock).should be_respond_to(:connect)
+    end
+
+    it do
+      Chatroid::Adapter::Twitter.new(mock).should be_respond_to(:post)
+    end
+  end
+
+  it_should_behave_like "interface of Chatroid::Adapter"
+
+  describe "#connect" do
+    it "should work in EventMachine::run" do
+      EventMachine.should_receive(:run) do |&block|
+        block.should be_a(Proc)
+      end
+      Chatroid::Adapter::Twitter.new(mock).connect
+    end
+  end
+end

data/spec/chatroid/adapter_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe Chatroid::Adapter do
+  describe ".find" do
+    context "when proper adapter class exists" do
+      before do
+        Chatroid::Adapter.stub(:const_get).and_return(adapter_class)
+      end
+
+      let(:adapter_class) do
+        Class.new
+      end
+
+      it "should return it" do
+        Chatroid::Adapter.find("AdapterClassName").should == adapter_class
+      end
+    end
+
+    context "when proper adapter class does not exist" do
+      it do
+        Chatroid::Adapter.find("AdapterClassName").should == nil
+      end
+    end
+  end
+end

data/spec/chatroid/callback_spec.rb

@@ -0,0 +1,59 @@
+require "spec_helper"
+
+describe Chatroid::Callback do
+  let(:instance) do
+    mod = described_class
+    Class.new { include mod }.new
+  end
+
+  describe "#on_xxx" do
+    it "should store given block as callback" do
+      callback = proc {}
+      instance.on_xxx(&callback)
+      instance.list_xxx.should == [callback]
+    end
+  end
+
+  describe "#list_xxx" do
+    context "before #on_xxx is called" do
+      it do
+        instance.list_xxx.should have(0).callback
+      end
+    end
+
+    context "after #on_yyy is called" do
+      before do
+        instance.on_yyy {}
+      end
+
+      it do
+        instance.list_xxx.should have(0).callback
+      end
+    end
+
+    context "after #on_xxx is called" do
+      before do
+        instance.on_xxx {}
+      end
+
+      it do
+        instance.list_xxx.should have(1).callback
+      end
+    end
+  end
+
+  describe "#trigger_xxx" do
+    it "should trigger all callbacks for xxx" do
+      callback = proc {}
+      callback.should_receive(:call)
+      instance.on_xxx(&callback)
+      instance.trigger_xxx
+    end
+
+    it "should trigger callbacks with given args" do
+      args = mock
+      instance.on_xxx { |block_args| block_args.should == args }
+      instance.trigger_xxx(args)
+    end
+  end
+end

data/spec/chatroid_spec.rb

@@ -0,0 +1,64 @@
+require "spec_helper"
+
+describe Chatroid do
+  describe "#set" do
+    context "when given a hash" do
+      it "should set it to config" do
+        Chatroid.new { set :key => "val" }.config.should == { :key => "val" }
+      end
+    end
+
+    context "when given two args" do
+      it "should set it to config as key-value config" do
+        Chatroid.new { set :key, "val" }.config.should == { :key => "val" }
+      end
+    end
+
+    context "when given args more than two args" do
+      it do
+        expect do
+          Chatroid.new { set 1, 2, 3 }
+        end.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe "#run!" do
+    context "when service to connect is not specified" do
+      it do
+        expect do
+          Chatroid.new.run!
+        end.to raise_error(Chatroid::ConnectionError)
+      end
+    end
+
+    context "when specified service is not supported" do
+      it do
+        expect do
+          Chatroid.new { set :service, "NotSupportedService" }.run!
+        end.to raise_error(Chatroid::ConnectionError)
+      end
+    end
+
+    context "when specified service is supported" do
+      let(:adapter) do
+        Class.new do
+          def initialize(chatroid)
+          end
+
+          def connect
+          end
+        end.new(mock)
+      end
+
+      it "should find adapter and call #connect of it" do
+        chatroid = Chatroid.new
+        chatroid.stub(:has_service?).and_return(true)
+        chatroid.stub(:has_adapter?).and_return(true)
+        chatroid.stub(:adapter).and_return(adapter)
+        adapter.should_receive(:connect)
+        chatroid.run!
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "chatroid"

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: chatroid
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ryo NAKAMURA
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: twitter-stream
+  requirement: &70137995987880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70137995987880
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70137995987160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70137995987160
+description: Chatroid is a gem for quickly creating chatterbot in Ruby
+email:
+- r7kamura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- chatroid.gemspec
+- lib/chatroid.rb
+- lib/chatroid/adapter.rb
+- lib/chatroid/adapter/twitter.rb
+- lib/chatroid/callback.rb
+- lib/chatroid/version.rb
+- spec/chatroid/adapter/twitter_spec.rb
+- spec/chatroid/adapter_spec.rb
+- spec/chatroid/callback_spec.rb
+- spec/chatroid_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/r7kamura/chatroid
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Chatterbot builder
+test_files:
+- spec/chatroid/adapter/twitter_spec.rb
+- spec/chatroid/adapter_spec.rb
+- spec/chatroid/callback_spec.rb
+- spec/chatroid_spec.rb
+- spec/spec_helper.rb
+has_rdoc: