augury 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a28ff9832d2d3004984bc13a8da85a2798c1c324
-  data.tar.gz: 6988fd81ed53f496199b64519571c3b9782f50fc
+  metadata.gz: 9658042a5e949c0611f9e7044dac8f8d5f5a4b4b
+  data.tar.gz: 0d6b3d19af712ddde14d4690c00e3c721ba5521e
 SHA512:
-  metadata.gz: e14065d03249995fd1f8382ee444b4a8c48b62ba01fcfb270dbded58d1e58379bb3779dbc06a24a46d037422fdf6cc49c3613a998c8cebd19492c19cf174c677
-  data.tar.gz: f821c6685eb1eda754f90c8f209c71c9f09f4e1b6cea032343839ed22ad0fabe06e85a5ee4e1e53deb30710fcd5316b35e34bcf96ed5162ad777439b0c5e7d94
+  metadata.gz: 08b35032107de0c6f05119eeadf8b6bc2316ae5904105c84ef5ff6655642b49223ed36932e987abcedad3462dc3926e07e7f67ab83b2de2fb1bf25e49f356a00
+  data.tar.gz: c8bbbfefdcc61cf07844543e7a7e14e0bb074655ed867ce271279155398046a81995feaa5242a6b61aed097cea1c46e6518b06b3892c6aacd244d1f53224ac4b

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

data/README.md

@@ -1,8 +1,31 @@
 # Augury
 
-Have you ever wanted to turn a twitter account into an updating fortune file?
+Have you ever wanted to turn a twitter account into a fortune file?
 Well, today is your lucky day!
-Augury can take a twitter feed and turn it into a fortune file for you.
+
+Here is an example:
+
+```
+$ augury generate SeinfeldToday
+```
+
+This just created the fortune files in the current directory:
+
+```
+$ ls
+SeinfeldToday SeinfeldToday.dat
+```
+
+You can now read the new fortunes!
+
+```
+$ 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?"
+```
+
+Thanks for all the laughs fortune :)
 
 ## Installation
 
@@ -14,36 +37,83 @@ gem 'augury'
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install augury
+```
+$ gem install augury
+```
+
+### Requirements
+
+This gem requires that the fortune program is also installed.
+The fortune program ships with a `strfile` program that converts the plain text files to something that fortune can select from.
+
+For example,
+if you are using Homebrew on OS X:
+
+```
+$ brew install fortune
+```
 
 ## Configuration
 
-First, you will need to create a new Twitter application by going here:
+### Augury Config
+
+Create the `~/.augry.cfg` file and then set the permissions since your Twitter API info will be in there.
+
+```sh
+$ touch ~/.augury.cfg
+$ chmod 600 ~/.augury.cfg
+```
+
+Set any of these settings in the `augury` section of the config like this:
+
+```ini
+[augury]
+example_option = "An interesting value"
+```
+
+### Option list
+
+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
 
+### Twitter Setup
+
+First, you will need to create a new Twitter application by going here:
 https://apps.twitter.com
 
 This will give you the ability to generate the consumer and access information used below.
 
-In order to use this gem, you need to set up your Twitter credentials.
-This can be done by setting up the `~/.augury.conf` file.
-Here is an example of its contents:
+Add the following to your `~/.augury.cfg` file.
 
-  consumer_key = "YOUR_CONSUMER_KEY"
-  consumer_secret = "YOUR_CONSUMER_SECRET"
-  access_token = "YOUR_ACCESS_TOKEN"
-  access_token_secret = "YOUR_ACCESS_SECRET"
+```ini
+[twitter]
+consumer_key = "YOUR_CONSUMER_KEY"
+consumer_secret = "YOUR_CONSUMER_SECRET"
+access_token = "YOUR_ACCESS_TOKEN"
+access_token_secret = "YOUR_ACCESS_SECRET"
+```
 
-Make sure only your user has access to the file:
+## Usage
 
-  $ chmod 600 ~/.augury.conf
+Create a fortune for the latest SeinfeldToday tweets.
 
