augury 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dde4ab6e3cfe2e7942e603cecbd45b49c74080b37923bdc050426e769ce9241b
-  data.tar.gz: e820b4fee8dba782143f93ac761d1bbdee9743e82108425d32c864d19255cb6d
+  metadata.gz: c20cb6d68923a886d955dc7f94305b9f59acb06991e96112170b933c4dbf56ae
+  data.tar.gz: 29a140a75cb40148ac27955ccfb489e322f79a54e9f735933e67dc0f291588b7
 SHA512:
-  metadata.gz: 4ebf89891a5f7b535aa8fe76fd1b08e055fde4530e326442743741c0476842c65440361cc651672509d6ca56ec3236ba60b70d1a9e613b76e83e30c4631c5411
-  data.tar.gz: afc5e614422f71e30e8e16492eb7679d2d659759a7adad9d2d506648e2c01410c90c6d73851fbe9ae035ad3cf04f75c44f179470ffa8633a85fb8f05d9d40118
+  metadata.gz: 81038a2cd623f5a7ba2ba9e38bcceb104b301a90276e71f4eaa2a37152f49ffa45cae9d01e83a0ec1142401d1a006cb4cca348efe3c2ace6d2c57bd99555b0b2
+  data.tar.gz: 24ddd1018b9ff51169a2c8dd6d76e43623e84fac2a19a3161ee96b1947829967c586c46b41fac222aa8befa7a22d3d280da5645ffd05f898f75cf3ca7d8b2abc

data/.codeclimate.yml

@@ -8,6 +8,3 @@ plugins:
 ratings:
   paths:
   - "**.rb"
-exclude_paths:
-- features/**/*
-- spec/**/*

data/.gitignore

@@ -1,13 +1,63 @@
-/.bundle/
-/vendor/
-/.yardoc
-/_yardoc/
+# gem sets
+/gems/
+
+# rspec failure tracking
+.rspec_status
+
+# Ruby.gitignore
+*.gem
+*.rbc
+/.config
 /coverage/
-/doc/
+/InstalledFiles
 /pkg/
 /spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
 /tmp/
