chatterbot 0.4.0 → 0.5.0

data/Gemfile

@@ -12,7 +12,6 @@ group :development do
   gem "shoulda", ">= 0"
   gem "rspec"
 
-  gem "bundler", "~> 1.0.0"
   gem "watchr"
 end
 

data/README.markdown

@@ -36,7 +36,7 @@ Write your bot
 --------------
 
 Chatterbot has a very simple DSL inspired by Sinatra and Twibot, an
-earlier Twitter bot framework.  Here's an example, based on 
+earlier Twitter bot framework.  Here's an example, based on
 [@dr_rumack](http://twitter.com/#!/Dr_Rumack), an actual bot running
 on Twitter:
 
@@ -60,7 +60,7 @@ Authorization
 If you only want to use Chatterbot to search for tweets, it will work
 out of the box without any authorization.  However, if you want to
 reply to tweets, or check for replies to your bot, you will have to
-jump through a few authorization hoops with Twitter. 
+jump through a few authorization hoops with Twitter.
 
 Before you setup a bot for the first time, you will need to register an
 application with Twitter.  Twitter requires all API communication to be via an
@@ -78,11 +78,9 @@ the instructions if you want to do it yourself:
 
 1. [Setup your own app](https://twitter.com/apps/new) on Twitter.
 
-2. Choose 'Client' as the app type.
+2. Put in whatever name, description, and website you want.
 
-3. Choose 'Read & Write' access unless you don't need to send tweets.
-
-4. Take the consumer key/consumer secret values, and either run your bot, and enter them 
+3. Take the consumer key/consumer secret values, and either run your bot, and enter them
 in when prompted, or store them in a config file for your bot. (See
 below for details on this).  It should look like this:
 
@@ -141,13 +139,40 @@ Run it via cron.  Here's an example of running a bot every two minutes
 
 Run it as a background process.  Just put the guts of your bot in a loop like this:
 
-    loop do
-      replies do |tweet|
-        # do stuff
-      end
+```rb
+loop do
+  search "twitter" do |tweet|
+    # here you could do something with a tweet
+    # if you want to retweet
+    retweet(tweet[:id])
+  end
+
+  replies do |tweet|
+    # do stuff
+  end
+
+  # explicitly update our config
+  update_config
+
+  sleep 60
+end
+```
+
+**NOTE:** You need to call `update_config` to update the last tweet your script
+has processed -- if you don't have this call, you will get duplicate
+tweets.
+
+Retweet
+-------
+
+Chatterbot can retweet the tweets found based upon the search:
+
+```rb
+  search "xyzzy" do |tweet|
+    retweet(tweet[:id])
+  end
+```
 
-      sleep 60
-    end
 
 Database logging
 ----------------

data/chatterbot.gemspec

@@ -28,7 +28,6 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
       s.add_development_dependency(%q<rdoc>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<simplecov>, [">= 0"])
       s.add_development_dependency(%q<watchr>, [">= 0"])
     else
@@ -36,7 +35,6 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 0"])
       s.add_dependency(%q<rdoc>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<simplecov>, [">= 0"])
       s.add_dependency(%q<watchr>, [">= 0"])
     end
@@ -44,8 +42,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<twitter_oauth>, [">= 0"])
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 0"])
-	s.add_dependency(%q<rdoc>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+	  s.add_dependency(%q<rdoc>, [">= 0"])
     s.add_dependency(%q<rcov>, [">= 0"])
     s.add_dependency(%q<watchr>, [">= 0"])
   end

data/examples/tweet_logger.rb

@@ -0,0 +1,68 @@
+#!/usr/bin/env ruby
+
+require 'chatterbot/dsl'
+
+##
+#
+# Simple example of a bot that will log tweets to the
+# database. Chatterbot will only log outgoing tweets by default, and
+# coding incoming tweet processing seems problematic right now, but
+# this is pretty straightforward
+#
+
+#
+# Set some date defaults for Sequel
+#
+Sequel.datetime_class = DateTime
+Sequel.default_timezone = :utc
+
+#
+# grab a copy of the db handle
+#
+db = bot.db
+
+#
+# create a table to hold search results
+#
+if ! db.tables.include?(:searches)
+
+  #
+  # if there's other data you want to track, you can add it here
+  #
+  db.create_table :searches do
+    primary_key :id, :type=>Bignum
+
+    String :text
+    String :from_user
+    String :from_user_id
+
+    String :to_user
+    String :to_user_id
+
+    String :in_reply_to_status_id
+
+    DateTime :created_at
+  end
+end
+
+cols = db[:searches].columns
+
+#
+# run a search
+#
+search("foo", :lang => "en") do |tweet|
+
+  #
+  # reject anything from the incoming tweet that doesn't have a
+  # matching column
+  #
+  data = tweet.delete_if { |k, v|
+    ! cols.include?(k)
+  }
+
+  # update timestamp manually -- sequel isn't doing it right
+  data[:created_at] ||= Sequel.string_to_datetime(data[:created_at])
+
+  # store to the db!
+  db[:searches].insert(data)
+end

data/lib/chatterbot.rb

@@ -37,6 +37,7 @@ module Chatterbot
     require "chatterbot/client"
     require "chatterbot/search"
     require "chatterbot/tweet"
+    require "chatterbot/retweet"
     require "chatterbot/reply"
     require "chatterbot/helpers"    
 

data/lib/chatterbot/bot.rb

@@ -8,6 +8,7 @@ module Chatterbot
     include Logging
     include Search
     include Tweet
+    include Retweet
     include Reply
     include Client
     include DB

data/lib/chatterbot/client.rb

@@ -70,10 +70,7 @@ module Chatterbot
       puts "Hey, looks like you need to get an API key from Twitter before you can get started."
       puts "Please go to this URL: https://twitter.com/apps/new"
 
-      puts "\nChoose 'Client' as the app type."
-      puts "Choose 'Read & Write' access."
-
-      print "\n\n\nPaste the 'Consumer Key' here: "
+      print "\n\nPaste the 'Consumer Key' here: "
       STDOUT.flush
       config[:consumer_key] = STDIN.readline.chomp
 

data/lib/chatterbot/dsl.rb

@@ -11,19 +11,19 @@ module Chatterbot
     # otherwise create a bot and return that
     def bot
       return @bot unless @bot.nil?
-      
+
       #
       # parse any command-line options and use them to initialize the bot
       #
       params = {}
-      
+
       opts = OptionParser.new
 
       opts.banner = "Usage: #{File.basename($0)} [options]"
 
       opts.separator ""
-      opts.separator "Specific options:" 
-      
+      opts.separator "Specific options:"
+
       opts.on('-d', '--db [ARG]', "Specify a DB connection URI")    { |d| ENV["chatterbot_db"] = d }
       opts.on('-c', '--config [ARG]', "Specify a config file to use")    { |c| ENV["chatterbot_config"] = c }
       opts.on('-t', '--test', "Run the bot without actually sending any tweets") { params[:debug_mode] = true }
@@ -34,8 +34,8 @@ module Chatterbot
       opts.on_tail("-h", "--help", "Show this message") do
         puts opts
         exit
-      end      
-      
+      end
+
       opts.parse!(ARGV)
 
       @bot = Chatterbot::Bot.new(params)
@@ -80,37 +80,37 @@ module Chatterbot
         end
       end.flatten
     end
-    
+
     #
-    # specify a bot-specific blacklist of users.  accepts an array, or a 
+    # specify a bot-specific blacklist of users.  accepts an array, or a
     # comma-delimited string
     def blacklist(*args)
       list = flatten_list_of_strings(args)
-      
+
       if list.nil? || list.empty?
         bot.blacklist = []
-      else     
+      else
         bot.blacklist += list
       end
     end
-    
+
     #
     # specify list of strings we will check when deciding to respond to a tweet or not
     def exclude(*args)
       e = flatten_list_of_strings(args)
       if e.nil? || e.empty?
         bot.exclude = []
-      else     
+      else
         bot.exclude += e
       end
     end
-    
+
     #
     # search twitter for the specified terms
     def search(query, opts = {}, &block)
       bot.search(query, opts, &block)
     end
-    
+
     #
     # handle replies to the bot
     def replies(&block)
@@ -121,7 +121,13 @@ module Chatterbot
     # send a tweet
     def tweet(txt, params = {}, original = nil)
       bot.tweet(txt, params, original)
-    end   
+    end
+
+    #
+    # retweet
+    def retweet(id)
+      bot.retweet(id)
+    end
 
     #
     # reply to a tweet
@@ -132,10 +138,14 @@ module Chatterbot
     def since_id
       bot.config[:since_id]
     end
-    
+
     def update_config
       bot.update_config
     end
+
+    def db
+      bot.db
+    end
   end
 end
 

data/lib/chatterbot/retweet.rb

@@ -0,0 +1,17 @@
+module Chatterbot
+
+  # routines for retweet
+  module Retweet 
+
+    # simple wrapper for retweeting a message
+    def retweet(id)
+      return if require_login == false
+
+      if debug_mode?
+        debug "I'm in debug mode, otherwise I would retweet with tweet id: #{id}"
+      else
+        client.retweet id
+      end
+    end
+  end
+end

data/lib/chatterbot/version.rb

@@ -1,3 +1,3 @@
 module Chatterbot
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/spec/dsl_spec.rb

@@ -8,7 +8,7 @@ describe "Chatterbot::DSL" do
 
       Chatterbot::DSL.stub!(:bot).and_return(@bot)
     end
-    
+
     describe "blacklist" do
       it "#blacklist passes along to bot object" do
         @bot.should_receive(:blacklist=).with(["foo"])
@@ -39,12 +39,12 @@ describe "Chatterbot::DSL" do
         end
 
         it "#debug_mode with true is passed" do
-          @bot.should_receive("#{method.to_s}=").with(true)          
+          @bot.should_receive("#{method.to_s}=").with(true)
           send method, true
         end
       end
     end
-    
+
     describe "exclude" do
       it "#exclude passes along to bot object" do
         @bot.should_receive(:exclude=).with(["foo"])
@@ -61,8 +61,8 @@ describe "Chatterbot::DSL" do
         exclude "foo, bar"
       end
     end
-    
-    
+
+
     it "#search passes along to bot object" do
       @bot.should_receive(:search).with("foo", { })
       search("foo")
@@ -72,7 +72,7 @@ describe "Chatterbot::DSL" do
       @bot.should_receive(:search).with(["foo","bar"], { })
       search(["foo","bar"])
     end
-    
+
     it "#replies passes along to bot object" do
       @bot.should_receive(:replies)
       replies
@@ -86,7 +86,7 @@ describe "Chatterbot::DSL" do
     it "#reply passes along to bot object" do
       @bot.should_receive(:reply).with("hello sailor!", { :source => "source "})
       reply "hello sailor!", { :source => "source "}
-    end    
+    end
 
     describe "update_config" do
       it "should pass to bot object" do
@@ -102,5 +102,14 @@ describe "Chatterbot::DSL" do
       end
     end
 
+    describe "db" do
+      it "should pass to bot object" do
+        bot_db = mock(Object)
+        @bot.should_receive(:db).and_return(bot_db)
+
+        db.should eql(bot_db)
+      end
+    end
+
   end
 end

data/spec/retweet_spec.rb

@@ -0,0 +1,27 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Chatterbot::Retweet" do
+  describe "#retweet" do
+    before(:each) do
+      @bot = test_bot
+    end
+
+    it "calls require_login when tweeting" do
+      @bot.should_receive(:require_login).and_return(false)
+      @bot.retweet "tweet test!"
+    end
+
+    it "calls client.retweet with the right values" do
+      bot = test_bot
+
+      bot.should_receive(:require_login).and_return(true)
+      bot.stub!(:client).and_return(mock(TwitterOAuth::Client))
+
+      bot.stub!(:debug_mode?).and_return(false)
+
+      tweet_id = 12345
+      bot.client.should_receive(:retweet).with(tweet_id)
+      bot.retweet(tweet_id)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chatterbot
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-09 00:00:00.000000000Z
+date: 2011-12-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twitter_oauth
-  requirement: &24000540 !ruby/object:Gem::Requirement
+  requirement: &17236180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *24000540
+  version_requirements: *17236180
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &24000040 !ruby/object:Gem::Requirement
+  requirement: &17235680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *24000040
+  version_requirements: *17235680
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &23999560 !ruby/object:Gem::Requirement
+  requirement: &17235200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *23999560
+  version_requirements: *17235200
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &24048660 !ruby/object:Gem::Requirement
+  requirement: &17234720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,21 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *24048660
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: &24048180 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
-  prerelease: false
-  version_requirements: *24048180
+  version_requirements: *17234720
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &24047700 !ruby/object:Gem::Requirement
+  requirement: &17234240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *24047700
+  version_requirements: *17234240
 - !ruby/object:Gem::Dependency
   name: watchr
-  requirement: &24047220 !ruby/object:Gem::Requirement
+  requirement: &17259500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *24047220
+  version_requirements: *17259500
 description: A framework for writing bots that run on Twitter. Comes with a simple
   DSL for easy coding.
 email: colin@muffinlabs.com
@@ -113,6 +102,7 @@ files:
 - examples/dsl_test.rb
 - examples/echoes_bot.rb
 - examples/loop_bot.rb
+- examples/tweet_logger.rb
 - lib/chatterbot.rb
 - lib/chatterbot/blacklist.rb
 - lib/chatterbot/bot.rb
@@ -123,6 +113,7 @@ files:
 - lib/chatterbot/helpers.rb
 - lib/chatterbot/logging.rb
 - lib/chatterbot/reply.rb
+- lib/chatterbot/retweet.rb
 - lib/chatterbot/search.rb
 - lib/chatterbot/tweet.rb
 - lib/chatterbot/version.rb
@@ -135,6 +126,7 @@ files:
 - spec/helpers_spec.rb
 - spec/logging_spec.rb
 - spec/reply_spec.rb
+- spec/retweet_spec.rb
 - spec/search_spec.rb
 - spec/spec_helper.rb
 - spec/tweet_spec.rb