chatterbot 2.0.2 → 2.2.0

data/lib/chatterbot/ui.rb

@@ -13,7 +13,6 @@ module Chatterbot
       puts str.colorize(:red)
     end
 
-    #:nocov:
     def green(str)
       puts str.colorize(:green)
     end

data/lib/chatterbot/version.rb

@@ -1,3 +1,3 @@
 module Chatterbot
-  VERSION = "2.0.2"
+  VERSION = "2.2.0"
 end

data/spec/bot_spec.rb

@@ -5,88 +5,13 @@ describe "Chatterbot::Bot" do
     @bot = Chatterbot::Bot.new
   end
 
-  describe "Streaming API" do
-    it "should call streaming_client.user" do
-      expect(@bot.streaming_client).to receive(:user)
-      @bot.stream!
-    end
-  end
 
   describe "REST API" do
     it "should work" do
       allow(@bot).to receive(:require_login).and_return(false)
       allow(@bot).to receive(:client).and_return(fake_home_timeline(3))
       @bot.register_handler(:home_timeline) {}
-      #@bot.run!
-    end
-  end
-
-  describe "run_or_stream" do
-    it "should use streaming if specified" do
-      expect(@bot).to receive(:stream!)
-      @bot.streaming = true
-      @bot.run_or_stream
-    end
-
-    it "should use streaming if required by handler" do
-      expect(@bot).to receive(:stream!)
-      @bot.register_handler(:deleted) {}
-      @bot.run_or_stream
-    end
-
-    it "should use REST if specified" do
-      expect(@bot).to receive(:run!)
-      @bot.run_or_stream
-    end
-  end
-
-
-  
-  describe "stream!" do
-    before(:each) do
-      @bot.streaming = true
-      @sc = double(Twitter::Client)
-      expect(@bot).to receive(:streaming_client).and_return(@sc)
-    end
-
-    it "tweaks settings for searches" do
-      @bot.register_handler(:search, "hello") {}
-      expect(@sc).to receive(:filter)
-      @bot.stream!
-    end
-
-    it "calls :user for non-searches" do
-      @bot.register_handler(:home_timeline) {}
-      expect(@sc).to receive(:user)
-
-      @bot.stream!
+      @bot.run!
     end
   end
-  
-  describe "streamify_search_options" do
-    it "works with string" do
-      expect( @bot.streamify_search_options("hello there") ).
-        to eql({track:"hello there"})
-
-
-      expect( @bot.streamify_search_options("hello there, friend") ).
-        to eql({track:"hello there, friend"})
-    end
-
-    it "works with array" do
-      expect( @bot.streamify_search_options(["hello there"]) ).
-        to eql({track:"hello there"})
-
-      expect( @bot.streamify_search_options(["hello there", "friend"]) ).
-        to eql({track:"hello there, friend"})
-    end
-
-    it "works with hash" do
-      opts = {filter:"hello"}
-      expect( @bot.streamify_search_options(opts) ).
-        to eql(opts)
-
-    end
-  end
-
 end

data/spec/client_spec.rb

@@ -8,9 +8,6 @@ describe "Chatterbot::Client" do
   it "should initialize client" do
     expect(@bot.client).to be_a(Twitter::REST::Client)
   end
-  it "should initialize streaming client" do
-    expect(@bot.streaming_client).to be_a(Twitter::Streaming::Client)
-  end
 
   describe "reset!" do
     it "should reset a bunch of stuff" do

data/spec/config_manager_spec.rb

@@ -1,11 +1,16 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 require 'tempfile'
+require 'tmpdir'
+
 
 describe "Chatterbot::ConfigManager" do
   before(:each) do
-    @tmp_config_dest = "/tmp/bot.yml"
+    tempdir = Dir.tmpdir
+
+    @tmp_config_dest = File.join(tempdir, 'bot.yml')
     @config = Chatterbot::ConfigManager.new(@tmp_config_dest, {:consumer_key => "bar"})
   end
+
   after(:each) do
     if File.exist?(@tmp_config_dest)
       File.unlink(@tmp_config_dest)
