RubyGems - chatterbot - Versions diffs - 2.0.5 → 2.1.0 - Mend

chatterbot 2.0.5 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (43) hide show

checksums.yaml +5 -5
data/.github/workflows/ci.yml +19 -0
data/Gemfile +2 -2
data/README.markdown +7 -21
data/chatterbot.gemspec +3 -3
data/docs/_site/advanced.html +43 -54
data/docs/_site/configuration.html +23 -43
data/docs/_site/contributing.html +18 -37
data/docs/_site/deploying.html +44 -61
data/docs/_site/examples.html +108 -123
data/docs/_site/features.html +70 -71
data/docs/_site/index.html +43 -64
data/docs/_site/other-tools.html +22 -41
data/docs/_site/rdoc.html +17 -36
data/docs/_site/setup.html +62 -71
data/docs/_site/tut.html +16 -36
data/docs/_site/twitter-docs.html +17 -36
data/docs/_site/walkthrough.html +35 -51
data/docs/advanced.md +0 -5
data/docs/deploying.md +0 -6
data/docs/examples.md +0 -48
data/docs/index.md +2 -3
data/lib/chatterbot.rb +0 -1
data/lib/chatterbot/bot.rb +5 -68
data/lib/chatterbot/client.rb +2 -9
data/lib/chatterbot/config.rb +0 -1
data/lib/chatterbot/dsl.rb +0 -43
data/lib/chatterbot/skeleton.rb +0 -2
data/lib/chatterbot/version.rb +1 -1
data/spec/bot_spec.rb +1 -76
data/spec/client_spec.rb +0 -3
data/spec/config_manager_spec.rb +6 -5
data/spec/config_spec.rb +4 -1
data/spec/dsl_spec.rb +1 -33
data/templates/skeleton.txt +0 -47
metadata +13 -21
data/.document +0 -5
data/.travis.yml +0 -9
data/docs/_site/streaming.html +0 -506
data/docs/streaming.md +0 -98
data/examples/streaming_bot.rb +0 -49
data/lib/chatterbot/streaming.rb +0 -72
data/spec/streaming_spec.rb +0 -172

data/docs/_site/features.html CHANGED Viewed

@@ -9,15 +9,15 @@
         <meta name="description" content="twitter bots in ruby">
         <link href="//netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
-        <link rel="stylesheet" href="/css/syntax.css">
-        <link rel="stylesheet" href="/css/main.css">
+        <link rel="stylesheet" href="/chatterbot/css/syntax.css">
+        <link rel="stylesheet" href="/chatterbot/css/main.css">
     </head>
     <body>
         <div class="container">
             <div class=row-fluid>
                 <div id=header class=span12>
-                    <h4><a class=brand href="/">chatterbot</a>
+                    <h4><a class=brand href="/chatterbot/">chatterbot</a>
     <small>twitter bots in ruby</small>
 </h4>
@@ -30,7 +30,7 @@
                     <div id=navigation class=span2>
                         <ul class="nav nav-list">
-  <li><a href="/">Home</a></li>
+  <li><a href="/chatterbot/">Home</a></li>
@@ -56,7 +56,7 @@
         <li data-order="">
-            <a href="/examples.html">Examples</a>
+            <a href="/chatterbot/examples.html">Examples</a>
         </li>
@@ -82,7 +82,7 @@
         <li data-order="">
-            <a href="/setup.html">Authorizing Your Bot</a>
+            <a href="/chatterbot/setup.html">Authorizing Your Bot</a>
         </li>
@@ -97,14 +97,10 @@
         <li data-order="">
-            <a href="/walkthrough.html">Walkthrough</a>
+            <a href="/chatterbot/walkthrough.html">Walkthrough</a>
         </li>
@@ -119,7 +115,7 @@
         <li data-order="">
-            <a href="/advanced.html">Advanced Features</a>
+            <a href="/chatterbot/advanced.html">Advanced Features</a>
         </li>
@@ -129,7 +125,7 @@
         <li data-order="">
-            <a href="/configuration.html">Configuration</a>
+            <a href="/chatterbot/configuration.html">Configuration</a>
         </li>
@@ -143,7 +139,7 @@
         <li data-order="">
-            <a href="/deploying.html">Running your Bot</a>
+            <a href="/chatterbot/deploying.html">Running your Bot</a>
         </li>
@@ -157,7 +153,7 @@
         <li data-order="">
-            <a href="/features.html">Basic Features</a>
+            <a href="/chatterbot/features.html">Basic Features</a>
         </li>