-## Usage
+```
+$ augury generate SeinfeldToday
+```
+
+Now you have some fortunes.
 
-TODO: Write usage instructions here
+```
+$ fortune SeinfeldToday
+```
 
 ## Development
 

data/TODO.md

@@ -0,0 +1,11 @@
+# TODO
+
+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.

data/augury.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["robots@claytron.com"]
 
   spec.summary       = %q{Turn a twitter feed into a fortune file}
-  spec.description   = %q{This gem turns a twitter feed into a fortune file that you can use with the fortune program}
+  spec.description   = File.open('README.md').read
   spec.homepage      = "https://github.com/claytron/augury"
   spec.license       = "MIT"
 
@@ -20,15 +20,26 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Actual dependencies
-  spec.add_dependency "twitter"
   spec.add_dependency "parseconfig"
   spec.add_dependency "thor"
+  spec.add_dependency "twitter"
+  ## Handle booleans from simple config
+  spec.add_dependency "wannabe_bool"
+  ## For the word_wrap function
+  spec.add_dependency "facets"
 
   # Development dependencies
+  ## Setup
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
+  ## Testing
   spec.add_development_dependency "rspec"
-  spec.add_development_dependency "pry"
   spec.add_development_dependency "cucumber"
   spec.add_development_dependency "aruba"
+  ## Debugging
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency 'pry-stack_explorer'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'pry-doc'
+  spec.add_development_dependency 'pry-awesome_print'
 end

data/lib/augury.rb

@@ -5,3 +5,4 @@ module Augury
 end
 
 require 'augury/fortune'
+require 'augury/exception'

data/lib/augury/cli.rb

@@ -3,10 +3,25 @@ require 'augury'
 
 module Augury
   class CLI < Thor
-    desc 'generate USERNAME', 'Generate a fortune file for the given username'
-    def generate(username)
-      augury = Augury::Fortune.new
-      puts augury.tweet_texts(username)
+    desc 'generate USERNAME [PATH]', 'Generate a fortune file for the given username'
+    option :width, :type => :numeric, :aliases => :w
+    option :append, :type => :boolean, :aliases => :a
+    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
+        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/exception.rb

@@ -0,0 +1,7 @@
+module Augury
+  class TwitterConfigError < StandardError
+    def message
+      "No twitter credential configuration found in the augury config"
+    end
+  end
+end

data/lib/augury/fortune.rb

@@ -1,21 +1,55 @@
-require 'twitter'
+require 'facets/string/word_wrap'
 require 'parseconfig'
+require 'twitter'
+require 'wannabe_bool'
 
 module Augury
   class Fortune
-    def initialize
-      # TODO: add a check for the file and warn the user
-      @config = ParseConfig.new(File.expand_path('~/.augury.conf'))
+    def initialize(username, path, width=nil, append=nil)
+      begin
+        @config = ParseConfig.new(File.expand_path('~/.augury.cfg'))
+      rescue Errno::EACCES
+        @config = ParseConfig.new
+      end
+
+      augury_config = @config.params['augury'] || {}
+      @username = username
+      @path = path
+      @width = width || augury_config['width'] || 72
+      @append = append || augury_config['append'].to_b || false
+
+      twitter_config = @config.params['twitter']
+      raise Augury::TwitterConfigError unless twitter_config
       @twitter  = Twitter::REST::Client.new do |config|
-        config.consumer_key = @config.params['consumer_key']
-        config.consumer_secret = @config.params['consumer_secret']
-        config.access_token = @config.params['access_token']
-        config.access_token_secret = @config.params['access_token_secret']
+        config.consumer_key = twitter_config['consumer_key']
+        config.consumer_secret = twitter_config['consumer_secret']
+        config.access_token = twitter_config['access_token']
+        config.access_token_secret = twitter_config['access_token_secret']
       end
     end
 
