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

chatterbot 2.0.5 → 2.1.0

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/contributing.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="">
@@ -364,17 +342,20 @@
 <p>Bug fixes, features, etc are eagerly welcomed. Since this code is
 being used to run current Twitter bots, any changes need to maintain
 compatibility. If there are bugs or things you would like to improve,
-fork the project and hack away. I&#39;ll pull anything back that makes
+fork the project and hack away. I’ll pull anything back that makes
 sense if requested.</p>
                     </div>
             </div>
             <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/deploying.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,46 +339,49 @@
     </h2>
 </div>
-<p>There&#39;s a couple ways of running your bot:</p>
+<p>There’s a couple ways of running your bot:</p>
 <h2 id="manually">Manually</h2>
 <p>Run it on the command-line whenever you like. Whee!</p>
 <h2 id="cron">Cron</h2>
+<p>Run it via cron.  Here’s an example of running a bot every two minutes</p>
-<p>Run it via cron.  Here&#39;s an example of running a bot every two minutes</p>
-<div class="highlight"><pre><code class="language-text" data-lang="text">*/2 * * * * . ~/.bash_profile; cd /path/to/bot/;  ./bot.rb
-</code></pre></div>
-<h2 id="looping">Looping</h2>
+<pre><code>*/2 * * * * . ~/.bash_profile; cd /path/to/bot/;  ./bot.rb
+</code></pre>
+<h2 id="looping">Looping</h2>
 <p>Run it as a background process.  Just put the guts of your bot in a loop like this:</p>
-<div class="highlight"><pre><code class="language-rb" data-lang="rb"><span class="kp">loop</span> <span class="k">do</span>
-  <span class="n">search</span> <span class="s2">&quot;twitter&quot;</span> <span class="k">do</span> <span class="o">|</span><span class="n">tweet</span><span class="o">|</span>
-    <span class="c1"># here you could do something with a tweet</span>
-    <span class="c1"># if you want to retweet</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>
-  <span class="n">replies</span> <span class="k">do</span> <span class="o">|</span><span class="n">tweet</span><span class="o">|</span>
-    <span class="c1"># do stuff</span>
-  <span class="k">end</span>
-  <span class="c1"># explicitly update our config</span>
-  <span class="n">update_config</span>
-  <span class="nb">sleep</span> <span class="mi">60</span>
-<span class="k">end</span>
-</code></pre></div>
+<p>```rb
+loop do
+  search “twitter” do |tweet|
+    # here you could do something with a tweet
+    # if you want to retweet
+    retweet(tweet[:id])
+  end</p>
+<p>replies do |tweet|
+    # do stuff
+  end</p>
+<p># explicitly update our config
+  update_config</p>
+<p>sleep 60
+end
+```</p>
 <p><strong>NOTE:</strong> You need to call <code>update_config</code> to update the last tweet your script
-has processed -- if you don&#39;t have this call, you will get duplicate
+has processed – if you don’t have this call, you will get duplicate
 tweets.</p>
 <h2 id="streaming">Streaming</h2>
 <p>Chatterbot has rough support for the Streaming API. If your bot can
-use it, it&#39;s a great option, because you get your data immediately.
-You can read more about setting up a bot to use <a href="/streaming.html">streaming</a>.</p>
+use it, it’s a great option, because you get your data immediately.
+You can read more about setting up a bot to use <a href="streaming.html">streaming</a>.</p>
                     </div>
@@ -409,7 +390,9 @@ You can read more about setting up a bot to use <a href="/streaming.html">stream
             <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/examples.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,153 +339,158 @@
     </h2>
 </div>
-<p>Here&#39;s a couple examples of working bots.</p>
+<p>Here’s a couple examples of working bots.</p>
-<h2 id="@echoes_bot">@echoes_bot</h2>
+<h2 id="echoesbot">@echoes_bot</h2>
 <p>This is a working bot. It responds to any mentions with the incoming
 text:</p>
 <blockquote class="twitter-tweet" lang="en"><p><a href="https://twitter.com/muffinista">@muffinista</a> hello there!</p>&mdash; Echo Echo (@echoes_bot) <a href="https://twitter.com/echoes_bot/status/515166110950256640">September 25, 2014</a></blockquote>
