chatroid 0.0.8 → 0.0.9

data/README.md

@@ -7,8 +7,13 @@ Chatroid is a gem for quickly creating chatterbot in Ruby.
 $ gem "chatroid"
 ```
 
+## Supported
+* IRC
+* Twitter
+* HipChat(xmpp)
+
 ## Example
-Let's create your own bot working in a chat service, and let bot do it!
+For more examples, please see [examples](https://github.com/r7kamura/chatroid/tree/master/examples).
 
 ```ruby
 require "chatroid"
@@ -21,53 +26,56 @@ Chatroid.new do
   set :access_secret,   "..."
 
   on_tweet do |event|
-    if event["text"] =~ /yunotti/
+    if event["text"] =~ /chatroid/
       favorite event
-      follow event
     end
   end
 
   on_reply do |event|
-    reply "✘╹◡╹✘", event
+    reply "Hi, i am a chatroid", event
+  end
+
+  on_time :hour => 12, :min => 0 do
+    tweet "Hello, world!"
   end
 end.run!
 ```
 
-```ruby
-require "chatroid"
+## Deploy to Heroku
 
-Chatroid.new do
-  set :service,  "HipChat"
-  set :room,     "12345_example@conf.hipchat.com"
-  set :jid,      "12345_67890@chat.hipchat.com"
-  set :nick,     "example"
-  set :password, "..."
-
-  on_message do |time, nick, text|
-    if nick != config[:nick]
-      say "Hi, #{nick}"
-    end
-  end
-end.run!
 ```
+$ gem install heroku
+$ heroku login
+
+$ mkdir bot
+$ cd !$
+$ echo "bot: bundle exec ruby bot.rb" >> Procfile
+$ echo "source :rubygems" >> Gemfile
+$ echo "gem 'chatroid'"   >> Gemfile
+$ bundle install
+$ vim bot.rb
 
-```ruby
 require "chatroid"
 
 Chatroid.new do
-  set :service,  "Irc"
-  set :server,   "example.com"
-  set :port,     "6667"
-  set :channel,  "#chatroid"
-  set :username, "chatroid"
-
-  on_privmsg do |message|
-    privmsg "#chatroid", ":" + "hi, i am a chatroid"
+  set :service,         "Twitter"
+  set :filter,          "chatroid,Chatroid"
+  set :consumer_key,    ENV["CONSUMER_KEY"]
+  set :consumer_secret, ENV["CONSUMER_SECRET"]
+  set :access_key,      ENV["ACCESS_KEY"]
+  set :access_secret,   ENV["ACCESS_SECRET"]
+
+  on_tweet do |event|
+    favorite event
+  end
+
+  on_reply do |event|
+    favorite event
   end
 end.run!
-```
 
-## Adapters
-* Twitter
-* HipChat
-* IRC
+$ heroku create your_favorite_bot_name --stack cedar
+$ heroku config:add CONSUMER_KEY=... CONSUMER_SECRET=... ACCESS_KEY=... ACCESS_SECRET=...
+$ git push heroku master
+$ heroku ps:scale bot=1
+```

data/examples/hip_chat.rb

@@ -0,0 +1,13 @@
+require "chatroid"
+
+Chatroid.new do
+  set :service,  "HipChat"
+  set :room,     "12345_example@conf.hipchat.com"
+  set :jid,      "12345_67890@chat.hipchat.com"
+  set :nick,     "example"
+  set :password, "..."
+
+  on_message do |time, nick, text|
+    say "Hi, #{nick}" if nick != config[:nick]
+  end
+end.run!

data/examples/irc.rb

@@ -0,0 +1,13 @@
+require "chatroid"
+
+Chatroid.new do
+  set :service,  "Irc"
+  set :server,   "example.com"
+  set :port,     "6667"
+  set :channel,  "#chatroid"
+  set :username, "chatroid"
+
+  on_privmsg do |message|
+    privmsg "#chatroid", ":" + "Hi, i am a chatroid"
+  end
+end.run!

data/examples/twitter_public_stream.rb

@@ -0,0 +1,18 @@
+require "chatroid"
+
+Chatroid.new do
+  set :service,         "Twitter"
+  set :filter,          "chatroid,Chatroid"
+  set :consumer_key,    "..."
+  set :consumer_secret, "..."
+  set :access_key,      "..."
+  set :access_secret,   "..."
+
+  on_tweet do |event|
+    favorite event
+  end
+
+  on_reply do |event|
+    favorite event
+  end
+end.run!

data/examples/twitter_timer.rb

@@ -0,0 +1,21 @@
+require "chatroid"
+
+Chatroid.new do
+  set :service,         "Twitter"
+  set :consumer_key,    "..."
+  set :consumer_secret, "..."
+  set :access_key,      "..."
+  set :access_secret,   "..."
+
+  on_timer :hour => 6 do
+    tweet "Good morning!"
+  end
+
+  on_timer :hour => 0 do
+    tweet "Good night!"
+  end
+
+  on_timer :day => [10, 20, 30] do
+    tweet "@chatroid How are you?"
+  end
+end.run!

data/examples/twitter_user_stream.rb