-/bin/*
 
-# rspec failure tracking
-.rspec_status
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/.rbenv-gemsets

@@ -0,0 +1 @@
+./gems

data/.ruby-gemset

@@ -0,0 +1 @@
+augury

data/.ruby-version

@@ -0,0 +1 @@
+2.7.2

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changes
 
+## 1.1.1 (2020-02-13)
+
+- Fix attribution on last item
+- More test coverage for formatting
+- Add hidden debug option
+
+## 1.1.0 (2020-01-24)
+
+- Add ability to transform tweet text with find / replace
+- Get full text of tweets, not the default abbreviated version
+- Switch to better word wrapping library
+
+## 1.0.3 (2020-01-23)
+
+- Pin Thor version to avoid issue with `options` override
+- Add tests for `Augury::CLI`
+
+## 1.0.2 (2020-01-09)
+
+- Fix bug with specific tweet count retrieval
+
+## 1.0.1 (2020-01-08)
+
+- Remove unused gem
+
 ## 1.0.0 (2020-01-08)
 
 - Convert augury config from ini style to yaml (breaking change)

data/Gemfile

@@ -17,6 +17,7 @@ gem 'webmock'
 gem 'pry'
 gem 'pry-awesome_print'
 gem 'pry-byebug'
+gem 'pry-doc'
 
 # Linting / completion
 gem 'rubocop', '0.92'

data/Gemfile.lock

@@ -1,18 +1,17 @@
 PATH
   remote: .
   specs:
-    augury (1.0.0)
-      equalizer (~> 0.0)
-      facets (~> 3.0)
-      thor (~> 1.0)
+    augury (1.1.0)
+      thor (~> 1.0.0)
       twitter (~> 7.0)
+      word_wrap (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.1)
+    ast (2.4.2)
     awesome_print (1.8.0)
     backport (1.1.2)
     benchmark (0.1.1)
@@ -22,12 +21,11 @@ GEM
     crack (0.4.5)
       rexml
     diff-lcs (1.4.4)
-    docile (1.3.4)
+    docile (1.3.5)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
     e2mmap (0.1.0)
     equalizer (0.0.11)
-    facets (3.1.0)
     ffi (1.14.2)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
@@ -41,8 +39,8 @@ GEM
     http-cookie (1.0.3)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
-    http-parser (1.2.2)
-      ffi-compiler
+    http-parser (1.2.3)
+      ffi-compiler (>= 1.0, < 2.0)
     http_parser.rb (0.6.0)
     jaro_winkler (1.5.4)
     kramdown (2.3.0)
@@ -59,7 +57,7 @@ GEM
       mini_portile2 (~> 2.5.0)
       racc (~> 1.4)
     parallel (1.20.1)
-    parser (2.7.2.0)
+    parser (3.0.0.0)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -70,6 +68,9 @@ GEM
     pry-byebug (3.9.0)
       byebug (~> 11.0)
       pry (~> 0.13.0)
+    pry-doc (1.1.0)
+      pry (~> 0.11)
+      yard (~> 0.9.11)
     public_suffix (4.0.6)
     racc (1.5.2)
     rainbow (3.0.0)
@@ -100,7 +101,7 @@ GEM
       rubocop-ast (>= 0.5.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.4.0)
+    rubocop-ast (1.4.1)
       parser (>= 2.7.1.5)
     rubocop-rake (0.5.1)
       rubocop
@@ -109,13 +110,13 @@ GEM
       rubocop-ast (>= 0.7.1)
     ruby-progressbar (1.11.0)
     simple_oauth (0.3.1)
-    simplecov (0.21.1)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.2)
-    solargraph (0.40.1)
+    solargraph (0.40.2)
       backport (~> 1.1)
       benchmark
       bundler (>= 1.17.2)
@@ -123,7 +124,7 @@ GEM
       jaro_winkler (~> 1.5)
       kramdown (~> 2.3)
       kramdown-parser-gfm (~> 1.1)
-      parser (~> 2.3)
+      parser (~> 3.0)
       reverse_markdown (>= 1.0.5, < 3)
       rubocop (>= 0.52)
       thor (~> 1.0)
@@ -148,10 +149,11 @@ GEM
     unf_ext (0.0.7.7)
     unicode-display_width (1.7.0)
     vcr (6.0.0)
-    webmock (3.11.0)
+    webmock (3.11.1)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
+    word_wrap (1.0.0)
     yard (0.9.26)
 
 PLATFORMS
@@ -162,6 +164,7 @@ DEPENDENCIES
   pry
   pry-awesome_print
   pry-byebug
+  pry-doc
   rake
   rspec (~> 3.0)
   rubocop (= 0.92)

data/README.md

@@ -81,14 +81,14 @@ $ brew install fortune
 
 ### Augury Config
 
-Create the `~/.augry.cfg` file and then set the permissions since your Twitter API info will be in there.
+Create the `~/.augry.yml` file and then set the permissions since your Twitter API info will be in there.
 
 ```sh
-$ touch ~/.augury.cfg
-$ chmod 600 ~/.augury.cfg
+$ touch ~/.augury.yml
+$ chmod 600 ~/.augury.yml
 ```
 
-Set any of these settings in the `augury` section of the config like this:
+Set any of the available settings in the config like this:
 
 ```yaml
 count: 20
@@ -107,7 +107,11 @@ Option | Description | Default
 `retweets` | Include retweets. | `false`
 `replies` | Include replies. | `false`
 `links` | Include tweets with links in them. | `false`
+`remove_links` | Remove all links from tweets before any other `transforms`. If set, this infers `links` is `true`. | `false`
 `attribution` | Add an author attribution to each fortune. | `false`
+`apply_transforms` | Apply the global and feed specific transforms. | `false`
+`transforms` | Transformations to apply to specific user feeds. See [Transforms](#transforms) below. |
+`global-transforms` | Transformations to apply to all feeds. Applied after `transforms` See [Transforms](#transforms) below. |
 
 ### Twitter Setup
 
@@ -126,6 +130,65 @@ twitter:
   access_token_secret: YOUR_ACCESS_TOKEN_SECRET
 ```
 
+### Transforms
+
+Global substitutions can be made using regular expressions.
+Each transform is a pattern and replacement.
+For instance, if you wanted to replace all `Hello`'s with `Hello world`, you could add the following:
+
+```yaml
+global-transforms:
+  -
+    - !ruby/regexp /(hello)/i
+    - "\\1 world"
+```
+
+Global transforms are applied after all other `transforms`.
+Word wrapping is applied after the transforms have been applied.
+
+#### Feed specific
+
+Transforms can also be defined per user feed.
+If you wanted to do the same as the global above, but only for `seinfeldtoday`, then add the following:
+
+```yaml
+transforms:
+  seinfeldtoday:
+    -
+      - !ruby/regexp /(hello)/i
+      - "\\1 world"
+```
+
+Or a more interesting example using the example earlier for `seinfeldtoday`:
+
+```text
+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?"
+```
+
+Then add the following to make this a bit more readable:
+
+```yaml
+transforms:
+  seinfeldtoday:
+    -
+      - !ruby/regexp /(E:\s*)/
+      - "\n\nElaine: "
+    -
+      - !ruby/regexp /BF/
+      - "boyfriend"
+```
+
+Then we end up with this:
+
+```text
+Elaine has no idea what her boyfriend does for a living and it's now
+too late to ask.
+
+Elaine: "Teacher, I think. Or a doctor? Wait Is 'computers' a job?"
+```
+
 ## Usage
 
 Create a fortune for the latest *seinfeldtoday* tweets.
@@ -201,7 +264,21 @@ $ bundle exec ruby exe/augury help
 You can run the tests with the rake task:
 
 ```sh
-$ bundle exec rake spec
+$ bundle exec rspec
+```
+
+#### Twitter ENV
+
+If you need to record a test with the Twitter API, you can set up the proper env vars by getting them from your currently set up `augury.yml` file.
+
+```sh
+$ eval `bin/extract_creds`
+```
+
+Then run the tests as you normally would.
+
+```sh
+$ bundle exec rspec
 ```
 
 ## Contributing

data/augury.gemspec

@@ -20,9 +20,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   # Actual dependencies
-  spec.add_dependency 'thor', '~>1.0'
+  spec.add_dependency 'thor', '~>1.0.0'
   spec.add_dependency 'twitter', '~>7.0'
   ## For the word_wrap function
-  spec.add_dependency 'equalizer', '~>0.0'
-  spec.add_dependency 'facets', '~>3.0'
+  spec.add_dependency 'word_wrap', '~>1.0'
 end

data/bin/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+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.
+
+require "pry"
+Pry.start

data/bin/extract_creds

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'yaml'
+
+begin
+  augury_config = YAML.load_file(File.expand_path('~/.augury.yml'))
+  puts augury_config['twitter'].collect { |k, v| "export TWITTER_#{k.upcase}=#{v}" }.join("\n")
+rescue Errno::ENOENT
+  puts 'echo "No config file present (~/.augury.yml) no env vars set"'
+  exit 1
+end

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install --binstubs

data/lib/augury/cli.rb

@@ -16,7 +16,7 @@ module Augury
     option :append,
       type: :boolean,
       aliases: '-a',
-      desc: 'If set, the target path will be appended to instead of overwritten'
+      desc: 'If set, the target path will be appended to instead of overwritten. DEFAULT: false'
 
     option :count,
       type: :numeric,
@@ -38,11 +38,26 @@ module Augury
       aliases: '-l',
       desc: 'Include tweets with links in them. DEFAULT: false'
 
+    option :remove_links,
+      type: :boolean,
+      aliases: '--remove-links',
+      desc: 'Remove links from tweets. DEFAULT: false'
+
     option :attribution,
       type: :boolean,
       aliases: '-A',
       desc: 'Add an author attribution to each fortune. DEFAULT: false'
 
+    option :apply_transforms,
+      type: :boolean,
+      aliases: '-t',
+      desc: 'Apply transforms from config file. DEFAULT: false'
+
+    option :debug,
+      type: :boolean,
+      aliases: '-d',
+      hide: true
+
     def generate(username, *path)
       path = File.expand_path(path[0] || username)
       augury = Augury::Fortune.new(username, path, options)
@@ -53,6 +68,7 @@ module Augury
     rescue StandardError => e
       say 'There was an error running the command. Details below:'
       say e.message
+      puts e.backtrace if options[:debug]
       exit 1
     end
 
@@ -63,21 +79,19 @@ module Augury
       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')
+      config_path = File.expand_path(ENV.fetch('AUGURY_CFG_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
 
+      # Enforce implied options
+      defaults[:links] = true if original_options[:remove_links] || defaults[:remove_links]
+
       Thor::CoreExt::HashWithIndifferentAccess.new(defaults.merge(original_options))
     end
   end

data/lib/augury/exception.rb

@@ -6,4 +6,10 @@ module Augury
       'No twitter credential configuration found in the augury config'
     end
   end
+
+  class TransformError < StandardError
+    def message
+      'Augury transforms are invalid, check your configuration'
+    end
+  end
 end

data/lib/augury/fortune.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'cgi'
-require 'facets/string/word_wrap'
+require 'word_wrap'
 require 'twitter'
 
 module Augury
@@ -17,23 +17,25 @@ module Augury
       response = yield(max_id)
       collection += response
       if response.empty?
-        collection.flatten
+        collection
       elsif !@config[:count].zero? && collection.length >= @config[:count]
-        collection.flatten
+        # 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 retrieve_tweets
-      collect_with_max_id do |max_id|
+      @tweets = collect_with_max_id do |max_id|
         options = {
-          count: @config[:count].zero? ? 200 : @config[:count],
+          count: 200,
+          tweet_mode: 'extended',
           include_rts: @config[:retweets],
           exclude_replies: !@config[:replies],
         }
         options[:max_id] = max_id unless max_id.nil?
-        @tweets = @twitter.user_timeline(@username, options)
+        @twitter.user_timeline(@username, options)
       end
     rescue Twitter::Error::TooManyRequests => e
       reset_length = e.rate_limit.reset_in + 1
@@ -45,9 +47,17 @@ module Augury
       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]) }
+      to_transform = transforms
+      formatted = filtered.flat_map do |tweet|
+        text = CGI.unescapeHTML(tweet)
+        to_transform.each do |transform|
+          text.gsub!(transform[0], transform[1])
+        end
+        WordWrap.ww text, @config.fetch(:width, 72)
+      end
       author = @config[:attribution] ? "\n-- #{@twitter.user(@username).name}\n" : ''
-      formatted.join("#{author}%\n")
+      text = formatted.join("#{author}%\n")
+      text + author if author
     end
 
     def write_fortune
@@ -74,5 +84,28 @@ module Augury
         cfg.access_token_secret = @config[:twitter]['access_token_secret']
       end
     end
+
+    private
+
+    def transforms
+      all_transforms = []
+      all_transforms << [/https?:\/\/[^\s]+/, ''] if @config[:remove_links]
+      return all_transforms unless @config[:apply_transforms]
+
+      all_transforms.push(*@config.dig('transforms', @username) || [])
+      all_transforms.push(*@config.fetch('global-transforms', []))
+
+      raise Augury::TransformError unless validate_transforms(all_transforms)
+
+      all_transforms
+    end
+
+    def validate_transforms(all_transforms)
+      all_transforms.all? do |transform|
+        transform.count == 2 &&
+          [String, Regexp].include?(transform[0].class) &&
+          transform[1].is_a?(String)
+      end
+    end
   end
 end

data/lib/augury/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Augury
-  VERSION = '1.0.0'
+  VERSION = '1.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: augury
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Clayton Parker
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-08 00:00:00.000000000 Z
+date: 2021-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: twitter
   requirement: !ruby/object:Gem::Requirement
@@ -39,33 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: equalizer
+  name: word_wrap
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.0'
-- !ruby/object:Gem::Dependency
-  name: facets
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.0'
 description: This gem turns a twitter feed into a fortune file that you can use with
   the fortune program
 email:
@@ -77,8 +63,11 @@ extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
 - ".gitignore"
+- ".rbenv-gemsets"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
 - ".solargraph.yml"
 - ".travis.yml"
 - CHANGELOG.md
@@ -87,9 +76,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- TODO.md
 - augury.gemspec
 - bin/console
+- bin/extract_creds
 - bin/setup
 - exe/augury
 - lib/augury.rb
@@ -101,7 +90,7 @@ homepage: https://github.com/claytron/augury
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -117,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Turn a twitter feed into a fortune file
 test_files: []

data/TODO.md

@@ -1,10 +0,0 @@
-# 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.
-- Ask user for twitter config on first start, save it out
-- 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.