chatterbot 2.0.2 → 2.2.0

data/docs/tips.md

@@ -0,0 +1,22 @@
+---
+layout: page
+title: "Tips and Tricks"
+category: doc
+published: false
+---
+
+setting profile data
+
+resetting since_id/since_id_reply
+
+deleting tweets
+
+making sure a user is following your bot
+
+posting images
+
+running multiple searches
+
+
+
+

data/docs/tut.md

@@ -0,0 +1,6 @@
+---
+layout: default
+title: "Setup"
+---
+
+setting up your bot!

data/docs/twitter-docs.md

@@ -0,0 +1,6 @@
+---
+layout: page
+title: "Twitter API docs"
+category: links
+link: https://dev.twitter.com/rest/public
+---

data/docs/walkthrough.md

@@ -0,0 +1,46 @@
+---
+layout: page
+title: "Walkthrough"
+category: tut
+---
+
+Make a Twitter account
+----------------------
+
+First thing you'll need to do is create an account for your bot on
+Twitter.  That's the easy part.
+
+Run the generator
+-----------------
+
+Chatterbot comes with a script named `chatterbot-register` which will
+handle two tasks -- it will authorize your bot with Twitter and it
+will generate a skeleton script, which you use to implement your
+actual bot.
+
+When you run `chatterbot-register` it will walk you through the
+authorization process. If you prefer, you can do this manually. If
+you'd like to learn more about it, you can read the
+[Authorizing your Bot](setup.html) section.
+
+Write your bot
+--------------
+
+Chatterbot is written in ruby, but it accepts some very simple
+scripting commands which can handle almost everything you might need
+to do on Twitter.  You can get some ideas of things you can do on the
+[Examples](examples.html) page.
+
+    require 'chatterbot/dsl'
+    search("'surely you must be joking'") do |tweet|
+      reply "@#{tweet_user(tweet)} I am serious, and don't call me Shirley!", tweet
+    end
+
+Or, you can create a bot object yourself, extend it if needed, and use it like so:
+
+    bot = Chatterbot::Bot.new
+    bot.search("'surely you must be joking'") do |tweet|
+     bot.reply "@#{tweet_user(tweet)} I am serious, and don't call me Shirley!", tweet
+    end
+
+That's it!

data/lib/chatterbot.rb

@@ -45,7 +45,6 @@ module Chatterbot
     require "chatterbot/followers"
     require "chatterbot/helpers"
     require "chatterbot/utils"
-    require "chatterbot/streaming"
 
     require "chatterbot/bot"
   end

data/lib/chatterbot/bot.rb

@@ -5,7 +5,6 @@ module Chatterbot
   # primary Bot object, includes all the other modules
   class Bot
     include Utils
-    include Streaming
     include Blocklist
     include Safelist
     include Config
@@ -26,9 +25,6 @@ module Chatterbot
     # handlers that can use the REST API
     HANDLER_CALLS = [:direct_messages, :home_timeline, :replies, :search]
 
-    # handlers that require the Streaming API
-    STREAMING_ONLY_HANDLERS = [:favorited, :followed, :deleted]
-    
     #
     # Create a new bot. No options for now.
     def initialize(params={})
@@ -46,7 +42,7 @@ module Chatterbot
 
       at_exit do
         if !@handlers.empty? && @run_count <= 0 && skip_run? != true
-          run_or_stream
+          run!
         end
         
         raise $! if $!
@@ -54,58 +50,10 @@ module Chatterbot
       @handlers = {}
     end
 
-    #
-    # determine the right API to use and run the bot
-    #
-    def run_or_stream
-      @run_count += 1
-      if streaming?
-        stream!
-      else
-        run!
-      end
-    end
-
-    #
-    # run the bot with the Streaming API
-    #
-    def stream!
-      before_run
-
-      #
-      # figure out how we want to call streaming client
-      #
-      if @handlers[:search]
-        method = :filter
-        args = streamify_search_options(@handlers[:search].opts)
-      else
-        method = :user
-        args = {
-          stall_warnings: "true"
-        }
-      end
-
-      
-      streaming_client.send(method, args) do |object|
-        handle_streaming_object(object)
-      end
-      after_run
+    def screen_name
+      @screen_name ||= client.settings.screen_name
     end
 
