augury 0.2.0 → 1.0.2

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/TODO.md

@@ -4,8 +4,7 @@ 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/augury.gemspec

@@ -1,45 +1,27 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'augury/version'
+# frozen_string_literal: true
+
+require_relative 'lib/augury/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "augury"
+  spec.name          = 'augury'
   spec.version       = Augury::VERSION
-  spec.authors       = ["Clayton Parker"]
-  spec.email         = ["robots@claytron.com"]
+  spec.authors       = ['Clayton Parker']
+  spec.email         = ['robots@claytron.com']
 
-  spec.summary       = %q{Turn a twitter feed into a fortune file}
-  spec.description   = File.open('README.md').read
-  spec.homepage      = "https://github.com/claytron/augury"
-  spec.license       = "MIT"
+  spec.summary       = 'Turn a twitter feed into a fortune file'
+  spec.description   = 'This gem turns a twitter feed into a fortune file that you can use with the fortune program'
+  spec.homepage      = 'https://github.com/claytron/augury'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   # Actual dependencies
-  spec.add_dependency "parseconfig"
-  spec.add_dependency "thor"
-  spec.add_dependency "twitter"
-  ## Handle booleans from simple config
-  spec.add_dependency "wannabe_bool"
+  spec.add_dependency 'thor', '~>1.0'
+  spec.add_dependency 'twitter', '~>7.0'
   ## 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 "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'
+  spec.add_dependency 'facets', '~>3.0'
 end

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/extract_creds

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'yaml'
+
+augury_config = YAML.load_file(File.expand_path('~/.augury.yml'))
+puts augury_config['twitter'].collect { |k, v| "export TWITTER_#{k.upcase}=#{v}" }.join("\n")

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.rb

@@ -1,7 +1,8 @@
-require "augury/version"
+# frozen_string_literal: true
+
+require 'augury/version'
 
 module Augury
-  # Your code goes here...
 end
 
 require 'augury/fortune'

data/lib/augury/cli.rb

@@ -1,27 +1,84 @@
+# frozen_string_literal: true
+
 require 'thor'
+require 'yaml'
 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'
+
+    option :retweets,
+      type: :boolean,
+      aliases: '-r',
+      desc: 'Include retweets. DEFAULT: false'
+
+    option :replies,
+      type: :boolean,
+      aliases: '-R',
+      desc: 'Include replies. DEFAULT: false'
+
+    option :links,
+      type: :boolean,
+      aliases: '-l',
+      desc: 'Include tweets with links in them. DEFAULT: false'
+
+    option :attribution,
+      type: :boolean,
+      aliases: '-A',
+      desc: 'Add an author attribution to each fortune. DEFAULT: false'
+
     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
+      augury = Augury::Fortune.new(username, path, options)
+      augury.twitter_setup
+      augury.retrieve_tweets
+      augury.write_fortune
+      say "Fortune written out to #{path}"
+    rescue StandardError => e
+      say 'There was an error running the command. Details below:'
+      say e.message
+      exit 1
+    end
+
+    private
+
+    def options
+      original_options = super
+      defaults = Thor::CoreExt::HashWithIndifferentAccess.new(
+        {
+          width: 72,
+          append: false,
+          count: 200,
+          retweets: false,
+          replies: false,
+          links: false,
+          attribution: false,
+        },
+      )
+
+      config_path = File.expand_path('~/.augury.yml')
+      if File.file?(config_path)
+        config_options = Thor::CoreExt::HashWithIndifferentAccess.new(YAML.load_file(config_path) || {})
+        defaults = defaults.merge(config_options)
       end
-      tweets = augury.tweet_texts
-      augury.write_fortune(augury.format_fortune(tweets))
-      puts "Fortune written out to #{path}"
+
+      Thor::CoreExt::HashWithIndifferentAccess.new(defaults.merge(original_options))
     end
   end
 end

data/lib/augury/exception.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Augury
   class TwitterConfigError < StandardError
     def message
-      "No twitter credential configuration found in the augury config"
+      'No twitter credential configuration found in the augury config'
     end
   end
 end

