chatterbot 1.0.2 → 2.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f47ae273235445119432cb12e637dddef93b7a60
-  data.tar.gz: b16803b44e1e27ef85a14d87beaeea861e594d34
+  metadata.gz: 7333d751e027fb23ffd45e3df6a2602d271af411
+  data.tar.gz: 29e07ecf21574c314f0603a16b6f7b65cf2af4ce
 SHA512:
-  metadata.gz: 37d91e3432c7585611b3999ae18cdae67281d6c9e6cf8e06d7803c987d1573990d98330fbf6856f7b0aaf2141d0a367e0e68cec2e7a83d9b5a700b82d9a25c8c
-  data.tar.gz: 518a94f32455be84ccfa9932123820fb863b00bda64d81c1b434b621cf0c3d9acb669e85d7a1c24bfbf93c155246dd1adff52f0674a91ee9315be06e167b9c3a
+  metadata.gz: 92e31e5c24e929fe2ecca7e9a8f01b1bfdc9dfb56754817bd44ce3dcf29a2bf3beb5c8e1a259059e31b4bb1d6f005e1c5f795ac573cef52478711005dd55c2b2
+  data.tar.gz: ae42ada56f4635ea488e3996e3f7643aa5fcac79fd724a88512e0b4c39d3683189a3f9b21803411227464265981fb051f2697750ba23b4d7b74e38ea25e9eb9a

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
-  - 1.9.2
-  - 1.9.3
   - 2.0.0
   - 2.1.1
+  - 2.2.0
+  - ruby-head
 # uncomment this line if your project needs to run something other than `rake`:
 # script: bundle exec rspec spec

data/LICENSE.txt

@@ -1,13 +1,22 @@
-            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
-                    Version 2, December 2004
+The MIT License (MIT)
+Copyright © 2015 Colin Mitchell, http://muffinlabs.com
 
- Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+“Software”), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
 
- Everyone is permitted to copy and distribute verbatim or modified
- copies of this license document, and changing it is allowed as long
- as the name is changed.
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
 
-            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
-   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-  0. You just DO WHAT THE FUCK YOU WANT TO.

data/README.markdown

@@ -14,17 +14,20 @@ Features
 * Handles search queries and replies to your bot
 * Use a simple scripting language, or extend a Bot class if you need it
 * Wraps the Twitter gem so you have access to the entire Twitter API
-* Simple blacklistling system to limit your annoyance of users
+* Simple blocklist 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
 
 
 Using Chatterbot
 ================
 