-    #
-    # the REST API and Streaming API have a slightly different format.
-    # tweak our search handler to switch from REST to Streaming
-    #
-    def streamify_search_options(opts)
-      if opts.is_a?(String)
-        { track: opts }
-      elsif opts.is_a?(Array)
-        { track: opts.join(", ") }
-      else
-        opts
-      end
-    end
-    
     #
     # run the bot with the REST API
     #
@@ -114,7 +62,6 @@ module Chatterbot
 
       HANDLER_CALLS.each { |c|
         if (h = @handlers[c])
-          puts "calling #{c} #{h.opts.inspect}"
           send(c, *(h.opts)) do |obj|
             h.call(obj)
           end
@@ -134,24 +81,17 @@ module Chatterbot
     end
 
     def call_api_immediately?
-      !streaming?
+      true
     end
     
     def register_handler(method, opts = nil, &block)
       # @todo raise error if method already defined
       @handlers[method] = Handler.new(opts, &block)
 
-      if STREAMING_ONLY_HANDLERS.include?(method)
-        puts "Forcing usage of Streaming API to support #{method} calls"
-        self.streaming = true
-      elsif call_api_immediately?
-        @run_count += 1
-        h = @handlers[method]
-        self.send(method, *(h.opts)) do |obj|
-          h.call(obj)
-        end
+      h = @handlers[method]
+      self.send(method, *(h.opts)) do |obj|
+        h.call(obj)
       end
-     
     end
   end
 end

data/lib/chatterbot/client.rb

@@ -6,7 +6,7 @@ module Chatterbot
   # routines for connecting to Twitter and validating the bot
   #
   module Client
-    attr_accessor :screen_name, :client, :streaming_client
+    attr_accessor :screen_name, :client
 
     #
     # the main interface to the Twitter API
@@ -14,14 +14,7 @@ module Chatterbot
     def client
       @client ||= Twitter::REST::Client.new(client_params)
     end
-
-    #
-    # interace to the Streaming API
-    #
-    def streaming_client
-      @streaming_client ||= Twitter::Streaming::Client.new(client_params)
-    end
-
+    
     #
     # return the currently authenticated User
     #

data/lib/chatterbot/config.rb

@@ -55,7 +55,6 @@ module Chatterbot
     
     attr_boolean :debug_mode, false
     attr_boolean :verbose, false
-    attr_boolean :streaming, false
     attr_boolean :skip_run, false
     attr_boolean :only_interact_with_followers, false    
 
@@ -212,7 +211,7 @@ module Chatterbot
         :consumer_key => ENV["chatterbot_consumer_key"],
         :consumer_secret => ENV["chatterbot_consumer_secret"],
         :access_token => ENV["chatterbot_access_token"],
-        :access_token_secret => ENV["chatterbot_access_secret"]
+        :access_token_secret => ENV["chatterbot_access_secret"] || ENV["chatterbot_access_token_secret"]
       }.delete_if { |k, v| v.nil? }.merge(slurp_file(config_file) || {})
     end
     

data/lib/chatterbot/dsl.rb

@@ -14,6 +14,10 @@ module Chatterbot
     #
     # search twitter for the specified terms, then pass any matches to
     # the block.
+    # NOTE: by default, search terms are wrapped in quotes so the
+    # Twitter API will return tweets that include your exact query.
+    # You can disable this by passing exact:false as an option
+    #
     # @param args [Hash] options. these will be passed directly to
     # Twitter via the twitter gem. You can see the possible arguments
     # at http://www.rubydoc.info/gems/twitter/Twitter/REST/Search#search-instance_method
@@ -66,55 +70,17 @@ module Chatterbot
       bot.register_handler(:direct_messages, block)
     end
     
