twitter_topic_bot 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51f87423398e6dc3297df21d9cee48baf4d37523
-  data.tar.gz: c76436994c099997a64442345b3265ccdaece364
+  metadata.gz: 18bcde73d848ce382fc2455843573ab9398b5684
+  data.tar.gz: d30f0c510f82cde515f48925aded164d06a1d246
 SHA512:
-  metadata.gz: a2002e5b392461168589db6587b6c4f27ab3c1ee53010659c776151b9506d109ac3f920524b3e3498ae0bb3af044fc1d1dcb43f86806ae77ac8de6564c2e4cab
-  data.tar.gz: 9d8ba0e9015d8c6a920e8dc030d69fc5b874bbd233fb2883981cae0d246dbfe25946c473835173e82b983dd93a106504f21cb8a497300e1cd5fc57009f1d4fc4
+  metadata.gz: fb7109ff79978710b2a586a8e1548706aee2e1c6466cab28a7b40ecf75c458d9e17c9c3b09ba6fb414e3481f46b1b726a5d0060b933b67f81cb2d4a718945b39
+  data.tar.gz: 78e88f92d0a7a6d7929947cab163d9c06ac20812afc4714355bd052bbcdc23a001127988331969777415e815fdb7d6a85d1007911cde9029bb8c75f7061f28dd

data/README.md

@@ -1,5 +1,8 @@
 # TwitterTopicBot
 
+[![Gem](https://img.shields.io/gem/v/twitter_topic_bot.svg?style=flat-square)](https://rubygems.org/gems/twitter_topic_bot)
+[![Travis](https://img.shields.io/travis/annejohnson/twitter_topic_bot.svg?style=flat-square)](https://travis-ci.org/annejohnson/twitter_topic_bot)
+
 Create a Twitter bot in 5 minutes that tweets and engages with the community on topics you're interested in!
 
 ## Installation
@@ -20,6 +23,8 @@ Or install it yourself as:
 
 ## Usage
 
+### Telling Your Bot What to Tweet
+
 To let your bot know what to tweet about, you need to make an object that responds to the three methods in the code sample below. The topic below is art, but your topic can be about anything.
 
 ```ruby
@@ -40,11 +45,13 @@ end
 content_preparer = ArtContentPreparer.new
 ```
 
+### Getting Twitter Credentials
+
 Next, get your Twitter API credentials ready. Register an app on [Twitter](https://apps.twitter.com/) with read & write permissions. Once you have your API keys, prepare the following pieces of information:
 
 ```ruby
 credentials = {
-  username: '<Your bot\'s username (without the @ sign)>',
+  username: '<Your bot\'s Twitter username (without the @ sign)>',
   consumer_key: '<Your consumer key>',
   consumer_secret: '<Your consumer secret>',
   access_token: '<Your access token>',
@@ -52,6 +59,8 @@ credentials = {
 }
 ```
 
+### Making Your Bot Interact with the World
+
 Next, instantiate a `TwitterTopicBot`, and make it do things!
 
 ```ruby
@@ -65,6 +74,39 @@ bot.reply_to_someone
 bot.follow_followers
 ```
 
+### Automating Your Bot's Activities
+
+To make your bot run automatically on a schedule, define a schedule for it like so:
+
+```ruby
+bot.schedule do |schedule|
+  schedule.every('30m') { bot.tweet }
+  schedule.every('3h') { bot.follow_someone }
+  schedule.every('1d') { bot.reply_to_someone }
+  schedule.cron('15,45 * * * *') { bot.retweet_someone }
+end
+```
+
+View the [Rufus-Scheduler](https://github.com/jmettraux/rufus-scheduler) documentation to see examples of how to configure the schedule.
+
+For the schedule take effect over time, you need to keep your process open. You can add the following to your Ruby file to keep the process running indefinitely:
+
+```ruby
+loop { sleep 1 }
+```
+
+### Launching Your Bot
+
+If your Ruby code so far is in a file called `my_bot.rb`, you can launch your bot with the following command in the terminal:
+
+```
+ruby my_bot.rb
+```
+
+### Example File
+
+The code above is available in this [example file](https://github.com/annejohnson/twitter_topic_bot/blob/master/examples/art_topic_bot.rb).
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/examples/art_topic_bot.rb

@@ -0,0 +1,36 @@
+require 'twitter_topic_bot'
+
+class ArtContentPreparer
+  def topic_string
+    ['#painting', '#watercolor'].sample
+  end
+
+  def prepare_tweet
+    %q{If you hear a voice within you say 'you cannot paint,' then by all means paint, and that voice will be silenced. -Vincent Van Gogh}
+  end
+
+  def prepare_reply(tweet_to_reply_to, user_to_reply_to)
+    "@#{user_to_reply_to}, thank you for tweeting about art!"
+  end
+end
+
+content_preparer = ArtContentPreparer.new
+
+credentials = {
+  username: '<Your bot\'s Twitter username (without the @ sign)>',
+  consumer_key: '<Your consumer key>',
+  consumer_secret: '<Your consumer secret>',
+  access_token: '<Your access token>',
+  access_token_secret: '<Your access token secret>'
+}
+
+bot = TwitterTopicBot.new(content_preparer, credentials)
+
+bot.schedule do |schedule|
+  schedule.every('30m') { bot.tweet }
+  schedule.every('3h') { bot.follow_someone }
+  schedule.every('1d') { bot.reply_to_someone }
+  schedule.cron('15,45 * * * *') { bot.retweet_someone }
+end
+
+loop { sleep 1 }

data/lib/twitter_topic_bot/schedulable.rb

@@ -0,0 +1,15 @@
+require 'rufus-scheduler'
+
+class TwitterTopicBot
+  module Schedulable
+    def schedule
+      yield(schedule_object)
+    end
+
+    private
+
+    def schedule_object
+      @schedule_object ||= Rufus::Scheduler.new
+    end
+  end
+end

data/lib/twitter_topic_bot/version.rb

@@ -1,3 +1,3 @@
 class TwitterTopicBot
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/twitter_topic_bot.rb

@@ -1,9 +1,11 @@
-require 'twitter'
 require 'twitter_topic_bot/version'
 require 'twitter_topic_bot/api_client'
 require 'twitter_topic_bot/tweet_filterer'
+require 'twitter_topic_bot/schedulable'
 
 class TwitterTopicBot
+  include Schedulable
+
   def initialize(content_preparer, credentials)
     @content_preparer = content_preparer
     @api_client = TwitterTopicBot::ApiClient.new(credentials)

data/twitter_topic_bot.gemspec

@@ -17,7 +17,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'twitter', '~> 5.16.0'
+  spec.add_runtime_dependency 'twitter', '~> 5.16', '>= 5.16.0'
+  spec.add_runtime_dependency 'rufus-scheduler', '~> 3.2', '>= 3.2.1'
   spec.add_development_dependency 'bundler', '~> 1.12'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twitter_topic_bot
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Anne Johnson
@@ -15,6 +15,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.16.0
   type: :runtime
@@ -22,8 +25,31 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.16.0
+- !ruby/object:Gem::Dependency
+  name: rufus-scheduler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -82,8 +108,10 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/art_topic_bot.rb
 - lib/twitter_topic_bot.rb
 - lib/twitter_topic_bot/api_client.rb
+- lib/twitter_topic_bot/schedulable.rb
 - lib/twitter_topic_bot/tweet_filterer.rb
 - lib/twitter_topic_bot/version.rb
 - twitter_topic_bot.gemspec