@@ -17,10 +22,6 @@ describe "Chatterbot::ConfigManager" do
       expect(@config.delete(:baz)).to be_nil
     end
 
-    it "works with missing key" do
-
-    end
-
     it "retains read-only data" do
       expect(@config[:consumer_key]).to eql("bar")
       expect(@config.delete(:consumer_key)).to be_nil

data/spec/config_spec.rb

@@ -1,12 +1,15 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 require 'tempfile'
+require 'tmpdir'
 
 describe "Chatterbot::Config" do
   before(:each) do
     @bot = Chatterbot::Bot.new
-    @tmp_config_dest = "/tmp/bot.yml"
+    tempdir = Dir.tmpdir
+    @tmp_config_dest = File.join(tempdir, 'bot.yml')
     allow(@bot).to receive(:config_file).and_return(@tmp_config_dest)
   end
+
   after(:each) do
     if File.exist?(@tmp_config_dest)
       File.unlink(@tmp_config_dest)

data/spec/dsl_spec.rb

@@ -100,7 +100,7 @@ describe "Chatterbot::DSL" do
 
     describe "search" do
       it "passes along to bot object" do
-        allow(@bot).to receive(:run_or_stream)
+        allow(@bot).to receive(:run!)
         expect(@bot).to receive(:register_handler).with(:search, ["foo"])
         search("foo") {}
       end
@@ -118,39 +118,7 @@ describe "Chatterbot::DSL" do
       end
     end
 
-    describe "favorited" do
-      it "passes along to bot object" do
-        expect(@bot).to receive(:register_handler).with(:favorited, instance_of(Proc))
-
-        favorited {}
-      end
-    end
-
-    describe "followed" do
-      it "passes along to bot object" do
-        expect(@bot).to receive(:register_handler).with(:followed, instance_of(Proc))
-
-        followed {}
-      end
-    end
-
-    describe "deleted" do
-      it "passes along to bot object" do
-        expect(@bot).to receive(:register_handler).with(:deleted, instance_of(Proc))
-
-        deleted {}
-      end
-    end
-
    
-    describe "streaming" do
-      it "passes along to bot object" do
-        expect(@bot).to receive(:streaming=).with(true)
-        use_streaming
-      end
-    end
-
-    
     it "#retweet passes along to bot object" do
       expect(@bot).to receive(:retweet).with(1234)
       retweet(1234)
@@ -187,10 +155,17 @@ describe "Chatterbot::DSL" do
     end
 
     it "#reply passes along to bot object" do
-      expect(@bot).to receive(:reply).with("hello sailor!", { :source => "source "})
-      reply "hello sailor!", { :source => "source "}
+      source = double(Twitter::Tweet)
+      expect(@bot).to receive(:reply).with("hello sailor!", source, {})
+      reply "hello sailor!", source
     end
 
+    it "#reply passes along to bot object with media" do
+      source = double(Twitter::Tweet)
+      expect(@bot).to receive(:reply).with("hello sailor!", source, {media:"/tmp/foo.jpg"})
+      reply "hello sailor!", source, media:"/tmp/foo.jpg"
+    end
+    
     describe "#direct_message" do
       it "passes along to bot object" do
         expect(@bot).to receive(:direct_message).with("hello sailor!", nil)

data/spec/search_spec.rb

@@ -7,7 +7,6 @@ describe "Chatterbot::Search" do
     bot.search("foo")
   end
  
-
   it "calls update_since_id" do
     bot = test_bot
     
@@ -32,6 +31,46 @@ describe "Chatterbot::Search" do
     bot.search(["foo", "bar"])
   end
 