-    
-    #
-    # handle notifications of bot tweets favorited by other users.
-    # Using this block will require usage of the Streaming API.
-    #
-    # @example
-    #   favorited do |tweet|
-    #     puts tweet.text # this is the actual tweeted text
-    #     reply "@#{user.screen_name} thanks for the fave!", tweet
-    #   end
-    def favorited(&block)
-      bot.register_handler(:favorited, block)
-    end
-  
-    #
-    # handle notifications that the bot has a new follower.
-    # Using this block will require usage of the Streaming API.
-    #
-    # @example
-    #   followed do |user|
-    #     follow user
-    #   end
-    def followed(&block)
-      bot.register_handler(:followed, block)
-    end
-  
-    #
-    # handle notifications of tweets on the bot's timeline that were deleted.
-    # Using this block will require usage of the Streaming API.
-    def deleted(&block)
-      bot.register_handler(:deleted, block)
-    end
-
-
-    #
-    # enable or disable usage of the Streaming API
-    #
-    def use_streaming(s=nil)
-      s = true if s.nil?
-      bot.streaming = s
-    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 [Hash] params options for the tweet. You can get an idea
+    #   of possible values you can send here from the underlying Twitter
+    #   gem docs: http://rdoc.info/gems/twitter/Twitter/API#update-instance_method
+    # @option params [String,File] :media Optional file object to send
+    #   with the tweet. Must be an image or video that will be accepted by
+    #   Twitter. You can pass a File object, or the path to a file
+    # @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)
@@ -141,8 +107,15 @@ module Chatterbot
     #
     # @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)
+    # @param [Hash] params options for the tweet. You can get an idea
+    #   of possible values you can send here from the underlying Twitter
+    #   gem docs: http://rdoc.info/gems/twitter/Twitter/API#update-instance_method
+    # @option params [String,File] :media Optional file object to send with the
+    #   tweet. Must be an image or video that will be accepted by
+    #   Twitter. You can pass a File object, or the path to a file
+    # @see http://rdoc.info/gems/twitter/Twitter/API#update-instance_method
+    def reply(txt, source, params={})
+      bot.reply(txt, source, params)
     end
 
     #

data/lib/chatterbot/home_timeline.rb

@@ -7,7 +7,7 @@ module Chatterbot
     # handle the bots timeline
     def home_timeline(*args, &block)
       return unless require_login
-      debug "check for home_timeline tweets since #{since_id}"
+      debug "check for home_timeline tweets since #{since_id_home_timeline}"
 
       opts = {
         :since_id => since_id_home_timeline,

data/lib/chatterbot/search.rb

@@ -24,25 +24,47 @@ module Chatterbot
       @skip_retweets = false
     end
 
-
+    
     #
     # check if this is a retweet that we want to skip
     #
     def skippable_retweet?(t)
       @skip_retweets && t.retweeted_status?
     end
+
+    def wrap_search_query(q)
+      if q =~ / /
+        ['"', q.gsub(/^"/, '').gsub(/"$/, ''), '"'].join("")
+      else
+        q
+      end
+    end
     
     # internal search code
     def search(queries, opts = {}, &block)
       debug "check for tweets since #{since_id}"
       
       max_tweets = opts.delete(:limit) || MAX_SEARCH_TWEETS
+      exact_match = if opts.key?(:exact)
+                      opts.delete(:exact)
+                    else
+                      true
+                    end
+        
       
       if queries.is_a?(String)
-        queries = [queries]
+        queries = [
+          queries
+        ]
       end
 
-      query = queries.join(" OR ")
+      query = queries.map { |q|
+        if exact_match == true
+          q = wrap_search_query(q)
+        end
+
+        q
+      }.join(" OR ")
       
       #
       # search twitter
@@ -50,6 +72,7 @@ module Chatterbot
 
       debug "search: #{query} #{default_opts.merge(opts)}"
       @current_tweet = nil
+
       client.search( query, default_opts.merge(opts) ).take(max_tweets).each { |s|
         update_since_id(s)
         debug s.text

data/lib/chatterbot/skeleton.rb

@@ -18,8 +18,6 @@ module Chatterbot
           :timestamp => Time.now
         })
 
-        puts opts.inspect
-        
         src % opts
       end
     end

data/lib/chatterbot/tweet.rb

@@ -13,7 +13,16 @@ module Chatterbot
         debug "I'm in debug mode, otherwise I would tweet: #{txt}"
       else
         debug txt
-        client.update txt, params
+        if params.has_key?(:media)
+          file = params.delete(:media)
+          if ! file.is_a?(File)
+            file = File.new(file)
+          end
+
+          client.update_with_media txt, file, params
+        else
+          client.update txt, params
+        end
       end
     rescue Twitter::Error::Forbidden => e
       #:nocov:
@@ -24,9 +33,10 @@ module Chatterbot
 
     
     # reply to a tweet
-    def reply(txt, source)
+    def reply(txt, source, params = {})
       debug txt
-      tweet txt, {:in_reply_to_status_id => source.id}, source
+      params = {:in_reply_to_status_id => source.id}.merge(params)
+      tweet txt, params, source
     end
   end
 end