@@ -0,0 +1,20 @@
+require "chatroid"
+
+Chatroid.new do
+  set :service,         "Twitter"
+  set :consumer_key,    "..."
+  set :consumer_secret, "..."
+  set :access_key,      "..."
+  set :access_secret,   "..."
+
+  on_tweet do |event|
+    if event["text"] =~ /chatroid/
+      favorite event
+      follow event
+    end
+  end
+
+  on_reply do |event|
+    reply "Hi, i am a chatroid", event
+  end
+end.run!

data/lib/chatroid/adapter/twitter.rb

@@ -10,7 +10,7 @@ class Chatroid
       private
 
       def connect
-        EventMachine::run do
+        EventMachine.run do
           stream.on_error &method(:on_error)
           stream.each_item &method(:on_each_item)
         end

data/lib/chatroid/timer/event.rb

@@ -0,0 +1,54 @@
+class Chatroid
+  module Timer
+    class Event
+      # `every` is a Hash object which may have following keys:
+      # :sec
+      # :min
+      # :hour
+      #
+      # `block` will be executed at times specified by `every`
+      #
+      # Example: "Hello, world!" will be printed at 14:00 and 14:30 every day
+      # event = Event.new(:hour => 14, :min => [0, 30], :sec => 0) do
+      #   foo
+      # end
+      #
+      # loop do
+      #   event.call
+      #   sleep 1
+      # end
+
+      UNITS = [
+        :sec,
+        :min,
+        :hour,
+        :day,
+        :wday,
+        :month,
+      ].freeze
+
+      def initialize(every, &block)
+        @every = every
+        @block = block
+      end
+
+      def call
+        @block.call if available?
+      end
+
+      private
+
+      def available?
+        now = Time.now
+        UNITS.all? do |unit|
+          if @every[unit]
+            conditions = Array(@every[unit])
+            conditions.any? { |condition| condition == now.send(unit) }
+          else
+            true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chatroid/timer.rb

@@ -0,0 +1,24 @@
+require "chatroid/timer/event"
+
+class Chatroid
+  module Timer
+    def on_time(every, &block)
+      events << Event.new(every, &block)
+    end
+
+    private
+
+    def start_timer
+      Thread.new do
+        loop do
+          events.each(&:call)
+          sleep 1
+        end
+      end
+    end
+
+    def events
+      @events ||= []
+    end
+  end
+end

data/lib/chatroid/version.rb

@@ -1,3 +1,3 @@
 class Chatroid
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/lib/chatroid.rb

@@ -1,9 +1,11 @@
 require "chatroid/version"
 require "chatroid/callback"
+require "chatroid/timer"
 require "chatroid/adapter"
 
 class Chatroid
   include Callback
+  include Timer
 
   def initialize(&block)
     instance_eval(&block) if block_given?
@@ -14,8 +16,10 @@ class Chatroid
   end
 
   def run!
+    Thread.abort_on_exception = true
     validate_connection
     extend(adapter)
+    start_timer unless events.empty?
     connect
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chatroid
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-23 00:00:00.000000000 Z
+date: 2012-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twitter-stream
-  requirement: &70286360703520 !ruby/object:Gem::Requirement
+  requirement: &70332858617320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70286360703520
+  version_requirements: *70332858617320
 - !ruby/object:Gem::Dependency
   name: twitter_oauth
-  requirement: &70286360563500 !ruby/object:Gem::Requirement
+  requirement: &70332858613600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70286360563500
+  version_requirements: *70332858613600
 - !ruby/object:Gem::Dependency
   name: xmpp4r
-  requirement: &70286360422800 !ruby/object:Gem::Requirement
+  requirement: &70332858611960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70286360422800
+  version_requirements: *70332858611960
 - !ruby/object:Gem::Dependency
   name: avalon
-  requirement: &70286360194160 !ruby/object:Gem::Requirement
+  requirement: &70332858625340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70286360194160
+  version_requirements: *70332858625340
 - !ruby/object:Gem::Dependency
   name: zircon
-  requirement: &70286360181340 !ruby/object:Gem::Requirement
+  requirement: &70332858622360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70286360181340
+  version_requirements: *70332858622360
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70286360184420 !ruby/object:Gem::Requirement
+  requirement: &70332858635180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70286360184420
+  version_requirements: *70332858635180
 description: Chatroid is a gem for quickly creating chatterbot in Ruby
 email:
 - r7kamura@gmail.com
@@ -90,6 +90,11 @@ files:
 - README.md
 - Rakefile
 - chatroid.gemspec
+- examples/hip_chat.rb
+- examples/irc.rb
+- examples/twitter_public_stream.rb
+- examples/twitter_timer.rb
+- examples/twitter_user_stream.rb
 - lib/chatroid.rb
 - lib/chatroid/adapter.rb
 - lib/chatroid/adapter/hip_chat.rb
@@ -97,6 +102,8 @@ files:
 - lib/chatroid/adapter/twitter.rb
 - lib/chatroid/adapter/twitter/event.rb
 - lib/chatroid/callback.rb
+- lib/chatroid/timer.rb
+- lib/chatroid/timer/event.rb
 - lib/chatroid/version.rb
 - spec/chatroid/adapter/hip_chat_spec.rb
 - spec/chatroid/adapter/irc_spec.rb