twitter_bot_generator 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b18a537127a7c7ef076d12b91be3d3c76df3389f
-  data.tar.gz: d4c1f1bf6593a680dfa9a63d15bdbd4bcc85cc9c
+  metadata.gz: 9354d645a4a295e9321481d95149c5a5d62653ba
+  data.tar.gz: 47d124b7b15a814c7b2f84982ddb190394baaaf3
 SHA512:
-  metadata.gz: 7f74ac28c801bfc1f7c57d653a8e5d83afeb1260253ea47e7255798b01571d2abd77d2ba809b21297c94e07f85a7c72938b8c334520416df9bc06ae0962a5d9b
-  data.tar.gz: c0324015959982b927a493b55c163fe17af1057cbbcf124f00d12061298ad3849f1de666fc5477d7469d2f7ce99a02b78a2ef8395232e0b5e0d7235f82a25791
+  metadata.gz: a25ce81c2b3142f8198e335d4a8b841208638c9b1f45cf182caf0b86fe10b74524b11c7410082eb5df75c32ce53f16157b5e847ce3576123c3eca768f6dd2257
+  data.tar.gz: b690edbf48ebae94bedf29ad9032b358e3a93d073a02c901eadbe14411ca2e0fba46ec4242b2645254b6586a59c08176d353ed11710df211873224453a8b1a90

data/.travis.yml

@@ -4,7 +4,7 @@ cache: bundler
 rvm:
   - 2.0.0
 
-script: 'bundle exec rake'
+script: 'bundle exec rake && bundle exec ruby test/generated_default_bot.rb && bundle exec ruby test/generated_streaming_bot.rb && bundle exec ruby test/generated_userstream_bot.rb'
 
 notifications:
   email:

data/README.md

@@ -1,45 +1,102 @@
 # twitter_bot_generator
 
