chatterbot 2.0.0.pre → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7333d751e027fb23ffd45e3df6a2602d271af411
-  data.tar.gz: 29e07ecf21574c314f0603a16b6f7b65cf2af4ce
+  metadata.gz: dd3b277547610b8d5e0ec0993a5952d015cab80b
+  data.tar.gz: 114e6d11f506a6bbb331081b66395613346e3a12
 SHA512:
-  metadata.gz: 92e31e5c24e929fe2ecca7e9a8f01b1bfdc9dfb56754817bd44ce3dcf29a2bf3beb5c8e1a259059e31b4bb1d6f005e1c5f795ac573cef52478711005dd55c2b2
-  data.tar.gz: ae42ada56f4635ea488e3996e3f7643aa5fcac79fd724a88512e0b4c39d3683189a3f9b21803411227464265981fb051f2697750ba23b4d7b74e38ea25e9eb9a
+  metadata.gz: 92c72bf9e9ab384e2a5a00756d78af0128998efd1dd7d1eba9ac069b8fe427042e5ea73aeed03e2ae9dd30a140833382f9e239090b6c835794fe9207073e6d98
+  data.tar.gz: 3d6c202746806977bd602b9ad2f196cec49ef4dd091582ce38711906b1e7ddb9fd93be34b517b6aadeb7492e024e07784c12c4002d74e0220247bd623616fea6

data/.travis.yml

@@ -4,5 +4,8 @@ rvm:
   - 2.1.1
   - 2.2.0
   - ruby-head
+before_install:
+  - gem install bundler -v '~> 1.11'
+
 # uncomment this line if your project needs to run something other than `rake`:
 # script: bundle exec rspec spec

data/README.markdown

@@ -1,6 +1,11 @@
 Chatterbot
 ===========
 