data/lib/augury/fortune.rb

@@ -1,55 +1,79 @@
+# frozen_string_literal: true
+
+require 'cgi'
 require 'facets/string/word_wrap'
-require 'parseconfig'
 require 'twitter'
-require 'wannabe_bool'
 
 module Augury
   class Fortune
-    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'] || {}
+    def initialize(username, path, config)
       @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 = 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']
+      @config = config
+      @tweets = []
+    end
+
+    def collect_with_max_id(collection = [], max_id = nil, &block)
+      response = yield(max_id)
+      collection += response
+      if response.empty?
+        collection
+      elsif !@config[:count].zero? && collection.length >= @config[:count]
+        # Get everything or trim the results to the count
+        @config[:count].zero? ? collection : collection[0..@config[:count] - 1]
+      else
+        collect_with_max_id(collection, response.last.id - 1, &block)
       end
     end
 
-    def tweet_texts
-      @twitter.user_timeline(@username).flat_map { |tweet| tweet.full_text }
+    def retrieve_tweets
+      @tweets = collect_with_max_id do |max_id|
+        options = {
+          count: 200,
+          include_rts: @config[:retweets],
+          exclude_replies: !@config[:replies],
+        }
+        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
 
-    def format_fortune(tweets)
-      tweets.flat_map { |tweet| tweet.word_wrap(@width) }.join("%\n")
+    def format_fortune
+      filtered = @tweets.flat_map(&:full_text).reject do |tweet|
+        tweet.match(/https?:/) unless @config[:links]
+      end
+      formatted = filtered.flat_map { |tweet| CGI.unescapeHTML(tweet).word_wrap(@config[:width]) }
+      author = @config[:attribution] ? "\n-- #{@twitter.user(@username).name}\n" : ''
+      formatted.join("#{author}%\n")
     end
 
-    def write_fortune(text)
+    def write_fortune
       # Write out the file
       begin
-        mode = @append ? 'a' : 'w'
+        mode = @config[:append] ? 'a' : 'w'
         file = File.open(@path, mode)
-        file.write("%\n") if @append
-        file.write(text)
-      rescue IOError => e
-        puts e
+        file.write("%\n") if @config[:append]
+        file.write(format_fortune)
       ensure
-        file.close unless file.nil?
+        file&.close
       end
       # Create the dat file too
-      `strfile #{@path} #{@path}.dat`
+      `strfile '#{@path}' '#{@path}.dat'`
+    end
+
+    def twitter_setup
+      raise Augury::TwitterConfigError unless @config[:twitter]
+
+      @twitter = Twitter::REST::Client.new do |cfg|
+        cfg.consumer_key = @config[:twitter]['consumer_key']
+        cfg.consumer_secret = @config[:twitter]['consumer_secret']
+        cfg.access_token = @config[:twitter]['access_token']
+        cfg.access_token_secret = @config[:twitter]['access_token_secret']
+      end
     end
   end
 end

data/lib/augury/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Augury
-  VERSION = "0.2.0"
+  VERSION = '1.0.2'
 end

metadata

@@ -1,362 +1,59 @@
 --- !ruby/object:Gem::Specification
 name: augury
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Clayton Parker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-20 00:00:00.000000000 Z
+date: 2021-01-10 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'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: twitter
-  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: wannabe_bool
-  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: facets
-  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: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
-  type: :development
+        version: '7.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: facets
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
+        version: '3.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  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: 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
-    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-stack_explorer
-  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-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:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-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).
+        version: '3.0'
+description: This gem turns a twitter feed into a fortune file that you can use with
+  the fortune program
 email:
 - robots@claytron.com
 executables:
@@ -364,16 +61,22 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".solargraph.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - TODO.md
 - augury.gemspec
 - bin/console
+- bin/extract_creds
 - bin/setup
 - exe/augury
 - lib/augury.rb
@@ -393,17 +96,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Turn a twitter feed into a fortune file
 test_files: []
-has_rdoc: