chatterbot 2.0.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dd3b277547610b8d5e0ec0993a5952d015cab80b
-  data.tar.gz: 114e6d11f506a6bbb331081b66395613346e3a12
+SHA256:
+  metadata.gz: 49208ab18cf0449b6e3e9edaee0be33e626ffb1871137bc1131ed7a4745404c1
+  data.tar.gz: 3f921764ebfb8121ac30fb3c6785f586d785102376abc1c5e41faa4e5f04bcca
 SHA512:
-  metadata.gz: 92c72bf9e9ab384e2a5a00756d78af0128998efd1dd7d1eba9ac069b8fe427042e5ea73aeed03e2ae9dd30a140833382f9e239090b6c835794fe9207073e6d98
-  data.tar.gz: 3d6c202746806977bd602b9ad2f196cec49ef4dd091582ce38711906b1e7ddb9fd93be34b517b6aadeb7492e024e07784c12c4002d74e0220247bd623616fea6
+  metadata.gz: 46c3805f65a29e1f538e03aaa5d506f966b33fad6b879bb818929ff2086a940f15ab3e68f6584daac61182650b100b962c02ede0d5e83c93e4ed1ab13437cc02
+  data.tar.gz: 89fdcbd28704b4547b0bf3593e1b4384dcba7755d7a7fda4ee6f9836bc6fe9c4d05677da208d85e6a74229d01114f89d120d5666cf17bf90c88ab5270b01878a

data/.github/workflows/ci.yml

@@ -0,0 +1,19 @@
+---
+name: Run tests
+on: [push, pull_request]
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        ruby: [2.5, 2.6, 2.7]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: rspec
+        run: bundle exec rake

data/Gemfile

@@ -2,29 +2,21 @@ source 'https://rubygems.org'
 
 gemspec
 
-#gem "twitter_oauth"
-#gem "sequel"
+gem 'rake'
+gem 'yard'
 
 # 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 "rake"
-  #gem "twitter", "~> 4.4.0"
-
-  #gem "watchr"
+  gem 'pry'
 end
 
-gem "pry"
 
-#
-# couple extra gems for testing db connectivity
-#
 group :test do
-  gem "sequel"
-  gem "mysql"
-  gem "sqlite3"
+  gem 'rspec', '~> 3.10.0'
+  gem 'rspec-mocks', '~> 3.10.0'
+  gem 'simplecov', '>= 0'
+  gem 'observr', '>= 0'
 end
+
+

data/README.markdown

@@ -22,7 +22,6 @@ Features
 * Simple blocklist 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
 
 
 Using Chatterbot
