chatterbot 2.0.3 → 2.0.4

data/docs/features.md

@@ -0,0 +1,88 @@
+---
+layout: page
+title: "Basic Features"
+category: doc
+---
+
+Here's a list of some of the commonly-used 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 "#USER# I am serious, and don't call me Shirley!", tweet
+    end
+    
+By default, Chatterbot keeps track of the last time you ran the bot,
+and it will only search for new tweets.
+
+**replies** -- Use this to check for replies and mentions:
+
+    replies do |tweet|
+      reply "#USER# Thanks for contacting me!", tweet
+    end
+
+Note that the string **#USER#** is automatically replaced with the
+username of the person who sent the original tweet. Also, Chatterbot
+will only return tweets that were sent since the last run of the bot.
+
+**tweet** -- send a Tweet out for this bot:
+
+    tweet "I AM A BOT!!!"
+
+**reply** -- reply to another tweet:
+
+    reply "THIS IS A REPLY TO #USER#!", original_tweet
+
+**retweet** -- Chatterbot can retweet tweets as well:
+
+```rb
+  search "xyzzy" do |tweet|
+    retweet(tweet[:id])
+  end
+```
+
+**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:
+  
+    blacklist "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
+your bot in a tweet, you will still receive that tweet when checking
+for replies.
+
+**exclude** -- similarly, you can specify a list of words/phrases
+  which shouldn't trigger your bot. If you use the following:
+  
+    exclude "spam"
+    
+Any tweets or mentions with the word 'spam' in them will be ignored by
+the bot. If you wanted to ignore any tweets with links in them (a wise
+precaution if you want to avoid spreading spam), you could call:
+
+    exclude "http://"
+
+The library actually comes with a pre-defined list of 'bad words'
+which you can exclude by default by calling:
+
+    exclude bad_words
+    
+The word list is from Darius Kazemi's
+[wordfilter](https://github.com/dariusk/wordfilter).
+
+
+**whitelist**
+
+**followers** -- get a list of your followers. This is an experimental
+  feature but should work for most purposes.
+
+**follow**
+
+**profile_text**
+**profile_website**
+
+
+For more details, check out
+[dsl.rb](https://github.com/muffinista/chatterbot/blob/master/lib/chatterbot/dsl.rb)
+in the source code.

data/docs/index.md

@@ -0,0 +1,70 @@
+---
+layout: default
+title: "Chatterbot - ruby for Twitter bots"
+---
+
+Chatterbot
+===========
+
+[Chatterbot](https://github.com/muffinista/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
+a simple blacklist/whitelist system to help minimize spam and unwanted
+data.
+
+A bot using chatterbot can be as simple as this:
+
+```
+exclude "http://"
+blacklist "mean_user, private_user"
+
+puts "checking my timeline"
+home_timeline do |tweet|
+    # i like to favorite things
+    favorite tweet
+end
+
+puts "checking for replies to my tweets and mentions of me"
+replies do |tweet|
+  text = tweet.text
+  puts "message received: #{text}"
+  src = text.gsub(/@echoes_bot/, "#USER#")  
+
+  # send it back!
+  reply src, tweet
+end
+```
+
+Or you can write a bot using more traditional ruby classes.
+
+Chatterbot can actually generate a template bot file for you, and will
+walk you through process of getting a bot authorized with Twitter.
+
+
+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
+* 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
+
+
+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::Tweet` objects.
+
+
+Copyright/License
+-----------------
+
+Copyright (c) 2014 Colin Mitchell. Chatterbot is distributed under the
+WTFPL license.
+
+
+http://muffinlabs.com
+

data/docs/javascripts/main.js

@@ -0,0 +1 @@
+console.log('This would be the main JS file.');

data/docs/other-tools.md

@@ -0,0 +1,17 @@
+---
+layout: page
+title: "Other Tools"
+category: links
+---
+
+
+* [twitter_ebooks](https://github.com/mispy/twitter_ebooks) from mispy
+  is powering a bunch of ebooks-ish accounts, and other things too.
+* The [twitter gem](https://github.com/sferik/twitter) from sferik is
+  great, and is what sits beneath Chatterbot.
+* [t](https://github.com/sferik/t), also by sferik, is a handy
+  command-line interface to Twitter.
+* [twitterbot](https://github.com/thricedotted/twitterbot) from thricedotted.
+* [tweepy](https://github.com/tweepy/tweepy).
+
+

data/docs/params.json

@@ -0,0 +1 @@
+{"name":"Chatterbot","tagline":"A straightforward ruby-based Twitter Bot Framework, using OAuth to authenticate.","body":"### Welcome to GitHub Pages.\r\nThis automatic page generator is the easiest way to create beautiful pages for all of your projects. Author your page content here using GitHub Flavored Markdown, select a template crafted by a designer, and publish. After your page is generated, you can check out the new branch:\r\n\r\n```\r\n$ cd your_repo_root/repo_name\r\n$ git fetch origin\r\n$ git checkout gh-pages\r\n```\r\n\r\nIf you're using the GitHub for Mac, simply sync your repository and you'll see the new branch.\r\n\r\n### Designer Templates\r\nWe've crafted some handsome templates for you to use. Go ahead and continue to layouts to browse through them. You can easily go back to edit your page before publishing. After publishing your page, you can revisit the page generator and switch to another theme. Your Page content will be preserved if it remained markdown format.\r\n\r\n### Rather Drive Stick?\r\nIf you prefer to not use the automatic generator, push a branch named `gh-pages` to your repository to create a page manually. In addition to supporting regular HTML content, GitHub Pages support Jekyll, a simple, blog aware static site generator written by our own Tom Preston-Werner. Jekyll makes it easy to create site-wide headers and footers without having to copy them across every page. It also offers intelligent blog support and other advanced templating features.\r\n\r\n### Authors and Contributors\r\nYou can @mention a GitHub username to generate a link to their profile. The resulting `<a>` element will link to the contributor's GitHub Profile. For example: In 2007, Chris Wanstrath (@defunkt), PJ Hyett (@pjhyett), and Tom Preston-Werner (@mojombo) founded GitHub.\r\n\r\n### Support or Contact\r\nHaving trouble with Pages? Check out the documentation at http://help.github.com/pages or contact support@github.com and we’ll help you sort it out.\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}

data/docs/rdoc.md

@@ -0,0 +1,6 @@
+---
+layout: page
+title: "rdoc"
+category: links
+link: http://rubydoc.info/gems/chatterbot
+---

data/docs/setup.md

@@ -0,0 +1,84 @@
+---
+layout: page
+title: "Authorizing Your Bot"
+category: tut
+---
+
+Getting a bot running on Twitter can be a little tricky. Twitter uses
+a something called [OAuth](https://dev.twitter.com/oauth) to validate
+requests, but it's a little more complicated than just specifying a
+username/password.
+
+* Login to Twitter with your bot account
+
+* Go to https://apps.twitter.com/app/new
+
+* Fill out the form. You need to put a name, description, and Website
+  URL, although the URL doesn't need to exist. <img
+  src="./images/01-create-application.png" />
+  
+
+* Save the form, and then click on the Permissions tab. You will need
+  to specify what level of access is needed for your bot. <img
+  src="./images/02-application-permissions.png" /> You have three
+  choices here: Read only, Read and Write, and Read and Write and
+  access DMs. If your bot isn't actually ever going to post to Twitter
+  (for example, if you're just running a search to find interesting
+  tweets), you can choose read-only. Otherwise, you should pick
+  read/write, or read/write/DMs. Chatterbot has limited support for
+  handling Direct Messages, but if you can imagine a situation where
+  you might want to handle them, you should pick this option.
+
+* *NOTE:* When you try and save this form, there's a good chance that
+  you will get an error that tells you to add a mobile phone to your Twitter
+  profile. It will look a lot like this: <img src="./images/03-mobile-number.png" />
+
+  You can add your number here: https://twitter.com/settings/devices
+
+  After you add the number, Twitter will ask you to send them a text
+  message. Once you do this, you can finish updating the settings for
+  your application. Later, we'll remove the mobile number.
+
+
+Once you've registered your application, you have two options. You can
+create access tokens for your bot via Twitter, or you can run the
+`chatterbot-register` script. Running the script will take care of
+creating a template file for your bot, but if you don't want to do
+that, here are the steps for doing this manually:
+  
+*  click the 'Keys and Access Tokens' link. You should see this: <img src="./images/04-access-token.png" />
+* click the 'Create my access token' link. 
+* It might take a few minutes for Twitter to actually generate the
+  token. You can refresh the page a couple times until they are there,
+  then you can copy the keys into your application. There's four keys
+  you will need for your bot, and a couple different ways to save
+  them:
+
+**In a separate YAML config file**. Create a file named botname.yaml
+  -- the botname part must match your bot's username EXACTLY. Put the
+  following contents, pasting the credential values that you just
+  generated:
+
+```
+  ---
+  :consumer_secret: Consumer Secret (API Secret) GOES HERE
+  :consumer_key: Consumer Key (API Key) GOES HERE
+  :token: Access Token GOES HERE
+  :secret: Access Token Secret GOES HERE
+```
+
+**in the script**. Add some lines to your bot script like this:
+```
+consumer_key 'Consumer Secret (API Secret)'
+consumer_secret 'Consumer Key (API Key)'
+secret 'Access Token Secret'
+token 'Access Token'
+```
+
+**in a database**. If you've setup chatterbot to use a database, you
+  can store your configuration info in the **config** table.
+
+
+**NOTE** At this point, you can remove the phone number from the bot
+  account if you like. From your bot's account, click 'Settings' ->
+  'Mobile' -> 'Delete my phone'.

data/docs/streaming.md

@@ -0,0 +1,98 @@
+---
+layout: page
+title: "Streaming API"
+category: doc
+---
+
+Chatterbot has basic support for Twitter's [Streaming API](https://dev.twitter.com/streaming/overview). If
+you are an advanced developer, or want to create something very
+involved, it might make more sense to use a different library.
+However, if you do use Chatterbot, you can continue to use the DSL,
+and you get access to a bunch of helpful routines.
+
+Here's an example bot using the Streaming API:
+
+```
+#!/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
+```
+
+By default, chatterbot will use the
+[user endpoint](https://dev.twitter.com/streaming/userstreams), which
+returns events for the bot -- mentions, follows, etc. If you want to
+perform a search, or use the sample endpoint, you will need to specify
+that:
+
+
+```
+#
+# sample the twitter stream
+#
+streaming(endpoint:"sample") do
+    sample do |tweet|
+      puts tweet.text
+    end
+end
+```
+
+
+```
+#
+# run a search
+#
+streaming(endpoint:"search") do
+    search("Streaming API") do |tweet|
+      puts tweet.text
+    end
+end
+```
+
+```
+#
+# find geocoded tweets
+#
+streaming(endpoint: :filter, locations:"-180,-90,180,90") do
+    user do |tweet|
+      puts tweet.text
+    end
+end
+```

data/docs/stylesheets/pygment_trac.css

@@ -0,0 +1,68 @@
+.highlight .c { color: #999988; font-style: italic } /* Comment */
+.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
+.highlight .k { font-weight: bold } /* Keyword */
+.highlight .o { font-weight: bold } /* Operator */
+.highlight .cm { color: #999988; font-style: italic } /* Comment.Multiline */
+.highlight .cp { color: #999999; font-weight: bold } /* Comment.Preproc */
+.highlight .c1 { color: #999988; font-style: italic } /* Comment.Single */
+.highlight .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */
+.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
+.highlight .gd .x { color: #000000; background-color: #ffaaaa } /* Generic.Deleted.Specific */
+.highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .gr { color: #aa0000 } /* Generic.Error */
+.highlight .gh { color: #999999 } /* Generic.Heading */
+.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
+.highlight .gi .x { color: #000000; background-color: #aaffaa } /* Generic.Inserted.Specific */
+.highlight .go { color: #888888 } /* Generic.Output */
+.highlight .gp { color: #555555 } /* Generic.Prompt */
+.highlight .gs { font-weight: bold } /* Generic.Strong */
+.highlight .gu { color: #800080; font-weight: bold; } /* Generic.Subheading */
+.highlight .gt { color: #aa0000 } /* Generic.Traceback */
+.highlight .kc { font-weight: bold } /* Keyword.Constant */
+.highlight .kd { font-weight: bold } /* Keyword.Declaration */
+.highlight .kn { font-weight: bold } /* Keyword.Namespace */
+.highlight .kp { font-weight: bold } /* Keyword.Pseudo */
+.highlight .kr { font-weight: bold } /* Keyword.Reserved */
+.highlight .kt { color: #445588; font-weight: bold } /* Keyword.Type */
+.highlight .m { color: #009999 } /* Literal.Number */
+.highlight .s { color: #d14 } /* Literal.String */
+.highlight .na { color: #008080 } /* Name.Attribute */
+.highlight .nb { color: #0086B3 } /* Name.Builtin */
+.highlight .nc { color: #445588; font-weight: bold } /* Name.Class */
+.highlight .no { color: #008080 } /* Name.Constant */
+.highlight .ni { color: #800080 } /* Name.Entity */
+.highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */
+.highlight .nf { color: #990000; font-weight: bold } /* Name.Function */
+.highlight .nn { color: #555555 } /* Name.Namespace */
+.highlight .nt { color: #CBDFFF } /* Name.Tag */
+.highlight .nv { color: #008080 } /* Name.Variable */
+.highlight .ow { font-weight: bold } /* Operator.Word */
+.highlight .w { color: #bbbbbb } /* Text.Whitespace */
+.highlight .mf { color: #009999 } /* Literal.Number.Float */
+.highlight .mh { color: #009999 } /* Literal.Number.Hex */
+.highlight .mi { color: #009999 } /* Literal.Number.Integer */
+.highlight .mo { color: #009999 } /* Literal.Number.Oct */
+.highlight .sb { color: #d14 } /* Literal.String.Backtick */
+.highlight .sc { color: #d14 } /* Literal.String.Char */
+.highlight .sd { color: #d14 } /* Literal.String.Doc */
+.highlight .s2 { color: #d14 } /* Literal.String.Double */
+.highlight .se { color: #d14 } /* Literal.String.Escape */
+.highlight .sh { color: #d14 } /* Literal.String.Heredoc */
+.highlight .si { color: #d14 } /* Literal.String.Interpol */
+.highlight .sx { color: #d14 } /* Literal.String.Other */
+.highlight .sr { color: #009926 } /* Literal.String.Regex */
+.highlight .s1 { color: #d14 } /* Literal.String.Single */
+.highlight .ss { color: #990073 } /* Literal.String.Symbol */
+.highlight .bp { color: #999999 } /* Name.Builtin.Pseudo */
+.highlight .vc { color: #008080 } /* Name.Variable.Class */
+.highlight .vg { color: #008080 } /* Name.Variable.Global */
+.highlight .vi { color: #008080 } /* Name.Variable.Instance */
+.highlight .il { color: #009999 } /* Literal.Number.Integer.Long */
+
+.type-csharp .highlight .k { color: #0000FF }
+.type-csharp .highlight .kt { color: #0000FF }
+.type-csharp .highlight .nf { color: #000000; font-weight: normal }
+.type-csharp .highlight .nc { color: #2B91AF }
+.type-csharp .highlight .nn { color: #000000 }
+.type-csharp .highlight .s { color: #A31515 }
+.type-csharp .highlight .sc { color: #A31515 }