+  it "encloses search queries in quotes" do
+    bot = test_bot
+
+    allow(bot).to receive(:client).and_return(fake_search(100, 1))
+    expect(bot.client).to receive(:search).
+                           with("\"foo bar baz\"", {
+                                  :result_type=>"recent",
+                                  :since_id => 1,
+                                  :since_id_reply => 1
+                                })
+    
+    bot.search("foo bar baz")
+  end
+
+  it "doesn't enclose search queries in quotes if not exact" do
+    bot = test_bot
+
+    allow(bot).to receive(:client).and_return(fake_search(100, 1))
+    expect(bot.client).to receive(:search).
+                           with("foo bar baz", {
+                                  :result_type=>"recent",
+                                  :since_id => 1,
+                                  :since_id_reply => 1
+                                })
+    
+    bot.search("foo bar baz", exact:false)
+  end
+  
+  it "passes along since_id" do
+    bot = test_bot
+    allow(bot).to receive(:since_id).and_return(123)
+    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", {:since_id => 123, :result_type => "recent", :since_id_reply => 456})
+
+    bot.search("foo")
+  end
+
+  
   it "accepts extra params" do
     bot = test_bot
 

data/spec/spec_helper.rb

@@ -2,10 +2,7 @@
 require 'simplecov'
 SimpleCov.start
 
-require 'bundler/setup'
-Bundler.require
-
-require "twitter"
+require "chatterbot"
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.

data/spec/tweet_spec.rb

@@ -11,29 +11,48 @@ describe "Chatterbot::Tweet" do
       @bot.tweet "tweet test!"
     end
 
-    it "calls client.update with the right values" do
-      bot = test_bot
+    context "when authenticated" do
+      let(:bot) { test_bot }
+      before(:each) do
+        expect(bot).to receive(:require_login).and_return(true)
+        allow(bot).to receive(:client).and_return(double(Twitter::Client))
+      end
+      
+      it "calls client.update with the right values" do
+        allow(bot).to receive(:debug_mode?).and_return(false)
 
-      expect(bot).to receive(:require_login).and_return(true)
-      allow(bot).to receive(:client).and_return(double(Twitter::Client))
+        test_str = "test!"
+        expect(bot.client).to receive(:update).with(test_str, {})
+        bot.tweet test_str
+      end
 
-      allow(bot).to receive(:debug_mode?).and_return(false)
+      it "calls client.update_with_media if media file is specified" do
+        allow(bot).to receive(:debug_mode?).and_return(false)
 
-      test_str = "test!"
-      expect(bot.client).to receive(:update).with(test_str, {})
-      bot.tweet test_str
-    end
+        test_str = "test!"
+        path = File.join(File.dirname(__FILE__), "fixtures", "update_with_media.png")
+        media = File.new(path)
+        expect(bot.client).to receive(:update_with_media).with(test_str, media, {})
+        bot.tweet test_str, media:media
+      end
 
-    it "doesn't tweet when debug_mode? is set" do
-      bot = test_bot
-      
-      expect(bot).to receive(:require_login).and_return(true)
-      allow(bot).to receive(:client).and_return(double(Twitter::Client))
+      it "calls client.update_with_media if media file path is specified" do
+        allow(bot).to receive(:debug_mode?).and_return(false)
 
-      allow(bot).to receive(:debug_mode?).and_return(true)
+        test_str = "test!"
+        path = File.join(File.dirname(__FILE__), "fixtures", "update_with_media.png")
 
-      expect(bot.client).not_to receive(:update)
-      bot.tweet "no tweet!"
+        expect(bot.client).to receive(:update_with_media).with(test_str, an_instance_of(File), {})
+        bot.tweet test_str, media:path
+      end
+
+      
+      it "doesn't tweet when debug_mode? is set" do
+        allow(bot).to receive(:debug_mode?).and_return(true)
+
+        expect(bot.client).not_to receive(:update)
+        bot.tweet "no tweet!"
+      end
     end
   end
 
@@ -44,30 +63,51 @@ describe "Chatterbot::Tweet" do
       bot.reply "reply test!", fake_tweet(100)
     end
 
-    it "calls client.update with the right values" do
-      bot = test_bot
-      expect(bot).to receive(:require_login).and_return(true)
-      allow(bot).to receive(:client).and_return(double(Twitter::Client))
+    context "when authenticated" do
+      let(:bot) { test_bot }
+      before(:each) do
+        expect(bot).to receive(:require_login).and_return(true)
+        allow(bot).to receive(:client).and_return(double(Twitter::Client))
+      end
 
