chatterbot 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d6048b3fe526c7dc7cdf2007b9f086ea9b84a41
-  data.tar.gz: 8fcae3ba935e6d6703dad6dcdee8ebbea139d268
+  metadata.gz: bb0d7e5550a5496c33802ec97967e13ece9adc70
+  data.tar.gz: be65c23352fb603a2ff7694cdfeb5221f9ccfc9c
 SHA512:
-  metadata.gz: c85326eb7f64cc05bfd670195a18855f4ee474a362226b0be3aa56ce91298542efe0afc30a74b1db12bee1bc5baa84226f8c349b899826f45d8a337e2a16609a
-  data.tar.gz: 8415e97f10e4b6900e7f07a9c50616803fe71623de6c10743171bb2965a197f58eaa1c83bd71fbc0101fb74c6c848655d81fd98ddf9feb41b2e1f809bc7ff9a1
+  metadata.gz: 29c0d716108c6e654aab1aaf6f06daa46f5f934c0b090d2322ae0f5a12fa895067ff269b31e372b0b0f9c80d17510a76be50749590198613716ae6878a4937c9
+  data.tar.gz: d4377d0133715d08adf1a93f28b4f8e0453e06e27ca5b78f56eb5fc2311be711a42b77e6123b28005b110d7fbd462d5cdf01ab4066da6a3e3739d860bf342e21

data/lib/chatterbot.rb

@@ -37,6 +37,7 @@ module Chatterbot
     require "chatterbot/db"
     require "chatterbot/logging"
     require "chatterbot/blacklist"
+    require "chatterbot/whitelist"
     require "chatterbot/ui"
     require "chatterbot/client"    
     require "chatterbot/search"

data/lib/chatterbot/bot.rb

@@ -5,6 +5,7 @@ module Chatterbot
   class Bot
     include Utils
     include Blacklist
+    include Whitelist
     include Streaming
     include Config
     include Logging

data/lib/chatterbot/config.rb

@@ -214,14 +214,13 @@ 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")
+      File.join(File.expand_path(dest), "#{botname}.yml")
     end
 
     #
     # load in a config file
     def slurp_file(f)
       f = File.expand_path(f)
-
       tmp = {}
 
       if File.exist?(f)

data/lib/chatterbot/dsl.rb

@@ -225,6 +225,29 @@ module Chatterbot
       end
     end
 
+    #
+    # specify a bot-specific whitelist of users.  accepts an array, or a
+    # comma-delimited string. when called, any subsequent calls to
+    # search or replies will only act upon these users.
+    #
+    # @param [Array, String] args list of usernames or Twitter::User objects
+    # @example
+    #   whitelist "mean_user, private_user"
+    #
+    def whitelist(*args)
+      list = flatten_list_of_strings(args)
+
+      if list.nil? || list.empty?
+        bot.whitelist = []
+      else
+        bot.whitelist += list
+      end
+    end
+
+    def only_interact_with_followers
+      whitelist followers
+    end
+    
     #
     # return a list of users following the bot. This passes directly
     # to the underlying Twitter API call

data/lib/chatterbot/reply.rb