+[![Gem Version](https://badge.fury.io/rb/twitter_bot_generator.svg)](http://badge.fury.io/rb/twitter_bot_generator)
+
+[![Build Status](https://travis-ci.org/coleww/twitter_bot_generator.svg?branch=master)](https://travis-ci.org/coleww/twitter_bot_generator)
+
+[![Coverage Status](https://coveralls.io/repos/coleww/twitter_bot_generator/badge.png?branch=master)](https://coveralls.io/r/coleww/twitter_bot_generator?branch=master)
+
 #### I GENERATE TWITTER BOTS! RUBY IS JOY!
 
+
 ## Installation
 
     $ gem install twitter_bot_generator
 
 ## Usage
 
-    $ twitter_bot_generator --help
-    twitter_bot_generator <yr_bots_name_camel_cased>
-    ## creates a new directory called <yr_bots_name_camel_cased> in the current working directory,
-    and fills it with a bunch of boilerplate goodness
-
-    $ twitter_bot_generator wat_fun
-    scaffolding a twitter bot that is named wat_fun!
-    mkdir wat_fun/
-    mkdir wat_fun/lib
-    mkdir wat_fun/src
-    mkdir wat_fun/test
-    touch wat_fun/bot.rb
-    touch wat_fun/.gitignore
-    touch wat_fun/Gemfile
-    touch wat_fun/README.md
-    touch wat_fun/Procfile
-    touch wat_fun/spec.rb
-    touch wat_fun/test.rb
-    touch wat_fun/test/wat_fun_test.rb
-    touch wat_fun/src/wat_fun.rb
-    touch wat_fun/lib/greetings.txt
-    done generating! your turn now!
-    $ cd wat_fun
-    $ bundle install
-    $ ./test.rb
-    $ ./spec.rb
-    HAVE FUN BE SAFE PLAY NICE
-
-This will create a skeleton class named YrBotNameSnakeCaseStyleYes, some smokescreen minitest::unit tests, and a variety of other "ruby app on free heroku instance" boiler plate. You will need to manually set the config variables with yr twitter api keys on heroku for deployment or add figaro or some such... documentation/scripts forthcoming
+```
+$ twitter_bot_generator --help
+twitter_bot_generator <yr_bots_name_camel_cased>
+## creates a new directory called <yr_bots_name_camel_cased> in the current working directory,
+and fills it with a bunch of boilerplate goodness
+
+$ twitter_bot_generator wat_fun
+scaffolding a twitter bot that is named wat_fun!
+mkdir wat_fun/
+mkdir wat_fun/lib
+mkdir wat_fun/src
+mkdir wat_fun/test
+touch wat_fun/bot.rb
+touch wat_fun/.gitignore
+touch wat_fun/Gemfile
+touch wat_fun/README.md
+touch wat_fun/Procfile
+touch wat_fun/spec.rb
+touch wat_fun/test.rb
+touch wat_fun/test/wat_fun_test.rb
+touch wat_fun/src/wat_fun.rb
+touch wat_fun/lib/greetings.txt
+done generating! your turn now!
+$ cd wat_fun
+$ bundle install
+$ ruby test.rb
+$ ruby spec.rb
+HAVE FUN BE SAFE PLAY NICE
+```
+
+This will create a skeleton class named YrBotNameSnakeCaseStyleYes, some smokescreen minitest::unit tests, and a variety of other "ruby app on free heroku instance" boiler plate.
+
+## Deployment (heroku)
+
+Once your bot has been well tested on the command line you'll need to get it out into the world!
+
+0. You probably need git and the heroku toolbet installed and also a heroku account.
+0. Make a twitter account for your bot. Give it a photo and header and some biographical information
+0. Go into settings > mobile and add a cell phone number that you can send a text from.
+    not all carriers will work :(
+    without a mobile number, twitter won't let you get the api keys you need to deploy
+    if your mobile number is associated with your personal account, temporarily delete it from that account so you can use it for your bot. Twitter doesn't care.
+0. go to apps.twitter.com and sign in again
+0. click create a new app
+0. fill in the details. just put down the github repo link or twitter page for the bot as website/callback url. no one will ever see this except you.
+0. once your app is created, click "modify app permissions" and set the app to read and write
+0. wait a lil bit for permissions to change.......
+0. click 'generate my access token'
+0. wait a lil bit to get access tokens.....
+0. SUCCESS! copy the access tokens down to a scratch txt file, but make sure not to commit it to source control/git/etc.! That would be bad because these things are secrets.
+0. From the command line:
+
+```
+heroku create
+heroku config:set TWITTER_CONSUMER_KEY=INSERT-YR-SECRETS-HERE
+heroku config:set TWITTER_CONSUMER_SECRET=INSERT-YR-SECRETS-HERE
+heroku config:set TWITTER_ACCESS_TOKEN=INSERT-YR-SECRETS-HERE
+heroku config:set TWITTER_ACCESS_SECRET=INSERT-YR-SECRETS-HERE
+ ```
+
+0. go back to twitter.com and delete yr mobile phone from the bot account. you may also want to disable email notifications as well.
+0. THE MAIN EVENT:
+
+```
+git push heroku master
+heroku ps:scale bot=1
+```
+
+0. go to your bot's page and you should see it's first tweet! Or something?
 
 This gem was made for use in the twitter-art-robot-[tutorial](http://github.com/coleww/twitter-art-tutorial) and more details and documentation and such will be there when things happen. :dancers:
 
+Depends on:
+
+https://github.com/sferik/twitter
+
+And sometimes:
+
+https://github.com/tweetstream/tweetstream
+
+
+
 ## Contribute
 
     all kinds of issues in the thing to the upper right! =>

data/bin/twitter_bot_generator

@@ -3,13 +3,26 @@
 require 'twitter_bot_generator'
 
 begin
-  if !ARGV[0] || ARGV[0] == '--help'
-    puts 'twitter_bot_generator <yr_bots_name_camel_cased>'
+
+  if !ARGV[0] || ARGV.any?{ |a| a == '--help' || a == '-H' }
+    puts 'twitter_bot_generator <yr_bots_name_camel_cased> (--<OPTIONAL OPTION>)'
     puts '## creates a new directory called <yr_bots_name_camel_cased> in the current working directory, '
     puts 'and fills it with a bunch of boilerplate goodness'
+    puts 'for building a bot that says stuff at a semi-random interval'
+    puts 'OPTIONAL ALTERNATIVE OPTIONS:'
+    puts '--streaming || -S: generates a bot that listens to the "gardenhose"'
+    puts '--userstream || -U: generates a bot that listens for tweets @ it'
+    puts 'have fun be kind to each other thanks goodbye!'
   else
-    TwitterBotGenerator.generate ARGV[0].gsub('-', '_')
+
+    bot_name = ARGV[0].downcase.gsub(/[^a-z]/, '_')
+
+    TwitterBotGenerator.generate bot_name, ARGV[1] || ''
+
   end
+
 rescue
+
   puts 'something horrible has happened'
+
 end

data/lib/twitter_bot_generator/templates/.gitignore.erb

@@ -1,3 +1,3 @@
 .DS_Store
 */.DS_Store
-notes.todo
+*.todo

data/lib/twitter_bot_generator/templates/Gemfile.erb

@@ -1,3 +1,4 @@
 source 'https://rubygems.org'
 ruby '2.0.0'
 gem 'twitter'
+gem "tweetstream"

data/lib/twitter_bot_generator/templates/README.md.erb

@@ -1,5 +1,44 @@
 # <%= bot_name %>
 A Twitter Bot
 
+## Development
+
 > bundle install
 > ruby test.rb
+> ruby spec.rb
+
+## Deployment (heroku)
+
+Once your bot has been well tested on the command line you'll need to get it out into the world!
+
+0. You probably need git and the heroku toolbet installed and also a heroku account.
+0. Make a twitter account for your bot. Give it a photo and header and some biographical information
+0. Go into settings > mobile and add a cell phone number that you can send a text from.
+    not all carriers will work :(
+    without a mobile number, twitter won't let you get the api keys you need to deploy
+    if your mobile number is associated with your personal account, temporarily delete it from that account so you can use it for your bot. Twitter doesn't care.
+0. go to apps.twitter.com and sign in again
+0. click create a new app
+0. fill in the details. just put down the github repo link or twitter page for the bot as website/callback url. no one will ever see this except you.
+0. once your app is created, click "modify app permissions" and set the app to read and write
+0. wait a lil bit to get access tokens
+0. SUCCESS! copy the access tokens down to a scratch txt file, but make sure not to commit it to source control/git/etc.! That would be bad because these things are secrets.
+0. From the command line:
+
+```
+heroku create
+heroku config:set TWITTER_CONSUMER_KEY=INSERT-YR-SECRETS-HERE
+heroku config:set TWITTER_CONSUMER_SECRET=INSERT-YR-SECRETS-HERE
+heroku config:set TWITTER_ACCESS_TOKEN=INSERT-YR-SECRETS-HERE
+heroku config:set TWITTER_ACCESS_SECRET=INSERT-YR-SECRETS-HERE
+ ```
+
+0. go back to twitter.com and delete yr mobile phone from the bot account. you may also want to disable email notifications as well.
+0. THE MAIN EVENT:
+
+```
+git push heroku master
+heroku ps:scale bot=1
+```
+
+0. go to your bot's page and you should see it's first tweet! Or something?

data/lib/twitter_bot_generator/templates/src/streaming-test_bot.rb.erb

@@ -0,0 +1,11 @@
+class <%= class_name %>
+
+  class << self
+
+    def matches? text
+      !!(text =~ /hello world/)
+    end
+
+  end
+
+end

data/lib/twitter_bot_generator/templates/src/test_bot.rb.erb

@@ -15,7 +15,9 @@ class <%= class_name %>
   private
 
     def load_txt_file file_name
-      (File.readlines (File.join 'lib', file_name)).map &:strip
+      home_sweet_home = File.expand_path File.dirname __FILE__
+      ultimate_pathway = File.join home_sweet_home, '..', 'lib', file_name
+      (File.readlines ultimate_pathway).map &:strip
     end
 
   end

data/lib/twitter_bot_generator/templates/src/userstream-test_bot.rb.erb

@@ -0,0 +1,11 @@
+class <%= class_name %>
+
+  class << self
+
+    def respond_to text
+      text.reverse
+    end
+
+  end
+
+end

data/lib/twitter_bot_generator/templates/streaming-bot.rb.erb

@@ -0,0 +1,34 @@
+require_relative 'src/<%= bot_name %>.rb'
+require "twitter"
+require "tweetstream"
+
+Twitter.configure do |config|
+  config.consumer_key       = ENV['TWITTER_CONSUMER_KEY']
+  config.consumer_secret    = ENV['TWITTER_CONSUMER_SECRET']
+  config.oauth_token        = ENV['TWITTER_OAUTH_TOKEN']
+  config.oauth_token_secret = ENV['TWITTER_OAUTH_SECRET']
+end
+
+TweetStream.configure do |config|
+  config.consumer_key       = ENV['TWITTER_CONSUMER_KEY']
+  config.consumer_secret    = ENV['TWITTER_CONSUMER_SECRET']
+  config.oauth_token        = ENV['TWITTER_OAUTH_TOKEN']
+  config.oauth_token_secret = ENV['TWITTER_OAUTH_SECRET']
+  config.auth_method        = :oauth
+end
+
+loop do
+  begin
+    puts "starting search"
+    TweetStream::Client.new.sample(language: 'en') do |tweet|
+      if <%= class_name %>.matches? tweet.text
+        puts "got one!"
+        Twitter.retweet tweet.id
+      end
+    end
+  rescue
+    puts 'FAILURE'
+  ensure
+    sleep 300
+  end
+end

data/lib/twitter_bot_generator/templates/streaming-spec.rb.erb

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+require_relative 'src/<%= bot_name %>'
+
+puts "hello world! ?"
+puts <%= class_name %>.matches? "hello world!"
+puts "hello canada! ?"
+puts <%= class_name %>.matches? "hello canada!"
+puts "replace this with meaningful example strings to test yr app!"
+puts <%= class_name %>.matches? "replace this with meaningful example strings to test yr app!"

data/lib/twitter_bot_generator/templates/test/streaming-test_bot_test.rb.erb

@@ -0,0 +1,16 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+
+require_relative '../src/<%= bot_name %>.rb'
+
+class Test<%= class_name %> <  MiniTest::Test
+
+  def test_matches_hello_world
+    assert_equal true, (<%= class_name %>.matches? 'hello world')
+  end
+
+  def test_doesnt_match_hello_canada
+    assert_equal false, (<%= class_name %>.matches? 'hello canada')
+  end
+
+end

data/lib/twitter_bot_generator/templates/test/test_bot_test.rb.erb

@@ -1,4 +1,6 @@
 require 'minitest/autorun'
+require 'minitest/pride'
+
 require_relative '../src/<%= bot_name %>.rb'
 
 class Test<%= class_name %> <  MiniTest::Test
@@ -9,10 +11,12 @@ class Test<%= class_name %> <  MiniTest::Test
 
   def test_hides_greetings
     refute_respond_to <%= class_name %>, :greetings
+    assert_instance_of String, <%= class_name %>.send(:greetings)[0]
   end
 
   def test_hides_io_metal
     refute_respond_to <%= class_name %>, :load_txt_file
+    assert_equal 3, <%= class_name %>.send(:load_txt_file, 'greetings.txt').length
   end
 
 end

data/lib/twitter_bot_generator/templates/test/userstream-test_bot_test.rb.erb

@@ -0,0 +1,12 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+
+require_relative '../src/<%= bot_name %>.rb'
+
+class Test<%= class_name %> <  MiniTest::Test
+
+  def test_reverses_hello_world
+    assert_match (<%= class_name %>.respond_to 'hello world'), 'dlrow olleh'
+  end
+
+end

data/lib/twitter_bot_generator/templates/userstream-bot.rb.erb

@@ -0,0 +1,28 @@
+require_relative 'src/<%= bot_name %>.rb'
+require "twitter"
+require "tweetstream"
+
+Twitter.configure do |config|
+  config.consumer_key       = ENV['TWITTER_CONSUMER_KEY']
+  config.consumer_secret    = ENV['TWITTER_CONSUMER_SECRET']
+  config.oauth_token        = ENV['TWITTER_OAUTH_TOKEN']
+  config.oauth_token_secret = ENV['TWITTER_OAUTH_SECRET']
+end
+
+TweetStream.configure do |config|
+  config.consumer_key       = ENV['TWITTER_CONSUMER_KEY']
+  config.consumer_secret    = ENV['TWITTER_CONSUMER_SECRET']
+  config.oauth_token        = ENV['TWITTER_OAUTH_TOKEN']
+  config.oauth_token_secret = ENV['TWITTER_OAUTH_SECRET']
+  config.auth_method        = :oauth
+end
+
+TweetStream::Client.new.userstream do |tweet|
+  puts "@#{tweet.user.screen_name} asks: #{tweet.text}"
+  begin
+    puts (answer = <%= class_name %>.respond_to tweet.text)
+    Twitter.update(answer, :in_reply_to_status_id => tweet.id)
+  rescue => e
+    puts e
+  end
+end

data/lib/twitter_bot_generator/templates/userstream-spec.rb.erb

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+require_relative 'src/<%= bot_name %>'
+
+puts "hello world! ?"
+puts <%= class_name %>.respond_to "hello world!"
+puts "hello applesauce! ?"
+puts <%= class_name %>.respond_to "hello applesauce!"
+puts "replace this with meaningful example strings to test yr app!"
+puts <%= class_name %>.respond_to "replace this with meaningful example strings to test yr app!"

data/lib/twitter_bot_generator/version.rb

@@ -1,4 +1,4 @@
 class TwitterBotGenerator
-  VERSION = "0.1.6"
+  VERSION = "0.2.0"
 end
 

data/lib/twitter_bot_generator.rb

@@ -6,21 +6,46 @@ class TwitterBotGenerator
 
   class << self
 
-    def generate bot_name
-      puts "scaffolding a twitter bot that is named #{bot_name}!"
+    def generate bot_name, flag=''
+      welcome_message bot_name, flag
+      make_directories! bot_name
+      write_files! bot_name, flag
+      exit_message bot_name
+    end
+
+  protected
+
+    def welcome_message bot_name, flag
+      descriptor = ''
+      if flag == '--streaming' || flag == '-S'
+        descriptor = 'streaming '
+      elsif flag == '--userstream' || flag == '-U'
+        descriptor = 'userstream '
+      end
+      puts "scaffolding a #{descriptor}twitter bot named #{bot_name}!"
+    end
+
+    def make_directories! bot_name
       Dir.mkdir bot_name
-      dirname = "#{bot_name}/"
-      puts "mkdir #{dirname}"
+      puts "mkdir #{bot_name}/"
       folders.each do |folder|
-        Dir.mkdir dirname + folder
-        puts "mkdir #{dirname + folder}"
+        folder_path = File.join bot_name, folder
+        Dir.mkdir folder_path
+        puts "mkdir #{folder_path}/"
       end
-      (files bot_name).each do |(file_name, contents)|
-        puts "touch #{dirname}#{file_name}"
-        File.open bot_name + '/' + file_name, 'w' do |f|
+    end
+
+    def write_files! bot_name, flag
+      (files bot_name, flag).each do |(file_name, contents)|
+        file_path = File.join bot_name, file_name
+        puts "touch #{file_path}"
+        File.open file_path, 'w' do |f|
           f.write contents
         end
       end
+    end
+
+    def exit_message bot_name
       puts 'done generating! your turn now!'
       puts "$ cd #{bot_name}"
       puts '$ bundle install'
@@ -29,13 +54,13 @@ class TwitterBotGenerator
       puts 'HAVE FUN BE SAFE PLAY NICE'
     end
 
-  protected
+  private
 
     def folders
       %w(lib src test)
     end
 
-    def files bot_name
+    def files bot_name, flag
       varz = grab_a_binding_for bot_name
       {
         'bot.rb' => (render_code 'bot.rb', varz),
@@ -48,7 +73,19 @@ class TwitterBotGenerator
         "test/#{bot_name}_test.rb" => (render_code 'test/test_bot_test.rb', varz),
         "src/#{bot_name}.rb" => (render_code 'src/test_bot.rb', varz),
         'lib/greetings.txt' => (render_code 'lib/greetings.txt', varz)
-      }
+      }.tap do |filz|
+        if flag == '--streaming' || flag == '-S'
+          filz['bot.rb'] = (render_code 'streaming-bot.rb', varz)
+          filz['spec.rb'] = (render_code 'streaming-spec.rb', varz)
+          filz["test/#{bot_name}_test.rb"] = (render_code 'test/streaming-test_bot_test.rb', varz)
+          filz["src/#{bot_name}.rb"] = (render_code 'src/streaming-test_bot.rb', varz)
+        elsif flag == '--userstream' || flag == '-U'
+          filz['bot.rb'] = (render_code 'userstream-bot.rb', varz)
+          filz['spec.rb'] = (render_code 'userstream-spec.rb', varz)
+          filz["test/#{bot_name}_test.rb"] = (render_code 'test/userstream-test_bot_test.rb', varz)
+          filz["src/#{bot_name}.rb"] = (render_code 'src/userstream-test_bot.rb', varz)
+        end
+      end
     end
 
     def grab_a_binding_for bot_name
@@ -60,8 +97,6 @@ class TwitterBotGenerator
       (get_template file_name).result varz
     end
 
-  private
-
     def camelize str
       ((str.split '_').map &:capitalize).join
     end

data/such_test_bot/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+*/.DS_Store
+*.todo

data/such_test_bot/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+ruby '2.0.0'
+gem 'twitter'
+gem "tweetstream"

data/such_test_bot/Procfile

@@ -0,0 +1 @@
+bot: ruby bot.rb

data/such_test_bot/README.md

@@ -0,0 +1,44 @@
+# such_test_bot
+A Twitter Bot
+
+## Development
+
+> bundle install
+> ruby test.rb
+> ruby spec.rb
+
+## Deployment (heroku)
+
+Once your bot has been well tested on the command line you'll need to get it out into the world!
+
+0. You probably need git and the heroku toolbet installed and also a heroku account.
+0. Make a twitter account for your bot. Give it a photo and header and some biographical information
+0. Go into settings > mobile and add a cell phone number that you can send a text from.
+    not all carriers will work :(
+    without a mobile number, twitter won't let you get the api keys you need to deploy
+    if your mobile number is associated with your personal account, temporarily delete it from that account so you can use it for your bot. Twitter doesn't care.
+0. go to apps.twitter.com and sign in again
+0. click create a new app
+0. fill in the details. just put down the github repo link or twitter page for the bot as website/callback url. no one will ever see this except you.
+0. once your app is created, click "modify app permissions" and set the app to read and write
+0. wait a lil bit to get access tokens
+0. SUCCESS! copy the access tokens down to a scratch txt file, but make sure not to commit it to source control/git/etc.! That would be bad because these things are secrets.
+0. From the command line:
+
+```
+heroku create
+heroku config:set TWITTER_CONSUMER_KEY=INSERT-YR-SECRETS-HERE
+heroku config:set TWITTER_CONSUMER_SECRET=INSERT-YR-SECRETS-HERE
+heroku config:set TWITTER_ACCESS_TOKEN=INSERT-YR-SECRETS-HERE
+heroku config:set TWITTER_ACCESS_SECRET=INSERT-YR-SECRETS-HERE
+ ```
+
+0. go back to twitter.com and delete yr mobile phone from the bot account. you may also want to disable email notifications as well.
+0. THE MAIN EVENT:
+
+```
+git push heroku master
+heroku ps:scale bot=1
+```
+
+0. go to your bot's page and you should see it's first tweet! Or something?

data/such_test_bot/bot.rb

@@ -0,0 +1,16 @@
+require_relative 'src/such_test_bot.rb'
+require 'twitter'
+twitter = Twitter::REST::Client.new do |config|
+  config.consumer_key = ENV['TWITTER_CONSUMER_KEY']
+  config.consumer_secret = ENV['TWITTER_CONSUMER_SECRET']
+  config.access_token = ENV['TWITTER_ACCESS_TOKEN']
+  config.access_token_secret = ENV['TWITTER_ACCESS_SECRET']
+end
+
+loop do
+  begin
+    twitter.update SuchTestBot.generate
+  ensure
+    sleep 10800 + (rand 5400)
+  end
+end

data/such_test_bot/lib/greetings.txt

@@ -0,0 +1,3 @@
+Hello World!
+Hello Twitter!
+Hello Ruby!

data/such_test_bot/spec.rb

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require_relative 'src/such_test_bot'
+12.times { puts SuchTestBot.generate }

data/such_test_bot/src/such_test_bot.rb

@@ -0,0 +1,25 @@
+class SuchTestBot
+
+  class << self
+
+    def generate
+      greetings.sample
+    end
+
+  protected
+
+    def greetings
+      @greetings ||= load_txt_file 'greetings.txt'
+    end
+
+  private
+
+    def load_txt_file file_name
+      home_sweet_home = File.expand_path File.dirname __FILE__
+      ultimate_pathway = File.join home_sweet_home, '..', 'lib', file_name
+      (File.readlines ultimate_pathway).map &:strip
+    end
+
+  end
+
+end

data/such_test_bot/test/such_test_bot_test.rb

@@ -0,0 +1,22 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+
+require_relative '../src/such_test_bot.rb'
+
+class TestSuchTestBot <  MiniTest::Test
+
+  def test_generate_returns_hello_world
+    assert_match /Hello/, SuchTestBot.generate
+  end
+
+  def test_hides_greetings
+    refute_respond_to SuchTestBot, :greetings
+    assert_instance_of String, SuchTestBot.send(:greetings)[0]
+  end
+
+  def test_hides_io_metal
+    refute_respond_to SuchTestBot, :load_txt_file
+    assert_equal 3, SuchTestBot.send(:load_txt_file, 'greetings.txt').length
+  end
+
+end

data/such_test_bot/test.rb

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+Dir.glob('./test/*_test.rb').each { |file| require file }

data/test/generated_default_bot.rb

@@ -0,0 +1,9 @@
+require_relative 'test_helper'
+
+wipe_such_test_bot!
+TwitterBotGenerator.generate 'such_test_bot'
+
+puts 'Running the test suite for the generated DEFAULT bot'
+Dir.chdir('such_test_bot')
+puts load '../such_test_bot/test/such_test_bot_test.rb'
+Dir.chdir('..')

data/test/generated_streaming_bot.rb

@@ -0,0 +1,9 @@
+require_relative 'test_helper'
+
+wipe_such_test_bot!
+TwitterBotGenerator.generate 'such_test_bot', '--streaming'
+
+puts 'Running the test suite for the generated STREAMING bot'
+Dir.chdir('such_test_bot')
+puts load '../such_test_bot/test/such_test_bot_test.rb'
+Dir.chdir('..')

data/test/generated_userstream_bot.rb

@@ -0,0 +1,9 @@
+require_relative 'test_helper'
+
+wipe_such_test_bot!
+TwitterBotGenerator.generate 'such_test_bot', '--userstream'
+
+puts 'Running the test suite for the generated USERSTREAM bot'
+Dir.chdir('such_test_bot')
+puts load '../such_test_bot/test/such_test_bot_test.rb'
+Dir.chdir('..')

data/test/scaffold_generator_test.rb

@@ -1,5 +1,10 @@
 require_relative 'test_helper'
 
+wipe_such_test_bot!
+TwitterBotGenerator.generate 'such_test_bot'
+
+puts 'testing the scaffolding'
+
 class TestTwitterBotGenerator <  MiniTest::Test
 
   def test_it_creates_an_app_directory
@@ -27,7 +32,7 @@ class TestTwitterBotGenerator <  MiniTest::Test
   def test_it_creates_a_gitignore
     assert_equal true, (File.exists? './such_test_bot/.gitignore')
     assert_match /.DS_Store/, (File.read './such_test_bot/.gitignore')
-    assert_match /notes.todo/, (File.read './such_test_bot/.gitignore')
+    assert_match /\*.todo/, (File.read './such_test_bot/.gitignore')
   end
 
   def test_it_creates_a_gemfile

data/test/test_helper.rb

@@ -1,15 +1,11 @@
 require 'minitest/autorun'
-require 'minitest/autorun'
 require 'minitest/pride'
 require 'coveralls'
 Coveralls.wear!
 
 require_relative "../lib/twitter_bot_generator.rb"
 
-# before :all do
-TwitterBotGenerator.generate 'such_test_bot'
-
-Minitest.after_run do
+def wipe_such_test_bot!
   ['./such_test_bot/Gemfile',
     './such_test_bot/README.md',
     './such_test_bot/test.rb',
@@ -19,10 +15,17 @@ Minitest.after_run do
     './such_test_bot/test/such_test_bot_test.rb',
     './such_test_bot/lib/greetings.txt',
     './such_test_bot/src/such_test_bot.rb',
-    './such_test_bot/.gitignore'].each { |file| File.unlink file }
+    './such_test_bot/.gitignore'].each { |file| File.unlink file if File.exists? file }
 
   ['./such_test_bot/lib',
     './such_test_bot/src',
     './such_test_bot/test',
-    './such_test_bot'].each { |dir| Dir.rmdir dir }
+    './such_test_bot'].each { |dir| Dir.rmdir dir if Dir.exists? dir}
+  true
+end
+
+Minitest.after_run do
+  # leave behind a default scaffold ALWAYS
+  wipe_such_test_bot!
+  TwitterBotGenerator.generate 'such_test_bot'
 end

data/twitter_bot_generator.gemspec

@@ -9,7 +9,23 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Cole Willsea"]
   spec.email         = ["coleww@gmail.com"]
   spec.summary       = %q{Generates a twitter bot template from command line.}
-  spec.description   = %q{gem install twitter_bot_generator && twitter_bot_generator new_twitter_bot}
+  spec.description   = <<-EOF
+    Scaffolds a new boilerplate twitter bot project from the command line.
+    By default will create a bot that tweets a "hello world" type greeting once every 3-4.5 hours
+    Can also pass a --streaming flag to create a bot that listens to the "gardenhose"
+    Or a --userstream flag for a bot that listens for tweets @ it.
+    To use:
+
+      $ gem install twitter_bot_generator
+      $ twitter_bot_generator --help
+      $ twitter_bot_generator my_new_bot
+      $ cd my_new_bot
+      $ bundle install
+      $ ruby test.rb
+      $ ruby spec.rb
+
+    etc.
+  EOF
   spec.homepage      = "https://github.com/coleww/twitter_bot_generator"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twitter_bot_generator
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Cole Willsea
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-13 00:00:00.000000000 Z
+date: 2014-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,7 +80,22 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: gem install twitter_bot_generator && twitter_bot_generator new_twitter_bot
+description: |2
+      Scaffolds a new boilerplate twitter bot project from the command line.
+      By default will create a bot that tweets a "hello world" type greeting once every 3-4.5 hours
+      Can also pass a --streaming flag to create a bot that listens to the "gardenhose"
+      Or a --userstream flag for a bot that listens for tweets @ it.
+      To use:
+
+        $ gem install twitter_bot_generator
+        $ twitter_bot_generator --help
+        $ twitter_bot_generator my_new_bot
+        $ cd my_new_bot
+        $ bundle install
+        $ ruby test.rb
+        $ ruby spec.rb
+
+      etc.
 email:
 - coleww@gmail.com
 executables:
@@ -104,11 +119,31 @@ files:
 - lib/twitter_bot_generator/templates/bot.rb.erb
 - lib/twitter_bot_generator/templates/lib/greetings.txt.erb
 - lib/twitter_bot_generator/templates/spec.rb.erb
+- lib/twitter_bot_generator/templates/src/streaming-test_bot.rb.erb
 - lib/twitter_bot_generator/templates/src/test_bot.rb.erb
+- lib/twitter_bot_generator/templates/src/userstream-test_bot.rb.erb
+- lib/twitter_bot_generator/templates/streaming-bot.rb.erb
+- lib/twitter_bot_generator/templates/streaming-spec.rb.erb
 - lib/twitter_bot_generator/templates/test.rb.erb
+- lib/twitter_bot_generator/templates/test/streaming-test_bot_test.rb.erb
 - lib/twitter_bot_generator/templates/test/test_bot_test.rb.erb
+- lib/twitter_bot_generator/templates/test/userstream-test_bot_test.rb.erb
+- lib/twitter_bot_generator/templates/userstream-bot.rb.erb
+- lib/twitter_bot_generator/templates/userstream-spec.rb.erb
 - lib/twitter_bot_generator/version.rb
-- test/generated_bot_test.rb
+- such_test_bot/.gitignore
+- such_test_bot/Gemfile
+- such_test_bot/Procfile
+- such_test_bot/README.md
+- such_test_bot/bot.rb
+- such_test_bot/lib/greetings.txt
+- such_test_bot/spec.rb
+- such_test_bot/src/such_test_bot.rb
+- such_test_bot/test.rb
+- such_test_bot/test/such_test_bot_test.rb
+- test/generated_default_bot.rb
+- test/generated_streaming_bot.rb
+- test/generated_userstream_bot.rb
 - test/scaffold_generator_test.rb
 - test/test_helper.rb
 - twitter_bot_generator.gemspec
@@ -137,6 +172,8 @@ signing_key:
 specification_version: 4
 summary: Generates a twitter bot template from command line.
 test_files:
-- test/generated_bot_test.rb
+- test/generated_default_bot.rb
+- test/generated_streaming_bot.rb
+- test/generated_userstream_bot.rb
 - test/scaffold_generator_test.rb
 - test/test_helper.rb

data/test/generated_bot_test.rb

@@ -1,6 +0,0 @@
-# require_relative 'test_helper'
-
-# # Running the test suite for the generated bot
-# Dir.chdir('such_test_bot')
-# puts Dir.entries(".").join
-# require_relative '../such_test_bot/test/such_test_bot_test.rb'