chatterbot 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb0d7e5550a5496c33802ec97967e13ece9adc70
-  data.tar.gz: be65c23352fb603a2ff7694cdfeb5221f9ccfc9c
+  metadata.gz: 6fbc2531f820dba19fb0a7a8a42d167608e0c6ed
+  data.tar.gz: 940c107b1d1a3e625dd6a95dcb0a289b7833bd49
 SHA512:
-  metadata.gz: 29c0d716108c6e654aab1aaf6f06daa46f5f934c0b090d2322ae0f5a12fa895067ff269b31e372b0b0f9c80d17510a76be50749590198613716ae6878a4937c9
-  data.tar.gz: d4377d0133715d08adf1a93f28b4f8e0453e06e27ca5b78f56eb5fc2311be711a42b77e6123b28005b110d7fbd462d5cdf01ab4066da6a3e3739d860bf342e21
+  metadata.gz: 8e8c77f2a0d9a9353e9bc7823b0bdcf7d61c6b7c3a8b7000b33314712c8aa9fbd78cee2f97ba17cb9c7a5ec4528c863c50d6e021a8b97bc87c73a6ab5cfffa30
+  data.tar.gz: 1abb9ed9e3500ff31b784f42028c8213be682d01292847928bf3e73fa51c85dc2f6fa921dac608bd803f9bfdee4ac0625c23e258c74286260387a81f0185e71b

data/LICENSE.txt

@@ -1,17 +1,13 @@
-DO WHAT THE FUCK YOU WANT TO -- BUT DON'T BE AN ASSHOLE PUBLIC LICENSE
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                    Version 2, December 2004
 
-   Version 1, May 2011
-
-Copyright (C) 2011 Colin Mitchell <colin@muffinlabs.com>
-Derived from WTFPL, Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+ Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
 
  Everyone is permitted to copy and distribute verbatim or modified
  copies of this license document, and changing it is allowed as long
  as the name is changed.
 
- DO WHAT THE FUCK YOU WANT TO -- BUT DON'T BE AN ASSHOLE PUBLIC LICENSE
- TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 
   0. You just DO WHAT THE FUCK YOU WANT TO.
-  1. Don't be an asshole. Really.
-

data/README.markdown

@@ -1,38 +1,32 @@
 Chatterbot
 ===========
 
