chatterbot 0.7.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a201bdebfa6dbcffa480ca035bc84053a6c6a10
-  data.tar.gz: 611a0e13a984bdb0afc67a208a011aa6b113e750
+  metadata.gz: d6cc3315231e205c177354dd5673822215379086
+  data.tar.gz: d4b0c0bb2d9ce6d2aa3d06ab17250a43868f1050
 SHA512:
-  metadata.gz: e2fc941f17f82850bef55c0af704b66b65cd1986640f8bdaa2b3ac53c528028a5f9feda5826822eccbc567b1f900ad03bb3a4872ae369b386f88c1d2430ea573
-  data.tar.gz: 4d605782e35d922cca012873ef32ea9c82e4aafb1e80a6424074467fdd26c280120f0e9276eff5f3f94826dcc5765265f59f93dbf2473f4666590be0445a205d
+  metadata.gz: 2a8a816511a450286f76f0a7e7650c57fda15d9fcf58492473883402253997817a450e55d586858612acf2cf05741afc76567af25c319c7aea1ba0279f4359de
+  data.tar.gz: a66dc9d98fa5f1b40270ac88231b7849a13861a97b565ed0a40f1e582bbae93ef19daf804ce7ae629bd9f3ab06b2db236fea15e3092d1449014d4106edcd782e

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
-  - 1.8.7
   - 1.9.2
   - 1.9.3
   - 2.0.0
+  - 2.1.1
 # uncomment this line if your project needs to run something other than `rake`:
 # script: bundle exec rspec spec

data/Gemfile

@@ -8,16 +8,18 @@ gemspec
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem 'simplecov', :require => false, :group => :test
+  #gem 'simplecov', :require => false, :group => :test
 
-  gem "shoulda", ">= 0"
-  gem "rspec"
-  gem "rake"
+  #gem "shoulda", ">= 0"
+  #gem "rspec"
+  #gem "rake"
   #gem "twitter", "~> 4.4.0"
 
-  gem "watchr"
+  #gem "watchr"
 end
 
+gem "pry"
+
 #
 # couple extra gems for testing db connectivity
 #

data/README.markdown

@@ -217,7 +217,7 @@ your bot:
    it with your bots if desired.
 6. In a database.  You can store your configuration in a DB, and then
    specify the connection string either in one of the global config
-   files, or on the command-line by using the `--db="db_uri"`
+   files by setting `:db_uri: postgres://username:password@host/database`, or on the command-line by using the `--db="db_uri"`
    configuration option.  Any calls to the database are handled by the
    Sequel gem, and MySQL and Sqlite should work.  The DB URI should
    be in the form of `mysql://username:password@host/database` -- see

data/Rakefile

@@ -24,3 +24,11 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "'chatterbot #{Chatterbot::VERSION}'"
 end
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'chatterbot' # You know what to do.
+  ARGV.clear
+  IRB.start
+end

data/bin/chatterbot-blacklist

@@ -10,6 +10,8 @@ include Chatterbot::Config
 include Chatterbot::DB
 include Chatterbot::Logging
 
+Chatterbot::from_helper = true
+
 @display_blacklist = false
 
 #

data/bin/chatterbot-register

@@ -10,6 +10,8 @@ include Chatterbot::Config
 include Chatterbot::DB
 include Chatterbot::Logging
 
+Chatterbot::from_helper = true
+
 @force = false
 @skeleton = true
 

data/bin/chatterbot-status

@@ -8,6 +8,8 @@ include Chatterbot::Helpers
 include Chatterbot::Config
 include Chatterbot::DB
 
+Chatterbot::from_helper = true
+
 @tweet_count = 5
 
 #

data/chatterbot.gemspec

@@ -27,17 +27,17 @@ Gem::Specification.new do |s|
   else
     s.add_development_dependency(%q<redcarpet>, [">= 0"])
   end
