chatterbot 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd3b277547610b8d5e0ec0993a5952d015cab80b
-  data.tar.gz: 114e6d11f506a6bbb331081b66395613346e3a12
+  metadata.gz: 3d88eeab29e199d49fb99f081f90d483263c57d9
+  data.tar.gz: 92dbfd810dc21b7c638bc6ff22903194881734e3
 SHA512:
-  metadata.gz: 92c72bf9e9ab384e2a5a00756d78af0128998efd1dd7d1eba9ac069b8fe427042e5ea73aeed03e2ae9dd30a140833382f9e239090b6c835794fe9207073e6d98
-  data.tar.gz: 3d6c202746806977bd602b9ad2f196cec49ef4dd091582ce38711906b1e7ddb9fd93be34b517b6aadeb7492e024e07784c12c4002d74e0220247bd623616fea6
+  metadata.gz: f33ae22b7f5ebf4d3e774aa95a9761cb4ec8c8970e670ca89181fdf64507814d034fecd206fc52aa0469f3d6c4c854a69395be31a0de4fcde04bfc4f05f181c4
+  data.tar.gz: 5ab5abed1989ef5963b7d2b7b422b433cb7581aa7cd24ccbaee63fc07b9153aaaf9f3cf9c406ef46568844d4140c048402a0bc4e59dc82ebf0607e09e275b69d

data/README.markdown

@@ -79,8 +79,9 @@ Or you can write a bot using more traditional ruby classes, extend it if needed,
 ```
   class MyBot < Chatterbot::Bot
      def do_stuff
-       search("'surely you must be joking'") do |tweet|
-        reply "@#{tweet_user(tweet)} I am serious, and don't call me Shirley!", tweet
+       home_timeline do |tweet|
+         puts "I like to favorite things"
+         favorite tweet
        end
     end
   end

data/lib/chatterbot/bot.rb

@@ -85,7 +85,6 @@ module Chatterbot
         }
       end
 
-      
       streaming_client.send(method, args) do |object|
         handle_streaming_object(object)
       end

data/lib/chatterbot/dsl.rb

@@ -113,8 +113,13 @@ module Chatterbot
     # send a tweet
     #
     # @param [String] txt the text you want to tweet
-    # @param [Hash] params opts for the tweet
-    #   @see http://rdoc.info/gems/twitter/Twitter/API#update-instance_method
+    # @param [Hash] params options for the tweet. You can get an idea
+    #   of possible values you can send here from the underlying Twitter
+    #   gem docs: http://rdoc.info/gems/twitter/Twitter/API#update-instance_method
+    # @option params [String,File] :media Optional file object to send
+    #   with the tweet. Must be an image or video that will be accepted by
+    #   Twitter. You can pass a File object, or the path to a file
+    # @see http://rdoc.info/gems/twitter/Twitter/API#update-instance_method
     # @param [Tweet] original if this is a reply, the original tweet. this will
     #   be used for variable substitution, and for logging
     def tweet(txt, params = {}, original = nil)
@@ -141,8 +146,15 @@ module Chatterbot
     #
     # @param [String] txt the text you want to tweet
     # @param [Tweet] source the original tweet you are replying to
-    def reply(txt, source)
-      bot.reply(txt, source)
+    # @param [Hash] params options for the tweet. You can get an idea
+    #   of possible values you can send here from the underlying Twitter
+    #   gem docs: http://rdoc.info/gems/twitter/Twitter/API#update-instance_method
+    # @option params [String,File] :media Optional file object to send with the
+    #   tweet. Must be an image or video that will be accepted by
+    #   Twitter. You can pass a File object, or the path to a file
+    # @see http://rdoc.info/gems/twitter/Twitter/API#update-instance_method
+    def reply(txt, source, params={})
+      bot.reply(txt, source, params)
     end
 
     #

data/lib/chatterbot/tweet.rb

@@ -13,7 +13,16 @@ module Chatterbot
         debug "I'm in debug mode, otherwise I would tweet: #{txt}"
       else
         debug txt
-        client.update txt, params
+        if params.has_key?(:media)
+          file = params.delete(:media)
+          if ! file.is_a?(File)
+            file = File.new(file)
+          end
+
+          client.update_with_media txt, file, params
+        else
+          client.update txt, params
+        end
       end
     rescue Twitter::Error::Forbidden => e
       #:nocov:
@@ -24,9 +33,10 @@ module Chatterbot
 
     
     # reply to a tweet
-    def reply(txt, source)
+    def reply(txt, source, params = {})
       debug txt
-      tweet txt, {:in_reply_to_status_id => source.id}, source
+      params = {:in_reply_to_status_id => source.id}.merge(params)
+      tweet txt, params, source
     end
   end
 end

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.0.3"
 end

data/spec/dsl_spec.rb

@@ -187,10 +187,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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chatterbot
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Colin Mitchell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-10 00:00:00.000000000 Z
+date: 2016-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -249,6 +249,7 @@ files:
 - spec/direct_messages_spec.rb
 - spec/dsl_spec.rb
 - spec/favorite_spec.rb
+- spec/fixtures/update_with_media.png
 - spec/followers_spec.rb
 - spec/handler_spec.rb
 - spec/helpers_spec.rb
@@ -299,6 +300,7 @@ test_files:
 - spec/direct_messages_spec.rb
 - spec/dsl_spec.rb
 - spec/favorite_spec.rb
+- spec/fixtures/update_with_media.png
 - spec/followers_spec.rb
 - spec/handler_spec.rb
 - spec/helpers_spec.rb