+<script async="" src="//platform.twitter.com/widgets.js" charset="utf-8"></script>
-<script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script>
+<p>Here’s the code. This is right out of the git repo for chatterbot:</p>
-<p>Here&#39;s the code. This is right out of the git repo for chatterbot:</p>
-<div class="highlight"><pre><code class="language-text" data-lang="text">## This is a very simple working example of a bot you can build with
-## chatterbot. It looks for mentions of &#39;@echoes_bot&#39; (the twitter
+<p>```
+## This is a very simple working example of a bot you can build with
+## chatterbot. It looks for mentions of ‘@echoes_bot’ (the twitter
 ## handle the bot uses), and sends replies with the name switched to
-## the handle of the sending user
+## the handle of the sending user</p>
-#
+<p>#
 # require the dsl lib to include all the methods you see below.
 #
-require &#39;rubygems&#39;
-require &#39;chatterbot/dsl&#39;
+require ‘rubygems’
+require ‘chatterbot/dsl’</p>
-puts &quot;Loading echoes_bot.rb&quot;
+<p>puts “Loading echoes_bot.rb”</p>
+<h1 id="section">#</h1>
+<p>## If I wanted to exclude some terms from triggering this bot, I would list them here.
+## For now, we’ll block URLs to keep this from being a source of spam
 ##
-## If I wanted to exclude some terms from triggering this bot, I would list them here.
-## For now, we&#39;ll block URLs to keep this from being a source of spam
-##
-exclude &quot;http://&quot;
+exclude “http://”</p>
-blacklist &quot;mean_user, private_user&quot;
+<p>blacklist “mean_user, private_user”</p>
-puts &quot;checking for replies to me&quot;
+<p>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/, &quot;#USER#&quot;)
+  src = tweet.text.gsub(/@echoes_bot/, “#USER#”)  </p>
-  # send it back!
+<p># send it back!
   reply src, tweet
 end
-</code></pre></div>
-<h2 id="@spacejamcheck">@SpaceJamCheck</h2>
+```</p>
+<h2 id="spacejamcheck">@SpaceJamCheck</h2>
 <p>This is another working bot. It checks the website for the movie Space
 Jam to see if it is still online (it does this by using the spacejam
 gem), and tweets the results of that check.</p>
-<div class="highlight"><pre><code class="language-text" data-lang="text">#!/usr/bin/env ruby
-require &#39;rubygems&#39;
-require &#39;bundler/setup&#39;
+<p>```
+#!/usr/bin/env ruby</p>
-require &#39;chatterbot/dsl&#39;
-require &#39;spacejam&#39;
+<p>require ‘rubygems’
+require ‘bundler/setup’</p>
-#
+<p>require ‘chatterbot/dsl’
+require ‘spacejam’</p>
+<p>#
 # this is the script for the twitter bot SpaceJamCheck
 # generated on 2013-11-04 16:24:46 -0500
-#
+#</p>
-consumer_key &#39;key&#39;
-consumer_secret &#39;secret&#39;
+<p>consumer_key ‘key’
+consumer_secret ‘secret’</p>
-secret &#39;secret&#39;
-token &#39;token&#39;
+<p>secret ‘secret’
+token ‘token’</p>
+<p>check_url = “http://www2.warnerbros.com/spacejam/movie/jam.htm”
+check_string = “<title>Space Jam</title>”</p>
-check_url = &quot;http://www2.warnerbros.com/spacejam/movie/jam.htm&quot;
-check_string = &quot;&lt;title&gt;Space Jam&lt;/title&gt;&quot;
+<p>uptime_messages = [
+                   “Hooray! Space Jam is still online!”,
+                   “It’s #{Time.now.year} and the Space Jam website is still online”,
+                   “In case you were worried, Space Jam is still online”,
+                   “Looks like the Space Jam website is still there”,
+                   “Yes”,
+                   “Yep”,
+                   “Still Kickin”,
+                   “The Space Jam website is still online”,
+                   “Still Online”
+                  ]</p>
-uptime_messages = [
-                   &quot;Hooray! Space Jam is still online!&quot;,
-                   &quot;It&#39;s #{Time.now.year} and the Space Jam website is still online&quot;,
-                   &quot;In case you were worried, Space Jam is still online&quot;,
-                   &quot;Looks like the Space Jam website is still there&quot;,
-                   &quot;Yes&quot;,
-                   &quot;Yep&quot;,
-                   &quot;Still Kickin&quot;,
-                   &quot;The Space Jam website is still online&quot;,
-                   &quot;Still Online&quot;
-                  ]
+<p>downtime_messages = [
+                     “Hmm, looks like Space Jam isn’t online. Hopefully it’s a fluke ;(“
+                    ]</p>
-downtime_messages = [
-                     &quot;Hmm, looks like Space Jam isn&#39;t online. Hopefully it&#39;s a fluke ;(&quot;
-                    ]
+<p>x = Spacejam::HTTPCheck.new(url:check_url, body:check_string)</p>
-x = Spacejam::HTTPCheck.new(url:check_url, body:check_string)
-# pick a random tweet according to the website status
-result = if x.online?
+<h1 id="pick-a-random-tweet-according-to-the-website-status">pick a random tweet according to the website status</h1>
+<p>result = if x.online?
   uptime_messages
 else
   downtime_messages
-end.sample
+end.sample</p>
+<h1 id="add-a-timestamp-this-helps-to-prevent-duplicate-tweet-issues">add a timestamp. this helps to prevent duplicate tweet issues</h1>
+<p>result « ” (#{Time.now.utc})”</p>
-# add a timestamp. this helps to prevent duplicate tweet issues
-result &lt;&lt; &quot; (#{Time.now.utc})&quot;
+<h1 id="tweet-it-out">tweet it out!</h1>
+<p>tweet result
+```</p>
-# tweet it out!
-tweet result
-</code></pre></div>
 <h2 id="streaming-bot">Streaming Bot</h2>