-   
-  s.add_runtime_dependency(%q<oauth>, [">= 0"])
-  s.add_runtime_dependency(%q<twitter>, ["4.8.1"])
+
+  s.add_runtime_dependency(%q<oauth>, [">= 0.4.7"])
+  s.add_runtime_dependency(%q<twitter>, ["5.8.0"])
   s.add_runtime_dependency(%q<launchy>, [">= 2.1.2"])
   s.add_development_dependency(%q<yard>, [">= 0"])
   s.add_development_dependency(%q<shoulda>, [">= 0"])
   s.add_development_dependency(%q<rake>, [">= 0"])
-  s.add_development_dependency(%q<rspec>, [">= 2.14.1"])
-  s.add_development_dependency(%q<rspec-mocks>, [">= 2.14.1"])
+  s.add_development_dependency(%q<rspec>, ["~> 3.0.0"])
+  s.add_development_dependency(%q<rspec-mocks>, ["~> 3.0.2"])
   s.add_development_dependency(%q<rdoc>, [">= 0"])
   s.add_development_dependency(%q<simplecov>, [">= 0"])
-  s.add_development_dependency(%q<watchr>, [">= 0"])
+  s.add_development_dependency(%q<observr>, [">= 0"])
 end
 

data/examples/streaming_bot.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+
+## This is a very simple working example of a bot using the streaming
+## API. It's basically a copy of echoes_bot.rb, just using streaming.
+
+#
+# require the dsl lib to include all the methods you see below.
+#
+require 'rubygems'
+require 'chatterbot/dsl'
+
+consumer_secret 'foo'
+secret 'bar'
+token 'biz'
+consumer_key 'bam'
+
+
+puts "Loading echoes_bot.rb using the streaming API"
+
+exclude "http://", "https://"
+
+blacklist "mean_user, private_user"
+
+streaming do
+  favorited do |user, tweet|
+    reply "@#{user.screen_name} thanks for the fave!", tweet
+  end
+
+  followed do |user|
+    tweet "@#{user.screen_name} just followed me!"
+    follow user
+  end
+
+  replies do |tweet|
+    favorite tweet
+
+    puts "It's a tweet!"
+    src = tweet.text.gsub(/@echoes_bot/, "#USER#")  
+    reply src, tweet
+  end
+end
+

data/lib/chatterbot.rb

@@ -28,6 +28,8 @@ end
 #
 # the big kahuna!
 module Chatterbot
+  @@from_helper = false
+
   #
   # load in our assorted modules
   def self.load
@@ -40,13 +42,26 @@ module Chatterbot
     require "chatterbot/search"
     require "chatterbot/tweet"
     require "chatterbot/retweet"
+    require "chatterbot/favorite"
+    require "chatterbot/profile"
     require "chatterbot/reply"
+    require "chatterbot/streaming"
+    require "chatterbot/streaming_handler"
     require "chatterbot/followers"
-    require "chatterbot/helpers"    
+    require "chatterbot/helpers"
+    require "chatterbot/utils"
 
     require "chatterbot/bot"
   end
 
+  def self.from_helper=(x)
+    @@from_helper = x
+  end
+
+  def self.from_helper
+    @@from_helper
+  end
+  
   require 'chatterbot/version'
   
   # Return a directory with the project libraries.

data/lib/chatterbot/blacklist.rb

@@ -29,6 +29,9 @@ module Chatterbot
     #
     # Is this tweet from a user on our blacklist?
     def on_blacklist?(s)
+      puts s.inspect
+      puts blacklist.inspect
+
       search = (s.respond_to?(:user) ? from_user(s) : s).downcase
       blacklist.any? { |b| search.include?(b.downcase) } ||
         on_global_blacklist?(search)
@@ -52,7 +55,6 @@ module Chatterbot
 
       # make sure we don't have an @ at the beginning of the username
       user.gsub!(/^@/, "")
-
       debug "adding #{user} to blacklist"
 
       db[:blacklist].insert({ :user => user, :created_at => Time.now }) # 

