chatterbot 0.5.1 → 0.6.1

data/README.markdown

@@ -7,6 +7,9 @@ pretty involved bots. It handles searches, replies and tweets, and has
 a simple blacklist system to help keep you from spamming people who
 don't want to hear from your bot.
 
+[![Build Status](https://secure.travis-ci.org/muffinista/chatterbot.png?branch=master)](http://travis-ci.org/muffinista/chatterbot)
+
+
 Features
 --------
 * Works via Twitter's OAuth system.
@@ -15,6 +18,18 @@ Features
 * Simple blacklistling system to limit your annoyance of users
 * Optionally log tweets to the database for metrics and tracking purposes
 
+Is Writing Bots a Good Use of My Time?
+======================================
+
+Quick answer: if you're planning on being spammish on Twitter, you
+should probably find something else to do. If you're planning on
+writing a bot that isn't too rude or annoying, or that expects a
+certain amount of opt-in from users, then you're probably good. I've
+written a blog post about bots on Twitter here:
+http://muffinlabs.com/2012/06/04/the-current-state-of-bots-on-twitter/
+
+
+
 Using Chatterbot
 ================
 
@@ -54,6 +69,72 @@ Or, you can create a bot object yourself, extend it if needed, and use it like s
 
 That's it!
 
+Chatterbot uses the the Twitter gem
+(https://github.com/sferik/twitter) to handle the underlying API
+calls. Any calls to the search/reply methods will return
+Twitter::Status objects, which are basically extended hashes.
+
+What Can I Do?
+--------------
+
+Here's a list of the important methods in the Chatterbot DSL:
+
+**search** -- You can use this to perform a search on Twitter:
+
+    search("'surely you must be joking'") do |tweet|
+      reply "@#{tweet_user(tweet)} I am serious, and don't call me Shirley!", tweet
+    end
+
+**replies** -- Use this to check for replies and mentions:
+
+    replies do |tweet|
+      reply "#USER# Thanks for contacting me!", tweet
+    end
+
+Note that the string #USER# will be replaced with the username of the person who sent the original tweet.
+
+**tweet** -- send a Tweet out for this bot:
+
+    tweet "I AM A BOT!!!"
+
+**reply** -- reply to another tweet:
+
+    reply "THIS IS A REPLY TO #USER#!", original_tweet
+
+**retweet** -- Chatterbot can retweet tweets as well:
+
+```rb
+  search "xyzzy" do |tweet|
+    retweet(tweet[:id])
+  end
+```
+
+
+**blacklist** -- you can use this to specify a list of users you don't
+  want to interact with. If you put the following line at the top of
+  your bot:
+  
+    blacklist "user1, user2, user3"
+    
+None of those users will trigger your bot if they come up in a
+search. However, if a user replies to one of your tweets or mentions
+your bot in a tweet, you will receive that tweet when calling the
+reply method.
+
+**exclude** -- similarly, you can specify a list of words/phrases
+  which shouldn't trigger your bot. If you use the following:
+  
+    exclude "spam"
+    
+Any tweets or mentions with the word 'spam' in them will be ignored by
+the bot. If you wanted to ignore any tweets with links in them (a wise
+precaution if you want to avoid spreading spam), you could call:
+
+    exclude "http://"
+
+For more details, check out dsl.rb in the source code.
+
+
 Authorization
 -------------
 
@@ -162,17 +243,6 @@ end
 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
-```
-
 
 Database logging
 ----------------
@@ -210,7 +280,6 @@ TODO
 
 * document DSL methods
 * document database setup
-* consider switching to Twitter gem for API
 * web-based frontend for tracking bot activity
 * opt-out system that adds people to blacklist if they reply to a bot
   in the right way

data/bin/chatterbot-register

@@ -89,10 +89,10 @@ end
 @bot.config.delete(:token)
 @bot.require_login(false)
 
-if @bot.client.authorized?
+unless @bot.screen_name.nil?
   if @botname == "tmp_bot_name"
-    puts "change botname to #{@bot.access_token.params[:screen_name]}"
-    @bot.botname = @bot.access_token.params[:screen_name]
+    puts "change botname to #{@bot.screen_name}"
+    @bot.botname = @bot.screen_name
   end
 
   puts "Storing config info"

data/chatterbot.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.authors = ["Colin Mitchell"]
   s.email = %q{colin@muffinlabs.com}
   s.homepage = %q{http://github.com/muffinista/chatterbot}
-  s.summary = %q{A framework for writing Twitter bots}
-  s.description = %q{A framework for writing bots that run on Twitter. Comes with a simple DSL for easy coding.}
+  s.summary = %q{A ruby framework for writing Twitter bots}
+  s.description = %q{A ruby framework for writing bots that run on Twitter. Comes with a simple DSL for easy coding.}
 
   s.rubyforge_project = "chatterbot"
 
@@ -20,31 +20,16 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.licenses = ["WTFDBAL"]
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<twitter_oauth>, [">= 0"])
-      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<simplecov>, [">= 0"])
-      s.add_development_dependency(%q<watchr>, [">= 0"])
-    else
-      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<simplecov>, [">= 0"])
-      s.add_dependency(%q<watchr>, [">= 0"])
-    end
-  else
-    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<rcov>, [">= 0"])
-    s.add_dependency(%q<watchr>, [">= 0"])
-  end
+  s.add_runtime_dependency(%q<oauth>, [">= 0"])
+  s.add_runtime_dependency(%q<twitter>, [">= 3.4.1"])
+  s.add_runtime_dependency(%q<launchy>, [">= 2.1.2"])
+  s.add_development_dependency(%q<yard>, [">= 0"])
+  s.add_development_dependency(%q<redcarpet>, [">= 0"])
+  s.add_development_dependency(%q<shoulda>, [">= 0"])
+  s.add_development_dependency(%q<rake>, [">= 0"])
+  s.add_development_dependency(%q<rspec>, [">= 0"])
+  s.add_development_dependency(%q<rdoc>, [">= 0"])
+  s.add_development_dependency(%q<simplecov>, [">= 0"])
+  s.add_development_dependency(%q<watchr>, [">= 0"])
 end
 

data/examples/echoes_bot.rb

@@ -1,5 +1,9 @@
 #!/usr/bin/env ruby
 
+## This is a very simple working example of a bot you can build with
+## chatterbot. It looks for mentions of '@echoes_bot' (the twitter
+## handle the bot uses), and sends replies with the name switched to
+## the handle of the sending user
 
 #
 # require the dsl lib to include all the methods you see below.
@@ -19,10 +23,6 @@ blacklist "mean_user, private_user"
 
 puts "checking for replies to me"
 replies do |tweet|
-  
-  # replace the incoming username with the handle of the user who tweeted us
-  # src = tweet[:text].gsub(/@echoes_bot/, tweet_user(tweet))
-
   # replace the incoming username with #USER#, which will be replaced
   # with the handle of the user who tweeted us by the
   # replace_variables helper

data/lib/chatterbot.rb

@@ -1,5 +1,7 @@
 require 'yaml'
-require 'twitter_oauth'
+require 'oauth'
+require 'twitter'
+require 'launchy'
 
 #
 # Try and load Sequel, but don't freak out if it's not there
@@ -34,7 +36,8 @@ module Chatterbot
     require "chatterbot/db"
     require "chatterbot/logging"
     require "chatterbot/blacklist"
-    require "chatterbot/client"
+    require "chatterbot/ui"
+    require "chatterbot/client"    
     require "chatterbot/search"
     require "chatterbot/tweet"
     require "chatterbot/retweet"

data/lib/chatterbot/blacklist.rb

@@ -22,14 +22,14 @@ module Chatterbot
     #
     # Based on the text of this tweet, should it be skipped?
     def skip_me?(s)
-      search = s.is_a?(Hash) ? s[:text] : s
+      search = s.respond_to?(:text) ? s.text : s
       exclude.detect { |e| search.downcase.include?(e) } != nil
     end
     
     #
     # Is this tweet from a user on our blacklist?
     def on_blacklist?(s)
-      search = (s.is_a?(Hash) ? from_user(s) : s).downcase
+      search = (s.respond_to?(:user) ? from_user(s) : s).downcase
       blacklist.any? { |b| search.include?(b.downcase) } ||
         on_global_blacklist?(search)
     end

data/lib/chatterbot/bot.rb

@@ -10,6 +10,7 @@ module Chatterbot
     include Tweet
     include Retweet
     include Reply
+    include UI
     include Client
     include DB
     include Helpers
@@ -22,13 +23,19 @@ module Chatterbot
       end
 
       @config = load_config(params)
-      
-      # update config when we exit
-      at_exit do
-        raise $! if $!
+
+      if reset_bot?
+        reset_since_id
         update_config
-      end  
+        puts "Reset to #{@config[:since_id]}"
+        exit
+      else    
+        # update config when we exit
+        at_exit do
+          raise $! if $!
+          update_config
+        end  
+      end
     end
-    
   end
 end

data/lib/chatterbot/client.rb

@@ -2,31 +2,79 @@ module Chatterbot
   
   #
   # routines for connecting to Twitter and validating the bot
+  #
   module Client
+    attr_accessor :screen_name, :client, :search_client
+
+    #
+    # the main interface to the Twitter API
+    #
+    def client
+      @client ||= Twitter::Client.new(
+                                      :endpoint => base_url,
+                                      :consumer_key => client_params[:consumer_key],
+                                      :consumer_secret => client_params[:consumer_secret],
+                                      :oauth_token => client_params[:token],
+                                      :oauth_token_secret => client_params[:secret]
+                                      )
+    end
+
+    #
+    # client for running searches -- for some reason Twitter::Client was overwriting
+    # the endpoint for searches in a destructive fashion, so I had two
+    # clients. That appears to be fixed, but if not, this takes care of that problem
+    #
+    def search_client
+      client
+      # return client
+
+      # @search_client ||= Twitter::Client.new(
+      #                                 :endpoint => base_url,
+      #                                 :consumer_key => client_params[:consumer_key],
+      #                                 :consumer_secret => client_params[:consumer_secret],
+      #                                 :oauth_token => client_params[:token],
+      #                                 :oauth_token_secret => client_params[:secret]
+      #                                 )
+    end
+
+    #
+    # reset the since_id for this bot to the highest since_id we can
+    # get, by running a really open search and updating config with
+    # the max_id   
+    #
+    def reset_since_id
+      result = search_client.search("a")
+      update_since_id(result)
+    end
+
+    
 
-    # the Twitter client
-    attr_accessor :client
+    #
+    # the URL we should use for api calls
+    #
+    def base_url
+      "https://api.twitter.com"
+    end
 
-    # track the access token so we can get screen name when
-    # registering new bots
-    attr_accessor :access_token
 
     #
     # default options when querying twitter -- this could be extended
     # with a language, etc.
     def default_opts
-      return {} if since_id <= 0
-      {
-        :since_id => since_id,
+      opts = {
         :result_type => "recent"
       }
+      opts[:since_id] = since_id if since_id > 0
+
+      opts
     end
     
 
     #
-    # Initialize the Twitter client
+    # Initialize the Twitter client, and check to see if it has credentials or not
+    # @return true/false depending on if client has OAuth credentials
     def init_client
-      @client ||= TwitterOAuth::Client.new(client_params)
+      client.credentials?
     end
     
     #
@@ -44,53 +92,49 @@ module Chatterbot
       login(do_update_config)
     end
 
-    #
-    # 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(request_token)
-      puts "Please go to the following URL and authorize the bot.\n"        
-      puts "#{request_token.authorize_url}\n"
 
-      puts "Paste your PIN and hit enter when you have completed authorization."
-      STDIN.readline.chomp
-    rescue Interrupt => e
 
+    #
+    # simple OAuth client for setting up with Twitter
+    #
+    def consumer
+      @consumer ||= OAuth::Consumer.new(
+                          config[:consumer_key],
+                          config[:consumer_secret],
+                          :site => base_url
+                          )
     end
 
     #
-    # Ask the user to get an API key from Twitter.
-    def get_api_key
-      puts "****************************************"
-      puts "****************************************"
-      puts "****        API SETUP TIME!         ****"
-      puts "****************************************"
-      puts "****************************************"      
-      
-      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"
-
-      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_client
-      
-      #
-      # capture ctrl-c and exit without a stack trace
-      #
-    rescue Interrupt => e
-#      exit
+    # copied from t, the awesome twitter cli app
+    # @see https://github.com/sferik/t/blob/master/lib/t/authorizable.rb
+    #
+    def generate_authorize_url(request_token)
+      request = consumer.create_signed_request(:get,
+        consumer.authorize_path, request_token,
+        {:oauth_callback => 'oob'})
+
+      params = request['Authorization'].sub(/^OAuth\s+/, '').split(/,\s+/).map do |param|
+        key, value = param.split('=')
+        value =~ /"(.*?)"/
+        "#{key}=#{CGI::escape($1)}"
+      end.join('&')
+
+      "#{base_url}#{request.path}?#{params}"
+    end
+
+    def request_token
+      @request_token ||= consumer.get_request_token
     end
 
     #
-    # error message for auth
-    def display_oauth_error
-      debug "Oops!  Looks like something went wrong there, please try again!"
+    # query twitter for the bots screen name. we do this during the bot registration process
+    #
+    def get_screen_name
+      return unless @screen_name.nil?
+
+      oauth_response = @access_token.get('/1/account/verify_credentials.json')
+      @screen_name = JSON.parse(oauth_response.body)["screen_name"]
     end
     
     #
@@ -106,30 +150,28 @@ module Chatterbot
       end
 
       if needs_auth_token?
-        request_token = client.request_token
-
-        pin = get_oauth_verifier(request_token)
+        pin = get_oauth_verifier #(request_token)
         return false if pin.nil?
 
-        @access_token = client.authorize(
-                                         request_token.token,
-                                         request_token.secret,
-                                         :oauth_verifier => pin
-                                         )
 
+        begin
+          # this will throw an error that we can try and catch
+          @access_token = request_token.get_access_token(:oauth_verifier => pin.chomp)
+          get_screen_name
 
-        if client.authorized?
           config[:token] = @access_token.token
           config[:secret] = @access_token.secret
 
-          update_config unless do_update_config == false
-        else
+          update_config unless ! do_update_config
+          reset_client
+
+        rescue OAuth::Unauthorized => e
           display_oauth_error
           return false
         end
       end
 
-      true
+      return true
     end
   end
 end