jekyll-recker 1.2.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57baf95903827025064b936a07c83984779e201d632d62343c2c3dc046135e90
-  data.tar.gz: eb5f5afa3612fff8cd5f75b24aa976c7806ced88abfeb09b3f0951af15f34940
+  metadata.gz: 3e0cc3d6cafa2518fb5819ad8cc4a6db7ecf88e214b0e998468f521d0ec19a37
+  data.tar.gz: e623e1c53b62d3ccf0a55ac572ef0fc4257e03cdf7faf543baa1f5ce7d0a40ed
 SHA512:
-  metadata.gz: a6a6c5f66c0028be4371fac2125c6965a81b36e4e26fda36dcf9d822cb4446b710f959614e20db2cd7614e36f7bbebe4d8d7ffdfdaefb1b872b270cc6aebc50d
-  data.tar.gz: c840806dbd64b1f64fe891a8eec5326a09bb1be8f2c7e6130772da17616717186e9da58956d04f5c68a9cf423e8e86cd0ff476b31729a79e3905750046615a42
+  metadata.gz: b45d3daae8d8af21c963a412d8430dce81bafaff270a35ca94444b01e74a7d4bd25e422a3ac9afb958bb3693cd7359d4bab70a07776d1da7c3637a38d633eed7
+  data.tar.gz: 4f6aadcd49f0b0d71232ab67c361d3aac1e5a91887272d39e826e3300afa8e0cf872b2154f6e5371dda74a5fd8ea9ac928bd7a2acc6b98357be2e87b75d25903

data/README.md

@@ -0,0 +1,105 @@
+# jekyll-recker
+
+The Greatest Jekyll Plugin in the World.  For a live example, check
+out [my personal website].
+
+## Installation
+
+Add `jekyll-recker` to the `jekyll_plugins` group in your `Gemfile`.
+
+    group :jekyll_plugins do
+      gem 'jekyll-recker'
+    end
+
+Then add the plugin to jekyll site's `config.yml` file.
+
+    pugins:
+      - jekyll-recker
+
+If you'd like to make your site look like mine too, set the theme in
+`config.yml` too.
+
+    theme: jekyll-recker
+
+## Usage
+
+### Share
+
+Use the `share` jekyll command to post a link to your latest published
+blog post to any or all of the configured Shares.
+
+    # TODO: example of `be jekyll share`
+
+Perform a test run with the `--dry` flag.
+
+    # TODO: example of `be jekyll share --dry`
+
+Send to all configured shares, or just pick one of them.
+
+    $ jekyll share slack
+	$ jekyll share twitter
+
+#### Slack
+
+Send the latest published post to a slack channel.
+
+![example slack]
+
+Configure the slack share in `_config.yml`.
+
+    recker:
+      slack:
+        myteam:
+          channel: '#blogs'
+          username: 'blogbot'
+          emoji: ':robot:'
+          webhook_cmd: cat ~/.secrets/slack-webhook.txt
+
+Use the `webhook_cmd` option to shell out to `gpg` or another CLI
+password manager.  Alternatively, you can supply the private incoming
+webhook using an environment variable.
+
+    export SLACK_MYTEAM_WEBHOOK="https://.../"  # SLACK_ + MyTeam.upcase + _WEBHOOK
+
+Multiple teams are supported as well.
+
+    recker:
+      slack:
+        MyTeamA:
+          channel: '#blogs'
+          username: 'blogbot'
+          emoji: ':robot:'
+        MyTeamB:
+          channel: '#blogs'
+          username: 'blogbot'
+          emoji: ':robot:'
+        MyTeamC:
+          channel: '#blogs'
+          username: 'blogbot'
+          emoji: ':robot:'
+
+#### Twitter
+
+Send a tweet with a link to the latest published post.
+
+![example tweet]
+
+Configure the tweet share in `_config.yml`.
+
+    recker:
+      twitter:
+        access_token_secret_cmd: pass twitter/reckerbot/access-token-secret
+        access_token_cmd: pass twitter/reckerbot/access-token
+        consumer_api_key_cmd: pass twitter/reckerbot/consumer-api-key
+        consumer_api_secret_cmd: pass twitter/reckerbot/consumer-api-secret-key
+
+Alternatively, ensure these environment variables are set.
+
+    export TWITTER_ACCESS_TOKEN_SECRET="..."
+    export TWITTER_ACCESS_TOKEN="..."
+    export TWITTER_CONSUMER_API_KEY="..."
+    export TWITTER_CONSUMER_API_SECRET="..."
+
+[example slack]: screenshots/example-slack.png
+[example tweet]: screenshots/example-tweet.png
+[my personal website]: https://www.alexrecker.com

data/_includes/figure.html

@@ -0,0 +1,14 @@
+<figure>
+  {%- if include.url %}
+  <a href="{{ include.url }}">
+  {%- endif %}
+  <img alt="{{ alt | default: include.filename }}" src="{{ site.baseurl }}assets/images/{{ include.filename }}"/>
+  {%- if include.url %}
+  </a>
+  {%- endif %}
+  {%- if include.caption %}
+  <figcaption>
+    <p>{{ include.caption }}</p>
+  </figcaption>
+  {%- endif %}
+</figure>

data/_includes/footer.html

@@ -1,5 +1,14 @@
 <footer>
-  built with <a href="https://jekyllrb.com/">jekyll</a> using <a href="{% link README.org %}">jekyll-recker</a> v{% recker_version %}
+  <nav>
+    find me on: &nbsp
+    <a href="mailto:{{ site.email }}">email</a>
+    <a href="https://www.github.com/{{ site.github_username }}">github</a>
+    <a href="https://www.twitter.com/{{ site.twitter_username }}">twitter</a>
+    <a href="{{ site.basurl }}/assets/public.gpg.asc">gpg</a>
+    <a href="https://www.linkedin.com/in/{{ site.linkedin_username }}">linkedin</a>
+    <a href="https://www.facebook.com/{{ site.facebook_username }}">facebook</a>
+  </nav>
+  built with <a href="https://jekyllrb.com/">jekyll</a> using <a href="https://www.github.com/arecker/jekyll-recker/">jekyll-recker</a> v{% recker_version %}
   <br/>
   <small>&copy; copyright {{ 'now' | date: '%Y' }}, {{ site.author }}</small>
 </footer>

data/_includes/head.html

@@ -0,0 +1,21 @@
+{%- capture title %}{{ include.title | default: page.title }}{%- endcapture %}
+{%- capture description %}{{ include.description | default: site.description }}{%- endcapture %}
+{%- capture image %}{{ include.image | default: page.image }}{%- endcapture %}
+<head>
+  <meta charset="UTF-8"/>
+  <title>{{ title }} | {{ description }}</title>
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <meta name="twitter:card" content="summary" />
+  <meta name="twitter:site" content="@{{ site.twitter_username }}" />
+  <meta name="twitter:title" content="{{ include.title }}" />
+  <meta name="twitter:description" content="{{ include.description }}" />
+  <meta property="og:url" content="{{ site.url }}{{ page.url }}" />
+  <meta property="og:type" content="article" />
+  <meta property="og:title" content="{{ title }}"/>
+  <meta property="og:description" content="{{ description }}" />
+  {%- if image %}
+  <meta name="twitter:image" content="{{ site.url }}{{ site.base_url }}/assets/images/{{ image }}"/>
+  <meta property="og:image" content="{{ site.url }}{{ site.base_url }}/assets/images/{{ image }}"/>
+  {%- endif %}
+  <link href="{{ site.baseurl }}/assets/jekyll-recker.css" rel="stylesheet"/>
+</head>

data/_includes/nav.html

@@ -1,8 +1,5 @@
 <nav>
-  <a href="{{ site.baseurl }}/" class="{% if page.active == 'index' %}active{% endif %}">index</a>
-  <a href="{% link archive.html %}" class="{% if page.active == 'archive' %}active{% endif %}">archive</a>
-  <a href="{% link stats.org %}" class="{% if page.active == 'stats' %}active{% endif %}">stats</a>
-  <a href="{% link projects.html %}" class="{% if page.active == 'projects' %}active{% endif %}">projects</a>
-  <a href="{% link contact.html %}" class="{% if page.active == 'contact' %}active{% endif %}">contact</a>
+  <a href="{{ site.baseurl }}/" class="{% if page.active == 'index' %}active{% endif %}">index.html</a>
+  <a href="{{ site.basurl }}/feed.xml">feed.xml</a>
   <span class="float-right hide-on-mobile">{{ page.slug }}</span>
-</nav> 
+</nav>

data/_includes/pager.html

@@ -0,0 +1,13 @@
+<nav class="clearfix">
+  {%- if page.next -%}
+  <a href="{{ page.next.url }}">
+    ⟵ {{ page.next.slug }}
+  </a>
+  {%- endif -%}
+  {%- if page.previous -%}
+  <a class="float-right" href="{{ page.previous.url }}">
+    {{ page.previous.slug }} ⟶
+  </a>
+  {%- endif -%}
+</nav>
+

data/_layouts/home.html

@@ -1,9 +1,13 @@
----
-layout: default
----
-{% include header.html title=site.title subtitle=site.description %}
-<hr/>
-{% include nav.html %}
-<hr/>
-{{ content }}
-
+<!doctype html>
+<html lang="en">
+  {% include head.html title=site.title %}
+  <body>
+    {% include header.html title=site.title subtitle=site.description %}
+    <hr/>
+    {% include nav.html %}
+    <hr/>
+    {{ content }}
+    <hr/>
+    {% include footer.html %}
+  </body>
+</html>

data/_layouts/page.html

@@ -1,8 +1,13 @@
----
-layout: default
----
-{% include header.html title=page.title subtitle=page.description %}
-<hr/>
-{% include nav.html %}
-<hr/>
-{{ content }}
+<!doctype html>
+<html lang="en">
+  {% include head.html title=site.title %}
+  <body>
+    {% include header.html title=page.title subtitle=page.description %}
+    <hr/>
+    {% include nav.html %}
+    <hr/>
+    {{ content }}
+    <hr/>
+    {% include footer.html %}
+  </body>
+</html>

data/_layouts/post.html

@@ -1,28 +1,20 @@
----
-layout: default
----
-{% capture datestring %}{{ page.date | date: '%A, %B %d %Y' }}{% endcapture %}
-{% include header.html title=datestring subtitle=page.title %}
-<hr/>
-{% include nav.html %}
-<hr/>
-{%- if page.image -%}
-<br/>
-<figure>
-  <img alt="page.image" src="{{ site.baseurl }}assets/images/{{ page.image }}"/>
-</figure>
-<br/>
-{%- endif -%}
-{{ content }}
-<nav class="clearfix">
-  {%- if page.next -%}
-  <a href="{{ page.next.url }}">
-    ⟵ {{ page.next.slug }}
-  </a>
-  {%- endif -%}
-  {%- if page.previous -%}
-  <a class="float-right" href="{{ page.previous.url }}">
-      {{ page.previous.slug }} ⟶
-  </a>
-</nav>
-{%- endif -%}
+{%- capture datestring %}{{ page.date | uyd_date }}{% endcapture %}
+<!doctype html>
+<html lang="en">
+  {% include head.html title=datestring description=page.title %}
+  <body>
+    {% include header.html title=datestring subtitle=page.title %}
+    <hr/>
+    {% include nav.html %}
+    <hr/>
+    {%- if page.image -%}
+    <br/>
+    {% include figure.html filename=page.image %}
+    <br/>
+    {%- endif -%}
+    {{ content }}
+    {% include pager.html %}
+    <hr/>
+    {% include footer.html %}
+  </body>
+</html>

data/lib/jekyll-recker.rb

@@ -5,19 +5,20 @@ require 'jekyll'
 module Jekyll
   # Recker
   module Recker
-    require 'jekyll-recker/logger.rb'
-    require 'jekyll-recker/mixins.rb'
+    require 'jekyll_recker/logger.rb'
+    require 'jekyll_recker/mixins.rb'
 
-    require 'jekyll-recker/commands.rb'
-    require 'jekyll-recker/configuration.rb'
-    require 'jekyll-recker/error.rb'
-    require 'jekyll-recker/generators.rb'
-    require 'jekyll-recker/shell.rb'
-    require 'jekyll-recker/slack.rb'
-    require 'jekyll-recker/stats.rb'
-    require 'jekyll-recker/tags.rb'
-    require 'jekyll-recker/twitter.rb'
-    require 'jekyll-recker/version.rb'
-    require 'jekyll-recker/words.rb'
+    require 'jekyll_recker/commands.rb'
+    require 'jekyll_recker/configuration.rb'
+    require 'jekyll_recker/error.rb'
+    require 'jekyll_recker/facebook.rb'
+    require 'jekyll_recker/filters.rb'
+    require 'jekyll_recker/generators.rb'
+    require 'jekyll_recker/shell.rb'
+    require 'jekyll_recker/slack.rb'
+    require 'jekyll_recker/tags.rb'
+    require 'jekyll_recker/twitter.rb'
+    require 'jekyll_recker/version.rb'
+    require 'jekyll_recker/words.rb'
   end
 end

data/lib/jekyll_recker/commands.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Recker
+    # Commands
+    module Commands
+      # Share
+      class Share < Jekyll::Command
+        include Mixins::Logging
+
+        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 { |args, opts| action(args, opts) }
+          end
+        end
+
+        def self.action(args, options)
+          if args.empty? || args.include?('slack')
+            Recker::Slack.share(dry: options['dry'])
+          elsif args.empty? || args.include?('twitter')
+            Recker::Twitter.share(dry: options['dry'])
+          # elsif args.empty? || args.include?('facebook')
+          #   Recker::Facebook.share(dry: options['dry'])
+          end
+        rescue ReckerError => e
+          logger.error e.message
+          exit 1
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Recker
     # Configuration
@@ -10,6 +12,10 @@ module Jekyll
         jekyll.fetch('recker', {})
       end
 
+      def self.facebook
+        recker.fetch('facebook', {})
+      end
+
       def self.twitter
         recker.fetch('twitter', {})
       end

data/lib/jekyll_recker/facebook.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'koala'
+
+module Jekyll
+  module Recker
+    # Facebook Client
+    class Facebook
+      include Mixins::Logging
+
+      def self.share(dry: false)
+        client = new(dry: dry)
+        logger.info 'discovering credentials'
+        client.discover_credentials!
+        logger.info "sharing #{client.latest.data['title']}"
+        client.post_latest!
+      end
+
+      def initialize(dry: false)
+        @dry = dry
+      end
+
+      def discover_credentials!
+        @creds = extract_from_env || extract_from_config
+        raise ReckerError, 'cannot find facebook credentials!' if @creds.nil?
+
+        set_credentials!
+      end
+
+      def post_latest!
+        if @dry
+          logger.info('posting in dry mode, printing message')
+          logger.info("BEGIN POST\n#{post_body.strip}\nEND POST")
+        else
+          @graph.put_connections("me", "feed", message: "I am writing on my wall!")
+        end
+      end
+
+      def latest
+        Configuration.latest_post
+      end
+
+      private
+
+      def post_body
+        url = File.join Configuration.jekyll['url'], latest.url
+        <<~POST
+          #{latest.data['date'].strftime('%A, %B %-d %Y')}
+          #{latest.data['title']}
+          #{url}
+        POST
+      end
+
+      def set_credentials!
+        Koala.configure do |config|
+          config.access_token = @creds['access_token']
+          # config.app_access_token = @creds['app_access_token']
+          config.app_id = @creds['app_id']
+          config.app_secret = @creds['app_secret']
+        end
+        @client = Koala::Facebook::API.new(@creds['access_token'])
+      end
+
+      def extract_from_env
+        values = cred_fieldnames.map { |k| ENV["FACEBOOK_#{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|
+          cmd = Configuration.facebook.fetch("#{k}_cmd", '').strip
+          if cmd.empty?
+            nil
+          else
+            Recker.shell(Configuration.facebook["#{k}_cmd"]).strip
+          end
+        end
+
+        return nil if values.any? { |v| v.nil? || v.empty? }
+
+        Hash[cred_fieldnames.zip(values)]
+      end
+
+      def cred_fieldnames
+        # app_access_token
+        %w[
+          access_token
+          app_id
+          app_secret
+        ]
+      end
+    end
+  end
+end