augury 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a745ff0e70cbdadbaf9dd4415b1edb16ec0bb87d
-  data.tar.gz: 34a82cf9069b55127f301c6a54c623fea08866d0
+  metadata.gz: a0c7c48771363a9a5c848e76b7747bf9b5d9fbd3
+  data.tar.gz: 2dd47ecc12e320134c3ce249f64e088a436a1a4e
 SHA512:
-  metadata.gz: 6470c46d253a9315362d40d7035b516b7db8e69c936c2042b76a172fe145658d5e43f5f08185510715d92cafc65995cd91b9cc2f95ae60df549338de39c2d809
-  data.tar.gz: 6f4e38961aa97d87c085c2b7c9b5f007536eb5b5f6a21026420842c2afb39afc5a70ab3546ae3033a9ea37a96c08c4ea74afdb8c1106f64a519697e158d15101
+  metadata.gz: 8afece52e31616184f74750ae3eee61eca34ef30a7582ffac4f9777b3515cbea1e84d94e5610a4a2f1b1bb075cd64d1bb77358a564bded2a9251d83e26aa917e
+  data.tar.gz: c5ad6b4b98c483fca41f513f29e201f0b9a13b1f0bd9b31c3f34e725179d4b52b28ca98bae506169111e5e64ebdadaccbfd8ca75df5cebba73d30646e008dbb7

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 *.gem
+/bin/*

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changes
+
+## 0.3.0 (2015-08-20)
+
+- Add `count` option and allow for a user to get all tweets
+- Improve error handling
+- Handle spaces in `path` argument
+- Properly get defaults from the config if not passed on the command line
+- Updated docs and interactive help
+
+## 0.2.1 (2015-08-19)
+
+- Fix docs on rubygems site
+
+## 0.2.0 (2015-08-19)
+
+- Initial working code and documentation
+
+## 0.1.0 (2015-08-19)
+
+- Initial code skeleton
+- Test push to rubygems

data/README.md

@@ -3,23 +3,30 @@
 Have you ever wanted to turn a twitter account into a fortune file?
 Well, today is your lucky day!
 
-Here is an example:
+<blockquote>
+Augury is the practice from ancient Roman religion of<br>
+interpreting omens from the observed flight of birds.<br><br>
+As per [Wikipedia](https://en.wikipedia.org/wiki/Augury)
+</blockquote>
+
+There are a lot of really funny twitter accounts out there.
+Let's just pick one and get started.
 
 ```
-$ augury generate SeinfeldToday
+$ augury generate seinfeldtoday
 ```
 
 This just created the fortune files in the current directory:
 
 ```
 $ ls
-SeinfeldToday SeinfeldToday.dat
+seinfeldtoday seinfeldtoday.dat
 ```
 
 You can now read the new fortunes!
 
 ```
-$ fortune SeinfeldToday
+$ fortune seinfeldtoday
 Elaine has no idea what her BF does for a living and it's now too
 late to ask. E:"Teacher, I think. Or a doctor? Wait Is
 'computers' a job?"
@@ -27,6 +34,13 @@ late to ask. E:"Teacher, I think. Or a doctor? Wait Is
 
 Thanks for all the laughs fortune :)
 
+Here are some accounts that work well with Augury:
+
+- [Modern Seinfeld](https://twitter.com/seinfeldtoday)
+- [Very Short Story](https://twitter.com/veryshortstory)
+- [Bored Elon Musk](https://twitter.com/boredelonmusk)
+- Your own feed, so you can get nostalgic.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -81,8 +95,11 @@ example_option = "An interesting value"
 
 These are the available options for the `~/.augury.cfg`
 
-- `append` Make the script add more entries to the specified file instead of re-writing it. DEFAULT: False
-- `width` Set the default width used if none is given on the command line. DEFAULT: 72
+Option | Description | Default
+------ | :---------- | -------
+`append` | Make the script add more entries to the specified file instead of re-writing it | `false`
+`width` | Set the default width used if none is given on the command line. | `72`
+`count` | The number of tweets to get. Set to 0 to get all. | `200`
 
 ### Twitter Setup
 
@@ -103,29 +120,81 @@ access_token_secret = "YOUR_ACCESS_SECRET"
 
 ## Usage
 
-Create a fortune for the latest SeinfeldToday tweets.
+Create a fortune for the latest *seinfeldtoday* tweets.
 
 ```
-$ augury generate SeinfeldToday
+$ augury generate seinfeldtoday
 ```
 
 Now you have some fortunes.
 
 ```
-$ fortune SeinfeldToday
+$ fortune seinfeldtoday
+```
+
+Specify a width and a different path to use:
+
+```
+$ augury generate -w 120 seinfeldtoday /usr/local/share/games/fortune/Modern\ Seinfeld
+```
+
+If this is where your fortune program looks for fortunes,
+you can now use the new fortune.
+
+```
+$ fortune "Modern Seinfeld"
+```
+
+### See the interactive help
+
+Run the help to get more details about what the program can do
+
+```
+$ bin/augury help
+$ bin/augury help generate
 ```
 
 ## 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.
+If you want to contribute to this library,
+do the following.
+
+Create a fork, then get the code
+
+```
+$ git clone git@github.com:YOUR_USERNAME/augury.git
+$ cd augury
+```
+
+Run the setup script to get everything installed:
 
-To install this gem onto your local machine, run `bundle exec rake install`.
-To release a new version, update the version number in `version.rb`,
-and then run `bundle exec rake release`,
-which will create a git tag for the version,
-push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+**NOTE**: This requires having bundler available.
+That is beyond the scope of this README.
+
+```
+$ bin/setup
+```
+
+Once that is finished, there is a console available.
+This gives you access to all the code via Pry.
+
+```
+$ bin/console
+```
+
+The `augury` command will be available in bin:
+
+```
+$ bin/augury help
+```
+
+### Run the tests
+
+You can run the tests with the rake task:
+
+```
+$ rake spec
+```
 
 ## Contributing
 
@@ -134,3 +203,16 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/claytr
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Thanks for all the fish
+
+Thanks to [TinderBox](http://gettinderbox.com) for giving us time to make cool things happen!
+
+This was an excellent learning experience for the author,
+who is new at programming in Ruby.
+
+The [Developing a RubyGem using Bundler][gemdocs] documentation was fun to read and informative.
+It helped get the skeleton of the code set up and extra goodies in the development profile.
+Highly recommended read!
+
+[gemdocs]: https://github.com/radar/guides/blob/master/gem-development.md#developing-a-rubygem-using-bundler

data/TODO.md

@@ -4,8 +4,8 @@ Some ideas for things that could be added:
 
 - Add an option to limit the tweets from a certain date forward.
   This would allow for adding the latest tweets via cron.
-- Add options for how many tweets to retrieve
 - Ask user for twitter config on first start, save it out
 - Sign each entry with the name of the twitter account
 - Series of regex that could be applied.
   This would be a way to make SeinfeldToday dialog get put on their own lines.
+- Different word wrapping options. To a width, or by sentence, or whatever.

data/bin/console

@@ -2,6 +2,8 @@
 
 require "bundler/setup"
 require "augury"
+# Load up the cli here as well
+require "augury/cli"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/bin/setup

@@ -2,6 +2,4 @@
 set -euo pipefail
 IFS=$'\n\t'
 
-bundle install
-
-# Do any other automated setup that you need to do here
+bundle install --binstubs

data/lib/augury/cli.rb

@@ -4,24 +4,32 @@ require 'augury'
 module Augury
   class CLI < Thor
     desc 'generate USERNAME [PATH]', 'Generate a fortune file for the given username'
-    option :width, :type => :numeric, :aliases => :w
-    option :append, :type => :boolean, :aliases => :a
+    option :width,
+      :type => :numeric, :aliases => '-w',
+      :desc => 'The maximum number of columns that will be written on a line. DEFAULT: 72'
+    option :append,
+      :type => :boolean, :aliases => '-a',
+      :desc => 'If set, the target path will be appended to instead of overwritten'
+    option :count,
+      :type => :numeric, :aliases => '-c',
+      :desc => 'The number of tweets to get. Set to 0 to get all. DEFAULT: 200'
     def generate(username, *path)
-      path = File.expand_path(path[0] || username)
       begin
-        augury = Augury::Fortune.new(
-          username,
-          path,
-          options['width'],
-          options['append']
-        )
-      rescue Augury::TwitterConfigError => e
-        puts e.message
+        path = File.expand_path(path[0] || username)
+          augury = Augury::Fortune.new(
+            username,
+            path,
+            options['width'],
+            options['append'],
+            options['count'],
+          )
+        augury.write_fortune
+        self.say "Fortune written out to #{path}"
+      rescue => e
+        self.say "There was an error running the command. Details below:"
+        self.say e.message
         exit 1
       end
-      tweets = augury.tweet_texts
-      augury.write_fortune(augury.format_fortune(tweets))
-      puts "Fortune written out to #{path}"
     end
   end
 end

data/lib/augury/fortune.rb

@@ -5,7 +5,7 @@ require 'wannabe_bool'
 
 module Augury
   class Fortune
-    def initialize(username, path, width=nil, append=nil)
+    def initialize(username, path, width=nil, append=nil, count=nil)
       begin
         @config = ParseConfig.new(File.expand_path('~/.augury.cfg'))
       rescue Errno::EACCES
@@ -15,8 +15,9 @@ module Augury
       augury_config = @config.params['augury'] || {}
       @username = username
       @path = path
-      @width = width || augury_config['width'] || 72
-      @append = append || augury_config['append'].to_b || false
+      @width = (width || augury_config['width'] || 72).to_i
+      @append = (append || augury_config['append'] || false).to_b
+      @count = (count || augury_config['count'] || 200).to_i
 
       twitter_config = @config.params['twitter']
       raise Augury::TwitterConfigError unless twitter_config
@@ -28,28 +29,53 @@ module Augury
       end
     end
 
-    def tweet_texts
-      @twitter.user_timeline(@username).flat_map { |tweet| tweet.full_text }
+    def collect_with_max_id(collection=[], max_id=nil, &block)
+      response = yield(max_id)
+      collection += response
+      if response.empty?
+        collection.flatten
+      elsif ! @count.zero? && collection.length >= @count
+        collection.flatten
+      else
+        collect_with_max_id(collection, response.last.id - 1, &block)
+      end
+    end
+
+    def tweets
+      begin
+        collect_with_max_id do |max_id|
+          options = {
+            count: @count.zero? ? 200 : @count,
+            include_rts: true,
+          }
+          options[:max_id] = max_id unless max_id.nil?
+          @twitter.user_timeline(@username, options)
+        end
+      rescue Twitter::Error::TooManyRequests => e
+        reset_length = e.rate_limit.reset_in + 1
+        puts "Twitter rate limit exceeded. Waiting #{reset_length} minute(s)"
+        sleep reset_length
+      end
     end
 
-    def format_fortune(tweets)
-      tweets.flat_map { |tweet| tweet.word_wrap(@width) }.join("%\n")
+    def format_fortune
+      tweet_texts = self.tweets.flat_map { |tweet| tweet.full_text }
+      tweet_texts.flat_map { |tweet| tweet.word_wrap(@width) }.join("%\n")
     end
 
-    def write_fortune(text)
+    def write_fortune
+      text = self.format_fortune
       # Write out the file
       begin
         mode = @append ? 'a' : 'w'
         file = File.open(@path, mode)
         file.write("%\n") if @append
         file.write(text)
-      rescue IOError => e
-        puts e
       ensure
         file.close unless file.nil?
       end
       # Create the dat file too
-      `strfile #{@path} #{@path}.dat`
+      `strfile '#{@path}' '#{@path}.dat'`
     end
   end
 end

data/lib/augury/version.rb

@@ -1,3 +1,3 @@
 module Augury
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: augury
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Clayton Parker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-20 00:00:00.000000000 Z
+date: 2015-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parseconfig
@@ -232,6 +232,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md