@@ -79,8 +78,9 @@ Or you can write a bot using more traditional ruby classes, extend it if needed,
 ```
   class MyBot < Chatterbot::Bot
      def do_stuff
-       search("'surely you must be joking'") do |tweet|
-        reply "@#{tweet_user(tweet)} I am serious, and don't call me Shirley!", tweet
+       home_timeline do |tweet|
+         puts "I like to favorite things"
+         favorite tweet
        end
     end
   end
@@ -101,25 +101,12 @@ that you should just be using the Twitter gem directly.
 Streaming
 ---------
 
-Chatterbot has some basic support for the Streaming API. If you want
-to do something complicated, you should probably consider using the
-[Twitter gem](https://github.com/sferik/twitter#streaming) directly. 
-
-Basic usage is very straightforward:
-
-    use_streaming true
-    home_timeline do |tweet|
-      puts "someone i follow tweeted! #{tweet.text}"
-    end
-
-
-You can also run a search:
-
-    use_streaming true
-    search("pizza") do |tweet|
-      puts "someone is talking about pizza! #{tweet.text}"
-    end
-
+Chatterbot used to have some basic support for the Streaming API, but
+I've removed it because Twitter is removing and/or restricting access
+to those APIs. If you need the Streaming API, I highly recommend using
+the the [Twitter
+gem](https://github.com/sferik/twitter#streaming). Chatterbot is built
+on the Twitter gem, it works great, and has support for streaming.
 
 
 What Can I Do?
@@ -354,7 +341,7 @@ I can work with you on that.
 Copyright/License
 -----------------
 
-Copyright (c) 2016 Colin Mitchell. Chatterbot is distributed under the
+Copyright (c) 2018 Colin Mitchell. Chatterbot is distributed under the
 MIT licence -- Please see LICENSE.txt for further details.
 
 http://muffinlabs.com

data/Rakefile

@@ -1,30 +1,12 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
-require "chatterbot/version"
-
 require 'rspec/core'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov_opts = %w{--exclude .bundler,.rvm}
-  spec.rcov = true
-end
-
-task :default => :spec
-
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  rdoc.main = "README.rdoc"
-  rdoc.rdoc_files.include("README.rdoc", "lib/**/*.rb")
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "'chatterbot #{Chatterbot::VERSION}'"
-end
-
 task :console do
   require 'irb'
   require 'irb/completion'
@@ -32,3 +14,5 @@ task :console do
   ARGV.clear
   IRB.start
 end
+
+task :default => :spec

data/chatterbot.gemspec

@@ -1,5 +1,8 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+#$:.push File.expand_path("../lib", __FILE__)
 require "chatterbot/version"
 
 Gem::Specification.new do |s|
@@ -20,18 +23,20 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.licenses = ["MIT"]
 
-  s.add_development_dependency(%q<redcarpet>, [">= 0"])
-  s.add_runtime_dependency(%q<oauth>, ["~> 0.4.7"])
-  s.add_runtime_dependency(%q<twitter>, ["~> 5.16.0"])
+  s.required_ruby_version = '>= 2.2'
+  
+  s.add_runtime_dependency(%q<oauth>, ["~> 0.5.6"])
+  s.add_runtime_dependency(%q<twitter>, ["~> 7"])
   s.add_runtime_dependency(%q<launchy>, [">= 2.4.2"])
   s.add_runtime_dependency(%q<colorize>, [">= 0.7.3"])
-  s.add_development_dependency(%q<yard>, [">= 0"])
-  s.add_development_dependency(%q<shoulda>, [">= 0"])
-  s.add_development_dependency(%q<rake>, ["< 11"])
-  s.add_development_dependency(%q<rspec>, ["~> 3.0.0"])
-  s.add_development_dependency(%q<rspec-mocks>, ["~> 3.0.2"])
-  s.add_development_dependency(%q<rdoc>, [">= 0"])
-  s.add_development_dependency(%q<simplecov>, [">= 0"])
-  s.add_development_dependency(%q<observr>, [">= 0"])
+  
+  s.add_development_dependency 'bundler', '~> 2.0'
+
+
+  s.post_install_message = %q{This version of chatterbot removes
+activesupport as a dependency -- if you are using it, you might need
+to install it separately!
+
+}
 end
 

data/docs/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gem 'github-pages'
+

data/docs/README.md

@@ -0,0 +1,3 @@
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/bruth/jekyll-docs-template/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+
+Read the docs: http://bruth.github.io/jekyll-docs-template

data/docs/_config.yml

@@ -0,0 +1,37 @@
+# Site title and subtitle. This is used in _includes/header.html
+title: 'chatterbot'
+subtitle: 'twitter bots in ruby'
+
+# Enable/show navigation. There are there options:
+#   0 - always hide
+#   1 - always show
+#   2 - show only if posts are present
+navigation: 1
+
+# URL to source code, used in _includes/footer.html
+codeurl: 'https://github.com/muffinista/chatterbot'
+
+# Default categories (in order) to appear in the navigation
+sections: [
+    ['tut', 'Getting Started'],
+    ['doc', 'Documentation'],
+    ['dev', 'Developers'],
+    ['links', 'Resources']
+]
+
+# Keep as an empty string if served up at the root. If served up at a specific
+# path (e.g. on GitHub pages) leave off the trailing slash, e.g. /my-project
+baseurl: '/chatterbot'
+
+# Dates are not included in permalinks
+permalink: none
+
+# Syntax highlighting
+highlighter: 'rouge'
+
+# Since these are pages, it doesn't really matter
+future: true
+
+# Exclude non-site files
+exclude: ['bin', 'README.md']
+

data/docs/_includes/footer.html

@@ -0,0 +1,3 @@
+<!--
+Documentation for <a href="{% if site.codeurl %}{{ site.codeurl }}{% else %}{{ site.baseurl }}{% endif %}">{{ site.title }}</a>
+-->

data/docs/_includes/header.html

@@ -0,0 +1,4 @@
+<h4><a class=brand href="{{ site.baseurl }}/">{{ site.title }}</a>
+    {% if site.subtitle %}<small>{{ site.subtitle }}</small>{% endif %}
+</h4>
+

data/docs/_includes/navigation.html

@@ -0,0 +1,23 @@
+<ul class="nav nav-list">
+  <li><a href="{{ site.baseurl }}/">Home</a></li>
+  {% for section in site.sections %}
+    {% assign attr = section[0] %}
+    {% assign label = section[1] %}
+    <li class=nav-header>{{ label }}</li>
+    {% for page in site.pages %}
+{% if page.published != false %}
+      {% if page.category == attr %}     
+        <li data-order="{{ page.order }}">
+          {% if page.link %}
+            <a href="{{ page.link }}">{{ page.title }}</a>
+          {% else %}
+            <a href="{{ site.baseurl }}{{ page.url }}">{{ page.title }}</a>
+          {% endif %}
+        </li>
+      {% endif %}
+{% endif %}
+    {% endfor %}
+  {% endfor %}
+<!-- List additional links. It is recommended to add a divider
+    e.g. <li class=divider></li> first to break up the content. -->
+</ul>

data/docs/_layouts/default.html

@@ -0,0 +1,98 @@
+<!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>{{ site.title }}{% if page.title %} : {{ page.title }}{% endif %}</title>
+        <meta name="description" content="{{ site.subtitle }}">
+
+        <link href="//netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
+        <link rel="stylesheet" href="{{ site.baseurl }}/css/syntax.css">
+        <link rel="stylesheet" href="{{ site.baseurl }}/css/main.css">
+    </head>
+    <body>
+
+        <div class="container">
+            <div class=row-fluid>
+                <div id=header class=span12>
+                    {% include header.html %}
+                </div>
+            </div>
+
+            <div class=row-fluid>
+                {% assign post_count = site.posts|size %}
+                {% if site.navigation != 0 and site.navigation == 1 or post_count > 0 %}
+                    <div id=navigation class=span2>
+                        {% include navigation.html %}
+                    </div>
+
+                    <div id=content class=span10>
+                        {{ content }}
+                    </div>
+                {% else %}
+                    <div id=content class=span12>
+                        {{ content }}
+                    </div>
+                {% endif %}
+            </div>
+
+            <div class=row-fluid>
+                <div id=footer class=span12>
+                    {% include footer.html %}
+                </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>

data/docs/_layouts/page.html

@@ -0,0 +1,11 @@
+---
+layout: default
+---
+
+<div class=page-header>
+    <h2>{{ page.title }}
+        {% if page.subtitle %}<small>{{ page.subtitle }}</small>{% endif %}
+    </h2>
+</div>
+
+{{ content }}

data/docs/_site/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gem 'github-pages'
+

data/docs/_site/advanced.html

@@ -0,0 +1,465 @@
+<!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 : Advanced Features</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>Advanced Features
+        
+    </h2>
+</div>
+
+<h2 id="direct-client-access">Direct Client Access</h2>
+
+<p>If you want to do something not provided directly by Chatterbot, you
+have access to an instance of Twitter::Client provided by the
+<strong>client</strong> method. In theory, you can do something like this in your
+bot to unfollow users who DM you:</p>
+
+<pre><code>client.direct_messages_received(:since_id =&gt; since_id).each do |m|
+    client.unfollow(m.user.name)
+end
+</code></pre>
+
+<h2 id="storing-config-in-the-database">Storing Config in the Database</h2>
+<p>Sometimes it is preferable to store the authorization credentials for
+your bot in a database.</p>
+
+<p>Chatterbot can manage configurations that are stored in the database,
+but to do this you will need to specify how to connect to the
+database. You can do this by specifying the connection string
+either in one of the global config files by setting</p>
+
+<p><code>
+:db_uri:mysql://username:password@host/database
+</code></p>
+
+<p>Or you can specify the connection 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</p>
+
+<pre><code>mysql://username:password@host/database
+</code></pre>
+
+<p>see http://sequel.rubyforge.org/rdoc/files/doc/opening_databases_rdoc.html
+for details.</p>
+
+<h2 id="logging-tweets-to-the-database">Logging Tweets to the Database</h2>
+
+<p>Chatterbot can log tweet activity to a database if desired. This can
+be handy for archival purposes, or for tracking what’s going on with
+your bot.</p>
+
+<p>If you’ve configured your bot for database access, you can store a
+tweet to the database by calling the <code>log</code> method like this:</p>
+
+<p><code>
+search "chatterbot" do |tweet|
+    log tweet
+end
+</code></p>
+
+<p>See <code>Chatterbot::Logging</code> for details on this.</p>
+
+<h2 id="streaming">Streaming</h2>
+
+<p>Chatterbot has basic support for Twitter’s Streaming API. You can read
+more about it <a href="streaming.html">here</a></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>