chatterbot 0.5.1 → 0.6.1

data/lib/chatterbot/config.rb

@@ -41,6 +41,13 @@ module Chatterbot
     def no_update=(d)
       config[:no_update] = d
     end
+
+    #
+    # should we reset the since_id for this bot?
+    # 
+    def reset_bot?
+      config[:reset_since_id] || false
+    end
     
     #
     # are we in debug mode?
@@ -105,19 +112,24 @@ module Chatterbot
     # update the since_id with either the highest ID of the specified
     # tweets, unless it is lower than what we have already
     def update_since_id(search)
-      unless search.nil?
-        tmp_id = case
-                   # incoming tweets
-                 when search.has_key?(:id) then search[:id]
-                   
-                   # incoming searches
-                 when search.has_key?("max_id") then search["max_id"]
-
-                   # other?
-                 else 1
-                 end.to_i
-        config[:tmp_since_id] = [config[:tmp_since_id].to_i, tmp_id].max        
-      end
+      return if search.nil?
+      
+      tmp_id = case
+                 # Twitter::SearchResults
+               when search.respond_to?(:max_id) then search.max_id
+
+                 # incoming tweets
+               when search.respond_to?(:id) then search.id
+
+                 # an enumeration
+               when search.respond_to?(:max) then search.max { |a, b| a.id <=> b.id }.id
+                 
+                 # probably an actual tweet ID at this point,
+                 # otherwise it will fail and return 0
+               else search
+               end.to_i
+
+      config[:tmp_since_id] = [config[:tmp_since_id].to_i, tmp_id].max        
     end
 
     #

data/lib/chatterbot/dsl.rb

@@ -6,6 +6,60 @@ module Chatterbot
   # very basic DSL to handle the common stuff you would want to do with a bot.
   module DSL
 
+    #
+    # search twitter for the specified terms, then pass any matches to
+    # the block.
+    # @example
+    #   search("chatterbot is cool!") do |tweet|
+    #     puts tweet[:text] # this is the actual tweeted text
+    #     reply "I agree!", tweet
+    #   end
+    def search(query, opts = {}, &block)
+      bot.search(query, opts, &block)
+    end
+
+    #
+    # handle replies to the bot. Each time this is called, chatterbot
+    # will pass any replies since the last call to the specified block
+    #
+    # @example
+    #   replies do |tweet|
+    #     puts tweet[:text] # this is the actual tweeted text
+    #     reply "Thanks for the mention!", tweet
+    #   end
+    def replies(&block)
+      bot.replies(&block)
+    end
+
+    #
+    # send a tweet
+    #
+    # @param [String] txt the text you want to tweet
+    # @param [Hash] params opts for the tweet
+    #   @see http://rdoc.info/gems/twitter/Twitter/API#update-instance_method
+    # @param [Tweet] original if this is a reply, the original tweet. this will
+    #   be used for variable substitution, and for logging
+    def tweet(txt, params = {}, original = nil)
+      bot.tweet(txt, params, original)
+    end
+
+    #
+    # retweet a tweet
+    # @param [id] id the ID of the tweet
+    def retweet(id)
+      bot.retweet(id)
+    end
+
+    #
+    # reply to a tweet
+    #
+    # @param [String] txt the text you want to tweet
+    # @param [Tweet] source the original tweet you are replying to
+    def reply(txt, source)
+      bot.reply(txt, source)
+    end
+
+    
     #
     # generate a Bot object. if the DSL is being called from a Bot object, just return it
     # otherwise create a bot and return that
@@ -30,6 +84,10 @@ module Chatterbot
       opts.on('-v', '--verbose', "verbose output to stdout")    { params[:verbose] = true }
       opts.on('--dry-run', "Run the bot in test mode, and also don't update the database")    { params[:debug_mode] = true ; params[:no_update] = true }
       opts.on('-s', '--since_id [ARG]', "Check for tweets since tweet id #[ARG]")    { |s| params[:since_id] = s.to_i }
+      opts.on('-r', '--reset', "Reset your bot to ignore old tweets") {
+        params[:debug_mode] = true
+        params[:reset_since_id] = true
+      }
 
       opts.on_tail("-h", "--help", "Show this message") do
         puts opts
@@ -43,6 +101,7 @@ module Chatterbot
 
     #
     # should we send tweets?
+    # @param [Boolean] d true/false if we should send tweets
     #
     def debug_mode(d=nil)
       d = true if d.nil?
@@ -51,6 +110,7 @@ module Chatterbot
 
     #
     # should we update the db with a new since_id?
+    # @param [Boolean] d true/false if we should update the database
     #
     def no_update(d=nil)
       d = true if d.nil?