-Chatterbot is a Ruby library for making bots on Twitter.  It is basic
-enough that you can put it into use quickly, but can be used to make
-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.
+Chatterbot is a Ruby library for making bots on Twitter.  It's
+great for rapid development of bot ideas. It handles all of the basic
+Twitter API features -- searches, replies, tweets, retweets, etc. and has
+a simple blacklist/whitelist system to help minimize spam and unwanted
+data.
 
 [![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.
 * Handles search queries and replies to your bot
-* Use a simple DSL, or extend a Bot class if you need it
+* Use a simple scripting language, or extend a Bot class if you need it
+* Wraps the Twitter gem so you have access to the entire Twitter API
 * Simple blacklistling system to limit your annoyance of users
+* Avoid your bot making a fool of itself by ignoring tweets with
+  certain bad words
+* Basic Streaming API support
 * 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
 ================
 
+**NEW!!** Chatterbot has a [documentation website](http://muffinista.github.io/chatterbot/). It's a work-in-progress.
+
+
 Make a Twitter account
 ----------------------
 
@@ -50,23 +44,39 @@ actual bot.
 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
-[@dr_rumack](http://twitter.com/#!/Dr_Rumack), an actual bot running
-on Twitter:
+A bot using chatterbot can be as simple as this:
 
-    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
+```
+exclude "http://"
+blacklist "mean_user, private_user"
 
-Or, you can create a bot object yourself, extend it if needed, and use it like so:
+puts "checking my timeline"
+home_timeline do |tweet|
+    # i like to favorite things
+    favorite tweet
+end
+
+puts "checking for replies to my tweets and mentions of me"
+replies do |tweet|
+  text = tweet.text
+  puts "message received: #{text}"
+  src = text.gsub(/@echoes_bot/, "#USER#")  
+
+  # send it back!
+  reply src, tweet
+end
+```
+
+Or you can write a bot using more traditional ruby classes, 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
 
+Chatterbot can actually generate a template bot file for you, and will
+walk you through process of getting a bot authorized with Twitter.
+
 That's it!
 
 Chatterbot uses the the Twitter gem
@@ -93,6 +103,12 @@ Here's a list of the important methods in the Chatterbot DSL:
 
 Note that the string #USER# will be replaced with the username of the person who sent the original tweet.
 
+**home_timeline** -- This call will return tweets from the bot's home timeline -- this will include tweets from accounts the bot follows, as well as the bot's own tweets:
+    home_timeline do |tweet|
+      puts tweet.text # this is the actual tweeted text
+      favorite tweet # i like to fave tweets
+    end
+
 **tweet** -- send a Tweet out for this bot:
 
     tweet "I AM A BOT!!!"
@@ -314,13 +330,8 @@ sense if requested.
 Copyright/License
 -----------------
 
-Copyright (c) 2013 Colin Mitchell. Chatterbot is distributed under a
-modified WTFPL licence -- it's the 'Do what the fuck you want to --
-but don't be an asshole' public license.  Please see LICENSE.txt for
-further details. Basically, do whatever you want with this code, but
-don't be an asshole about it.  If you spam users inappropriately,
-expect your karma to suffer.
-
+Copyright (c) 2014 Colin Mitchell. Chatterbot is distributed under the
+WTFPL licence -- Please see LICENSE.txt for further details.
 
 http://muffinlabs.com
 

data/chatterbot.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  s.licenses = ["WTFDBAL"]
+  s.licenses = ["WTFPL"]
 
   if RUBY_VERSION < "1.9" || RUBY_VERSION == "1.9.2"
     s.add_dependency "activesupport", "~> 3.0.11"
@@ -30,7 +30,8 @@ Gem::Specification.new do |s|
 
   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_runtime_dependency(%q<launchy>, [">= 2.4.2"])
+  s.add_runtime_dependency(%q<colorize>, [">= 0.7.3"])
   s.add_development_dependency(%q<yard>, [">= 0"])
   s.add_development_dependency(%q<shoulda>, [">= 0"])
   s.add_development_dependency(%q<rake>, [">= 0"])

data/lib/chatterbot.rb

@@ -2,6 +2,7 @@ require 'yaml'
 require 'oauth'
 require 'twitter'
 require 'launchy'
+require 'colorize'
 
 #
 # Try and load Sequel, but don't freak out if it's not there
@@ -46,6 +47,7 @@ module Chatterbot
     require "chatterbot/favorite"
     require "chatterbot/profile"
     require "chatterbot/reply"
+    require "chatterbot/home_timeline"
     require "chatterbot/streaming"
     require "chatterbot/streaming_handler"
     require "chatterbot/followers"

data/lib/chatterbot/bot.rb

@@ -10,6 +10,7 @@ module Chatterbot
     include Config
     include Logging
     include Search
+    include HomeTimeline
     include Tweet
     include Profile
     include Retweet

data/lib/chatterbot/config.rb

@@ -6,6 +6,7 @@ module Chatterbot
     attr_accessor :config
 
     MAX_TWEET_ID = 9223372036854775807
+    COMMAND_LINE_VARIABLES = [:debug_mode, :no_update, :verbose, :reset_since_id]
 
     #
     # the entire config for the bot, loaded from YAML files and the DB if applicable
@@ -273,7 +274,7 @@ module Chatterbot
       return {} if db.nil?
       db[:config][:id => botname]
     end
-
+    
     #
     # figure out what we should save to the local config file.  we don't
     # save anything that exists in the global config, unless it's been modified
@@ -283,10 +284,9 @@ module Chatterbot
       tmp = config.delete_if { |k, v| global_config.has_key?(k) && global_config[k] == config[k] }
 
       # let's not store these, they're just command-line options
-      tmp.delete(:debug_mode)
-      tmp.delete(:no_update)
-      tmp.delete(:verbose)      
-
+      COMMAND_LINE_VARIABLES.each { |k|
+        tmp.delete(k)
+      }
       
       # update the since_id now
       tmp[:since_id] = tmp.delete(:tmp_since_id) unless ! tmp.has_key?(:tmp_since_id)

data/lib/chatterbot/dsl.rb

@@ -14,6 +14,13 @@ module Chatterbot
     #
     # search twitter for the specified terms, then pass any matches to
     # the block.
+    # @param opts [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
+    # There is one extra argument:
+    # @option options [Integer] :limit limit the number of tweets to
+    # return per search
+
     # @example
     #   search("chatterbot is cool!") do |tweet|
     #     puts tweet.text # this is the actual tweeted text
@@ -23,6 +30,19 @@ module Chatterbot
       bot.search(query, opts, &block)
     end
 
+    #
+    # handle tweets that are on the bot's home timeline. this includes
+    # tweets from accounts the bot is following, as well as its own tweets
+    #
+    # @example
+    #   home_timeline do |tweet|
+    #     puts tweet.text # this is the actual tweeted text
+    #     favorite tweet # i like to fave tweets
+    #   end
+    def home_timeline(opts = {}, &block)
+      bot.home_timeline(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
@@ -87,6 +107,10 @@ module Chatterbot
       bot.reply(txt, source)
     end
 
+    #
+    # handle getting/setting the profile text.
+    # @param [p] p The new value for the profile. If this isn't passed in, the method will simply return the current value
+    # @return profile text
     def profile_text(p=nil)
       if p.nil?
         bot.profile_text
@@ -95,6 +119,10 @@ module Chatterbot
       end
     end
 
+    #
+    # handle getting/setting the profile website
+    # @param [p] p The new value for the website. If this isn't passed in, the method will simply return the current value
+    # @return profile website
     def profile_website(w=nil)
       if w.nil?
         bot.profile_website

data/lib/chatterbot/home_timeline.rb

@@ -0,0 +1,33 @@
+module Chatterbot
+
+  #
+  # methods for checking the bots timeline
+  module HomeTimeline
+
+    # handle the bots timeline
+    def home_timeline(opts={}, &block)
+      return unless require_login
+
+      debug "check for home_timeline tweets since #{since_id}"
+
+      opts = {
+        :since_id => since_id,
+        :count => 200
+      }.merge(opts)
+
+      results = client.home_timeline(opts)
+
+      @current_tweet = nil
+      results.each { |s|
+        update_since_id(s)
+        if has_whitelist? && !on_whitelist?(s)
+          debug "skipping because user not on whitelist"
+        elsif block_given? && !on_blacklist?(s) && !skip_me?(s)
+          @current_tweet = s
+          yield s         
+        end
+      }
+      @current_tweet = nil
+    end
+  end
+end

data/lib/chatterbot/reply.rb

@@ -1,7 +1,7 @@
 module Chatterbot
 
   #
-  # reply method for responding to tweets
+  # handle checking for mentions of the bot
   module Reply
 
     # handle replies for the bot

data/lib/chatterbot/search.rb

@@ -4,6 +4,8 @@ module Chatterbot
   # handle Twitter searches
   module Search
 
+    MAX_SEARCH_TWEETS = 1000
+    
     @skip_retweets = true
     
     #
@@ -25,21 +27,20 @@ module Chatterbot
     def search(queries, opts = {}, &block)
       debug "check for tweets since #{since_id}"
 
+      max_tweets = opts.delete(:limit) || MAX_SEARCH_TWEETS
+      
       if queries.is_a?(String)
         queries = [queries]
       end
 
-      
       #
       # search twitter
       #
       queries.each { |query|
         debug "search: #{query} #{default_opts.merge(opts)}"
-        result = client.search( query, default_opts.merge(opts) )
-        update_since_id(result)
-
         @current_tweet = nil
-        result.each { |s|
+        client.search( query, default_opts.merge(opts) ).take(max_tweets).each { |s|
+          update_since_id(s)
           debug s.text
           if has_whitelist? && !on_whitelist?(s)
             debug "skipping because user not on whitelist"

data/lib/chatterbot/ui.rb

@@ -5,17 +5,28 @@ module Chatterbot
   #
   module UI
 
+    API_SIGNUP_URL = "https://twitter.com/apps/new"
+
+    
+    def red(str)
+      puts str.colorize(:red)
+    end
+
+    def green(str)
+      puts str.colorize(:green)
+    end
+    
     #
     # print out a message about getting a PIN from twitter, then output
     # the URL the user needs to visit to authorize
     #
     #:nocov:
     def get_oauth_verifier
-      puts "****************************************"
-      puts "****************************************"
-      puts "****        BOT AUTH TIME!          ****"
-      puts "****************************************"
-      puts "****************************************"      
+      green "****************************************"
+      green "****************************************"
+      green "****        BOT AUTH TIME!          ****"
+      green "****************************************"
+      green "****************************************"      
 
       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"
 
@@ -47,33 +58,32 @@ module Chatterbot
     #
     # Ask the user to get an API key from Twitter.
     def get_api_key
-      puts "****************************************"
-      puts "****************************************"
-      puts "****        API SETUP TIME!         ****"
-      puts "****************************************"
-      puts "****************************************"      
+      green "****************************************"
+      green "****************************************"
+      green "****        API SETUP TIME!         ****"
+      green "****************************************"
+      green "****************************************"      
 
-      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 "Please hit enter, and I will send you to #{API_SIGNUP_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)
+      Launchy.open(API_SIGNUP_URL)
       # pause to allow any launchy output
       sleep(1)
 
       puts "\n\n"
       
-      print "\n\nPaste the 'Consumer Key' here: "
+      print "\n\nPaste the 'API Key' here: "
       STDOUT.flush
       config[:consumer_key] = STDIN.readline.chomp
 
-      print "Paste the 'Consumer Secret' here: "
+      print "Paste the 'API Secret' here: "
       STDOUT.flush
       config[:consumer_secret] = STDIN.readline.chomp
 

data/lib/chatterbot/version.rb

@@ -1,3 +1,3 @@
 module Chatterbot
-  VERSION = "0.9.2"
+  VERSION = "0.9.3"
 end

data/spec/dsl_spec.rb

@@ -133,6 +133,11 @@ describe "Chatterbot::DSL" do
       expect(@bot).to receive(:replies)
       replies
     end
+    
+    it "#home_timeline passes along to bot object" do
+      expect(@bot).to receive(:home_timeline)
+      home_timeline
+    end
 
     it "#streaming_tweets passes along to bot object" do
       expect(@bot).to receive(:streaming_tweets)

data/spec/home_timeline_spec.rb

@@ -0,0 +1,53 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Chatterbot::HomeTimeline" do
+  it "calls require_login" do
+    bot = test_bot
+    expect(bot).to receive(:require_login).and_return(false)
+    bot.home_timeline
+  end
+
+  it "updates since_id when complete" do
+    bot = test_bot
+    expect(bot).to receive(:require_login).and_return(true)
+    results = fake_home_timeline(1, 1000)
+
+    allow(bot).to receive(:client).and_return(results)
+    
+    bot.home_timeline do
+    end
+
+    expect(bot.config[:tmp_since_id]).to eq(1000)
+  end
+
+  it "iterates results" do
+    bot = test_bot
+    expect(bot).to receive(:require_login).and_return(true)
+    allow(bot).to receive(:client).and_return(fake_home_timeline(3))
+    
+    expect(bot).to receive(:update_since_id).exactly(3).times
+
+    indexes = []
+    bot.home_timeline do |x|
+      indexes << x[:id]
+    end
+
+    expect(indexes).to eq([1,2,3])
+  end
+
+  it "checks blacklist" do
+    bot = test_bot
+    expect(bot).to receive(:require_login).and_return(true)
+    allow(bot).to receive(:client).and_return(fake_home_timeline(3))
+    
+    allow(bot).to receive(:on_blacklist?).and_return(true, false, false)
+
+
+    indexes = []
+    bot.home_timeline do |x|
+      indexes << x[:id]
+    end
+
+    expect(indexes).to eq([2,3])
+  end
+end

data/spec/search_spec.rb

@@ -13,7 +13,7 @@ describe "Chatterbot::Search" do
     
     data = fake_search(100, 1)
     allow(bot).to receive(:client).and_return(data)
-    expect(bot).to receive(:update_since_id).with(data.search)
+    expect(bot).to receive(:update_since_id).with(data.search[0])
     
     bot.search("foo")
   end
@@ -62,7 +62,7 @@ describe "Chatterbot::Search" do
     results = fake_search(1000, 1)
     allow(bot).to receive(:client).and_return(results)
     
-    expect(bot).to receive(:update_since_id).with(results.search)
+    expect(bot).to receive(:update_since_id).with(results.search[0])
     bot.search("foo")
   end
   

data/spec/spec_helper.rb

@@ -54,6 +54,12 @@ def fake_replies(result_count = 0, id_base = 0)
   c
 end
 
+def fake_home_timeline(result_count = 0, id_base = 0)
+  c = stubbable_client
+  allow(c).to receive_messages(:home_timeline => 1.upto(result_count).collect { |i| fake_tweet(i, id_base)})
+  c
+end
+
 def fake_followers(count)
   c = stubbable_client
   allow(c).to receive_messages(:followers => 1.upto(count).collect { |i| fake_follower(i) })

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chatterbot
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors:
 - Colin Mitchell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-28 00:00:00.000000000 Z
+date: 2014-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -58,14 +58,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.2
+        version: 2.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.2
+        version: 2.4.2
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.3
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -217,6 +231,7 @@ files:
 - lib/chatterbot/favorite.rb
 - lib/chatterbot/followers.rb
 - lib/chatterbot/helpers.rb
+- lib/chatterbot/home_timeline.rb
 - lib/chatterbot/logging.rb
 - lib/chatterbot/profile.rb
 - lib/chatterbot/reply.rb
@@ -239,6 +254,7 @@ files:
 - spec/favorite_spec.rb
 - spec/followers_spec.rb
 - spec/helpers_spec.rb
+- spec/home_timeline_spec.rb
 - spec/logging_spec.rb
 - spec/profile_spec.rb
 - spec/reply_spec.rb
@@ -255,7 +271,7 @@ files:
 - templates/skeleton.txt
 homepage: http://github.com/muffinista/chatterbot
 licenses:
-- WTFDBAL
+- WTFPL
 metadata: {}
 post_install_message: 
 rdoc_options: []