-    def tweet_texts(username='SeinfeldToday')
-      @twitter.user_timeline(username).flat_map { |tweet| tweet.full_text }
+    def tweet_texts
+      @twitter.user_timeline(@username).flat_map { |tweet| tweet.full_text }
+    end
+
+    def format_fortune(tweets)
+      tweets.flat_map { |tweet| tweet.word_wrap(@width) }.join("%\n")
+    end
+
+    def write_fortune(text)
+      # 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`
     end
   end
 end

data/lib/augury/version.rb

@@ -1,3 +1,3 @@
 module Augury
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: augury
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Clayton Parker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-19 00:00:00.000000000 Z
+date: 2015-08-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: parseconfig
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: twitter
   requirement: !ruby/object:Gem::Requirement
@@ -25,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: parseconfig
+  name: wannabe_bool
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: facets
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -94,6 +122,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +165,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: cucumber
+  name: pry-stack_explorer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +179,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: aruba
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -136,8 +220,143 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: This gem turns a twitter feed into a fortune file that you can use with
-  the fortune program
+description: |
+  # Augury
+
+  Have you ever wanted to turn a twitter account into a fortune file?
+  Well, today is your lucky day!
+
+  Here is an example:
+
+  ```
+  $ augury generate SeinfeldToday
+  ```
+
+  This just created the fortune files in the current directory:
+
+  ```
+  $ ls
+  SeinfeldToday SeinfeldToday.dat
+  ```
+
+  You can now read the new fortunes!
+
+  ```
+  $ 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?"
+  ```
+
+  Thanks for all the laughs fortune :)
+
+  ## Installation
+
+  Add this line to your application's Gemfile:
+
+  ```ruby
+  gem 'augury'
+  ```
+
+  And then execute:
+
+  ```
+  $ bundle
+  ```
+
+  Or install it yourself as:
+
+  ```
+  $ gem install augury
+  ```
+
+  ### Requirements
+
+  This gem requires that the fortune program is also installed.
+  The fortune program ships with a `strfile` program that converts the plain text files to something that fortune can select from.
+
+  For example,
+  if you are using Homebrew on OS X:
+
+  ```
+  $ brew install fortune
+  ```
+
+  ## Configuration
+
+  ### Augury Config
+
+  Create the `~/.augry.cfg` file and then set the permissions since your Twitter API info will be in there.
+
+  ```sh
+  $ touch ~/.augury.cfg
+  $ chmod 600 ~/.augury.cfg
+  ```
+
+  Set any of these settings in the `augury` section of the config like this:
+
+  ```ini
+  [augury]
+  example_option = "An interesting value"
+  ```
+
+  ### Option list
+
+  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
+
+  ### Twitter Setup
+
+  First, you will need to create a new Twitter application by going here:
+  https://apps.twitter.com
+
+  This will give you the ability to generate the consumer and access information used below.
+
+  Add the following to your `~/.augury.cfg` file.
+
+  ```ini
+  [twitter]
+  consumer_key = "YOUR_CONSUMER_KEY"
+  consumer_secret = "YOUR_CONSUMER_SECRET"
+  access_token = "YOUR_ACCESS_TOKEN"
+  access_token_secret = "YOUR_ACCESS_SECRET"
+  ```
+
+  ## Usage
+
+  Create a fortune for the latest SeinfeldToday tweets.
+
+  ```
+  $ augury generate SeinfeldToday
+  ```
+
+  Now you have some fortunes.
+
+  ```
+  $ fortune SeinfeldToday
+  ```
+
+  ## 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.
+
+  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).
+
+  ## Contributing
+
+  Bug reports and pull requests are welcome on GitHub at https://github.com/claytron/augury.
+
+  ## License
+
+  The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 email:
 - robots@claytron.com
 executables:
@@ -152,12 +371,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- TODO.md
 - augury.gemspec
 - bin/console
 - bin/setup
 - exe/augury
 - lib/augury.rb
 - lib/augury/cli.rb
+- lib/augury/exception.rb
 - lib/augury/fortune.rb
 - lib/augury/version.rb
 homepage: https://github.com/claytron/augury
@@ -185,3 +406,4 @@ signing_key:
 specification_version: 4
 summary: Turn a twitter feed into a fortune file
 test_files: []
+has_rdoc: