jekyll-recker 1.2.1 → 1.6.0

data/README.org

@@ -1,204 +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.
-
-** 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

data/_layouts/default.html

@@ -1,14 +0,0 @@
-<!doctype html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8"/>
-    <title>{{ site.title }} | {{ page.title | default: site.description }}</title>
-    <meta name="viewport" content="width=device-width, initial-scale=1">  
-    <link href="{{ site.baseurl }}/assets/jekyll-recker.css" rel="stylesheet"/>
-  </head>
-  <body>
-    {{ content }}
-    <hr/>
-    {% include footer.html %}
-  </body>
-</html>

data/assets/jekyll-recker.scss

@@ -1,110 +0,0 @@
----
----
-// @import 'https://fonts.googleapis.com/css?family=Titillium+Web&display=swap';
-@import 'https://fonts.googleapis.com/css?family=Open+Sans&display=swap';
-@import 'https://fonts.googleapis.com/css?family=Inconsolata&display=swap';
-
-.float-right {
-    float: right;
-}
-
-.float-left {
-    float: left;
-}
-
-.clearfix::after {
-    content: "";
-    clear: both;
-    display: block;
-}
-
-@media screen and (max-width: 600px) {
-    .hide-on-mobile {
-	display: none;
-    }
-}
-
-ul.unstyled {
-    list-style-type: none;
-    margin: 0;
-    padding: 0;
-}
-
-body {
-    margin: 40px auto;
-    max-width: 800px;
-    line-height: 1.6;
-    font-size: 18px;
-    color: #444;
-    padding: 0 10px;
-}
-
-h1, h2, h3 {
-    line-height: 1.2;
-}
-
-header {
-    h1 {
-	margin-bottom: 9px;
-    }
-    
-    p {
-	margin-top: 9px;
-    }
-}
-
-figure {
-    img {
-	display: block;
-	margin-left: auto;
-	margin-right: auto;
-	vertical-align: top;
-	height: auto;
-	max-width: 100%;
-    }
-
-    figcaption {
-	text-align: center;
-    }
-}
-
-nav {
-    a {
-	margin-right: 10px;
-    }
-
-    a.active {
-	color: black !important;
-    }
-
-    span {
-	color: #6f7370;
-    }
-}
-
-a {
-    text-decoration: none !important;
-    color: #008083 !important;
-
-    :hover {
-	text-decoration: underline !important;
-    }
-
-    :active {
-	color: #6f7370 !important;
-    }
-}
-
-* {
-    // font-family: 'Titillium Web', sans-serif !important;
-    font-family: 'Open Sans', 'sans-serif' !important;
-}
-
-code, pre, pre span {
-    font-family: Inconsolata, monospace !important;
-}
-
-pre, pre span {
-    font-size: 14px;
-}
-

data/lib/jekyll-recker/commands.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Jekyll
-  module Recker
-    # Commands
-    module Commands
-      require 'jekyll-recker/commands/share.rb'
-      require 'jekyll-recker/commands/slack.rb'
-      require 'jekyll-recker/commands/tweet.rb'
-    end
-  end
-end

data/lib/jekyll-recker/commands/share.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Jekyll
-  module Recker
-    module Commands
-      # Share
-      class Share < Jekyll::Command
-        include Jekyll::Recker::LoggingMixin
-
-        def self.init_with_program(prog)
-          prog.command(:share) do |c|
-            c.syntax 'share'
-            c.description 'Share latest post with each configured backend'
-            c.option 'dry', '-d', '--dry', 'perform dry run'
-            c.action do |_args, _options|
-              logger.info 'normally I\'d share here'
-            rescue ReckerError => e
-              logger.abort_with e.message
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/jekyll-recker/commands/slack.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Jekyll
-  module Recker
-    module Commands
-      # Slack
-      class Slack < Jekyll::Command
-        class << self
-          def init_with_program(prog)
-            prog.command(:slack) do |c|
-              c.syntax 'slack'
-              c.description 'slack latest post'
-              c.option 'dry', '-d', '--dry', 'print message instead of posting'
-              c.action do |_args, options|
-                Recker::Slack.each_in_config(dry: options['dry']) do |client|
-                  Recker.info "#{client.key}: discovering webhook"
-                  client.discover_webhook!
-                  Recker.info "#{client.key}: posting #{client.latest.data['title']}"
-                  client.post_latest!
-                end
-              rescue ReckerError => e
-                Recker.abort_with e.message
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/jekyll-recker/commands/tweet.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Jekyll
-  module Recker
-    module Commands
-      # Tweet
-      class Tweet < Jekyll::Command
-        include LoggingMixin
-
-        class << self
-          def init_with_program(prog)
-            prog.command(:tweet) do |c|
-              c.syntax 'tweet'
-              c.description 'tweet latest post'
-              c.option 'dry', '-d', '--dry', 'print message instead of tweeting'
-              c.action do |_args, options|
-                client = Jekyll::Recker::Twitter.new(dry: options['dry'])
-                logger.info 'discovering credentials'
-                client.discover_credentials!
-                logger.info "tweeting #{client.latest.data['title']}"
-                client.post_latest!
-              rescue ReckerError => e
-                logger.abort_with e.message
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/jekyll-recker/generators.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Jekyll
-  module Recker
-    module Generators
-      # StatsGenerator
-      class StatsGenerator < Jekyll::Generator
-        include Jekyll::Recker::LoggingMixin
-
-        def generate(site)
-          logger.info 'generating site statistics'
-          site.data['stats'] = Stats.crunch(site)
-        end
-      end
-    end
-  end
-end