@@ -59,6 +119,7 @@ module Chatterbot
 
     #
     # turn on/off verbose output
+    # @param [Boolean] d true/false use verbose output
     #
     def verbose(d=nil)
       d = true if d.nil?
@@ -66,24 +127,14 @@ module Chatterbot
     end
 
     #
-    # take a variable list of strings and possibly arrays and turn
-    # them into a single flat array of strings
+    # specify a bot-specific blacklist of users.  accepts an array, or a
+    # comma-delimited string. when called, any subsequent calls to
+    # search or replies will filter out these users.
     #
-    def flatten_list_of_strings(args)
-      args.collect do |b|
-        if b.is_a?(String)
-          # string, split on commas and turn into array
-          b.split(",").collect { |s| s.strip }
-        else
-          # presumably an array
-          b
-        end
-      end.flatten
-    end
-
+    # @param [Array, String] args list of usernames
+    # @example
+    #   blacklist "mean_user, private_user"
     #
-    # specify a bot-specific blacklist of users.  accepts an array, or a
-    # comma-delimited string
     def blacklist(*args)
       list = flatten_list_of_strings(args)
 
@@ -95,7 +146,14 @@ module Chatterbot
     end
 
     #
-    # specify list of strings we will check when deciding to respond to a tweet or not
+    # specify list of strings we will check when deciding to respond
+    # to a tweet or not. accepts an array or a comma-delimited string.
+    # when called, any subsequent calls to search or replies will
+    # filter out tweets with these strings
+    #
+    # @param [Array, String] args list of usernames
+    # @example
+    #   exclude "spam, junk, something"
     def exclude(*args)
       e = flatten_list_of_strings(args)
       if e.nil? || e.empty?
@@ -105,47 +163,48 @@ module Chatterbot
       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)
-      bot.replies(&block)
-    end
-
+    # The ID of the most recent tweet processed by the bot
     #
-    # send a tweet
-    def tweet(txt, params = {}, original = nil)
-      bot.tweet(txt, params, original)
-    end
-
-    #
-    # retweet
-    def retweet(id)
-      bot.retweet(id)
-    end
-
-    #
-    # reply to a tweet
-    def reply(txt, source)
-      bot.reply(txt, source)
-    end
-
     def since_id
       bot.config[:since_id]
     end
 
+    #
+    # explicitly save the configuration/state of the bot.
+    #
     def update_config
       bot.update_config
     end
 
+    #
+    # return the bot's current database connection, if available.
+    # handy if you need to manage data with your bot
+    #
     def db
       bot.db
     end
+
+    
+    protected
+    
+    #
+    # take a variable list of strings and possibly arrays and turn
+    # them into a single flat array of strings
+    #
+    def flatten_list_of_strings(args)
+      args.collect do |b|
+        if b.is_a?(String)
+          # string, split on commas and turn into array
+          b.split(",").collect { |s| s.strip }
+        else
+          # presumably an array
+          b
+        end
+      end.flatten
+    end
+    
   end
 end
 

data/lib/chatterbot/helpers.rb

@@ -24,6 +24,9 @@ module Chatterbot
     # if we're doing a search, or parsing through replies/mentions.
     def from_user(s)
       return s if s.is_a?(String)
+      return s.from_user if s.respond_to?(:from_user) #&& ! s.from_user.nil?
+#      return s.user.screen_name if s.respond_to?(:user)
+
       s.has_key?(:from_user) ? s[:from_user] : s[:user][:screen_name]
     end
 

data/lib/chatterbot/reply.rb

@@ -7,23 +7,19 @@ module Chatterbot
     # handle replies for the bot
     def replies(&block)
       return unless require_login
+
       debug "check for replies since #{since_id}"
 
       opts = since_id > 0 ? {:since_id => since_id} : {}
-      results = client.replies(opts)
+      opts[:count] = 200
 
-      if results.is_a?(Hash) && results.has_key?("error")
-        critical results["error"]
-      else
-        results.each { |s|
-          s.symbolize_keys!
-          unless ! block_given? || on_blacklist?(s) || skip_me?(s)
-            update_since_id(s)
-            yield s         
-          end
-        }
-      end
+      results = client.mentions(opts)
+      results.each { |s|
+        unless ! block_given? || on_blacklist?(s) || skip_me?(s)
+          update_since_id(s)
+          yield s         
+        end
+      }
     end
-
   end
 end

data/lib/chatterbot/retweet.rb

@@ -14,4 +14,4 @@ module Chatterbot
       end
     end
   end
-end
+end

data/lib/chatterbot/search.rb

@@ -13,8 +13,6 @@ module Chatterbot
     
     # internal search code
     def search(queries, opts = {}, &block)