@@ -180,16 +176,6 @@
-        <li data-order="">
-            <a href="/streaming.html">Streaming API</a>
-        </li>
@@ -218,7 +204,7 @@
         <li data-order="">
-            <a href="/contributing.html">Contributing</a>
+            <a href="/chatterbot/contributing.html">Contributing</a>
         </li>
@@ -259,10 +245,6 @@
@@ -305,7 +287,7 @@
         <li data-order="">
-            <a href="/other-tools.html">Other Tools</a>
+            <a href="/chatterbot/other-tools.html">Other Tools</a>
         </li>
@@ -330,10 +312,6 @@
         <li data-order="">
@@ -361,65 +339,84 @@
     </h2>
 </div>
-<p>Here&#39;s a list of some of the commonly-used methods in the Chatterbot DSL:</p>
+<p>Here’s a list of some of the commonly-used methods in the Chatterbot DSL:</p>
+<p><strong>search</strong> – You can use this to perform a search on Twitter:</p>
-<p><strong>search</strong> -- You can use this to perform a search on Twitter:</p>
-<div class="highlight"><pre><code class="language-text" data-lang="text">search(&quot;&#39;surely you must be joking&#39;&quot;) do |tweet|
-  reply &quot;#USER# I am serious, and don&#39;t call me Shirley!&quot;, tweet
+<pre><code>search("'surely you must be joking'") do |tweet|
+  reply "#USER# I am serious, and don't call me Shirley!", tweet
 end
-</code></pre></div>
+</code></pre>
 <p>By default, Chatterbot keeps track of the last time you ran the bot,
 and it will only search for new tweets.</p>
-<p><strong>replies</strong> -- Use this to check for replies and mentions:</p>
-<div class="highlight"><pre><code class="language-text" data-lang="text">replies do |tweet|
-  reply &quot;#USER# Thanks for contacting me!&quot;, tweet
+<p><strong>replies</strong> – Use this to check for replies and mentions:</p>
+<pre><code>replies do |tweet|
+  reply "#USER# Thanks for contacting me!", tweet
 end
-</code></pre></div>
+</code></pre>
 <p>Note that the string <strong>#USER#</strong> 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.</p>
-<p><strong>tweet</strong> -- send a Tweet out for this bot:</p>
-<div class="highlight"><pre><code class="language-text" data-lang="text">tweet &quot;I AM A BOT!!!&quot;
-</code></pre></div>
-<p><strong>reply</strong> -- reply to another tweet:</p>
-<div class="highlight"><pre><code class="language-text" data-lang="text">reply &quot;THIS IS A REPLY TO #USER#!&quot;, original_tweet
-</code></pre></div>
-<p><strong>retweet</strong> -- Chatterbot can retweet tweets as well:</p>
-<div class="highlight"><pre><code class="language-rb" data-lang="rb">  <span class="n">search</span> <span class="s2">&quot;xyzzy&quot;</span> <span class="k">do</span> <span class="o">|</span><span class="n">tweet</span><span class="o">|</span>
-    <span class="n">retweet</span><span class="p">(</span><span class="n">tweet</span><span class="o">[</span><span class="ss">:id</span><span class="o">]</span><span class="p">)</span>
-  <span class="k">end</span>
-</code></pre></div>
-<p><strong>blacklist</strong> -- you can use this to specify a list of users you don&#39;t
+<p><strong>tweet</strong> – send a Tweet out for this bot:</p>
+<pre><code>tweet "I AM A BOT!!!"
+</code></pre>
+<p><strong>reply</strong> – reply to another tweet:</p>
+<pre><code>reply "THIS IS A REPLY TO #USER#!", original_tweet
+</code></pre>
+<p><strong>retweet</strong> – Chatterbot can retweet tweets as well:</p>
+<p><code>rb
+  search "xyzzy" do |tweet|
+    retweet(tweet[:id])
+  end
+</code></p>
+<p><strong>blacklist</strong> – 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:</p>
-<div class="highlight"><pre><code class="language-text" data-lang="text">blacklist &quot;user1, user2, user3&quot;
-</code></pre></div>
+<pre><code>blacklist "user1, user2, user3"
+</code></pre>
 <p>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.</p>
-<p><strong>exclude</strong> -- similarly, you can specify a list of words/phrases
-  which shouldn&#39;t trigger your bot. If you use the following:</p>
-<div class="highlight"><pre><code class="language-text" data-lang="text">exclude &quot;spam&quot;
-</code></pre></div>
-<p>Any tweets or mentions with the word &#39;spam&#39; in them will be ignored by
+<p><strong>exclude</strong> – similarly, you can specify a list of words/phrases
+  which shouldn’t trigger your bot. If you use the following:</p>
+<pre><code>exclude "spam"
+</code></pre>
+<p>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:</p>
-<div class="highlight"><pre><code class="language-text" data-lang="text">exclude &quot;http://&quot;
-</code></pre></div>
-<p>The library actually comes with a pre-defined list of &#39;bad words&#39;
+<pre><code>exclude "http://"
+</code></pre>
+<p>The library actually comes with a pre-defined list of ‘bad words’
 which you can exclude by default by calling:</p>
-<div class="highlight"><pre><code class="language-text" data-lang="text">exclude bad_words
-</code></pre></div>
-<p>The word list is from Darius Kazemi&#39;s
+<pre><code>exclude bad_words
+</code></pre>
+<p>The word list is from Darius Kazemi’s
 <a href="https://github.com/dariusk/wordfilter">wordfilter</a>.</p>
 <p><strong>whitelist</strong></p>
-<p><strong>followers</strong> -- get a list of your followers. This is an experimental
+<p><strong>followers</strong> – get a list of your followers. This is an experimental
   feature but should work for most purposes.</p>
 <p><strong>follow</strong></p>
@@ -438,7 +435,9 @@ in the source code.</p>
             <div class=row-fluid>
                 <div id=footer class=span12>
-                    Documentation for <a href="https://github.com/muffinista/chatterbot">chatterbot</a>
+                    <!--
+Documentation for <a href="https://github.com/muffinista/chatterbot">chatterbot</a>
+-->
                 </div>
             </div>

data/docs/_site/index.html CHANGED Viewed

@@ -9,15 +9,15 @@
         <meta name="description" content="twitter bots in ruby">
         <link href="//netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
-        <link rel="stylesheet" href="/css/syntax.css">
-        <link rel="stylesheet" href="/css/main.css">
+        <link rel="stylesheet" href="/chatterbot/css/syntax.css">
+        <link rel="stylesheet" href="/chatterbot/css/main.css">
     </head>
     <body>
         <div class="container">
             <div class=row-fluid>
                 <div id=header class=span12>
-                    <h4><a class=brand href="/">chatterbot</a>
+                    <h4><a class=brand href="/chatterbot/">chatterbot</a>
     <small>twitter bots in ruby</small>
 </h4>
@@ -30,7 +30,7 @@
                     <div id=navigation class=span2>
                         <ul class="nav nav-list">
-  <li><a href="/">Home</a></li>
+  <li><a href="/chatterbot/">Home</a></li>
@@ -56,7 +56,7 @@
         <li data-order="">
-            <a href="/examples.html">Examples</a>
+            <a href="/chatterbot/examples.html">Examples</a>
         </li>
@@ -82,7 +82,7 @@
         <li data-order="">
-            <a href="/setup.html">Authorizing Your Bot</a>
+            <a href="/chatterbot/setup.html">Authorizing Your Bot</a>
         </li>
@@ -97,14 +97,10 @@
         <li data-order="">
-            <a href="/walkthrough.html">Walkthrough</a>
+            <a href="/chatterbot/walkthrough.html">Walkthrough</a>
         </li>
@@ -119,7 +115,7 @@
         <li data-order="">
-            <a href="/advanced.html">Advanced Features</a>
+            <a href="/chatterbot/advanced.html">Advanced Features</a>
         </li>
@@ -129,7 +125,7 @@
         <li data-order="">
-            <a href="/configuration.html">Configuration</a>
+            <a href="/chatterbot/configuration.html">Configuration</a>
         </li>
@@ -143,7 +139,7 @@
         <li data-order="">
-            <a href="/deploying.html">Running your Bot</a>
+            <a href="/chatterbot/deploying.html">Running your Bot</a>
         </li>
@@ -157,7 +153,7 @@
         <li data-order="">
-            <a href="/features.html">Basic Features</a>
+            <a href="/chatterbot/features.html">Basic Features</a>
         </li>
@@ -180,16 +176,6 @@
-        <li data-order="">
-            <a href="/streaming.html">Streaming API</a>
-        </li>
@@ -218,7 +204,7 @@
         <li data-order="">
-            <a href="/contributing.html">Contributing</a>
+            <a href="/chatterbot/contributing.html">Contributing</a>
         </li>
@@ -259,10 +245,6 @@
@@ -305,7 +287,7 @@
         <li data-order="">
-            <a href="/other-tools.html">Other Tools</a>
+            <a href="/chatterbot/other-tools.html">Other Tools</a>
         </li>
@@ -330,10 +312,6 @@
         <li data-order="">
@@ -357,65 +335,64 @@
                     <div id=content class=span10>
                         <h1 id="chatterbot">Chatterbot</h1>
-<p>Chatterbot is a Ruby library for making bots on Twitter.  It&#39;s
+<p><a href="https://github.com/muffinista/chatterbot">Chatterbot</a> 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
+Twitter API features – searches, replies, tweets, retweets, etc. and has
 a simple blacklist/whitelist system to help minimize spam and unwanted
 data.</p>
 <p>A bot using chatterbot can be as simple as this:</p>
-<div class="highlight"><pre><code class="language-text" data-lang="text">exclude &quot;http://&quot;
-blacklist &quot;mean_user, private_user&quot;
-puts &quot;checking my timeline&quot;
+<p>```
+exclude “http://”
+blacklist “mean_user, private_user”</p>
+<p>puts “checking my timeline”
 home_timeline do |tweet|
     # i like to favorite things
     favorite tweet
-end
+end</p>
-puts &quot;checking for replies to my tweets and mentions of me&quot;
+<p>puts “checking for replies to my tweets and mentions of me”
 replies do |tweet|
   text = tweet.text
-  puts &quot;message received: #{text}&quot;
-  src = text.gsub(/@echoes_bot/, &quot;#USER#&quot;)
+  puts “message received: #{text}”
+  src = text.gsub(/@echoes_bot/, “#USER#”)  </p>
-  # send it back!
+<p># send it back!
   reply src, tweet
 end
-</code></pre></div>
+```</p>
 <p>Or you can write a bot using more traditional ruby classes.</p>
 <p>Chatterbot can actually generate a template bot file for you, and will
 walk you through process of getting a bot authorized with Twitter.</p>
 <h2 id="features">Features</h2>
 <ul>
-<li>Handles search queries and replies to your bot</li>
-<li>Use a simple scripting language, or extend a Bot class if you need it</li>
-<li>Wraps the Twitter gem so you have access to the entire Twitter API</li>
-<li>Simple blacklistling system to limit your annoyance of users</li>
-<li>Avoid your bot making a fool of itself by ignoring tweets with
+  <li>Handles search queries and replies to your bot</li>
+  <li>Use a simple scripting language, or extend a Bot class if you need it</li>
+  <li>Wraps the Twitter gem so you have access to the entire Twitter API</li>
+  <li>Simple blacklistling system to limit your annoyance of users</li>
+  <li>Avoid your bot making a fool of itself by ignoring tweets with
 certain bad words</li>
-<li>Basic Streaming API support</li>
-<li>Optionally log tweets to the database for metrics and tracking purposes</li>
+  <li>Basic Streaming API support</li>
+  <li>Optionally log tweets to the database for metrics and tracking purposes</li>
 </ul>
 <p>Chatterbot uses the the Twitter gem
-(<a href="https://github.com/sferik/twitter">https://github.com/sferik/twitter</a>) to handle the underlying API
+(https://github.com/sferik/twitter) to handle the underlying API
 calls. Any calls to the search/reply methods will return
 <code>Twitter::Tweet</code> objects.</p>
-<h2 id="copyright/license">Copyright/License</h2>
+<h2 id="copyrightlicense">Copyright/License</h2>
+<p>Copyright (c) 2014 Colin Mitchell. Chatterbot is distributed under the
+WTFPL license.</p>
-<p>Copyright (c) 2014 Colin Mitchell. Chatterbot is distributed under a
-modified WTFPL licence -- it&#39;s the &#39;Do what the fuck you want to --
-but don&#39;t be an asshole&#39; public license.  Please see LICENSE.txt for
-further details. Basically, do whatever you want with this code, but
-don&#39;t be an asshole about it.  If you spam users inappropriately,
-expect your karma to suffer.</p>
+<p>http://muffinlabs.com</p>
-<p><a href="http://muffinlabs.com">http://muffinlabs.com</a></p>
                     </div>
@@ -423,7 +400,9 @@ expect your karma to suffer.</p>
             <div class=row-fluid>
                 <div id=footer class=span12>
-                    Documentation for <a href="https://github.com/muffinista/chatterbot">chatterbot</a>
+                    <!--
+Documentation for <a href="https://github.com/muffinista/chatterbot">chatterbot</a>
+-->
                 </div>
             </div>