chatterbot 2.0.5 → 2.1.0

data/docs/advanced.md

@@ -60,8 +60,3 @@ end
 See `Chatterbot::Logging` for details on this.
 
 
-Streaming
----------
-
-Chatterbot has basic support for Twitter's Streaming API. You can read
-more about it [here](streaming.html)

data/docs/deploying.md

@@ -45,9 +45,3 @@ end
 has processed -- if you don't have this call, you will get duplicate
 tweets.
 
-Streaming
----------
-
-Chatterbot has rough support for the Streaming API. If your bot can
-use it, it's a great option, because you get your data immediately.
-You can read more about setting up a bot to use [streaming](streaming.html).

data/docs/examples.md

@@ -118,51 +118,3 @@ tweet result
 ```
 
 
-Streaming Bot
---------------
-
-
-```
-#!/usr/bin/env ruby
-
-## This is a very simple working example of a bot using the streaming
-## API. It's basically a copy of echoes_bot.rb, just using streaming.
-
-#
-# require the dsl lib to include all the methods you see below.
-#
-require 'rubygems'
-require 'chatterbot/dsl'
-
-consumer_secret 'foo'
-secret 'bar'
-token 'biz'
-consumer_key 'bam'
-
-
-puts "Loading echoes_bot.rb using the streaming API"
-
-exclude "http://", "https://"
-
-blacklist "mean_user, private_user"
-
-streaming do
-  favorited do |user, tweet|
-    reply "@#{user.screen_name} thanks for the fave!", tweet
-  end
-
-  followed do |user|
-    tweet "@#{user.screen_name} just followed me!"
-    follow user
-  end
-
-  replies do |tweet|
-    favorite tweet
-
-    puts "It's a tweet!"
-    src = tweet.text.gsub(/@echoes_bot/, "#USER#")  
-    reply src, tweet
-  end
-end
-
-```

data/docs/index.md

@@ -49,7 +49,6 @@ Features
 * 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
 
 
@@ -62,9 +61,9 @@ calls. Any calls to the search/reply methods will return
 Copyright/License
 -----------------
 
-Copyright (c) 2014 Colin Mitchell. Chatterbot is distributed under the
-WTFPL license.
 
+Copyright (c) 2018 Colin Mitchell. Chatterbot is distributed under the
+MIT licence -- Please see LICENSE.txt for further details.
 
 http://muffinlabs.com
 

data/lib/chatterbot.rb

@@ -45,7 +45,6 @@ module Chatterbot
     require "chatterbot/followers"
     require "chatterbot/helpers"
     require "chatterbot/utils"
-    require "chatterbot/streaming"
 
     require "chatterbot/bot"
   end

data/lib/chatterbot/bot.rb

@@ -5,7 +5,6 @@ module Chatterbot
   # primary Bot object, includes all the other modules
   class Bot
     include Utils
-    include Streaming
     include Blocklist
     include Safelist
     include Config
@@ -26,9 +25,6 @@ module Chatterbot
     # handlers that can use the REST API
     HANDLER_CALLS = [:direct_messages, :home_timeline, :replies, :search]
 
-    # handlers that require the Streaming API
-    STREAMING_ONLY_HANDLERS = [:favorited, :followed, :deleted]
-    
     #
     # Create a new bot. No options for now.
     def initialize(params={})
@@ -46,7 +42,7 @@ module Chatterbot
 
       at_exit do
         if !@handlers.empty? && @run_count <= 0 && skip_run? != true
-          run_or_stream
+          run!
         end
         
         raise $! if $!
@@ -58,58 +54,6 @@ module Chatterbot
       @screen_name ||= client.settings.screen_name
     end
 
-    
-    #
-    # determine the right API to use and run the bot
-    #
-    def run_or_stream
-      @run_count += 1
-      if streaming?
-        stream!
-      else
-        run!
-      end
-    end
-
-    #
-    # run the bot with the Streaming API
-    #
-    def stream!
-      before_run
-
-      #
-      # figure out how we want to call streaming client
-      #
-      if @handlers[:search]
-        method = :filter
-        args = streamify_search_options(@handlers[:search].opts)
-      else
-        method = :user
-        args = {
-          stall_warnings: "true"
-        }
-      end
-
-      streaming_client.send(method, args) do |object|
-        handle_streaming_object(object)
-      end
-      after_run
-    end
-
-    #
-    # the REST API and Streaming API have a slightly different format.
-    # tweak our search handler to switch from REST to Streaming
-    #
-    def streamify_search_options(opts)
-      if opts.is_a?(String)
-        { track: opts }
-      elsif opts.is_a?(Array)
-        { track: opts.join(", ") }
-      else
-        opts
-      end
-    end
-    
     #
     # run the bot with the REST API
     #
@@ -137,24 +81,17 @@ module Chatterbot
     end
 
     def call_api_immediately?
-      !streaming?
+      true
     end
     
     def register_handler(method, opts = nil, &block)
       # @todo raise error if method already defined
       @handlers[method] = Handler.new(opts, &block)
 
-      if STREAMING_ONLY_HANDLERS.include?(method)
-        puts "Forcing usage of Streaming API to support #{method} calls"
-        self.streaming = true
-      elsif call_api_immediately?
-        @run_count += 1
-        h = @handlers[method]
-        self.send(method, *(h.opts)) do |obj|
-          h.call(obj)
-        end
+      h = @handlers[method]
+      self.send(method, *(h.opts)) do |obj|
+        h.call(obj)
       end
-     
     end
   end
 end

data/lib/chatterbot/client.rb

@@ -6,7 +6,7 @@ module Chatterbot
   # routines for connecting to Twitter and validating the bot
   #
   module Client
-    attr_accessor :screen_name, :client, :streaming_client
+    attr_accessor :screen_name, :client
 
     #
     # the main interface to the Twitter API
@@ -14,14 +14,7 @@ module Chatterbot
     def client
       @client ||= Twitter::REST::Client.new(client_params)
     end
-
-    #
-    # interace to the Streaming API
-    #
-    def streaming_client
-      @streaming_client ||= Twitter::Streaming::Client.new(client_params)
-    end
-
+    
     #
     # return the currently authenticated User
     #

data/lib/chatterbot/config.rb

@@ -55,7 +55,6 @@ module Chatterbot
     
     attr_boolean :debug_mode, false
     attr_boolean :verbose, false
-    attr_boolean :streaming, false
     attr_boolean :skip_run, false
     attr_boolean :only_interact_with_followers, false    
 

data/lib/chatterbot/dsl.rb

@@ -70,49 +70,6 @@ module Chatterbot
       bot.register_handler(:direct_messages, block)
     end
     
-    
-    #
-    # handle notifications of bot tweets favorited by other users.
-    # Using this block will require usage of the Streaming API.
-    #
-    # @example
-    #   favorited do |tweet|
-    #     puts tweet.text # this is the actual tweeted text
-    #     reply "@#{user.screen_name} thanks for the fave!", tweet
-    #   end
-    def favorited(&block)
-      bot.register_handler(:favorited, block)
-    end
-  
-    #
-    # handle notifications that the bot has a new follower.
-    # Using this block will require usage of the Streaming API.
-    #
-    # @example
-    #   followed do |user|
-    #     follow user
-    #   end
-    def followed(&block)
-      bot.register_handler(:followed, block)
-    end
-  
-    #
-    # handle notifications of tweets on the bot's timeline that were deleted.
-    # Using this block will require usage of the Streaming API.
-    def deleted(&block)
-      bot.register_handler(:deleted, block)
-    end
-
-
-    #
-    # enable or disable usage of the Streaming API
-    #
-    def use_streaming(s=nil)
-      s = true if s.nil?
-      bot.streaming = s
-    end
-    
-    
     #
     # send a tweet
     #

data/lib/chatterbot/skeleton.rb

@@ -18,8 +18,6 @@ module Chatterbot
           :timestamp => Time.now
         })
 
-        puts opts.inspect
-        
         src % opts
       end
     end

data/lib/chatterbot/version.rb

@@ -1,3 +1,3 @@
 module Chatterbot
-  VERSION = "2.0.5"
+  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
       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