-      return unless init_client
-      
       debug "check for tweets since #{since_id}"
 
       if queries.is_a?(String)
@@ -26,19 +24,17 @@ module Chatterbot
       #
       queries.each { |query|
         debug "search: #{query} #{opts.merge(default_opts)}"
-        
-        search = client.search(exclude_retweets(query), opts.merge(default_opts))
-        update_since_id(search)
+        result = search_client.search(
+                                      exclude_retweets(query),
+                                      opts.merge(default_opts)
+                                      )
+
+        update_since_id(result.max_id)
 
-        if search != nil
-          search["results"].each { |s|
-            s.symbolize_keys!
-            debug s[:text]
-            #if s[:text].downcase.include?(query.downcase)
-            yield s unless ! block_given? || on_blacklist?(s) || skip_me?(s)
-            #end
-          }
-        end
+        result.collection.each { |s|
+          debug s.text
+          yield s unless ! block_given? || on_blacklist?(s) || skip_me?(s)
+        }
       }
     end
   

data/lib/chatterbot/tweet.rb

@@ -3,7 +3,6 @@ module Chatterbot
   #
   # routines for sending tweets
   module Tweet 
-    
     # simple wrapper for sending a message
     def tweet(txt, params = {}, original = nil)
       return if require_login == false
@@ -17,12 +16,15 @@ module Chatterbot
         log txt, original
         client.update txt, params
       end
-    end   
+    rescue Twitter::Error::Forbidden => e
+      debug e
+      false
+    end
 
     # reply to a tweet
     def reply(txt, source)
       debug txt
-      self.tweet txt, {:in_reply_to_status_id => source[:id]}, source
-    end   
+      tweet txt, {:in_reply_to_status_id => source[:id]}, source
+    end
   end
 end

data/lib/chatterbot/ui.rb

@@ -0,0 +1,96 @@
+module Chatterbot
+  
+  #
+  # routines for outputting setup instructions
+  #
+  module UI
+
+    #
+    # print out a message about getting a PIN from twitter, then output
+    # the URL the user needs to visit to authorize
+    #
+    def get_oauth_verifier
+      puts "****************************************"
+      puts "****************************************"
+      puts "****        BOT AUTH TIME!          ****"
+      puts "****************************************"
+      puts "****************************************"      
+
+      puts "You need to authorize your bot with Twitter.\n\nPlease login to Twitter under the bot's account. When you're ready, hit Enter.\n\nYour browser will open with the following URL, where you can authorize the bot.\n\n"
+
+      url = request_token.authorize_url
+
+      puts url
+
+      puts "\nIf that doesn't work, you can open the URL in your browser manually."
+
+      puts "\n\nHit enter to start.\n\n"
+      
+      STDIN.readline.chomp
+      
+      Launchy.open(url)
+
+      # sleep here so that if launchy has any output (which it does
+      # sometimes), it doesn't interfere with our input prompt
+     
+      sleep(1)
+
+      puts "Paste your PIN and hit enter when you have completed authorization.\n\n"
+      print "> "
+
+      STDIN.readline.chomp
+    rescue Interrupt => e
+      
+    end
+
+    #
+    # Ask the user to get an API key from Twitter.
+    def get_api_key
+      puts "****************************************"
+      puts "****************************************"
+      puts "****        API SETUP TIME!         ****"
+      puts "****************************************"
+      puts "****************************************"      
+
+      api_url = "https://dev.twitter.com/apps/new"
+      
+      puts "Hey, looks like you need to get an API key from Twitter before you can get started."
+      puts "Please hit enter, and I will send you to #{api_url} to start the process."
+      puts "(If it doesn't work, you can open a browser and paste the URL in manually)"
+
+      puts "\nHit Enter to continue."
+      
+      STDIN.readline
+
+      Launchy.open(api_url)
+      # pause to allow any launchy output
+      sleep(1)
+
+      puts "\n\n"
+      
+      print "\n\nPaste the 'Consumer Key' here: "
+      STDOUT.flush
+      config[:consumer_key] = STDIN.readline.chomp
+
+      print "Paste the 'Consumer Secret' here: "
+      STDOUT.flush
+      config[:consumer_secret] = STDIN.readline.chomp
+
+      # reset the client so we can re-init with new OAuth credentials
+      reset_client
+      
+      #
+      # capture ctrl-c and exit without a stack trace
+      #
+    rescue Interrupt => e
+      exit
+    end
+
+    #
+    # error message for auth
+    def display_oauth_error
+      STDERR.puts "Oops!  Looks like something went wrong there, please try again!"
+    end
+
+  end
+end