-**NEW!!** Chatterbot has a [documentation website](http://muffinista.github.io/chatterbot/). It's a work-in-progress.
+Chatterbot has a [documentation
+website](http://muffinista.github.io/chatterbot/). It's a
+work-in-progress. You can also read the [gem
+documentation](http://www.rubydoc.info/gems/chatterbot/).
+
 
 
 Make a Twitter account
@@ -69,10 +72,13 @@ end
 
 Or you can write a bot using more traditional ruby classes, extend it if needed, and use it like so:
 
-    bot = Chatterbot::Bot.new
-    bot.search("'surely you must be joking'") do |tweet|
-     bot.reply "@#{tweet_user(tweet)} I am serious, and don't call me Shirley!", tweet
+   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.
@@ -82,7 +88,33 @@ That's it!
 Chatterbot uses the the Twitter gem
 (https://github.com/sferik/twitter) to handle the underlying API
 calls. Any calls to the search/reply methods will return
-Twitter::Status objects, which are basically extended hashes.
+Twitter::Status objects, which are basically extended hashes. If you
+find yourself pushing the limits of Chatterbot, it's very possible
+that you should just be using the Twitter gem directly.
+
+Streaming
+---------
+
+Chatterbot has some basic support for the Streaming API. If you want
+to do something complicated, you should probably consider using the
+[Twitter gem](https://github.com/sferik/twitter#streaming) directly. 
+
+Basic usage is very straightforward:
+
+    streaming true
+    home_timeline do |tweet|
+      puts "someone i follow tweeted! #{tweet.text}"
+    end
+
+
+You can also run a search:
+
+    streaming true
+    search("pizza") do |tweet|
+      puts "someone is talking about pizza! #{tweet.text}"
+    end
+
+
 
 What Can I Do?
 --------------
@@ -91,8 +123,8 @@ Here's a list of the important methods in the Chatterbot DSL:
 
 **search** -- You can use this to perform a search on Twitter:
 
-    search("'surely you must be joking'") do |tweet|
-      reply "@#{tweet_user(tweet)} I am serious, and don't call me Shirley!", tweet
+    search("pizza") do |tweet|
+      tweet "I just read another tweet about pizza"
     end
 
 **replies** -- Use this to check for replies and mentions:
@@ -101,14 +133,28 @@ Here's a list of the important methods in the Chatterbot DSL:
       reply "#USER# Thanks for contacting me!", tweet
     end
 
-Note that the string #USER# will be replaced with the username of the person who sent the original tweet.
+Note that the string #USER# will be replaced with the username of the
+person who sent the original tweet.
 
-**home_timeline** -- This call will return tweets from the bot's home timeline -- this will include tweets from accounts the bot follows, as well as the bot's own tweets:
+**home_timeline** -- This call will return tweets from the bot's home
+  timeline -- this will include tweets from accounts the bot follows,
+  as well as the bot's own tweets:
+  
     home_timeline do |tweet|
       puts tweet.text # this is the actual tweeted text
       favorite tweet # i like to fave tweets
     end
 
+**direct_messages** -- This will return any DMs for the bot:
+
+    direct_messages do |dm|
+      puts dm.text
+
+      # send a DM back to the user
+      direct_message "Hey, I got your message at #{Time.now.to_s}", dm.sender
+    end
+
+
 **tweet** -- send a Tweet out for this bot:
 
     tweet "I AM A BOT!!!"
@@ -125,6 +171,12 @@ Note that the string #USER# will be replaced with the username of the person who
   end
 ```
 
+**direct_message** -- send a DM to a user:
+
+    direct_message "I am a bot sending you a direct message", user
+
+(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
   want to interact with. If you put the following line at the top of
   your bot:
@@ -150,7 +202,11 @@ precaution if you want to avoid spreading spam), you could call:
 **followers** -- get a list of your followers. This is an experimental
   feature but should work for most purposes.
 
-For more details, check out dsl.rb in the source code.
+For more details, check out
+[dsl.rb](https://github.com/muffinista/chatterbot/blob/master/lib/chatterbot/dsl.rb)
+in the source code.
+
+
 
 Direct Client Access
 --------------------
@@ -168,11 +224,6 @@ users who DM you:
 Authorization
 -------------
 
-If you only want to use Chatterbot to search for tweets, it will work
-out of the box without any authorization.  However, if you want to
-reply to tweets, or check for replies to your bot, you will have to
-jump through a few authorization hoops with Twitter.
-
 Before you setup a bot for the first time, you will need to register an
 application with Twitter.  Twitter requires all API communication to be via an
 app which is registered on Twitter. I would set one up and make it
@@ -185,7 +236,7 @@ The helper script `chatterbot-register` will walk you through most of
 this without too much hand-wringing. And, if you write a bot without
 `chatterbot-register`, you'll still be sent through the authorization
 process the first time you run your script.  But if you prefer, here's
-the instructions if you want to do it yourself:
+sthe instructions if you want to do it yourself:
 
 1. [Setup your own app](https://twitter.com/apps/new) on Twitter.
 
@@ -222,6 +273,9 @@ your bot:
 1. Your credentials can be stored as variables in the script itself.
    `chatterbot-register` will do this for you. If your bot is using
    replies or searches, that data will be written to a YAML file.
+   **NOTE** this is a bad practice for scripts that are stored in a
+   source control system such as git, or are publicly available on a
+   site like github.
 2. In a YAML file with the same name as the bot, so if you have
    botname.rb or a Botname class, store your config in botname.yaml
 3. In a global config file at `/etc/chatterbot.yml` -- values stored here
@@ -231,14 +285,6 @@ your bot:
 5. In a `global.yml` file in the same directory as your bot.  This
    gives you the ability to have a global configuration file, but keep
    it with your bots if desired.
-6. In a database.  You can store your configuration in a DB, and then
-   specify the connection string either in one of the global config
-   files by setting `:db_uri: postgres://username:password@host/database`, or on the command-line by using the `--db="db_uri"`
-   configuration option.  Any calls to the database are handled by the
-   Sequel gem, and MySQL and Sqlite should work.  The DB URI should
-   be in the form of `mysql://username:password@host/database` -- see
-   http://sequel.rubyforge.org/rdoc/files/doc/opening_databases_rdoc.html
-   for details.
 
 Running Your Bot
 ----------------
@@ -251,6 +297,9 @@ Run it via cron.  Here's an example of running a bot every two minutes
 
     */2 * * * * . ~/.bash_profile; cd /path/to/bot/;  ./bot.rb
 
+
+
+
 Run it as a background process.  Just put the guts of your bot in a loop like this:
 
 ```rb
@@ -265,38 +314,17 @@ loop do
     # do stuff
   end
 
-  # explicitly update our config
-  update_config
-
   sleep 60
 end
 ```
 
-**NOTE:** You need to call `update_config` to update the last tweet your script
-has processed -- if you don't have this call, you will get duplicate
-tweets.
-
-
-Database logging
-----------------
-
-Chatterbot can log tweet activity to the database if desired.  This
-can be handy for tracking what's going on with your bot.  See
-`Chatterbot::Logging` for details on this.
-
 
 Blacklists
 ----------
 
 Not everyone wants to hear from your bot.  To keep annoyances to a
-minimum, Chatterbot has a global blacklist option, as well as
-bot-specific blacklists if desired.  The global blacklist is stored in
-the database, and you can add entries to it by using the
-`chatterbot-blacklist` script included with the gem.
+minimum, Chatterbot has a simple blacklist tool. Using it is as simple as:
 
-You can also specify users to skip as part of the DSL:
-
-    require 'chatterbot'
     blacklist "mean_user, private_user"
 
 You should really respect the wishes of users who don't want to hear
@@ -308,30 +336,20 @@ to ignore tweets with links, you could do something like this:
 
     exclude "http://"
 
-TODO
-====
-
-* document DSL methods
-* document database setup
-* web-based frontend for tracking bot activity
-* opt-out system that adds people to blacklist if they reply to a bot
-  in the right way
-
 Contributing to Chatterbot
 --------------------------
 
-Since this code is based off of actual Twitter bots, it's mostly
-working the way I want it to, and I might prefer to keep it that way.
-But please, if there are bugs or things you would like to improve,
-fork the project and hack away.  I'll pull anything back that makes
-sense if requested.
-
+Pull requests for bug fixes and new features are eagerly accepted.
+Since this code is based off of actual Twitter bots, please try and
+maintain compatability with the existing codebase. If you are
+comfortable writing a spec for any changed code, please do so. If not,
+I can work with you on that.
 
 Copyright/License
 -----------------
 
-Copyright (c) 2014 Colin Mitchell. Chatterbot is distributed under the
-WTFPL licence -- Please see LICENSE.txt for further details.
+Copyright (c) 2015 Colin Mitchell. Chatterbot is distributed under the
+MIT licence -- Please see LICENSE.txt for further details.
 
 http://muffinlabs.com
 

data/bin/chatterbot-register

@@ -7,7 +7,6 @@ require 'optparse'
 
 include Chatterbot::Helpers
 include Chatterbot::Config
-include Chatterbot::DB
 include Chatterbot::Logging
 
 Chatterbot::from_helper = true

data/chatterbot.gemspec

@@ -18,17 +18,10 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  s.licenses = ["WTFPL"]
+  s.licenses = ["MIT"]
 
-  if RUBY_VERSION < "1.9" || RUBY_VERSION == "1.9.2"
-    s.add_dependency "activesupport", "~> 3.0.11"
-    s.add_development_dependency(%q<redcarpet>, ["2.3.0"])
-    s.add_development_dependency(%q<shoulda-matchers>, ["1.0.0"])
-  else
-    s.add_development_dependency(%q<redcarpet>, [">= 0"])
-  end
-
-  s.add_runtime_dependency(%q<oauth>, ["~> 0.4.7"])
+  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<launchy>, [">= 2.4.2"])
   s.add_runtime_dependency(%q<colorize>, [">= 0.7.3"])

data/examples/class_bot.rb

@@ -2,7 +2,6 @@
 
 require 'chatterbot'
 
-
 x = Chatterbot::Bot.new
 x.search("foo") do |tweet|
   puts tweet.inspect

data/examples/echoes_bot.rb

@@ -19,14 +19,14 @@ puts "Loading echoes_bot.rb"
 ##
 exclude "http://"
 
-blacklist "mean_user, private_user"
+blocklist "mean_user, private_user"
 
 puts "checking for replies to me"
 replies do |tweet|
   # replace the incoming username with #USER#, which will be replaced
   # with the handle of the user who tweeted us by the
   # replace_variables helper
-  src = tweet[:text].gsub(/@echoes_bot/, "#USER#")  
+  src = tweet.text.gsub(/@echoes_bot/, "#USER#")  
 
   # send it back!
   reply src, tweet

data/examples/search_bot.rb

@@ -14,7 +14,7 @@ puts "Loading search_bot.rb"
 ##
 exclude "http://"
 
-blacklist "mean_user, private_user"
+blocklist "mean_user, private_user"
 
 search("twitter", :lang => "en") do |tweet|
   puts tweet[:text]

data/examples/streaming_bot.rb

@@ -19,24 +19,30 @@ puts "Loading echoes_bot.rb using the streaming API"
 
 exclude "http://", "https://"
 
-blacklist "mean_user, private_user"
+blocklist "mean_user, private_user"
 
-streaming do
-  favorited do |user, tweet|
-    reply "@#{user.screen_name} thanks for the fave!", tweet
-  end
+streaming true
 
-  followed do |user|
-    tweet "@#{user.screen_name} just followed me!"
-    follow user
-  end
+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
+replies do |tweet|
+  favorite tweet
+
+  puts "It's a tweet!"
+  src = tweet.text.gsub(/@echoes_bot/, "#USER#")  
+  reply src, tweet
+end
 
-    puts "It's a tweet!"
-    src = tweet.text.gsub(/@echoes_bot/, "#USER#")  
-    reply src, tweet
-  end
+direct_messages do |tweet|
+  puts "well, here i am #{tweet.text}"
+  puts tweet.inspect
+  direct_message "got it", tweet.sender
 end
 

data/lib/chatterbot.rb

@@ -4,13 +4,6 @@ require 'twitter'
 require 'launchy'
 require 'colorize'
 
-#
-# Try and load Sequel, but don't freak out if it's not there
-begin
-  require 'sequel'
-rescue Exception
-end
-
 
 #
 # extend Hash class to turn keys into symbols
@@ -34,33 +27,35 @@ module Chatterbot
   #
   # load in our assorted modules
   def self.load
+    require "chatterbot/config_manager"
     require "chatterbot/config"
-    require "chatterbot/db"
     require "chatterbot/logging"
-    require "chatterbot/blacklist"
-    require "chatterbot/whitelist"
+    require "chatterbot/blocklist"
+    require "chatterbot/safelist"
     require "chatterbot/ui"
     require "chatterbot/client"    
     require "chatterbot/search"
+    require "chatterbot/direct_messages"    
     require "chatterbot/tweet"
     require "chatterbot/retweet"
     require "chatterbot/favorite"
     require "chatterbot/profile"
     require "chatterbot/reply"
     require "chatterbot/home_timeline"
-    require "chatterbot/streaming"
-    require "chatterbot/streaming_handler"
     require "chatterbot/followers"
     require "chatterbot/helpers"
     require "chatterbot/utils"
+    require "chatterbot/streaming"
 
     require "chatterbot/bot"
   end
 
+  # setter to track if we're being called from a helper script
   def self.from_helper=(x)
     @@from_helper = x
   end
 
+  # are we being called from a helper script?
   def self.from_helper
     @@from_helper
   end