chatterbot 2.0.0.pre → 2.1.0

data/lib/chatterbot/skeleton.rb

@@ -13,13 +13,11 @@ module Chatterbot
         path = File.join(Chatterbot.libdir, "..", "templates", "skeleton.txt")
         src = File.read(path)
 
-        opts = bot.config.merge({
+        opts = bot.config.to_h.merge({
           :name => bot.botname,
           :timestamp => Time.now
         })
 
-        puts opts.inspect
-        
         src % opts
       end
     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:
@@ -22,10 +31,12 @@ module Chatterbot
       #:nocov:
     end
 
+    
     # 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

@@ -5,7 +5,7 @@ module Chatterbot
   #
   module UI
     # Where to send users who need to get API keys
-    API_SIGNUP_URL = "https://twitter.com/apps/new"
+    API_SIGNUP_URL = "https://apps.twitter.com/app/new"
 
     
     #:nocov:
@@ -13,7 +13,6 @@ module Chatterbot
       puts str.colorize(:red)
     end
 
-    #:nocov:
     def green(str)
       puts str.colorize(:green)
     end
@@ -52,27 +51,35 @@ module Chatterbot
       # sleep here so that if launchy has any output (which it does
       # sometimes), it doesn't interfere with our input prompt
      
-      sleep(1)
+      sleep(2)
 
       puts "Paste your PIN and hit enter when you have completed authorization.\n\n"
       print "> "
 
-      STDIN.readline.chomp
+      STDIN.readline.chomp.strip
     rescue Interrupt => e
       exit
     end
 
-    #
-    # Ask the user to get an API key from Twitter.
-    def get_api_key
-      green "****************************************"
-      green "****************************************"
-      green "****        API SETUP TIME!         ****"
-      green "****************************************"
-      green "****************************************"      
+    def ask_yes_no(q)
+      prompt = "> "
+      response = ""
+
 
+      while ! ["y", "n"].include?(response)
+        puts "#{q} [Y/N]"
+        print prompt
+        response = $stdin.gets.chomp.downcase[0]
+      end
       
-      puts "Hey, looks like you need to get an API key from Twitter before you can get started."
+      if response == "y"
+        true
+      else
+        false
+      end
+    end
+
+    def send_to_app_creation
       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)"
 
@@ -81,21 +88,82 @@ module Chatterbot
       STDIN.readline
 
       Launchy.open(API_SIGNUP_URL)
+
       # pause to allow any launchy output
-      sleep(1)
+      sleep(2)
 
       puts "\n\n"
+
+
+      puts "Once you've filled out the app form, click on the 'Keys and Access Tokens' link"
+    end
+    
+    #
+    # Ask the user to get an API key from Twitter.
+    def get_api_key
+      
+      green "****************************************"
+      green "****************************************"
+      green "****        API SETUP TIME!         ****"
+      green "****************************************"
+      green "****************************************"      
+
+
+      puts "\n\nWelcome to Chatterbot. Let's walk through the steps to get a bot running.\n\n"
+
+
+      #
+      # At this point, we don't have any API credentials at all for
+      # this bot, but it's possible the user has already setup an app.
+      # Let's ask!
+      #
       
-      print "\n\nPaste the 'API Key' here: "
+      puts "Hey, looks like you need to get an API key from Twitter before you can get started.\n\n"
+      
+      app_already_exists = ask_yes_no("Have you already set up an app with Twitter?")
+
+      if app_already_exists
+        puts "Terrific! Let's get your bot running!\n\n"
+      else
+        puts "OK, I can help with that!\n\n"
+        send_to_app_creation
+      end
+
+      
+      print "\n\nPaste the 'Consumer Key' here: "
       STDOUT.flush
-      config[:consumer_key] = STDIN.readline.chomp
+      config[:consumer_key] = STDIN.readline.chomp.strip
 
-      print "Paste the 'API Secret' here: "
+      print "Paste the 'Consumer Secret' here: "
       STDOUT.flush
-      config[:consumer_secret] = STDIN.readline.chomp
+      config[:consumer_secret] = STDIN.readline.chomp.strip
+
 
-      # reset the client so we can re-init with new OAuth credentials
-      reset_client
+      puts "\n\nNow it's time to authorize your bot!\n\n"
+      
+      if ! app_already_exists && ask_yes_no("Do you want to authorize a bot using the account that created the app?")
+        puts "OK, on the app page, you can click the 'Create my access token' button to proceed.\n\n"
+
+        print "Paste the 'Access Token' here: "
+        STDOUT.flush
+        config[:access_token] = STDIN.readline.chomp.strip
+
+
+        print "\n\nPaste the 'Access Token Secret' here: "
+        STDOUT.flush
+        config[:access_token_secret] = STDIN.readline.chomp.strip
+
+      
+        # reset the client so we can re-init with new OAuth credentials
+        reset_client
+
+        # at this point we should have a fully validated client, so grab
+        # the screen name
+        @screen_name = client.user.screen_name rescue nil
+      else
+        reset_client
+      end
+        
       
       #
       # capture ctrl-c and exit without a stack trace

data/lib/chatterbot/version.rb

@@ -1,3 +1,3 @@
 module Chatterbot
-  VERSION = "2.0.0.pre"
+  VERSION = "2.1.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
-      expect(@bot).to receive(:require_login).and_return(true)
-      expect(@bot).to receive(:client).and_return(fake_home_timeline(3))
+      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
-      @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!
-    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
@@ -139,12 +136,11 @@ describe "Chatterbot::Client" do
         and_return(double(:token => "access_token", :secret => "access_secret"))
 
       expect(@bot).to receive(:get_screen_name)
-      expect(@bot).to receive(:update_config)
       
       @bot.login
 
-      expect(@bot.config[:token]).to eq("access_token")
-      expect(@bot.config[:secret]).to eq("access_secret")     
+      expect(@bot.config[:access_token]).to eq("access_token")
+      expect(@bot.config[:access_token_secret]).to eq("access_secret")     
     end
 
     it "handles errors" 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