chatroid 0.0.3 → 0.0.4

data/README.md

@@ -10,7 +10,7 @@ $ gem "chatroid"
 ## Example
 You can create your own bot working in a chat service.
 The following example creates a bot,
-which responds to tweets which include the word "yunotti" or any replies to it.
+which responds to tweets including the word "yunotti" or any replies to it.
 
 ```ruby
 require "chatroid"

data/chatroid.gemspec

@@ -17,5 +17,6 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "twitter-stream"
   gem.add_dependency "twitter_oauth"
+  gem.add_dependency "avalon"
   gem.add_development_dependency "rspec"
 end

data/lib/chatroid/adapter/hip_chat.rb

@@ -0,0 +1,131 @@
+require "avalon"
+require "xmpp4r"
+require "xmpp4r/muc/helper/simplemucclient"
+require "logger"
+
+class Chatroid
+  module Adapter
+    module HipChat
+      REQUIRED_CONFIG_KEYS = [
+        :jid,
+        :room,
+        :nick,
+        :password,
+      ].freeze
+
+      EVENT_NAMES = [
+        :join,
+        :leave,
+        :message,
+        :private_message,
+        :room_message,
+        :self_leave,
+        :subject,
+      ].freeze
+
+      def self.extended(chatroid)
+        REQUIRED_CONFIG_KEYS.each do |key|
+          Avalon.validate(chatroid.config[key], String)
+        end
+      end
+
+      def say(text)
+        room.say(text)
+      end
+
+      def invite(jid, reason = nil)
+        room.invite(jid => reason)
+      end
+
+      def kick(nick, reason = nil)
+        room.kick(nick, reason)
+      end
+
+      def ban(jid, reason = nil)
+        room.ban(jid, reason)
+      end
+
+      def unban(jid)
+        room.unban(jid)
+      end
+
+      def promote(nick)
+        room.prompt(nick)
+      end
+
+      def demote(nick)
+        room.demote(nick)
+      end
+
+      def join(jid, password = nil)
+        room.join(jid, password)
+      end
+
+      def exit(reason = nil)
+        room.exit(reason)
+      end
+
+      def subject=(text)
+        room.subject = text
+      end
+
+      def subject
+        room.subject
+      end
+
+      def nick
+        room.nick
+      end
+
+      private
+
+      def connect
+        use_logger
+        bind_callbacks
+        join_room
+        persist
+      end
+
+      def persist
+        trap(:INT) { Kernel.exit }
+        loop { sleep 1 }
+      end
+
+      def client
+        @client ||= begin
+          jabber_client = Jabber::Client.new(config[:jid])
+          jabber_client.connect
+          jabber_client.auth(config[:password])
+          jabber_client
+        end
+      end
+
+      def room
+        @room ||= Jabber::MUC::SimpleMUCClient.new(client)
+      end
+
+      def join_room
+        room.join(room_key)
+      end
+
+      def room_key
+        config[:room] + "/" + config[:nick]
+      end
+
+      def use_logger
+        if config[:logger]
+          Jabber.logger = config[:logger]
+          Jabber.debug  = true
+        end
+      end
+
+      def bind_callbacks
+        EVENT_NAMES.each do |name|
+          room.__send__("on_#{name}") do |*args|
+            __send__("trigger_#{name}", *args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chatroid/adapter/twitter/event.rb

@@ -0,0 +1,55 @@
+require "json"
+
+class Chatroid
+  module Adapter
+    module Twitter
+      class Event
+        TYPES = %w[
+          favorite
+          unfavorite
+          follow
+          unfollow
+          list_member_added
+          list_member_removed
+          list_user_subscribed
+          list_user_unsubscribed
+        ].freeze
+
+        attr_reader :params
+
+        def initialize(json, user_id)
+          @params  = JSON.parse(json)
+          @user_id = user_id
+        end
+
+        def type
+          if has_event_type? && targeted_to_me?
+            @params["event"]
+          elsif reply_to_me?
+            "reply"
+          elsif tweet?
+            "tweet"
+          end
+        end
+
+        private
+
+        def targeted_to_me?
+          @params["target"] && @params["target"]["id"] == @user_id
+        end
+
+        def has_event_type?
+          @params["event"] && TYPES.include?(@params["event"])
+        end
+
+        def reply_to_me?
+          @params["in_reply_to_user_id"] && @params["in_reply_to_user_id"] == @user_id
+        end
+
+        def tweet?
+          @params["text"]
+        end
+      end
+    end
+  end
+end

data/lib/chatroid/adapter/twitter.rb

@@ -1,3 +1,4 @@
+require "chatroid/adapter/twitter/event"
 require "twitter/json_stream"
 require "twitter_oauth"
 require "json"
@@ -9,10 +10,7 @@ class Chatroid
 
       def connect
         EventMachine::run do
-          stream.each_item do |json|
-            event = JSON.parse(json)
-            on_each_event(event)
-          end
+          stream.each_item &method(:on_each_item)
         end
       end
 
@@ -63,13 +61,9 @@ class Chatroid
         @user_info ||= client.info
       end
 
-      def on_each_event(event)
-        case
-        when event["in_reply_to_user_id"] == user_info["id"]
-          trigger_reply(event)
-        when event["text"]
-          trigger_tweet(event)
-        end
+      def on_each_item(json)
+        event = Event.new(json, user_info["id"])
+        send("trigger_#{event.type}", event.params)
       end
     end
   end

data/lib/chatroid/adapter.rb

@@ -1,4 +1,5 @@
 require "chatroid/adapter/twitter"
+require "chatroid/adapter/hip_chat"
 
 class Chatroid
   module Adapter

data/lib/chatroid/version.rb

@@ -1,3 +1,3 @@
 class Chatroid
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/chatroid/adapter/hip_chat_spec.rb

@@ -0,0 +1,66 @@
+require "spec_helper"
+
+describe Chatroid::Adapter::HipChat do
+  let(:chatroid) do
+    Chatroid.new do
+      set :service, "HipChat"
+      set :jid, "jid"
+      set :room, "room@example.com"
+      set :nick, "nick"
+      set :password, "password"
+    end
+  end
+
+  describe ".extended" do
+    context "when chatroid has jid" do
+      it do
+        expect do
+          chatroid.extend(Chatroid::Adapter::HipChat)
+        end.to_not raise_error(Avalon::ValidationError)
+      end
+    end
+
+    context "when chatroid has no jid" do
+      before do
+        chatroid.config.delete(:jid)
+      end
+
+      it do
+        expect do
+          chatroid.extend(Chatroid::Adapter::HipChat)
+        end.to raise_error(Avalon::ValidationError)
+      end
+    end
+  end
+
+  describe "#connect" do
+    before do
+      Jabber::Client.stub(:new).and_return(client)
+      Jabber::MUC::SimpleMUCClient.stub(:new).and_return(room)
+      chatroid.stub(:persist)
+    end
+
+    let(:client) do
+      mock.as_null_object
+    end
+
+    let(:room) do
+      mock.as_null_object
+    end
+
+    it "should call Jabber::Client#connect" do
+      client.should_receive(:connect)
+      chatroid.run!
+    end
+
+    it "should call Jabber::Client#auth" do
+      client.should_receive(:auth)
+      chatroid.run!
+    end
+
+    it "should call Jabber::MUC::SimpleMUCClient#join" do
+      room.should_receive(:join)
+      chatroid.run!
+    end
+  end
+end

data/spec/chatroid/adapter/twitter/event_spec.rb

@@ -0,0 +1,97 @@
+require "spec_helper"
+
+describe Chatroid::Adapter::Twitter::Event do
+  describe "#type" do
+    subject do
+      Chatroid::Adapter::Twitter::Event.new(args.to_json, user_id).type
+    end
+
+    let(:args) do
+      {}
+    end
+
+    let(:user_id) do
+      1
+    end
+
+    context "when favorited" do
+      let(:args) do
+        { "event" => "favorite", "target" => { "id" => user_id } }
+      end
+
+      it do
+        should == "favorite"
+      end
+    end
+
+    context "when unfavorited" do
+      let(:args) do
+        { "event" => "unfavorite", "target" => { "id" => user_id } }
+      end
+
+      it do
+        should == "unfavorite"
+      end
+    end
+
+    context "when user's list is subscribed" do
+      let(:args) do
+        { "event" => "list_user_subscribed", "target" => { "id" => user_id } }
+      end
+
+      it do
+        should == "list_user_subscribed"
+      end
+    end
+
+    context "when user's list is unsubscribed" do
+      let(:args) do
+        { "event" => "list_user_unsubscribed", "target" => { "id" => user_id } }
+      end
+
+      it do
+        should == "list_user_unsubscribed"
+      end
+    end
+
+    context "when user is added to list" do
+      let(:args) do
+        { "event" => "list_member_added", "target" => { "id" => user_id } }
+      end
+
+      it do
+        should == "list_member_added"
+      end
+    end
+
+    context "when user is removed from list" do
+      let(:args) do
+        { "event" => "list_member_removed", "target" => { "id" => user_id } }
+      end
+
+      it do
+        should == "list_member_removed"
+      end
+    end
+
+    context "when replied" do
+      let(:args) do
+        { "in_reply_to_user_id" => user_id }
+      end
+
+      it do
+        should == "reply"
+      end
+    end
+
+    context "when tweeted" do
+      let(:args) do
+        { "text" => "foo" }
+      end
+
+      it do
+        should == "tweet"
+      end
+    end
+  end
+end

data/spec/chatroid_spec.rb

@@ -41,23 +41,12 @@ describe Chatroid do
     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
+      it "should find adapter and call #connect extended from it" do
+        adapter = mock
         chatroid = Chatroid.new
-        chatroid.stub(:has_service?).and_return(true)
-        chatroid.stub(:has_adapter?).and_return(true)
-        chatroid.stub(:adapter_class)
-        chatroid.stub(:extend)
+        chatroid.stub(:validate_connection)
         chatroid.stub(:adapter).and_return(adapter)
+        chatroid.should_receive(:extend).with(adapter)
         chatroid.should_receive(:connect)
         chatroid.run!
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chatroid
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-16 00:00:00.000000000 Z
+date: 2012-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twitter-stream
-  requirement: &70196510426520 !ruby/object:Gem::Requirement
+  requirement: &70201732417940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70196510426520
+  version_requirements: *70201732417940
 - !ruby/object:Gem::Dependency
   name: twitter_oauth
-  requirement: &70196510425840 !ruby/object:Gem::Requirement
+  requirement: &70201732417360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70196510425840
+  version_requirements: *70201732417360
+- !ruby/object:Gem::Dependency
+  name: avalon
+  requirement: &70201732416700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70201732416700
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70196510425060 !ruby/object:Gem::Requirement
+  requirement: &70201732416060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70196510425060
+  version_requirements: *70201732416060
 description: Chatroid is a gem for quickly creating chatterbot in Ruby
 email:
 - r7kamura@gmail.com
@@ -59,9 +70,13 @@ files:
 - chatroid.gemspec
 - lib/chatroid.rb
 - lib/chatroid/adapter.rb
+- lib/chatroid/adapter/hip_chat.rb
 - lib/chatroid/adapter/twitter.rb
+- lib/chatroid/adapter/twitter/event.rb
 - lib/chatroid/callback.rb
 - lib/chatroid/version.rb
+- spec/chatroid/adapter/hip_chat_spec.rb
+- spec/chatroid/adapter/twitter/event_spec.rb
 - spec/chatroid/adapter/twitter_spec.rb
 - spec/chatroid/adapter_spec.rb
 - spec/chatroid/callback_spec.rb
@@ -92,6 +107,8 @@ signing_key:
 specification_version: 3
 summary: Chatterbot builder
 test_files:
+- spec/chatroid/adapter/hip_chat_spec.rb
+- spec/chatroid/adapter/twitter/event_spec.rb
 - spec/chatroid/adapter/twitter_spec.rb
 - spec/chatroid/adapter_spec.rb
 - spec/chatroid/callback_spec.rb