chatterbot 0.2.8 → 0.2.9

data/Gemfile

@@ -7,11 +7,12 @@ gemspec
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
+  gem 'simplecov', :require => false, :group => :test
+
   gem "shoulda", ">= 0"
   gem "rspec"
 
   gem "bundler", "~> 1.0.0"
-  gem "rcov"
   gem "watchr"
 end
 

data/{README.rdoc → README.markdown}

@@ -1,4 +1,5 @@
-= Chatterbot
+Chatterbot
+===========
 
 Chatterbot is a Ruby library for making bots on Twitter.  It is basic
 enough that you can put it into use quickly, but can be used to make
@@ -6,49 +7,62 @@ pretty involved bots. It handles searches, replies and tweets, and has
 a simple blacklist system to help keep you from spamming people who
 don't want to hear from your bot.
 
-== A quick list of features:
-
+Features
+--------
 * Works via Twitter's OAuth system.
 * Handles search queries and replies to your bot
 * Use a simple DSL, or extend a Bot class if you need it
 * Simple blacklistling system to limit your annoyance of users
 * Optionally log tweets to the database for metrics and tracking purposes
 
-== Using Chatterbot
+Using Chatterbot
+================
 
-=== Make a Twitter account
+Make a Twitter account
+----------------------
 
 First thing you'll need to do is create an account for your bot on
 Twitter.  That's the easy part.
 
-=== Write your bot
+Run the generator
+-----------------
+
+Chatterbot comes with a script named `chatterbot-register` which will
+handle two tasks -- it will authorize your bot with Twitter and it
+will generate a skeleton script, which you use to implement your
+actual bot.
+
+Write your bot
+--------------
 
 Chatterbot has a very simple DSL inspired by Sinatra and Twibot, an