-      allow(bot).to receive(:debug_mode?).and_return(false)
+      
+      it "calls client.update with the right values" do
+        allow(bot).to receive(:debug_mode?).and_return(false)
 
-      test_str = "test!"
+        test_str = "test!"
 
-      expect(bot.client).to receive(:update).with(test_str, {:in_reply_to_status_id => 100})
-      bot.reply test_str, fake_tweet(100, 100)
-    end
+        expect(bot.client).to receive(:update).with(test_str, {:in_reply_to_status_id => 100})
+        bot.reply test_str, fake_tweet(100, 100)
+      end
 
+      it "calls client.update_with_media if media file is specified" do
+        allow(bot).to receive(:debug_mode?).and_return(false)
 
-    it "doesn't reply when debug_mode? is set" do
-      bot = test_bot
-      expect(bot).to receive(:require_login).and_return(true)
-      allow(bot).to receive(:client).and_return(double(Twitter::Client))
+        test_str = "test!"
+        path = File.join(File.dirname(__FILE__), "fixtures", "update_with_media.png")
+        media = File.new(path)
+
+        expect(bot.client).to receive(:update_with_media).with(test_str, media, {:in_reply_to_status_id => 100})
+        bot.reply test_str, fake_tweet(100, 100), media:media
+      end
 
-      allow(bot).to receive(:debug_mode?).and_return(true)
+      it "calls client.update_with_media if media file path is specified" do
+        allow(bot).to receive(:debug_mode?).and_return(false)
 
-      expect(bot.client).not_to receive(:update)
-      bot.reply "no reply test!", fake_tweet(100)
+        test_str = "test!"
+        path = File.join(File.dirname(__FILE__), "fixtures", "update_with_media.png")
+
+        expect(bot.client).to receive(:update_with_media).with(test_str, an_instance_of(File), {:in_reply_to_status_id => 100})
+        bot.reply test_str, fake_tweet(100, 100), media:path
+      end
+
+      it "doesn't reply when debug_mode? is set" do
+        allow(bot).to receive(:debug_mode?).and_return(true)
+
+        expect(bot.client).not_to receive(:update_with_media)
+        bot.reply "no reply test!", fake_tweet(100)
+      end
     end
   end
-
+  
 end

data/templates/skeleton.txt

@@ -94,14 +94,6 @@ exclude bad_words
 # will be rejected
 only_interact_with_followers
 
-#
-# Specifying 'use_streaming' will cause Chatterbot to use Twitter's
-# Streaming API. Your bot will run constantly, listening for tweets.
-# Alternatively, you can run your bot as a cron/scheduled job. In that
-# case, do not use this line. Every time you run your bot, it will
-# execute once, and then exit.
-#
-use_streaming
 
 #
 # Here's the fun stuff!
@@ -148,43 +140,4 @@ use_streaming
 # home_timeline do |tweet|
 #  puts tweet.inspect
 # end
-
-#
-# Use this block if you want to be notified about new followers of
-# your bot. You might do this to follow the user back.
-#
-# NOTE: This block only works with the Streaming API. If you use it,
-# chatterbot will assume you want to use streaming and will
-# automatically activate it for you.
-#
-# followed do |user|
-#  puts user.inspect
-# end
-
-#
-# Use this block if you want to be notified when one of your tweets is
-# favorited. The object passed in will be a Twitter::Streaming::Event
-# @see http://www.rubydoc.info/gems/twitter/Twitter/Streaming/Event
-#
-# NOTE: This block only works with the Streaming API. If you use it,
-# chatterbot will assume you want to use streaming and will
-# automatically activate it for you.
-#
-# favorited do |event|
-#  puts event.inspect
-# end
-
-#
-# Use this block if you want to be notified of deleted tweets from
-# your bots home timeline. The object passed in will be a
-# Twitter::Streaming::DeletedTweet
-# @see http://www.rubydoc.info/gems/twitter/Twitter/Streaming/DeletedTweet
-#
-# NOTE: This block only works with the Streaming API. If you use it,
-# chatterbot will assume you want to use streaming and will
-# automatically activate it for you.
-#
-#deleted do |tweet|
-#
-#end