RubyGems - chatterbot - Versions diffs - 2.0.0.pre → 2.1.0 - Mend

chatterbot 2.0.0.pre → 2.1.0

Files changed (96) hide show

checksums.yaml +5 -5
data/.github/workflows/ci.yml +19 -0
data/Gemfile +9 -17
data/README.markdown +27 -34
data/Rakefile +2 -18
data/bin/chatterbot-register +6 -2
data/chatterbot.gemspec +11 -12
data/docs/Gemfile +3 -0
data/docs/README.md +3 -0
data/docs/_config.yml +37 -0
data/docs/_includes/footer.html +3 -0
data/docs/_includes/header.html +4 -0
data/docs/_includes/navigation.html +23 -0
data/docs/_layouts/default.html +98 -0
data/docs/_layouts/page.html +11 -0
data/docs/_posts/.gitkeep +0 -0
data/docs/_site/Gemfile +3 -0
data/docs/_site/advanced.html +465 -0
data/docs/_site/configuration.html +436 -0
data/docs/_site/contributing.html +414 -0
data/docs/_site/css/main.css +58 -0
data/docs/_site/css/syntax.css +61 -0
data/docs/_site/deploying.html +451 -0
data/docs/_site/examples.html +559 -0
data/docs/_site/features.html +496 -0
data/docs/_site/images/01-create-application.png +0 -0
data/docs/_site/images/02-application-permissions.png +0 -0
data/docs/_site/images/03-mobile-number.png +0 -0
data/docs/_site/images/04-access-token.png +0 -0
data/docs/_site/index.html +461 -0
data/docs/_site/javascripts/main.js +1 -0
data/docs/_site/other-tools.html +419 -0
data/docs/_site/params.json +1 -0
data/docs/_site/rdoc.html +409 -0
data/docs/_site/setup.html +491 -0
data/docs/_site/stylesheets/pygment_trac.css +68 -0
data/docs/_site/stylesheets/stylesheet.css +247 -0
data/docs/_site/tut.html +402 -0
data/docs/_site/twitter-docs.html +409 -0
data/docs/_site/walkthrough.html +447 -0
data/docs/advanced.md +62 -0
data/docs/basics.md +12 -0
data/docs/bin/jekyll-page +109 -0
data/docs/configuration.md +32 -0
data/docs/contributing.md +14 -0
data/docs/css/main.css +58 -0
data/docs/css/syntax.css +61 -0
data/docs/deploying.md +47 -0
data/docs/examples.md +120 -0
data/docs/features.md +88 -0
data/docs/images/01-create-application.png +0 -0
data/docs/images/02-application-permissions.png +0 -0
data/docs/images/03-mobile-number.png +0 -0
data/docs/images/04-access-token.png +0 -0
data/docs/index.md +69 -0
data/docs/javascripts/main.js +1 -0
data/docs/other-tools.md +17 -0
data/docs/params.json +1 -0
data/docs/rdoc.md +6 -0
data/docs/setup.md +84 -0
data/docs/stylesheets/pygment_trac.css +68 -0
data/docs/stylesheets/stylesheet.css +247 -0
data/docs/tips.md +22 -0
data/docs/tut.md +6 -0
data/docs/twitter-docs.md +6 -0
data/docs/walkthrough.md +46 -0
data/ext/mkrf_conf.rb +28 -0
data/lib/chatterbot.rb +0 -1
data/lib/chatterbot/bot.rb +7 -63
data/lib/chatterbot/client.rb +6 -12
data/lib/chatterbot/config.rb +2 -2
data/lib/chatterbot/config_manager.rb +7 -1
data/lib/chatterbot/dsl.rb +20 -47
data/lib/chatterbot/home_timeline.rb +1 -2
data/lib/chatterbot/search.rb +26 -3
data/lib/chatterbot/skeleton.rb +1 -3
data/lib/chatterbot/tweet.rb +14 -3
data/lib/chatterbot/ui.rb +88 -20
data/lib/chatterbot/version.rb +1 -1
data/spec/bot_spec.rb +2 -77
data/spec/client_spec.rb +2 -6
data/spec/config_manager_spec.rb +6 -5
data/spec/config_spec.rb +4 -1
data/spec/dsl_spec.rb +10 -35
data/spec/fixtures/update_with_media.png +0 -0
data/spec/search_spec.rb +40 -1
data/spec/spec_helper.rb +1 -4
data/spec/tweet_spec.rb +75 -38
data/templates/skeleton.txt +26 -56
metadata +84 -141
data/.document +0 -5
data/.travis.yml +0 -8
data/examples/streaming_bot.rb +0 -48
data/examples/tweet_logger.rb +0 -68
data/lib/chatterbot/streaming.rb +0 -60
data/spec/streaming_spec.rb +0 -170

data/docs/_site/setup.html ADDED Viewed