data/lib/chatterbot/bot.rb

@@ -3,12 +3,16 @@ module Chatterbot
   #
   # primary Bot object, includes all the other modules
   class Bot
+    include Utils
     include Blacklist
+    include Streaming
     include Config
     include Logging
     include Search
     include Tweet
+    include Profile
     include Retweet
+    include Favorite
     include Reply
     include Followers
     include UI

data/lib/chatterbot/client.rb

@@ -6,39 +6,34 @@ module Chatterbot
   # routines for connecting to Twitter and validating the bot
   #
   module Client
-    attr_accessor :screen_name, :client, :search_client
+    attr_accessor :screen_name, :client, :streaming_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]
-                                      )
+      @client ||= Twitter::REST::Client.new(
+                                           :consumer_key => client_params[:consumer_key],
+                                           :consumer_secret => client_params[:consumer_secret],
+                                           :access_token => client_params[:token],
+                                           :access_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]
-      #                                 )
+    def streaming_client
+      @streaming_client ||= Twitter::Streaming::Client.new(
+                                                           :consumer_key => client_params[:consumer_key],
+                                                           :consumer_secret => client_params[:consumer_secret],
+                                                           :access_token => client_params[:token],
+                                                           :access_token_secret => client_params[:secret]
+                                                           )
     end
 
+    def reset!
+      config[:since_id] = 0
+      config[:since_id_reply] = 0
+    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
@@ -55,7 +50,7 @@ module Chatterbot
     #
     def reset_since_id_reply
       config[:tmp_since_id_reply] = 0
-      result = client.mentions.max_by(&:id)
+      result = client.mentions_timeline.max_by(&:id)
       update_since_id_reply(result)
     end
    
@@ -179,7 +174,7 @@ module Chatterbot
 
         rescue OAuth::Unauthorized => e
           display_oauth_error
-          puts e.inspect
+          warn e.inspect
           return false
         end
       end

data/lib/chatterbot/config.rb

@@ -4,7 +4,9 @@ module Chatterbot
   # routines for storing config information for the bot
   module Config  
     attr_accessor :config
-    
+
+    MAX_TWEET_ID = 9223372036854775807
+
     #
     # the entire config for the bot, loaded from YAML files and the DB if applicable
     def config
@@ -75,7 +77,7 @@ module Chatterbot
     def verbose?
       config[:verbose] || false
     end
-    
+   
     #
     # destination for log entries
     def log_dest
@@ -127,7 +129,10 @@ module Chatterbot
     end
 
     def max_id_from(s)
-      s.max { |a, b| a.id <=> b.id }.id
+      # don't use max_id if it's this ridiculous number
+      # @see https://dev.twitter.com/issues/1300
+      sorted = s.reject { |t| !t || t.id == MAX_TWEET_ID }.max { |a, b| a.id <=> b.id }
+      sorted && sorted.id
     end
 
     #
@@ -135,7 +140,7 @@ module Chatterbot
     # unless it is lower thant what we have already
     #
     def update_since_id_reply(tweet)
-      return if tweet.nil? or tweet.class != Twitter::Tweet
+      return if tweet.nil? or tweet.class != Twitter::Tweet || tweet.id == MAX_TWEET_ID
 
       tmp_id = tweet.id
 
@@ -147,29 +152,17 @@ module Chatterbot
     # tweets, unless it is lower than what we have already
     def update_since_id(search)
       return if search.nil?
-
-      
-      tmp_id = case search
-               when Twitter::SearchResults then
-                 # don't use max_id if it's this ridiculous number
-                 # @see https://dev.twitter.com/issues/1300
-                 if search.max_id != 9223372036854775807
-                   search.max_id
-                 else
-                   max_id_from(search)
-                 end
-
-                 # incoming tweets
-               when Twitter::Tweet then search.id
-
-                 # an enumeration
-               when Array then max_id_from(search)
-                 
-                 # probably an actual tweet ID at this point,
-                 # otherwise it will fail and return 0
-               else search
+     
+      tmp_id = if search.is_a?(Twitter::SearchResults)
+                 search.attrs[:search_metadata][:max_id]
+               elsif search.respond_to?(:max)
+                 max_id_from(search)
+               elsif search.is_a?(Twitter::Tweet)
+                 search.id
+               else
+                 search
                end.to_i