-<div class="highlight"><pre><code class="language-text" data-lang="text">#!/usr/bin/env ruby
-## This is a very simple working example of a bot using the streaming
-## API. It&#39;s basically a copy of echoes_bot.rb, just using streaming.
+<p>```
+#!/usr/bin/env ruby</p>
-#
+<h2 id="this-is-a-very-simple-working-example-of-a-bot-using-the-streaming">This is a very simple working example of a bot using the streaming</h2>
+<p>## API. It’s basically a copy of echoes_bot.rb, just using streaming.</p>
+<p>#
 # require the dsl lib to include all the methods you see below.
 #
-require &#39;rubygems&#39;
-require &#39;chatterbot/dsl&#39;
+require ‘rubygems’
+require ‘chatterbot/dsl’</p>
-consumer_secret &#39;foo&#39;
-secret &#39;bar&#39;
-token &#39;biz&#39;
-consumer_key &#39;bam&#39;
+<p>consumer_secret ‘foo’
+secret ‘bar’
+token ‘biz’
+consumer_key ‘bam’</p>
+<p>puts “Loading echoes_bot.rb using the streaming API”</p>
-puts &quot;Loading echoes_bot.rb using the streaming API&quot;
+<p>exclude “http://”, “https://”</p>
-exclude &quot;http://&quot;, &quot;https://&quot;
+<p>blacklist “mean_user, private_user”</p>
-blacklist &quot;mean_user, private_user&quot;
-streaming do
+<p>streaming do
   favorited do |user, tweet|
-    reply &quot;@#{user.screen_name} thanks for the fave!&quot;, tweet
-  end
+    reply “@#{user.screen_name} thanks for the fave!”, tweet
+  end</p>
-  followed do |user|
-    tweet &quot;@#{user.screen_name} just followed me!&quot;
+<p>followed do |user|
+    tweet “@#{user.screen_name} just followed me!”
     follow user
-  end
+  end</p>
-  replies do |tweet|
-    favorite tweet
+<p>replies do |tweet|
+    favorite tweet</p>
+<pre><code>puts "It's a tweet!"
+src = tweet.text.gsub(/@echoes_bot/, "#USER#")
+reply src, tweet   end end
+</code></pre>
+<p>```</p>
-    puts &quot;It&#39;s a tweet!&quot;
-    src = tweet.text.gsub(/@echoes_bot/, &quot;#USER#&quot;)
-    reply src, tweet
-  end
-end
-</code></pre></div>
                     </div>
@@ -515,7 +498,9 @@ end
             <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>