jekyll-recker 1.2.2 → 1.7.0

data/lib/jekyll_recker/mixins.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module Jekyll
+  module Recker
+    module Mixins
+      # Descendants
+      module Descendants
+        def self.included(base)
+          base.extend(self)
+        end
+
+        def descendants
+          ObjectSpace.each_object(Class).select { |klass| klass < self }
+        end
+      end
+
+      # Introspection
+      module Introspection
+        def self.included(base)
+          base.extend(self)
+        end
+
+        def class_name
+          self.class.name.split('::').last
+        end
+      end
+
+      # Logging
+      module Logging
+        def self.included(base)
+          base.extend(self)
+        end
+
+        def logger
+          @logger ||= Logger.new(
+            STDOUT,
+            formatter: proc { |_severity, _datetime, _progname, msg| "jekyll-recker: #{msg}\n" }
+          )
+        end
+      end
+    end
+  end
+end

data/lib/jekyll_recker/social.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+require 'slack-notifier'
+require 'twitter'
+
+module Jekyll
+  # Recker
+  module Recker
+    module Social
+      # Backend
+      #
+      # Backend base class for social sharing backends.
+      # @abstract
+      class Share
+        include Mixins::Introspection
+        include Mixins::Logging
+
+        def self.share(dry: false)
+          backend = new(dry: dry)
+          logger.info "#{backend.name} - building configuration"
+          backend.configure!
+
+          logger.info "#{backend.name} - sharing \"#{backend.latest_title}\""
+          backend.post!
+        end
+
+        def initialize(dry: false)
+          @dry = dry
+        end
+
+        def dry?
+          @dry
+        end
+
+        def config
+          @config ||= Jekyll::Recker::Configuration.recker.fetch(config_key)
+        end
+
+        def config_key
+          class_name.downcase
+        end
+        alias name config_key
+
+        def post_body
+          url = File.join Configuration.jekyll['url'], latest.url
+          <<~BODY
+            #{latest.data['date'].strftime('%A, %B %-d %Y')}
+            #{latest.data['title']}
+            #{url}
+          BODY
+        end
+
+        def latest
+          @latest ||= Configuration.latest_post
+        end
+
+        def latest_title
+          latest.data['title']
+        end
+
+        def configure!
+          raise NotImplementedError
+        end
+
+        def post!
+          raise NotImplementedError
+        end
+      end
+
+      # Slack
+      #
+      # Slack social sharing backend
+      class Slack < Share
+        def configure!
+          @creds = {}
+          workspaces.each do |key, data|
+            webhook = ENV["SLACK_#{key.upcase}_WEBHOOK"] || extract_from_config(data)
+            if webhook.nil?
+              raise ReckerError, "cannot find slack webhook for #{key} workspace!"
+            end
+
+            @creds[key] = webhook
+          end
+        end
+
+        def post!
+          message_body = ::Slack::Notifier::Util::LinkFormatter.format(post_body)
+          workspaces.each do |key, config|
+            logger.info "posting to #{key} workspace"
+            if @dry
+              logger.info("BEGIN MESSAGE\n#{message_body.strip}\nEND MESSAGE")
+            else
+              ::Slack::Notifier.new(
+                @creds[key].strip,
+                channel: config.fetch('channel'),
+                username: config.fetch('username'),
+                icon_emoji: config.fetch('emoji')
+              ).post(text: message_body)
+            end
+          end
+        end
+
+        private
+
+        def extract_from_config(data)
+          cmd = data['webhook_cmd']
+          return nil if cmd.nil?
+
+          Jekyll::Recker.shell(cmd)
+        end
+
+        def workspaces
+          config.each
+        end
+      end
+
+      # Twitter
+      #
+      # Twitter social sharing backend
+      class Twitter < Share
+        def configure!
+          creds = extract_from_env || extract_from_config
+          raise ReckerError, 'cannot find twitter credentials!' if creds.nil?
+
+          @client = ::Twitter::REST::Client.new do |settings|
+            settings.consumer_key = creds['consumer_api_key']
+            settings.consumer_secret = creds['consumer_api_secret']
+            settings.access_token = creds['access_token']
+            settings.access_token_secret = creds['access_token_secret']
+          end
+        end
+
+        def post!
+          if dry?
+            logger.info('tweeting in dry mode, printing message')
+            logger.info("BEGIN TWEET\n#{post_body}END TWEET")
+          else
+            @client.update(post_body)
+          end
+        end
+
+        private
+
+        def extract_from_env
+          values = cred_fieldnames.map { |k| ENV["TWITTER_#{k.upcase}"] }
+
+          return nil if values.any? { |v| v.nil? || v.empty? }
+
+          Hash[cred_fieldnames.zip(values)]
+        end
+
+        def extract_from_config
+          values = cred_fieldnames.map do |k|
+            Recker.shell(Configuration.twitter["#{k}_cmd"]).strip
+          end
+
+          return nil if values.any? { |v| v.nil? || v.empty? }
+
+          Hash[cred_fieldnames.zip(values)]
+        end
+
+        def cred_fieldnames
+          [
+            'access_token_secret',
+            'access_token',
+            'consumer_api_key',
+            'consumer_api_secret'
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/{jekyll-recker → jekyll_recker}/tags.rb

@@ -3,7 +3,7 @@
 module Jekyll
   module Recker
     module Tags
-      # Version
+      # Returns the VERSION of the running jekyll-recker gem.
       class Version < Liquid::Tag
         def render(_context)
           VERSION

data/lib/{jekyll-recker → jekyll_recker}/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Recker
-    VERSION = '1.2.2'
+    VERSION = '1.7.0'
   end
 end

metadata

@@ -1,37 +1,37 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-recker
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.7.0
 platform: ruby
 authors:
 - Alex Recker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-04 00:00:00.000000000 Z
+date: 2020-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: jekyll
+  name: bump
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.8'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: slack-notifier
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -39,13 +39,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: twitter
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,6 +80,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: slack-notifier
+  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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - alex@reckerfamily.com
@@ -88,33 +144,29 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
-- README.org
+- README.md
+- _includes/figure.html
 - _includes/footer.html
+- _includes/head.html
 - _includes/header.html
 - _includes/nav.html
-- _layouts/default.html
+- _includes/pager.html
 - _layouts/home.html
 - _layouts/page.html
 - _layouts/post.html
-- assets/jekyll-recker.scss
 - lib/jekyll-recker.rb
-- lib/jekyll-recker/commands.rb
-- lib/jekyll-recker/commands/share.rb
-- lib/jekyll-recker/commands/slack.rb
-- lib/jekyll-recker/commands/tweet.rb
-- lib/jekyll-recker/configuration.rb
-- lib/jekyll-recker/error.rb
-- lib/jekyll-recker/generators.rb
-- lib/jekyll-recker/logger.rb
-- lib/jekyll-recker/mixins.rb
-- lib/jekyll-recker/shell.rb
-- lib/jekyll-recker/slack.rb
-- lib/jekyll-recker/stats.rb
-- lib/jekyll-recker/tags.rb
-- lib/jekyll-recker/twitter.rb
-- lib/jekyll-recker/version.rb
-- lib/jekyll-recker/words.rb
-homepage: https://www.alexrecker.com/jekyll-recker.html
+- lib/jekyll_recker/commands.rb
+- lib/jekyll_recker/configuration.rb
+- lib/jekyll_recker/error.rb
+- lib/jekyll_recker/filters.rb
+- lib/jekyll_recker/generators.rb
+- lib/jekyll_recker/mixins.rb
+- lib/jekyll_recker/shell.rb
+- lib/jekyll_recker/social.rb
+- lib/jekyll_recker/tags.rb
+- lib/jekyll_recker/version.rb
+- lib/jekyll_recker/words.rb
+homepage: https://www.github.com/arecker/jekyll-recker/
 licenses:
 - GPLv3
 metadata: {}
@@ -136,5 +188,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: This is the jekyll theme for my personal website.
+summary: The Greatest Jekyll Plugin in the World
 test_files: []

data/README.org

@@ -1,205 +0,0 @@
-#+TITLE: jekyll-recker
-#+SLUG: jekyll-recker.html
-#+PERMALINK: jekyll-recker.html
-#+STARTUP: showall
-#+DESCRIPTION: my website's custom jekyll plugin
-
-This is the jekyll plugin for my personal website.  Source code
-available on [[https://github.com/arecker/blog][github]].
-
-** Installation
-
-Add =jekyll-recker= to the =jekyll_plugins= group of your =Gemfile=.
-
-#+BEGIN_SRC ruby
-  group :jekyll_plugins do
-    gem 'jekyll-recker'
-  end
-#+END_SRC
-
-Add =jekyll-recker= to the list of plugins in jekyll's =_config.yml=.
-
-#+BEGIN_SRC yaml
-  # _config.yaml
-  plugins:
-    - jekyll-recker
-#+END_SRC
-
-Set the theme.
-
-#+BEGIN_SRC yaml
-theme: jekyll-recker
-#+END_SRC
-
-Install and enjoy.
-
-#+BEGIN_SRC sh
-bundle install
-bundle exec jekyll serve
-#+END_SRC
-
-** Usage
-
-*** Commands
-
-**** =slack=
-
-The =slack= command posts a slack message advertising the latest
-published jekyll blog post using a private incoming webhook.
-
-Configure _config.yml
-
-#+BEGIN_SRC yaml
-  # _config.yml
-  recker:
-    slack:
-      MyTeam:
-        channel: '#blogs'   # required!
-        username: 'blogbot' # required!
-        emoji: ':robot:'    # required!
-#+END_SRC
-
-Multiple teams are supported too!
-
-#+BEGIN_SRC yaml
-  # _config.yml
-  recker:
-    slack:
-      MyTeamA:
-        channel: '#blogs'   # required!
-        username: 'blogbot' # required!
-        emoji: ':robot:'    # required!
-      MyTeamB:
-        channel: '#blogs'   # required!
-        username: 'blogbot' # required!
-        emoji: ':robot:'    # required!
-      MyTeamC:
-        channel: '#blogs'   # required!
-        username: 'blogbot' # required!
-        emoji: ':robot:'    # required!
-#+END_SRC
-
-
-Supply the private webhook through an environment variable.
-
-#+BEGIN_SRC sh
-  export SLACK_MYTEAM_WEBHOOK="https://..."  # SLACK_ + <MyTeam.upcase> + _WEBHOOK
-#+END_SRC
-
-Alternatively, add the command with which to retrieve the webhook in
-_config.yml
-
-#+BEGIN_SRC yaml
-  # _config.yml
-  recker:
-    slack:
-      MyTeam:
-        webhook_cmd: cat secrets/my-teams-secret-webhook.txt
-#+END_SRC
-
-Run =bundle exec jekyll slack= to let it rip!
-
-[[assets/images/example-slack.png]]
-
-Using the =--dry= flag, you can preview the message post without
-actually posting anything.
-
-#+BEGIN_EXAMPLE
-arecker@25732-arecker:~/src/blog$ be jekyll slack --dry
-Configuration file: /Users/arecker/src/blog/_config.yml
-jekyll-recker: reckerfamily: discovering webhook 
-Configuration file: /Users/arecker/src/blog/_config.yml
-jekyll-recker: reckerfamily: posting drag racing, windshield wipers, and alex's painting tips 
-jekyll-recker: postign in dry mode, printing message 
-jekyll-recker: BEGIN MESSAGE
-Sunday, March 15 2020
-drag racing, windshield wipers, and alex's painting tips
-https://www.alexrecker.com/2020-03-15.html
-END MESSAGE 
-#+END_EXAMPLE
-
-**** =tweet=
-
-The =tweet= command tweets a link to the latest published jekyll blog
-post.
-
-Ensure the following environment variables are set,.
-
-#+BEGIN_SRC sh
-  export ACCESS_TOKEN_SECRET="..."
-  export ACCESS_TOKEN="..."
-  export CONSUMER_API_KEY="..."
-  export CONSUMER_API_SECRET="..."
-#+END_SRC
-
-Alternatively, configure which commands to run to fetch the secrets.
-
-#+BEGIN_SRC yaml
-# _config.yml
-recker:
-  twitter:
-    access_token_secret_cmd: cat secrets/access-token-secret
-    access_token_cmd: cat secrets/access-token
-    consumer_api_key_cmd: cat secrets/consumer-api-key
-    consumer_api_secret_cmd: cat secrets/consumer-api-secret-key
-#+END_SRC
-
-Run =bundle exec jekyll tweet= to let it rip!
-
-[[assets/images/example-tweet.png]]
-
-Using the =--dry= flag, you can test your configuration without
-actually tweeting anything.
-
-#+BEGIN_EXAMPLE
-arecker@25732-arecker:~/src/blog$ be jekyll tweet --dry
-jekyll-recker: discovering credentials 
-Configuration file: /Users/arecker/src/blog/_config.yml
-Configuration file: /Users/arecker/src/blog/_config.yml
-jekyll-recker: tweeting drag racing, windshield wipers, and alex's painting tips 
-jekyll-recker: tweeting in dry mode, printing message 
-jekyll-recker: BEGIN TWEET
-Sunday, March 15 2020
-drag racing, windshield wipers, and alex's painting tips
-https://www.alexrecker.com/2020-03-15.html
-END TWEET 
-#+END_EXAMPLE
-
-*** Generators
-
-**** =stats=
-
-On build time, =jekyll-recker= calculates and stores the following
-stats in the =site.data.stats= object
-
-| Field Name      | Field Description                                    |
-|-----------------+------------------------------------------------------|
-| =posts=         | The total number of published posts.                 |
-| =words.total=   | The total number of words from all published post.   |
-| =words.average= | The average number of words for each published post. |
-| =days.days=     | Current streak of daily, consecutive posts.          |
-| =days.start=    | First day of current streak.                         |
-| =days.end=      | Last day of current streak.                          |
-
-Use these variables to render your own page of neat writing statistics!
-
-#+BEGIN_SRC html
-    <table>
-      <tr>
-        <th>Total Posts</th>
-        <th>Total Words</th>
-        <th>Average Words per Post</th>
-        <th>Current Streak</th>
-        <th>First day of current streak</th>
-        <th>Last day of current streak</th>
-      </tr>
-      <tr>
-        <td>{{ site.data.stats.posts }}</td>
-        <td>{{ site.data.stats.words.total }}</td>
-        <td>{{ site.data.stats.words.average }}</td>
-        <td>{{ site.data.stats.days.days }}</td>
-        <td>{{ site.data.stats.days.start }}</td>
-        <td>{{ site.data.stats.days.end }}</td>
-      </tr>
-    </table>
-#+END_SRC