@@ -0,0 +1,491 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <meta charset="utf-8">
+        <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+        <meta name="viewport" content="width=device-width">
+        <title>chatterbot : Authorizing Your Bot</title>
+        <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="/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/">chatterbot</a>
+    <small>twitter bots in ruby</small>
+</h4>
+                </div>
+            </div>
+            <div class=row-fluid>
+                    <div id=navigation class=span2>
+                        <ul class="nav nav-list">
+  <li><a href="/chatterbot/">Home</a></li>
+    <li class=nav-header>Getting Started</li>
+        <li data-order="">
+            <a href="/chatterbot/examples.html">Examples</a>
+        </li>
+        <li data-order="">
+            <a href="/chatterbot/setup.html">Authorizing Your Bot</a>
+        </li>
+        <li data-order="">
+            <a href="/chatterbot/walkthrough.html">Walkthrough</a>
+        </li>
+    <li class=nav-header>Documentation</li>
+        <li data-order="">
+            <a href="/chatterbot/advanced.html">Advanced Features</a>
+        </li>
+        <li data-order="">
+            <a href="/chatterbot/configuration.html">Configuration</a>
+        </li>
+        <li data-order="">
+            <a href="/chatterbot/deploying.html">Running your Bot</a>
+        </li>
+        <li data-order="">
+            <a href="/chatterbot/features.html">Basic Features</a>
+        </li>
+    <li class=nav-header>Developers</li>
+        <li data-order="">
+            <a href="/chatterbot/contributing.html">Contributing</a>
+        </li>
+    <li class=nav-header>Resources</li>
+        <li data-order="">
+            <a href="/chatterbot/other-tools.html">Other Tools</a>
+        </li>
+        <li data-order="">
+            <a href="http://rubydoc.info/gems/chatterbot">rdoc</a>
+        </li>
+        <li data-order="">
+            <a href="https://dev.twitter.com/rest/public">Twitter API docs</a>
+        </li>
+<!-- List additional links. It is recommended to add a divider
+    e.g. <li class=divider></li> first to break up the content. -->
+</ul>
+                    </div>
+                    <div id=content class=span10>
+                        <div class=page-header>
+    <h2>Authorizing Your Bot
+    </h2>
+</div>
+<p>Getting a bot running on Twitter can be a little tricky. Twitter uses
+a something called <a href="https://dev.twitter.com/oauth">OAuth</a> to validate
+requests, but it’s a little more complicated than just specifying a
+username/password.</p>
+<ul>
+  <li>
+    <p>Login to Twitter with your bot account</p>
+  </li>
+  <li>
+    <p>Go to https://apps.twitter.com/app/new</p>
+  </li>
+  <li>
+    <p>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" /></p>
+  </li>
+  <li>
+    <p>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.</p>
+  </li>
+  <li>
+    <p><em>NOTE:</em> 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" /></p>
+    <p>You can add your number here: https://twitter.com/settings/devices</p>
+    <p>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.</p>
+  </li>
+</ul>
+<p>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
+<code>chatterbot-register</code> 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:</p>
+<ul>
+  <li>click the ‘Keys and Access Tokens’ link. You should see this: <img src="./images/04-access-token.png" /></li>
+  <li>click the ‘Create my access token’ link. </li>
+  <li>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:</li>
+</ul>
+<p><strong>In a separate YAML config file</strong>. 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:</p>
+<p><code>
+  ---
+  :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
+</code></p>
+<p><strong>in the script</strong>. Add some lines to your bot script like this:
+<code>
+consumer_key 'Consumer Secret (API Secret)'
+consumer_secret 'Consumer Key (API Key)'
+secret 'Access Token Secret'
+token 'Access Token'
+</code></p>
+<p><strong>in a database</strong>. If you’ve setup chatterbot to use a database, you
+  can store your configuration info in the <strong>config</strong> table.</p>
+<p><strong>NOTE</strong> At this point, you can remove the phone number from the bot
+  account if you like. From your bot’s account, click ‘Settings’ -&gt;
+  ‘Mobile’ -&gt; ‘Delete my phone’.</p>
+                    </div>
+            </div>
+            <div class=row-fluid>
+                <div id=footer class=span12>
+                    <!--
+Documentation for <a href="https://github.com/muffinista/chatterbot">chatterbot</a>
+-->
+                </div>
+            </div>
+        </div>
+        <script>
+            function orderNav() {
+                var list,
+                    section,
+                    header,
+                    sections = [],
+                    lists = {},
+                    headers = {};
+                var navUl = document.querySelectorAll('#navigation ul')[0],
+                    navLis = document.querySelectorAll('#navigation ul li');
+                if (!navUl) return;
+                for (var i = 0; i < navLis.length; i++) {
+                    var order, li = navLis[i];
+                    if (li.classList.contains('nav-header')) {
+                        section = li.textContent || li.innerText;
+                        sections.push(section);
+                        headers[section] = li;
+                        continue;
+                    }
+                    if (!lists[section]) {
+                        lists[section] = [];
+                    }
+                    order = parseFloat(li.getAttribute('data-order'))
+                    lists[section].push([order, li]);
+                }
+                for (var i = 0; i < sections.length; i++) {
+                    section = sections[i];
+                    list = lists[section].sort(function(a, b) {
+                        return a[0] - b[0];
+                    });
+                    if (header = headers[section]) {
+                        navUl.appendChild(header);
+                    }
+                    for (var j = 0; j < list.length; j++) {
+                        navUl.appendChild(list[j][1]);
+                    }
+                }
+            }
+            if (document.querySelectorAll) orderNav();
+        </script>
+    </body>
+</html>