-
+      
       config[:tmp_since_id] = [config[:tmp_since_id].to_i, tmp_id].max
     end
 
@@ -200,7 +193,7 @@ module Chatterbot
     # determine if we're being called by one of our internal scripts
     #
     def chatterbot_helper?
-      File.basename($0).include?("chatterbot-")
+      Chatterbot::from_helper == true
     end
     
     #
@@ -221,7 +214,6 @@ module Chatterbot
     # figure out what config file to load based on the name of the bot
     def config_file
       dest = working_dir
-
       x = File.join(File.expand_path(dest), "#{botname}.yml")
     end
 
@@ -268,7 +260,12 @@ module Chatterbot
     #
     # bot-specific config settings
     def bot_config
-      slurp_file(config_file) || { }
+      {
+        :consumer_key => ENV["chatterbot_consumer_key"],
+        :consumer_secret => ENV["chatterbot_consumer_secret"],
+        :token => ENV["chatterbot_token"],
+        :secret => ENV["chatterbot_secret"]
+      }.merge(slurp_file(config_file) || {})
     end
 
     #
@@ -299,7 +296,6 @@ module Chatterbot
       tmp
     end
     
-    
     #
     # load in the config from the assortment of places it can be specified.
     def load_config(params={})

data/lib/chatterbot/db.rb

@@ -11,9 +11,11 @@ module Chatterbot
       @_db ||= connect_and_validate
     end
 
+    #:nocov:
     def display_db_config_notice
       puts "ERROR: You have specified a DB connection, but you need to install the sequel gem to use it"
     end
+    #:nocov:
 
     protected
 

data/lib/chatterbot/dsl.rb

@@ -5,6 +5,8 @@ module Chatterbot
   #
   # very basic DSL to handle the common stuff you would want to do with a bot.
   module DSL
+    #
+    # @return initialized Twitter::REST::Client
     def client
       bot.client
     end
@@ -14,7 +16,7 @@ module Chatterbot
     # the block.
     # @example
     #   search("chatterbot is cool!") do |tweet|
-    #     puts tweet[:text] # this is the actual tweeted text
+    #     puts tweet.text # this is the actual tweeted text
     #     reply "I agree!", tweet
     #   end
     def search(query, opts = {}, &block)
@@ -27,13 +29,28 @@ module Chatterbot
     #
     # @example
     #   replies do |tweet|
-    #     puts tweet[:text] # this is the actual tweeted text
+    #     puts tweet.text # this is the actual tweeted text
     #     reply "Thanks for the mention!", tweet
     #   end
     def replies(&block)
       bot.replies(&block)
     end
 
+    def streaming(opts = {}, &block)
+      params = {
+        :endpoint => :user
+      }.merge(opts)
+
+      h = StreamingHandler.new(bot, params)
+      h.apply block
+
+      bot.do_streaming(h)
+    end
+    
+    def streaming_tweets(opts={}, &block)
+      bot.streaming_tweets(opts, &block)
+    end
+    
     #
     # send a tweet
     #
@@ -48,11 +65,19 @@ module Chatterbot
 
     #
     # retweet a tweet
-    # @param [id] id the ID of the tweet
+    # @param [id] id A tweet or the ID of a tweet
     def retweet(id)
       bot.retweet(id)
     end
 
+
+    #
+    # favorite a tweet
+    # @param [id] id A tweet or the ID of a tweet
+    def favorite(id)
+      bot.favorite(id)
+    end
+    
     #
     # reply to a tweet
     #