@@ -22,7 +22,9 @@ module Chatterbot
       @current_tweet = nil
       results.each { |s|
         update_since_id_reply(s)
-        unless ! block_given? || on_blacklist?(s) || skip_me?(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

data/lib/chatterbot/search.rb

@@ -4,11 +4,21 @@ module Chatterbot
   # handle Twitter searches
   module Search
 
+    @skip_retweets = true
+    
     #
     # modify a query string to exclude retweets from searches
     #
-    def exclude_retweets(q)
-      q.include?("include:retweets") ? q : q += " -include:retweets"
+    def exclude_retweets
+      @skip_retweets = true
+    end
+
+    def include_retweets
+      @skip_retweets = false
+    end
+
+    def skippable_retweet?(t)
+      @skip_retweets && t.retweeted_status?
     end
     
     # internal search code
@@ -25,16 +35,15 @@ module Chatterbot
       #
       queries.each { |query|
         debug "search: #{query} #{default_opts.merge(opts)}"
-        result = client.search(
-                                      exclude_retweets(query),
-                                      default_opts.merge(opts)
-                                      )
+        result = client.search( query, default_opts.merge(opts) )
         update_since_id(result)
 
         @current_tweet = nil
         result.each { |s|
           debug s.text
-          if block_given? && !on_blacklist?(s) && !skip_me?(s)
+          if has_whitelist? && !on_whitelist?(s)
+            debug "skipping because user not on whitelist"
+          elsif block_given? && !on_blacklist?(s) && !skip_me?(s) && !skippable_retweet?(s)
             @current_tweet = s
             yield s
           end

data/lib/chatterbot/streaming.rb

@@ -31,7 +31,7 @@ module Chatterbot
       case object
       when Twitter::Tweet
         if object.user == authenticated_user
-          puts "skipping #{object} because it's from me"
+          debug "skipping #{object} because it's from me"
         elsif streamer.tweet_handler && !on_blacklist?(object) && !skip_me?(object)
           @current_tweet = object
           streamer.tweet_handler.call object
@@ -49,7 +49,7 @@ module Chatterbot
         end
       when Twitter::Streaming::Event
         if object.respond_to?(:source) && object.source == authenticated_user
-          puts "skipping #{object} because it's from me"
+          debug "skipping #{object} because it's from me"
         elsif object.name == :follow && streamer.follow_handler
           streamer.follow_handler.call(object.source)
         elsif object.name == :favorite && streamer.favorite_handler

data/lib/chatterbot/version.rb

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

data/lib/chatterbot/whitelist.rb

@@ -0,0 +1,32 @@
+module Chatterbot
+
+  #
+  # methods for only tweeting to users on a specific list
+  module Whitelist
+    attr_accessor :whitelist
+    
+    # A list of Twitter users that we can communicate with
+    def whitelist
+      @whitelist || []
+    end
+
+    def whitelist=(b)
+      @whitelist = b
+      @whitelist = @whitelist.flatten.collect { |e|
+        (e.is_a?(Twitter::User) ? from_user(e) : e).downcase
+      }
+      @whitelist
+    end
+
+    def has_whitelist?
+      !whitelist.empty?
+    end
+
+    #
+    # Is this tweet from a user on our whitelist?
+    def on_whitelist?(s)
+      search = (s.respond_to?(:user) ? from_user(s) : s).downcase
+      whitelist.any? { |b| search.include?(b.downcase) }
+    end
+  end
+end

data/spec/blacklist_spec.rb

@@ -10,7 +10,7 @@ describe "Chatterbot::Blacklist" do
   describe "skip_me?" do
     before(:each) do
       @bot = test_bot
-      allow(@bot).to receive(:exclude).and_return(["junk", "i hate bots", "foobar", "spam"])
+      @bot.exclude = ["junk", "i hate bots", "foobar", "spam"]
     end
 
     it "blocks tweets with phrases we don't want" do
@@ -34,7 +34,7 @@ describe "Chatterbot::Blacklist" do
   describe "on_blacklist?" do
     before(:each) do
       @bot = test_bot
-      allow(@bot).to receive(:blacklist).and_return(["skippy", "blippy", "dippy"])
+      @bot.blacklist = ["skippy", "blippy", "dippy"]
     end
 
     it "blocks users we don't want" do

data/spec/dsl_spec.rb

@@ -32,6 +32,33 @@ describe "Chatterbot::DSL" do
       end
     end
 
+    describe "whitelist" do
+      it "#whitelist passes along to bot object" do
+        expect(@bot).to receive(:whitelist=).with(["foo"])
+        whitelist ["foo"]
+      end
+
+      it "#whitelist turns single-string arg into an array" do
+        expect(@bot).to receive(:whitelist=).with(["foo"])
+        whitelist "foo"
+      end
+
+      it "#whitelist turns comma-delimited string arg into an array" do
+        expect(@bot).to receive(:whitelist=).with(["foo", "bar"])
+        whitelist "foo, bar"
+      end
+    end
+
+    describe "only_interact_with_followers" do
+      it "sets whitelist to be the bot's followers" do
+        f = fake_follower
+        allow(@bot).to receive(:followers).and_return([f])
+        expect(@bot).to receive(:whitelist=).with([f])
+        only_interact_with_followers
+      end
+    end
+
+    
     [:no_update, :debug_mode, :verbose].each do |method|
       describe method.to_s do
         it "#{method.to_s} with nil passes along true to bot object" do

data/spec/search_spec.rb

@@ -1,24 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "Chatterbot::Search" do
-  describe "exclude_retweets" do
-    before(:each) do
-      @bot = Chatterbot::Bot.new
-    end
-
-    it "should tack onto query" do
-      expect(@bot.exclude_retweets("foo")).to eq("foo -include:retweets")
-    end
-
-    it "shouldn't tack onto query" do
-      expect(@bot.exclude_retweets("foo -include:retweets")).to eq("foo -include:retweets")
-    end
-
-    it "shouldn't tack onto query" do
-      expect(@bot.exclude_retweets("foo include:retweets")).to eq("foo include:retweets")
-    end
-  end
-
   it "calls search" do
     bot = Chatterbot::Bot.new
     expect(bot).to receive(:search)
@@ -40,8 +22,8 @@ describe "Chatterbot::Search" do
     bot = test_bot
     
     allow(bot).to receive(:client).and_return(fake_search(100, 1))
-    expect(bot.client).to receive(:search).once.ordered.with("foo -include:retweets", {:result_type=>"recent"})
-    expect(bot.client).to receive(:search).once.ordered.with("bar -include:retweets", {:result_type=>"recent"})
+    expect(bot.client).to receive(:search).once.ordered.with("foo", {:result_type=>"recent"})
+    expect(bot.client).to receive(:search).once.ordered.with("bar", {:result_type=>"recent"})
 
     bot.search(["foo", "bar"])
   end
@@ -50,7 +32,7 @@ describe "Chatterbot::Search" do
     bot = test_bot
 
     allow(bot).to receive(:client).and_return(fake_search(100, 1))
-    expect(bot.client).to receive(:search).with("foo -include:retweets", {:lang => "en", :result_type=>"recent"})
+    expect(bot.client).to receive(:search).with("foo", {:lang => "en", :result_type=>"recent"})
 
     bot.search("foo", :lang => "en")
   end
@@ -59,7 +41,7 @@ describe "Chatterbot::Search" do
     bot = test_bot
 
     allow(bot).to receive(:client).and_return(fake_search(100, 1))
-    expect(bot.client).to receive(:search).with("foo -include:retweets", {:result_type=>"recent"})
+    expect(bot.client).to receive(:search).with("foo", {:result_type=>"recent"})
 
     bot.search("foo")
   end
@@ -70,7 +52,7 @@ describe "Chatterbot::Search" do
     allow(bot).to receive(:since_id_reply).and_return(456)
     
     allow(bot).to receive(:client).and_return(fake_search(100, 1))
-    expect(bot.client).to receive(:search).with("foo -include:retweets", {:since_id => 123, :result_type => "recent", :since_id_reply => 456})
+    expect(bot.client).to receive(:search).with("foo", {:since_id => 123, :result_type => "recent", :since_id_reply => 456})
 
     bot.search("foo")
   end

data/spec/whitelist_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Chatterbot::Whitelist" do
+  describe "on_whitelist?" do
+    before(:each) do
+      @bot = test_bot
+      @bot.whitelist = [fake_user('user', 100), "skippy", "blippy", "dippy"]
+    end
+
+    it "includes users we want" do
+      expect(@bot.on_whitelist?("user")).to eq(true)
+      expect(@bot.on_whitelist?("skippy")).to eq(true)
+    end
+
+    it "excludes users we don't want" do
+      expect(@bot.on_whitelist?("flippy")).to eq(false)
+    end
+
+    it "isn't case-specific" do
+      expect(@bot.on_whitelist?("FLIPPY")).to eq(false)
+      expect(@bot.on_whitelist?("SKIPPY")).to eq(true)
+    end
+
+    it "works with result hashes" do
+      expect(@bot.on_whitelist?(Twitter::Tweet.new(:id => 1,
+                                            :user => {:id => 1, :screen_name => "skippy"}))).to eq(true)
+      expect(@bot.on_whitelist?(Twitter::Tweet.new(:id => 1,
+                                            :user => {:id => 1, :screen_name => "flippy"}))).to eq(false)
+    end   
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chatterbot
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Colin Mitchell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-05 00:00:00.000000000 Z
+date: 2014-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -229,6 +229,7 @@ files:
 - lib/chatterbot/ui.rb
 - lib/chatterbot/utils.rb
 - lib/chatterbot/version.rb
+- lib/chatterbot/whitelist.rb
 - spec/blacklist_spec.rb
 - spec/bot_spec.rb
 - spec/client_spec.rb
@@ -249,6 +250,7 @@ files:
 - spec/streaming_spec.rb
 - spec/tweet_spec.rb
 - spec/utils_spec.rb
+- spec/whitelist_spec.rb
 - specs.watchr
 - templates/skeleton.txt
 homepage: http://github.com/muffinista/chatterbot