+Hey! This is Chatterbot 2.0. There have been some breaking changes
+from older versions of the library, and it doesn't support MySQL
+anymore. If you are looking for the old version, 
+you can try the [1.0 branch](https://github.com/muffinista/chatterbot/tree/1.0.2)
+
 Chatterbot is a Ruby library for making bots on Twitter.  It's
 great for rapid development of bot ideas. It handles all of the basic
 Twitter API features -- searches, replies, tweets, retweets, etc. and has
@@ -51,7 +56,7 @@ A bot using chatterbot can be as simple as this:
 
 ```
 exclude "http://"
-blacklist "mean_user, private_user"
+blocklist "mean_user, private_user"
 
 puts "checking my timeline"
 home_timeline do |tweet|
@@ -71,14 +76,15 @@ end
 ```
 
 Or you can write a bot using more traditional ruby classes, extend it if needed, and use it like so:
-
-   class MyBot < Chatterbot::Bot
+```
+  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
        end
     end
   end
+```
 
 Chatterbot can actually generate a template bot file for you, and will
 walk you through process of getting a bot authorized with Twitter.
@@ -101,7 +107,7 @@ to do something complicated, you should probably consider using the
 
 Basic usage is very straightforward:
 
-    streaming true
+    use_streaming true
     home_timeline do |tweet|
       puts "someone i follow tweeted! #{tweet.text}"
     end
@@ -109,7 +115,7 @@ Basic usage is very straightforward:
 
 You can also run a search:
 
-    streaming true
+    use_streaming true
     search("pizza") do |tweet|
       puts "someone is talking about pizza! #{tweet.text}"
     end
@@ -167,7 +173,7 @@ person who sent the original tweet.
 
 ```rb
   search "xyzzy" do |tweet|
-    retweet(tweet[:id])
+    retweet(tweet.id)
   end
 ```
 
@@ -177,11 +183,11 @@ person who sent the original tweet.
 
 (NOTE: you'll need to make sure your bot has permission to send DMs)
 
-**blacklist** -- you can use this to specify a list of users you don't
+**blocklist** -- you can use this to specify a list of users you don't
   want to interact with. If you put the following line at the top of
   your bot:
   
-    blacklist "user1, user2, user3"
+    blocklist "user1, user2, user3"
     
 None of those users will trigger your bot if they come up in a
 search. However, if a user replies to one of your tweets or mentions
@@ -307,7 +313,7 @@ loop do
   search "twitter" do |tweet|
     # here you could do something with a tweet
     # if you want to retweet
-    retweet(tweet[:id])
+    retweet(tweet.id)
   end
 
   replies do |tweet|
@@ -319,16 +325,16 @@ end
 ```
 
 
-Blacklists
+Blocklists
 ----------
 
 Not everyone wants to hear from your bot.  To keep annoyances to a
-minimum, Chatterbot has a simple blacklist tool. Using it is as simple as:
+minimum, Chatterbot has a simple blocklist tool. Using it is as simple as:
 
-    blacklist "mean_user, private_user"
+    blocklist "mean_user, private_user"
 
 You should really respect the wishes of users who don't want to hear
-from your bot, and add them to your blacklist whenever requested.
+from your bot, and add them to your blocklist whenever requested.
 
 There's also an 'exclude' method which can be used to add
 words/phrases you might want to ignore -- for example, if you wanted
@@ -348,7 +354,7 @@ I can work with you on that.
 Copyright/License
 -----------------
 
-Copyright (c) 2015 Colin Mitchell. Chatterbot is distributed under the
+Copyright (c) 2016 Colin Mitchell. Chatterbot is distributed under the
 MIT licence -- Please see LICENSE.txt for further details.
 
 http://muffinlabs.com

data/bin/chatterbot-register

@@ -58,6 +58,7 @@ end
 @bot.config.delete(:token)
 @bot.require_login(false)
 
+
 unless @bot.screen_name.nil?
   if @botname == "tmp_bot_name"
     puts "change botname to #{@bot.screen_name}"
@@ -66,8 +67,11 @@ unless @bot.screen_name.nil?
 
   puts "Storing config info"
   puts @bot.config.inspect
-  @bot.update_config
-  @bot.config = nil
+
+  config_src = File.join(Dir.getwd, "tmp_bot_name.yml")
+  config_dest = File.join(Dir.getwd, "#{@bot.botname}.yml")
+  File.rename(config_src, config_dest)
+  
   
   if @skeleton
     skel_dest = File.join(Dir.getwd, "#{@bot.botname}.rb")

data/chatterbot.gemspec

@@ -21,13 +21,13 @@ Gem::Specification.new do |s|
   s.licenses = ["MIT"]
 
   s.add_development_dependency(%q<redcarpet>, [">= 0"])
-  s.add_runtime_dependency(%q<oauth>, [">= 0.4.7"])
-  s.add_runtime_dependency(%q<twitter>, ["5.14.0"])
+  s.add_runtime_dependency(%q<oauth>, ["~> 0.4.7"])
+  s.add_runtime_dependency(%q<twitter>, ["~> 5.16.0"])
   s.add_runtime_dependency(%q<launchy>, [">= 2.4.2"])
   s.add_runtime_dependency(%q<colorize>, [">= 0.7.3"])
   s.add_development_dependency(%q<yard>, [">= 0"])
   s.add_development_dependency(%q<shoulda>, [">= 0"])
-  s.add_development_dependency(%q<rake>, [">= 0"])
+  s.add_development_dependency(%q<rake>, ["< 11"])
   s.add_development_dependency(%q<rspec>, ["~> 3.0.0"])
   s.add_development_dependency(%q<rspec-mocks>, ["~> 3.0.2"])
   s.add_development_dependency(%q<rdoc>, [">= 0"])

data/lib/chatterbot/bot.rb

@@ -80,8 +80,11 @@ module Chatterbot
         args = streamify_search_options(@handlers[:search].opts)
       else
         method = :user
-        args = nil
+        args = {
+          stall_warnings: "true"
+        }
       end
+
       
       streaming_client.send(method, args) do |object|
         handle_streaming_object(object)
@@ -131,7 +134,7 @@ module Chatterbot
     end
 
     def call_api_immediately?
-      streaming?
+      !streaming?
     end
     
     def register_handler(method, opts = nil, &block)
@@ -142,8 +145,9 @@ module Chatterbot
         puts "Forcing usage of Streaming API to support #{method} calls"
         self.streaming = true
       elsif call_api_immediately?
+        @run_count += 1
         h = @handlers[method]
-        send(method, *(h.opts)) do |obj|
+        self.send(method, *(h.opts)) do |obj|
           h.call(obj)
         end
       end

data/lib/chatterbot/client.rb

@@ -171,6 +171,7 @@ module Chatterbot
     #
     def get_screen_name(t = @access_token)
       return unless @screen_name.nil?
+      return if t.nil?
 
       oauth_response = t.get('/1.1/account/verify_credentials.json')
       @screen_name = JSON.parse(oauth_response.body)["screen_name"]
@@ -198,10 +199,10 @@ module Chatterbot
           @access_token = request_token.get_access_token(:oauth_verifier => pin.chomp)
           get_screen_name
 
-          self.config[:token] = @access_token.token
-          self.config[:secret] = @access_token.secret
+          self.config[:access_token] = @access_token.token
+          self.config[:access_token_secret] = @access_token.secret
 
-          update_config unless ! do_update_config
+          #update_config unless ! do_update_config
           reset_client
 
         rescue OAuth::Unauthorized => e

data/lib/chatterbot/config.rb

@@ -93,6 +93,7 @@ module Chatterbot
       config[:consumer_key].nil? || config[:consumer_secret].nil?
     end
 
+    
     #
     # has this script validated with Twitter OAuth?
     def needs_auth_token?

data/lib/chatterbot/config_manager.rb

@@ -27,6 +27,12 @@ module Chatterbot
       end
     end
 
+    def to_h
+      @store.transaction do
+        Hash[@store.roots.map { |k| [k, @store[k]] }]
+      end
+    end
+
     # set/update a key
     def []=(key, value)
       return if @no_update == true
@@ -37,7 +43,7 @@ module Chatterbot
 
     # retrieve a key
     def [](key)
-      if READ_ONLY_VARIABLES.include?(key)
+      if READ_ONLY_VARIABLES.include?(key) && @read_only[key]
         return @read_only[key]
       end
       @store.transaction do

data/lib/chatterbot/home_timeline.rb

@@ -7,7 +7,6 @@ module Chatterbot
     # handle the bots timeline
     def home_timeline(*args, &block)
       return unless require_login
-
       debug "check for home_timeline tweets since #{since_id}"
 
       opts = {

data/lib/chatterbot/skeleton.rb

@@ -13,7 +13,7 @@ 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
         })

data/lib/chatterbot/streaming.rb

@@ -52,6 +52,8 @@ module Chatterbot
         end
       when Twitter::Streaming::FriendList
         debug "got friend list"
+      when Twitter::Streaming::StallWarning
+        debug "***** STALL WARNING *****"
       end
     end
 

data/lib/chatterbot/tweet.rb

@@ -22,10 +22,11 @@ module Chatterbot
       #:nocov:
     end
 
+    
     # reply to a tweet
     def reply(txt, source)
       debug txt
-      tweet txt, {:in_reply_to_status_id => source[:id]}, source
+      tweet txt, {:in_reply_to_status_id => source.id}, 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:
@@ -52,27 +52,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 +89,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
       
-      print "\n\nPaste the 'API Key' here: "
+      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!
+      #
+      
+      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
+
+
+      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
+
 
-      # reset the client so we can re-init with new OAuth credentials
-      reset_client
+        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.0.2"
 end

data/spec/bot_spec.rb

@@ -14,10 +14,10 @@ describe "Chatterbot::Bot" do
 
   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!
+      #@bot.run!
     end
   end
 
@@ -44,6 +44,7 @@ describe "Chatterbot::Bot" do
   
   describe "stream!" do
     before(:each) do
+      @bot.streaming = true
       @sc = double(Twitter::Client)
       expect(@bot).to receive(:streaming_client).and_return(@sc)
     end
@@ -51,7 +52,6 @@ describe "Chatterbot::Bot" do
     it "tweaks settings for searches" do
       @bot.register_handler(:search, "hello") {}
       expect(@sc).to receive(:filter)
-
       @bot.stream!
     end
 

data/spec/client_spec.rb

@@ -139,12 +139,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/streaming_spec.rb

@@ -9,6 +9,7 @@ describe "Chatterbot::Streaming" do
   describe "streaming_tweet_handler" do
     before(:each) do
       bot.skip_run = true
+      bot.streaming = true
       allow(bot.client).to receive(:user).and_return(user)
     end
 
@@ -31,6 +32,7 @@ describe "Chatterbot::Streaming" do
   describe "handle_streaming_object" do
     before(:each) {
       bot.skip_run = true
+      bot.streaming = true
       allow(bot.client).to receive(:user).and_return(user)
     }
 

data/spec/tweet_spec.rb

@@ -41,7 +41,7 @@ describe "Chatterbot::Tweet" do
     it "calls require_login when replying" do
       bot = test_bot
       expect(bot).to receive(:require_login).and_return(false)
-      bot.reply "reply test!", {"id" => 100}
+      bot.reply "reply test!", fake_tweet(100)
     end
 
     it "calls client.update with the right values" do
@@ -53,11 +53,8 @@ describe "Chatterbot::Tweet" do
 
       test_str = "test!"
 
-      s = {
-        :id => 100
-      }
       expect(bot.client).to receive(:update).with(test_str, {:in_reply_to_status_id => 100})
-      bot.reply test_str, s
+      bot.reply test_str, fake_tweet(100, 100)
     end
 
 
@@ -69,7 +66,7 @@ describe "Chatterbot::Tweet" do
       allow(bot).to receive(:debug_mode?).and_return(true)
 
       expect(bot.client).not_to receive(:update)
-      bot.reply "no reply test!", {:id => 100}
+      bot.reply "no reply test!", fake_tweet(100)
     end
   end
 

data/templates/skeleton.txt

@@ -21,6 +21,23 @@ require 'chatterbot/dsl'
 #
 
 
+#
+# These lines here are just to make sure you edit this file before
+# trying to run your bot. You can safely remove them once you've
+# looked through this file.
+#
+puts "========================"
+puts "========================"
+puts "========================"
+puts "\n\n\n"
+
+puts "Hey there! You should open %{name}.rb and take a look before running this script."
+
+puts "\n\n\n"
+exit
+
+
+
 #
 # Placing your security credentials right in a script like this is
 # handy, but potentially dangerous, especially if your code is
@@ -78,13 +95,13 @@ exclude bad_words
 only_interact_with_followers
 
 #
-# Specifying 'streaming true' will cause Chatterbot to use Twitter's
+# 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.
 #
-streaming true
+use_streaming
 
 #
 # Here's the fun stuff!
@@ -100,19 +117,19 @@ streaming true
 # Still here? Hopefully it's because you're going to do something cool
 # with the data that doesn't bother other people. Hooray!
 #
-search "chatterbot" do |tweet|
-  # here's the content of a tweet
-  puts tweets.text
-end
+#search "chatterbot" do |tweet|
+#  # here's the content of a tweet
+#  puts tweets.text
+#end
 
 #
 # this block responds to mentions of your bot
 #
-replies do |tweet|
-  # Any time you put the #USER# token in a tweet, Chatterbot will
-  # replace it with the handle of the user you are interacting with
-  reply "Yes #USER#, you are very kind to say that!", tweet
-end
+#replies do |tweet|
+#  # Any time you put the #USER# token in a tweet, Chatterbot will
+#  # replace it with the handle of the user you are interacting with
+#  reply "Yes #USER#, you are very kind to say that!", tweet
+#end
 
 #
 # this block handles incoming Direct Messages. if you want to do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chatterbot
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre
+  version: 2.0.2
 platform: ruby
 authors:
 - Colin Mitchell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-01 00:00:00.000000000 Z
+date: 2016-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -28,30 +28,30 @@ dependencies:
   name: oauth
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.7
 - !ruby/object:Gem::Dependency
   name: twitter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.14.0
+        version: 5.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.14.0
+        version: 5.16.0
 - !ruby/object:Gem::Dependency
   name: launchy
   requirement: !ruby/object:Gem::Requirement
@@ -112,16 +112,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -281,9 +281,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: chatterbot
 rubygems_version: 2.2.2