@@ -62,18 +87,37 @@ module Chatterbot
       bot.reply(txt, source)
     end
 
+    def profile_text(p=nil)
+      if p.nil?
+        bot.profile_text
+      else
+        bot.profile_text(p)
+      end
+    end
+
+    def profile_website(w=nil)
+      if w.nil?
+        bot.profile_website
+      else
+        bot.profile_website(w)
+      end
+    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
     def bot
+      puts @bot.inspect
       return @bot unless @bot.nil?
 
+      
       #
       # parse any command-line options and use them to initialize the bot
       #
       params = {}
 
+      #:nocov:
       opts = OptionParser.new
 
       opts.banner = "Usage: #{File.basename($0)} [options]"
@@ -81,6 +125,7 @@ module Chatterbot
       opts.separator ""
       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 }
@@ -92,15 +137,47 @@ module Chatterbot
         params[:debug_mode] = true
         params[:reset_since_id] = true
       }
+      opts.on('--profile [ARG]', "get/set your bot's profile text") { |p| 
+        @handle_profile_text = true
+        @profile_text = p
+      }
+      opts.on('--website [ARG]', "get/set your bot's profile URL") { |u| 
+        @handle_profile_website = true
+        @profile_website = u
+      }
 
+      
       opts.on_tail("-h", "--help", "Show this message") do
         puts opts
         exit
       end
 
       opts.parse!(ARGV)
+      #:nocov:
 
       @bot = Chatterbot::Bot.new(params)
+
+      if @handle_profile_text == true
+        if !@profile_text.nil?
+          @bot.profile_text @profile_text
+        else
+          puts @bot.profile_text
+        end
+      end
+
+      if @handle_profile_website == true
+        if !@profile_website.nil?
+          @bot.profile_website @profile_website
+        else
+          puts @bot.profile_website
+        end
+      end
+
+      if @handle_profile_website == true || @handle_profile_text == true
+        exit
+      end
+
+      @bot
     end
 
     #
@@ -157,6 +234,26 @@ module Chatterbot
     def followers(opts={})
       bot.followers(opts)
     end
+
+    #
+    # follow a user
+    #
+    # @param u a Twitter::User or user id
+    def follow(u)
+      bot.follow(u)
+    end
+
+    
+    #
+    # a common list of bad words, which you might want to filter out.
+    # lifted from https://github.com/dariusk/wordfilter/blob/master/lib/badwords.json
+    #
+    def bad_words
+      ["skank", "wetback", "bitch", "cunt", "dick", "douchebag", "dyke", "fag", "nigger", "tranny", "trannies",
+       "paki", "pussy", "retard", "slut", "titt", "tits", "wop", "whore", "chink", "fatass", "shemale", "daygo",
+       "dego", "dago", "gook", "kike", "kraut", "spic", "twat", "lesbo", "homo", "fatso", "lardass", "jap",
+       "biatch", "tard", "gimp", "gyp", "chinaman", "chinamen", "golliwog", "crip", "raghead" ]     
+    end
     
     #
     # specify list of strings we will check when deciding to respond
@@ -187,25 +284,42 @@ module Chatterbot
       bot.config[:since_id]
     end
 
+    #
+    # set the consumer secret
+    # @param s [String] the consumer secret
     def consumer_secret(s)
       bot.config[:consumer_secret] = s
     end
 
+    #
+    # set the consumer key
+    # @param k [String] the consumer key
     def consumer_key(k)
       bot.config[:consumer_key] = k
     end
 
+    #
+    # set the secret
+    # @param s [String] the secret
     def secret(s)
       bot.config[:secret] = s
     end
+
+    #
+    # set the token
+    # @param s [String] the token
     def token(s)
       bot.config[:token] = s
     end
 
+    #
+    # get the id of the last tweet the bot replied to
+    # @return tweet id
     def since_id_reply
       bot.config[:since_id_reply]
     end
 
+    
     #
     # explicitly save the configuration/state of the bot.
     #