-earlier Twitter bot framework.  Here's an example, based on @dr_rumack
-on Twitter (http://twitter.com/#!/Dr_Rumack):
+earlier Twitter bot framework.  Here's an example, based on 
+[@dr_rumack](http://twitter.com/#!/Dr_Rumack), an actual bot running
+on Twitter:
 
-  require 'chatterbot/dsl'
-  search("'surely you must be joking'") do |tweet|
-    reply "@#{tweet_user(tweet)} I am serious, and don't call me Shirley!", tweet
-  end
+    require 'chatterbot/dsl'
+    search("'surely you must be joking'") do |tweet|
+      reply "@#{tweet_user(tweet)} I am serious, and don't call me Shirley!", tweet
+    end
 
-Or, you can create a bot object yourself, extend it if needed, and use
-it like so:
+Or, you can create a bot object yourself, 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
-  end
+    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
+    end
 
 That's it!
 
-=== Authorize your bot
+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. The very
-first time you want to setup a bot, you will need to register an
+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
 part of Chatterbot, but unfortunately Twitter doesn't allow developers
@@ -56,29 +70,29 @@ to publicly post the OAuth consumer key/secret that you would need to
 use.  If you're planning to run more than one bot, you only need to do
 this step once -- you can use the same app setup for other bots too.
 
-I've put together a {walkthrough of the process}[http://muffinlabs.com/content/walkthrough-setting-twitter-app-use-chatterbot] of setting up an app, and then authorizing your bot. It might be useful for first-time users
+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:
 
+1. [Setup your own app](https://twitter.com/apps/new) on Twitter.
 
+2. Choose 'Client' as the app type.
 
+3. Choose 'Read & Write' access unless you don't need to send tweets.
 
-Chatterbot will walk you through what is needed to get this setup.  If
-you run your bot without having an app setup, it will prompt you with
-the instructions. Here's the instructions if you want to do it yourself:
+4. Take the consumer key/consumer secret values, and either run your bot, and enter them 
+in when prompted, or store them in a config file for your bot. (See
+below for details on this).  It should look like this:
 
-1. Setup your own app on Twitter at this URL https://twitter.com/apps/new
-2. Choose 'Client' as the app type
-3. Choose 'Read & Write' access unless you don't need to send tweets.
-4. Take the consumer key/consumer secret values, and either run your
-   bot, and enter them in when prompted, or store them in a config
-   file for your bot. (See below for details on this).  It should look
-   like this:
+ 		 ---
+         :consumer_secret: CONSUMER SECRET GOES HERE
+         :consumer_key: CONSUMER KEY GOES HERE
 
-  --- 
-  :consumer_secret: CONSUMER SECRET GOES HERE
-  :consumer_key: CONSUMER KEY GOES HERE
 
-Chatterbot will point you at the URL in Step #1, then ask for the
-same values as in Step #4.
+When you do this via the helper script, chatterbot will point you at
+the URL in Step #1, then ask you to paste the same values as in Step #4.
 
 Once this is done, you will need to setup authorization for the actual
 bot with Twitter. At the first run, you'll get a message asking you to go
@@ -90,30 +104,32 @@ bot. Hit return, and you should be all set.
 This is obviously a bunch of effort, but once you're done, you're
 ready to go!
 
-=== Configuration
+Configuration
+-------------
 
 Chatterbot offers a couple different methods of storing the config for
 your bot:
 
 1. 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
-2. In a global config file at <tt>/etc/chatterbot.yml</tt> -- values stored here
+2. In a global config file at `/etc/chatterbot.yml` -- values stored here
    will apply to any bots you run.
 3. In another global config file specified in the environment variable
-   <tt>'chatterbot_config'</tt>.
-4. In a <tt>global.yml</tt> file in the same directory as your bot.  This
+   `'chatterbot_config'`.
+4. 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.
 5. 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, or on the command-line by using the <tt>--db="db_uri"</tt>
+   files, 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 <tt>mysql://username:password@host/database</tt> -- see
+   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
+Running Your Bot
+----------------
 
 There's a couple ways of running your bot:
 
@@ -121,51 +137,58 @@ Run it on the command-line whenever you like. Whee!
 
 Run it via cron.  Here's an example of running a bot every two minutes
 
-  */2 * * * * . ~/.bash_profile; cd /path/to/bot/;  ./bot.rb
+    */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:
-  loop do
-    replies do |tweet|
-      # do stuff
-    end
 
-    sleep 60
-  end
+    loop do
+      replies do |tweet|
+        # do stuff
+      end
 
-=== Database logging
+      sleep 60
+    end
+
+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
-<tt>Chatterbot::Logging</tt> for details on this.
+`Chatterbot::Logging` for details on this.
 
 
-=== Blacklists
+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
-<tt>chatterbot-blacklist</tt> script included with the gem.
+`chatterbot-blacklist` script included with the gem.
 
 You can also specify users to skip as part of the DSL:
 
-  require 'chatterbot'
-  blacklist "mean_user, private_user"
+    require 'chatterbot'
+    blacklist "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.
 
 There's also an 'exclude' method which can be used to add
 words/phrases you might want to ignore -- for example, if you wanted
 to ignore tweets with links, you could do something like this:
 
-  exclude "http://"
+    exclude "http://"
 
-== TODO
+TODO
+====
 
-* A skeleton bot generator
 * 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
+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.
@@ -174,7 +197,8 @@ fork the project and hack away.  I'll pull anything back that makes
 sense if requested.
 
 
-== Copyright/License
+Copyright/License
+-----------------
 
 Copyright (c) 2011 Colin Mitchell. Chatterbot is distributed under a
 modified WTFPL licence -- it's the 'Do what the fuck you want to --

data/bin/chatterbot-blacklist

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+#$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'chatterbot'
 require 'optparse'

data/bin/chatterbot-register

@@ -0,0 +1,113 @@
+#!/usr/bin/env ruby
+#$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'chatterbot'
+require 'optparse'
+
+include Chatterbot::Helpers
+include Chatterbot::Config
+include Chatterbot::DB
+include Chatterbot::Logging
+
+@force = false
+
+
+#
+# pull in any arguments and set them as env variables
+#
+opts = OptionParser.new
+opts.banner = <<-EOS
+
+Register a bot with Twitter, and generate a script to run
+it. This script will walk you through the whole process.
+
+Usage: #{File.basename($0)} [options]
+EOS
+
+opts.separator ""
+opts.separator "Options:" 
+
+opts.on('-d', '--db [ARG]', "Specify a DB connection URI")    { |d| ENV["chatterbot_db"] = d }
+opts.on('-c', '--config [ARG]', "Specify a config file to load")    { |c| ENV["chatterbot_config"] = c }
+opts.on('-b', '--bot [ARG]', "Name of the bot you want to register. If you don't specify this, it will be grabbed from twitter when you authenticate")    { |b| @botname = b }
+opts.on('-f', '--force', "Overwrite existing config values") { @force = true }
+
+opts.on_tail("-h", "--help", "Show this message") do
+  puts opts
+  exit
+end      
+
+#
+# skeleton code for a bot -- pretty basic but covers the bases
+#
+skeleton = <<'EOF'
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'chatterbot/dsl'
+
+# remove this to send out tweets
+debug_mode
+
+# remove this to update the db
+no_update
+# remove this to get less output when running
+verbose
+
+# here's a list of users to ignore
+blacklist "abc", "def"
+
+# here's a list of things to exclude from searches
+exclude "hi", "spammer", "junk"
+
+search "keyword" do |tweet|
+ reply "Hey #USER# nice to meet you!", tweet
+end
+
+replies do |tweet|
+  reply "Yes #USER#, you are very kind to say that!", tweet
+end
+
+EOF
+
+extra = opts.parse!(ARGV)
+
+
+if @botname.nil?
+  @botname = "tmp_bot_name"
+end
+
+@bot = Chatterbot::Bot.new(:name => @botname)
+
+if ! @bot.needs_auth_token? && @force == false
+  puts "Looks like your bot has already been authorized."
+  puts "If something went wrong, run #{File.basename($0)} again with the '-f' flag."
+end
+
+@bot.config.delete(:token)
+@bot.require_login(false)
+
+if @bot.client.authorized?
+  if @botname == "tmp_bot_name"
+    puts "change botname to #{@bot.access_token.params[:screen_name]}"
+    @bot.botname = @bot.access_token.params[:screen_name]
+  end
+
+  puts "Storing config info"
+  @bot.update_config
+
+  skel_dest = File.join(Dir.getwd, "#{@bot.botname}.rb")
+  if File.exist?(skel_dest)
+    puts "#{skel_dest} exists already, not doing anything"
+  else
+    puts "writing skeleton to #{skel_dest}"
+
+    f = File.new(skel_dest, "w")
+    f.write(skeleton)
+    f.close
+
+    File.chmod(0740, skel_dest)
+  end
+else
+  puts "Looks like something went wrong, better luck next time!"
+end

data/bin/chatterbot-status

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+#$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'chatterbot'
+require 'optparse'
+
+include Chatterbot::Helpers
+include Chatterbot::Config
+include Chatterbot::DB
+
+@tweet_count = 5
+
+#
+# pull in any arguments and set them as env variables
+#
+opts = OptionParser.new
+opts.banner = "Usage: #{File.basename($0)} [options]"
+
+opts.separator ""
+opts.separator "Specific options:" 
+
+opts.on('-d', '--db [ARG]', "Specify a DB connection URI")    { |d| ENV["chatterbot_db"] = d }
+opts.on('-c', '--config [ARG]', "Specify a config file to use")    { |c| ENV["chatterbot_config"] = c }
+opts.on('-t', '--tweets [ARG]', "How many tweets to display")    { |t| @tweet_count = t.to_i }
+
+opts.on_tail("-h", "--help", "Show this message") do
+  puts opts
+  exit
+end      
+
+extra = opts.parse!(ARGV)
+
+#
+# will only work if user is tracking tweets in a db
+#
+if ! has_db?
+  puts "You need to specify a db connection!"
+  exit
+end
+
+#
+# return total number of tweets sent in last 'days' days
+#
+def count_for_period(bot, days=1)
+  db[:tweets].filter(:bot => bot[:id]).filter{created_at > (Time.now - (days*86400))}.count
+end
+
+db[:config].each do |bot|
+  puts "Tweets from #{bot[:id]} #{[1,7,30].collect{|d| count_for_period(bot, d)}.join("/")}"
+  db[:tweets].filter(:bot => bot[:id]).order(:created_at.desc).limit(@tweet_count).each do |t|
+    puts "#{t[:created_at]}: #{t[:txt]} (#{t[:source_tweet]})"
+  end
+end

data/chatterbot.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rspec>, [">= 0"])
       s.add_development_dependency(%q<rdoc>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
       s.add_development_dependency(%q<watchr>, [">= 0"])
     else
       s.add_dependency(%q<twitter_oauth>, [">= 0"])
@@ -37,7 +37,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rspec>, [">= 0"])
       s.add_dependency(%q<rdoc>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
       s.add_dependency(%q<watchr>, [">= 0"])
     end
   else

data/lib/chatterbot.rb

@@ -47,4 +47,3 @@ end
 
 # mount up
 Chatterbot.load
-

data/lib/chatterbot/blacklist.rb

@@ -25,18 +25,11 @@ module Chatterbot
       search = s.is_a?(Hash) ? s[:text] : s
       exclude.detect { |e| search.downcase.include?(e) } != nil
     end
-
-    #
-    # Pull the username from a tweet hash -- this is different depending on
-    # if we're doing a search, or parsing through replies/mentions.
-    def tweet_user(s)
-      s.has_key?(:from_user) ? s[:from_user] : s[:user][:screen_name]
-    end
     
     #
     # Is this tweet from a user on our blacklist?
     def on_blacklist?(s)
-      search = (s.is_a?(Hash) ? tweet_user(s) : s).downcase
+      search = (s.is_a?(Hash) ? from_user(s) : s).downcase
       blacklist.any? { |b| search.include?(b.downcase) } ||
         on_global_blacklist?(search)
     end

data/lib/chatterbot/bot.rb

@@ -16,6 +16,10 @@ module Chatterbot
     #
     # Create a new bot. No options for now.
     def initialize(params={})
+      if params.has_key?(:name)
+        @botname = params.delete(:name)
+      end
+
       @config = load_config(params)
       
       # update config when we exit

data/lib/chatterbot/client.rb

@@ -7,13 +7,18 @@ module Chatterbot
     # the Twitter client
     attr_accessor :client
 
+    # track the access token so we can get screen name when
+    # registering new bots
+    attr_accessor :access_token
+
     #
     # default options when querying twitter -- this could be extended
     # with a language, etc.
     def default_opts
       return {} if since_id <= 0
       {
-        :since_id => since_id
+        :since_id => since_id,
+        :result_type => "recent"
       }
     end
     
@@ -34,9 +39,9 @@ module Chatterbot
     #
     # Call this before doing anything that requires an authorized Twitter
     # connection.
-    def require_login
+    def require_login(do_update_config=true)
       init_client
-      login
+      login(do_update_config)
     end
 
     #
@@ -49,6 +54,8 @@ module Chatterbot
 
       puts "Paste your PIN and hit enter when you have completed authorization."
       STDIN.readline.chomp
+    rescue Interrupt => e
+
     end
 
     #
@@ -87,13 +94,16 @@ module Chatterbot
     # error message for auth
     def display_oauth_error
       debug "Oops!  Looks like something went wrong there, please try again!"
-#      exit
     end
     
     #
     # handle oauth for this request.  if the client isn't authorized, print
     # out the auth URL and get a pin code back from the user
-    def login
+    # If +do_update_config+ is false, don't udpate the bots config
+    # file after authorization. This defaults to true but
+    # chatterbot-register will pass in false because it does some
+    # other work before saving.
+    def login(do_update_config=true)
       if needs_api_key?
         get_api_key
       end
@@ -102,16 +112,20 @@ module Chatterbot
         request_token = client.request_token
 
         pin = get_oauth_verifier(request_token)
-        access_token = client.authorize(
+        return false if pin.nil?
+
+        @access_token = client.authorize(
                                          request_token.token,
                                          request_token.secret,
                                          :oauth_verifier => pin
                                          )
 
+
         if client.authorized?
-          config[:token] = access_token.token
-          config[:secret] = access_token.secret
-          update_config
+          config[:token] = @access_token.token
+          config[:secret] = @access_token.secret
+
+          update_config unless do_update_config == false
         else
           display_oauth_error
           return false

data/lib/chatterbot/config.rb

@@ -35,6 +35,13 @@ module Chatterbot
       has_sequel? && config.has_key?(:db_uri)
     end
 
+    def debug_mode=(d)
+      config[:debug_mode] = d
+    end
+    def no_update=(d)
+      config[:no_update] = d
+    end
+    
     #
     # are we in debug mode?
     def debug_mode?
@@ -53,6 +60,10 @@ module Chatterbot
       has_config? && config.has_key?(:log_dest)
     end
 
+    def verbose=(v)
+      config[:verbose] = v
+    end
+   
     def verbose?
       config[:verbose] || false
     end
@@ -132,10 +143,32 @@ module Chatterbot
       config[:token].nil?
     end
 
+    #
+    # determine if we're being called by one of our internal scripts
+    #
+    def chatterbot_helper?
+      File.basename($0).include?("chatterbot-")
+    end
+    
+    #
+    # if we are called by a bot, we want to use the directory of that
+    # script.  If we are called by chatterbot-register or another
+    # helper script, we want to use the current working directory   
+    #
+    def working_dir
+      if chatterbot_helper?
+        Dir.getwd
+      else
+        File.dirname($0)
+      end
+    end
+    
     #
     # figure out what config file to load based on the name of the bot
     def config_file
-      File.join(File.expand_path(File.dirname($0)), "#{botname}.yml")
+      dest = working_dir
+
+      x = File.join(File.expand_path(dest), "#{botname}.yml")
     end
 
     #
@@ -164,7 +197,7 @@ module Chatterbot
        ENV["chatterbot_config"],
        
        # 'global' config file local to the path of the ruby script
-       File.join(File.dirname(File.expand_path($0)), "global.yml")
+       File.join(working_dir, "global.yml")
       ].compact
     end
 
@@ -172,6 +205,7 @@ module Chatterbot
     # get any config from our global config files
     def global_config
       tmp = {}
+
       global_config_files.each { |f|
         tmp.merge!(slurp_file(f) || {})      
       }

data/lib/chatterbot/dsl.rb

@@ -41,29 +41,63 @@ module Chatterbot
       @bot = Chatterbot::Bot.new(params)
     end
 
+    #
+    # should we send tweets?
+    #
+    def debug_mode(d=nil)
+      d = true if d.nil?
+      bot.debug_mode = d
+    end
+
+    #
+    # should we update the db with a new since_id?
+    #
+    def no_update(d=nil)
+      d = true if d.nil?
+      bot.no_update = d
+    end
+
+    #
+    # turn on/off verbose output
+    #
+    def verbose(d=nil)
+      d = true if d.nil?
+      bot.verbose = d
+    end
+
+    #
+    # take a variable list of strings and possibly arrays and turn
+    # them into a single flat array of strings
+    #
+    def flatten_list_of_strings(args)
+      args.collect do |b|
+        if b.is_a?(String)
+          # string, split on commas and turn into array
+          b.split(",").collect { |s| s.strip }
+        else
+          # presumably an array
+          b
+        end
+      end.flatten
+    end
+    
     #
     # specify a bot-specific blacklist of users.  accepts an array, or a 
     # comma-delimited string
-    def blacklist(b=nil)
-      if b.is_a?(String)
-        b = b.split(",").collect { |s| s.strip }
-      end
-
-      if b.nil? || b.empty?
+    def blacklist(*args)
+      list = flatten_list_of_strings(args)
+      
+      if list.nil? || list.empty?
         bot.blacklist = []
       else     
-        bot.blacklist += b
+        bot.blacklist += list
       end
-    
     end
     
     #
     # specify list of strings we will check when deciding to respond to a tweet or not
-    def exclude(e=nil)
-      if e.is_a?(String)
-        e = e.split(",").collect { |s| s.strip }
-      end
-
+    def exclude(*args)
+      e = flatten_list_of_strings(args)
       if e.nil? || e.empty?
         bot.exclude = []
       else     

data/lib/chatterbot/helpers.rb

@@ -3,27 +3,53 @@ module Chatterbot
   #
   # a bunch of helper routines for bots
   module Helpers
+    def botname=(b)
+      @botname = b
+    end
 
     #
     # The name of the currently running bot
     def botname
-      if self.class < Bot
+      if !@botname.nil?
+        @botname
+      elsif self.class < Bot
         self.class.to_s.downcase
       else
         File.basename($0,".rb")
       end
     end
 
+    #
+    # Pull the username from a tweet hash -- this is different depending on
+    # if we're doing a search, or parsing through replies/mentions.
+    def from_user(s)
+      return s if s.is_a?(String)
+      s.has_key?(:from_user) ? s[:from_user] : s[:user][:screen_name]
+    end
+
+    
     #
     # Take the incoming tweet/user name, and turn it into something suitable for replying 
     # to a user. Basically, get their handle and add a '@' to it.
     def tweet_user(tweet)     
-      if ! tweet.is_a?(String)
-        base = tweet.has_key?(:from_user) ? tweet[:from_user] : tweet[:user][:screen_name]
+      base = from_user(tweet)
+      base =~ /^@/ ? base : "@#{base}"
+    end
+
+
+    #
+    # do some simple variable substitution.  for now, it only handles
+    # replacing #USER# with the screen of the incoming tweet, but it
+    # could do more if needed
+    #
+    def replace_variables(txt, original = nil)
+      if ! original.nil? && txt.include?("#USER#")
+        username = tweet_user(original)
+        txt.gsub("#USER#", username)
       else
-        base = tweet
+        txt
       end
-      base =~ /^@/ ? base : "@#{base}"
     end
+
   end
 end

data/lib/chatterbot/reply.rb

@@ -8,7 +8,7 @@ module Chatterbot
     def replies(&block)
       return unless require_login
       debug "check for replies since #{since_id}"
-      
+
       opts = since_id > 0 ? {:since_id => since_id} : {}
       results = client.replies(opts)
 

data/lib/chatterbot/search.rb

@@ -4,6 +4,13 @@ module Chatterbot
   # handle Twitter searches
   module Search
 
+    #
+    # modify a query string to exclude retweets from searches
+    #
+    def exclude_retweets(q)
+      q.include?("include:retweets") ? q : q += " -include:retweets"
+    end
+    
     # internal search code
     def search(queries, opts = {}, &block)
       return unless init_client
@@ -18,13 +25,18 @@ module Chatterbot
       # search twitter
       #
       queries.each { |query|
-        search = client.search(query, opts.merge(default_opts))
+        debug "search: #{query} #{opts.merge(default_opts)}"
+        
+        search = client.search(exclude_retweets(query), opts.merge(default_opts))
         update_since_id(search)
 
         if search != nil
           search["results"].each { |s|
             s.symbolize_keys!
+            debug s[:text]
+            #if s[:text].downcase.include?(query.downcase)
             yield s unless ! block_given? || on_blacklist?(s) || skip_me?(s)
+            #end
           }
         end
       }

data/lib/chatterbot/tweet.rb

@@ -3,11 +3,13 @@ module Chatterbot
   #
   # routines for sending tweets
   module Tweet 
-   
+    
     # simple wrapper for sending a message
     def tweet(txt, params = {}, original = nil)
       return if require_login == false
 
+      txt = replace_variables(txt, original)
+      
       if debug_mode?
         debug "I'm in debug mode, otherwise I would tweet: #{txt}"
       else

data/lib/chatterbot/version.rb

@@ -1,3 +1,3 @@
 module Chatterbot
-  VERSION = "0.2.8"
+  VERSION = "0.2.9"
 end

data/spec/config_spec.rb

@@ -75,6 +75,28 @@ describe "Chatterbot::Config" do
     end
   end
 
+  describe "debug_mode=" do
+    it "works" do
+      @bot.debug_mode = true
+      @bot.config[:debug_mode].should == true
+    end
+  end
+
+  describe "no_update=" do
+    it "works" do
+      @bot.no_update = true
+      @bot.config[:no_update].should == true
+    end
+  end
+
+  describe "verbose=" do
+    it "works" do
+      @bot.verbose = true
+      @bot.config[:verbose].should == true
+    end
+  end
+  
+  
   describe "debug_mode?" do
     it "works when debug_mode isn't set" do
       @bot.debug_mode?.should == false
@@ -181,7 +203,19 @@ describe "Chatterbot::Config" do
     end
   end
 
+  
+  describe "working_dir" do
+    it "returns getwd for chatterbot scripts" do
+      @bot.should_receive(:chatterbot_helper?).and_return(true)
+      @bot.working_dir.should == Dir.getwd
+    end
 
+    it "returns calling dir for non-chatterbot scripts" do
+      @bot.should_receive(:chatterbot_helper?).and_return(false)
+      @bot.working_dir.should == File.dirname($0)
+    end
+  end
+  
   describe "file I/O" do
     it "loads in some YAML" do
       tmp = {:since_id => 0}
@@ -216,5 +250,21 @@ describe "Chatterbot::Config" do
       @bot.update_config     
     end
   end
+
+  describe "store_local_config" do
+    before(:each) do
+      tmp = {:x => 123, :foo => :bar}
+      
+      @src = Tempfile.new("config")
+
+      @bot.stub!(:config_file).and_return(@src.path)
+      @bot.stub!(:config_to_save).and_return(tmp)
+    end
+
+    it "should work" do
+      @bot.store_local_config
+      @bot.slurp_file(@src.path).should == { :x => 123, :foo => :bar }
+    end
+  end
   
 end

data/spec/dsl_spec.rb

@@ -25,7 +25,26 @@ describe "Chatterbot::DSL" do
         blacklist "foo, bar"
       end
     end
-  
+
+    [:no_update, :debug_mode, :verbose].each do |method|
+      describe method.to_s do
+        it "#{method.to_s} with nil passes along true to bot object" do
+          @bot.should_receive("#{method.to_s}=").with(true)
+          send method
+        end
+
+        it "#debug_mode with false is passed" do
+          @bot.should_receive("#{method.to_s}=").with(false)
+          send method, false
+        end
+
+        it "#debug_mode with true is passed" do
+          @bot.should_receive("#{method.to_s}=").with(true)          
+          send method, true
+        end
+      end
+    end
+    
     describe "exclude" do
       it "#exclude passes along to bot object" do
         @bot.should_receive(:exclude=).with(["foo"])

data/spec/helpers_spec.rb

@@ -18,15 +18,39 @@ describe "Chatterbot::Helpers" do
     bot.tweet_user("foo").should == "@foo"
     bot.tweet_user("@foo").should == "@foo"    
   end
- 
+
+  describe "#from_user" do
+    before(:each) do
+      @bot = Chatterbot::Bot.new
+    end
+
+    it "should accept strings" do
+      @bot.from_user("x").should == "x"
+    end
+
+    it "should accept :from_user" do
+      @bot.from_user(:from_user => "x").should == "x"
+    end
+
+    it "should accept :screen_name" do
+      @bot.from_user(:user => {:screen_name => "x"}).should == "x"
+    end
+  end
+  
   describe "#botname" do    
     before(:each) do
+      class TestBot < Chatterbot::Bot; end
       @bot = Chatterbot::Bot.new
       @bot.client = mock(Object)
     end
 
+    it "can set botname" do
+      @bot = TestBot.new
+      @bot.botname = "foo"
+      @bot.botname.should == "foo"
+    end
+    
     it "calls botname smartly for inherited classes" do
-      class TestBot < Chatterbot::Bot; end
       @bot2 = TestBot.new
       @bot2.botname.should == "testbot"
     end
@@ -35,6 +59,30 @@ describe "Chatterbot::Helpers" do
       File.should_receive(:basename).and_return("bot")
       @bot.botname.should == "bot"
     end
+
+    it "uses specified name" do
+      @bot = Chatterbot::Bot.new(:name => 'xyzzy')
+      @bot.botname.should == "xyzzy"
+    end
   end
-  
+
+  describe "#replace_variables" do
+    before(:each) do
+      @bot = Chatterbot::Bot.new(:name => 'xyzzy')
+      @tweet = {}
+    end
+
+    it "should replace username by calling tweet_user" do
+      @bot.should_receive(:tweet_user).and_return("@foobar")
+      @bot.replace_variables("#USER#", @tweet).should == "@foobar"
+    end
+    
+    it "should be fine with not replacing anything" do
+      @bot.replace_variables("foobar", @tweet).should == "foobar"
+    end
+    
+    it "should be fine without a tweet" do
+      @bot.replace_variables("foobar").should == "foobar"
+    end
+  end  
 end

data/spec/reply_spec.rb

@@ -72,6 +72,16 @@ describe "Chatterbot::Reply" do
 
     bot.replies
   end
-    
+
+
+  it "outputs an error if we get one from API" do
+    bot = test_bot
+    bot.stub!(:require_login).and_return(true)
+    bot.stub!(:client).and_return(mock(Object, :replies => {"error" => "You messed up"}))
+
+    bot.should_receive(:critical).with("You messed up")
+
+    bot.replies
+  end
   
 end

data/spec/search_spec.rb

@@ -1,12 +1,30 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "Chatterbot::Search" do
+  describe "exclude_retweets" do
+    before(:each) do
+      @bot = Chatterbot::Bot.new
+    end
+
+    it "should tack onto query" do
+      @bot.exclude_retweets("foo").should == ("foo -include:retweets")
+    end
+
+    it "shouldn't tack onto query" do
+      @bot.exclude_retweets("foo -include:retweets").should == ("foo -include:retweets")
+    end
+
+    it "shouldn't tack onto query" do
+      @bot.exclude_retweets("foo include:retweets").should == ("foo include:retweets")
+    end
+  end
+
   it "calls search" do
     bot = Chatterbot::Bot.new
     bot.should_receive(:search)
     bot.search("foo")
   end
-
+  
   it "calls init_client" do
     bot = test_bot
     bot.should_receive(:init_client).and_return(false)
@@ -27,8 +45,8 @@ describe "Chatterbot::Search" do
     #bot = Chatterbot::Bot.new
 
     bot.stub!(:client).and_return(fake_search(100))
-    bot.client.should_receive(:search).with("foo", {})
-    bot.client.should_receive(:search).with("bar", {})    
+    bot.client.should_receive(:search).with("foo -include:retweets", {})
+    bot.client.should_receive(:search).with("bar -include:retweets", {})    
 
     bot.search(["foo", "bar"])
   end
@@ -37,7 +55,7 @@ describe "Chatterbot::Search" do
     bot = test_bot
 
     bot.stub!(:client).and_return(fake_search(100))
-    bot.client.should_receive(:search).with("foo", {:lang => "en"})
+    bot.client.should_receive(:search).with("foo -include:retweets", {:lang => "en"})
 
     bot.search("foo", :lang => "en")
   end
@@ -46,7 +64,7 @@ describe "Chatterbot::Search" do
     bot = test_bot
 
     bot.stub!(:client).and_return(fake_search(100))
-    bot.client.should_receive(:search).with("foo", {})
+    bot.client.should_receive(:search).with("foo -include:retweets", {})
 
     bot.search("foo")
   end
@@ -56,7 +74,7 @@ describe "Chatterbot::Search" do
     bot.stub!(:since_id).and_return(123)
     
     bot.stub!(:client).and_return(fake_search(100))
-    bot.client.should_receive(:search).with("foo", {:since_id => 123})
+    bot.client.should_receive(:search).with("foo -include:retweets", {:since_id => 123, :result_type => "recent"})
 
     bot.search("foo")
   end

data/spec/spec_helper.rb

@@ -1,14 +1,16 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'simplecov'
+SimpleCov.start
+#$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+#$LOAD_PATH.unshift(File.dirname(__FILE__))
 
 require 'bundler/setup'
 Bundler.require
 
-require 'rspec'
-require 'chatterbot'
 
-require "twitter_oauth"
+#require 'rspec'
+#require 'chatterbot'
 
+require "twitter_oauth"
 
 require 'tempfile'
 require 'sqlite3'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chatterbot
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.2.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-06-15 00:00:00.000000000Z
+date: 2011-10-15 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twitter_oauth
-  requirement: &23683200 !ruby/object:Gem::Requirement
+  requirement: &9989900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *23683200
+  version_requirements: *9989900
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &23682700 !ruby/object:Gem::Requirement
+  requirement: &9989400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *23682700
+  version_requirements: *9989400
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &23682220 !ruby/object:Gem::Requirement
+  requirement: &9988920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *23682220
+  version_requirements: *9988920
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &23681740 !ruby/object:Gem::Requirement
+  requirement: &9988440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *23681740
+  version_requirements: *9988440
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &23681260 !ruby/object:Gem::Requirement
+  requirement: &9987960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *23681260
+  version_requirements: *9987960
 - !ruby/object:Gem::Dependency
-  name: rcov
-  requirement: &23711280 !ruby/object:Gem::Requirement
+  name: simplecov
+  requirement: &9987480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *23711280
+  version_requirements: *9987480
 - !ruby/object:Gem::Dependency
   name: watchr
-  requirement: &23710800 !ruby/object:Gem::Requirement
+  requirement: &9987000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,12 +87,14 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *23710800
+  version_requirements: *9987000
 description: A framework for writing bots that run on Twitter. Comes with a simple
   DSL for easy coding.
 email: colin@muffinlabs.com
 executables:
 - chatterbot-blacklist
+- chatterbot-register
+- chatterbot-status
 extensions: []
 extra_rdoc_files: []
 files:
@@ -100,9 +102,11 @@ files:
 - .gitignore
 - Gemfile
 - LICENSE.txt
-- README.rdoc
+- README.markdown
 - Rakefile
 - bin/chatterbot-blacklist
+- bin/chatterbot-register
+- bin/chatterbot-status
 - chatterbot.gemspec
 - examples/class_bot.rb
 - examples/config.yml.example
@@ -155,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: chatterbot
-rubygems_version: 1.8.3
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: A framework for writing Twitter bots