jekyll-twitter-plugin 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4c1b655f7a4220868b0d2cd098cba068f4956e68
-  data.tar.gz: a2c010f3a7d65bd5c9fe5e2af53971fa25ca7105
+SHA256:
+  metadata.gz: d5a28bcf4677a1a5ca462788776ead3431ed26444a2f6e2f632e1d2bc9ca5fcd
+  data.tar.gz: ba7ba303e24ca67c1ff1313813722c94f88353ef7d2014af2bbca7c75c53012f
 SHA512:
-  metadata.gz: 4f83e487aac6acb23ff716b6384914d9f881abdbcddc249418bfa471702b918d5efc39700a943beae3eb1cf37513da84ef7fa2fa41f5a437df150b4e1b8be2f3
-  data.tar.gz: 969e54b10b302987d5a8f40d64a0e545216ff587e68f517bd3b510e2f610453f0cd7afa2109842b98e53dd3825b5efab2b0747c983b2e08759c58db807779914
+  metadata.gz: 6fe96d45ec4959d1b98489408676f504e70398fc5aaaa4cb550201193457a7286f3a18e394298aafc68e1c2dc463b79b358d5c5c0dbef6c3b59672e6957a1e74
+  data.tar.gz: 2bd3d486f229a82c43ee757499fc23e975e490383b4b6d8ac725acde09818c4703b1537d47c7aaedcecb498d2963534cde5a261b37840c010b47a5c09230303e

data/.gitignore

@@ -38,3 +38,4 @@ Gemfile.lock
 .env
 output_test.html
 .tweet-cache
+test_app/

data/.travis.yml

@@ -1,11 +1,13 @@
 language: ruby
-cache: bundler
 sudo: false
 rvm:
-  - 2.0.0
-  - 2.1.0
-  - 2.2.0
-  - 2.3.0
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
   - ruby-head
 matrix:
   allow_failures:

data/Gemfile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in jekyll-twitter-plugin.gemspec

data/README.md

@@ -2,7 +2,7 @@
 
 # jekyll-twitter-plugin
 
-A Liquid tag plugin for Jekyll blogging engine that embeds Tweets, Timelines and more from Twitter API.
+A Liquid tag plugin for the Jekyll blogging engine that embeds Tweets, Timelines and more from Twitter API.
 
 [![Build Status](https://travis-ci.org/rob-murray/jekyll-twitter-plugin.svg?branch=master)](https://travis-ci.org/rob-murray/jekyll-twitter-plugin)
 [![Gem Version](https://badge.fury.io/rb/jekyll-twitter-plugin.svg)](http://badge.fury.io/rb/jekyll-twitter-plugin)
@@ -12,9 +12,9 @@ A Liquid tag plugin for Jekyll blogging engine that embeds Tweets, Timelines and
 
 ## Description
 
-**jekyll-twitter-plugin** is a Liquid tag plugin for [Jekyll](http://jekyllrb.com/) that enables Twitter content to be used in any pages generated by Jekyll, content is fetched from the [Twitter Publish platform](https://publish.twitter.com).
+**jekyll-twitter-plugin** is a Liquid tag plugin for [Jekyll](http://jekyllrb.com/) that enables Twitter content to be used in any pages generated by Jekyll. Content is fetched from the [Twitter Publish platform](https://publish.twitter.com).
 
-The [Publish platform](https://publish.twitter.com) allows Twitter users to curate content for display outside of Twitter, you can display many different types of content with the familiar Twitter styling. We use this API and allow any customisation of the content that is accepted by the Twitter publish platform.
+The [Publish platform](https://publish.twitter.com) allows Twitter users to curate content for display outside of Twitter. You can display many different types of content with the familiar Twitter styling. We use this API and allow any customisation of the content that is accepted by the Twitter publish platform.
 
 > You can now embed any Twitter content in your Jekyll powered blog!
 
@@ -57,7 +57,7 @@ The plugin supports the following features:
 
 ## Getting Started
 
-As mentioned by [Jekyll's documentation](http://jekyllrb.com/docs/plugins/#installing-a-plugin) you have two options; manually import the source file or require the plugin as a `gem`.
+As mentioned by [Jekyll's documentation](http://jekyllrb.com/docs/plugins/#installing-a-plugin) you have two options; manually import the source file, or require the plugin as a `gem`.
 
 
 #### Require gem
@@ -71,7 +71,7 @@ gem 'jekyll-twitter-plugin'
 Add the `jekyll-twitter-plugin` to your site `_config.yml` file for Jekyll to import the plugin as a gem.
 
 ```ruby
-gems: ['jekyll-twitter-plugin']
+plugins: ['jekyll-twitter-plugin']
 ```
 
 #### Manual import
@@ -89,7 +89,7 @@ $ wget https://raw.githubusercontent.com/rob-murray/jekyll-twitter-plugin/master
 
 #### Plugin tag usage
 
-To use the plugin, in your source content use the tag `twitter` and then pass additional options to the plugin, these are passed to the API.
+To use the plugin, in your source content use the tag `twitter` and then pass additional options to the plugin. These are passed to the API.
 
 ```liquid
 {% plugin_type twitter_url *options %}
@@ -98,20 +98,40 @@ To use the plugin, in your source content use the tag `twitter` and then pass ad
 {% twitter https://twitter.com/jekyllrb maxwidth=500 limit=5 %}
 ```
 
-| Argument | Required? | Description |
-|---|---|---|
-| `plugin_type` | Yes | Either `twitter` or `twitternocache` (same as `twitter` but does not cache api responses) |
-| `twitter_url` | Yes | The Twitter URL to use, check below for supported URLs. |
-| `*options` | No | Parameters for the API separated by spaces. Refer below and to respective Twitter API documentation for available parameters. |
+| Argument      | Required? | Description                                                                                                                   |
+| ---           | ---       | ---                                                                                                                           |
+| `plugin_type` | Yes       | Either `twitter` or `twitternocache` (same as `twitter` but does not cache api responses)                                     |
+| `twitter_url` | Yes       | The Twitter URL to use, check below for supported URLs.                                                                       |
+| `*options`    | No        | Parameters for the API separated by spaces. Refer below and to respective Twitter API documentation for available parameters. |
 
+#### Custom variables
+
+In addition to passing the Twitter URL directly to the plugin, you can also use [Front Matter](https://jekyllrb.com/docs/front-matter/) to store URLs as page variables. This allows you to re-use view configuration or partials by keeping the Twitter URL(s) separate to page content.
+
+```liquid
+---
+title: My page
+tweets:
+  - https://twitter.com/dhh/status/1162426045405921282
+  - https://twitter.com/rails/status/1205565185739673600
+a_tweet: https://twitter.com/rubygems/status/518821243320287232
+---
+
+{% for tweet in page.tweets %}
+  {% twitter tweet align=right width=350 %}
+{% endfor %}
+
+{% twitter page.a_tweet %}
+```
 
 ### Supported Twitter URLs
 
-The Twitter URLs that are supported depends on Twitter, we pass the url and all parameters to the API - check [Twitter Publish platform](https://publish.twitter.com) for availability. Here is documentation for some common types:
+The Twitter URLs that are supported depend on Twitter. We pass the url and all parameters to the API - check [Twitter Publish platform](https://publish.twitter.com) for availability. Here is documentation for some common types:
 
 ##### Tweet:
 
 * [https://dev.twitter.com/web/overview](https://dev.twitter.com/web/overview)
+* [https://dev.twitter.com/rest/reference/get/statuses/oembed](https://dev.twitter.com/rest/reference/get/statuses/oembed)
 * [https://dev.twitter.com/web/embedded-tweets/parameters](https://dev.twitter.com/web/embedded-tweets/parameters)
 
 ##### Timeline:
@@ -124,9 +144,9 @@ The Twitter URLs that are supported depends on Twitter, we pass the url and all
 
 ### Customisation
 
-All pairs of options and values after the URL are passed to the API, the parameters must be in pairs with the option as the key: `option=value`.
+All pairs of options and values after the URL are passed to the API. The parameters must be in pairs with the option as the key: `option=value`.
 
-For exampled if you wanted to limit the width of the embedded content then the API supports a `maxwidth` option so you could construct the tag as below to limit it to a value of 500 (pixels).
+For example, if you want to limit the width of the embedded content then the API supports a `maxwidth` option so you could construct the tag as below to limit it to a value of 500 (pixels).
 
 ```liquid
 {% twitter https://twitter.com/jekyllrb maxwidth=500 %}
@@ -149,11 +169,11 @@ All content will be rendered inside a div with the class `jekyll-twitter-plugin`
 </div>
 ```
 
-If something goes wrong then a basic error message will be displayed;
+If something goes wrong, then a basic error message will be displayed:
 
 > Tweet could not be processed
 
-If we receive an error from the API then a message will be cached and rendered something like this below. If its a 404 then this suggests the Tweet is protected or deleted and it is not fetched again, and again. If the Tweet is restored then simply delete the cached response from `.tweet-cache` directory and build again.
+If we receive an error from the API then a message will be cached and rendered something like this below. If it's a 404, then this suggests the Tweet is protected or deleted.  I will not be fetched again and again. If the Tweet is restored, then simply delete the cached response from `.tweet-cache` directory and build again.
 
 ```html
 <div class='jekyll-twitter-plugin'>
@@ -163,7 +183,7 @@ If we receive an error from the API then a message will be cached and rendered s
 
 ### Caching
 
-Twitter API responses can be cached to speed up Jekyll site builds. The reponses will be cached in a directory within your Jekyll project called `.tweet-cache`, this should not be committed to source control.
+Twitter API responses can be cached to speed up Jekyll site builds. The reponses will be cached in a directory within your Jekyll project called `.tweet-cache`. This should not be committed to source control.
 
 Caching is enabled by using the `twitter` tag.
 

data/Rakefile

@@ -1,2 +1,3 @@
 # frozen_string_literal: true
+
 require "bundler/gem_tasks"

data/jekyll-twitter-plugin.gemspec

@@ -1,11 +1,11 @@
-# coding: utf-8
 # frozen_string_literal: true
-lib = File.expand_path("../lib", __FILE__)
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-twitter-plugin"
-  spec.version       = "2.0.0"
+  spec.version       = "2.1.0"
   spec.authors       = ["Rob Murray"]
   spec.email         = ["robmurray17@gmail.com"]
   spec.summary       = "A Liquid tag plugin for Jekyll blogging engine that embeds Tweets, Timelines and more from Twitter API."
@@ -17,9 +17,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "byebug" if RUBY_VERSION >= "2.0"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubocop"
   spec.add_development_dependency "webmock"
-  spec.add_development_dependency "byebug" if RUBY_VERSION >= "2.0"
 end

data/lib/jekyll-twitter-plugin.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "fileutils"
 require "net/http"
 require "uri"
@@ -11,12 +12,14 @@ require "digest"
 # https://github.com/rob-murray/jekyll-twitter-plugin
 #
 module TwitterJekyll
+  VERSION = "2.0.0".freeze
+  REFER_TO_README   = "Please see 'https://github.com/rob-murray/jekyll-twitter-plugin' for usage.".freeze
+  LIBRARY_VERSION   = "jekyll-twitter-plugin-v#{VERSION}".freeze
+  REQUEST_HEADERS   = { "User-Agent" => LIBRARY_VERSION }.freeze
+
   # TODO: remove after deprecation cycle
   CONTEXT_API_KEYS  = %w(consumer_key consumer_secret access_token access_token_secret).freeze
   ENV_API_KEYS      = %w(TWITTER_CONSUMER_KEY TWITTER_CONSUMER_SECRET TWITTER_ACCESS_TOKEN TWITTER_ACCESS_TOKEN_SECRET).freeze
-  REFER_TO_README   = "Please see 'https://github.com/rob-murray/jekyll-twitter-plugin' for usage.".freeze
-  LIBRARY_VERSION   = "jekyll-twitter-plugin-v2.0.0".freeze
-  REQUEST_HEADERS   = { "User-Agent" => LIBRARY_VERSION }.freeze
 
   # Cache class that writes to filesystem
   # TODO: Do i really need to cache?
@@ -28,23 +31,22 @@ module TwitterJekyll
     end
 
     def read(key)
-      file_to_read = cache_file(cache_filename(key))
+      file_to_read = cache_file(key)
       JSON.parse(File.read(file_to_read)) if File.exist?(file_to_read)
     end
 
     def write(key, data)
-      file_to_write = cache_file(cache_filename(key))
-      data_to_write = JSON.generate data.to_h
+      file_to_write = cache_file(key)
 
       File.open(file_to_write, "w") do |f|
-        f.write(data_to_write)
+        f.write(JSON.generate(data.to_h))
       end
     end
 
     private
 
-    def cache_file(filename)
-      File.join(@cache_folder, filename)
+    def cache_file(key)
+      File.join(@cache_folder, cache_filename(key))
     end
 
     def cache_filename(cache_key)
@@ -75,7 +77,6 @@ module TwitterJekyll
       end
 
       handle_response(api_request, response)
-
     rescue Timeout::Error => e
       ErrorResponse.new(api_request, e.class.name).to_h
     end
@@ -142,11 +143,22 @@ module TwitterJekyll
     ERROR_BODY_TEXT = "<p>Tweet could not be processed</p>".freeze
     OEMBED_ARG      = "oembed".freeze
 
+    URL_OR_STRING_PARAM = /^("|')?(http|https):\/\//i
+
     attr_writer :cache # for testing
 
     def initialize(_name, params, _tokens)
       super
-      @api_request = parse_params(params)
+
+      # Test if first arg is a URL or starts with oembed,
+      # otherwise its a Jekyll variable. TODO: remove oembed after deprecation cycle
+      if params =~ URL_OR_STRING_PARAM || params.to_s.start_with?(OEMBED_ARG)
+        @fetch_from_context = false
+        @api_request = parse_params_from_string(params)
+      else
+        @fetch_from_context = true
+        @variable_params = normalize_string_params(params)
+      end
     end
 
     # Class that implements caching strategy
@@ -158,6 +170,12 @@ module TwitterJekyll
     # Return html string for Jekyll engine
     # @api public
     def render(context)
+      if fetch_from_context?
+        variable_name, *params = @variable_params
+        tweet_url = context[variable_name]
+        @api_request = parse_params_from_array [tweet_url, *params]
+      end
+
       api_secrets_deprecation_warning(context) # TODO: remove after deprecation cycle
       response = cached_response || live_response
       html_output_for(response)
@@ -165,6 +183,10 @@ module TwitterJekyll
 
     private
 
+    def fetch_from_context?
+      @fetch_from_context
+    end
+
     def cache
       @cache ||= self.class.cache_klass.new("./.tweet-cache")
     end
@@ -197,11 +219,19 @@ module TwitterJekyll
       build_response(response) unless response.nil?
     end
 
+    def parse_params_from_string(str)
+      args = normalize_string_params(str)
+      parse_params(args)
+    end
+
+    def parse_params_from_array(arr)
+      parse_params(arr)
+    end
+
     # Return an `ApiRequest` with the url and arguments
     # @api private
-    def parse_params(params)
-      args = params.split(/\s+/).map(&:strip)
-      invalid_args!(args) unless args.any?
+    def parse_params(args)
+      invalid_args!(args) unless args.compact.any?
 
       if args[0].to_s == OEMBED_ARG # TODO: remove after deprecation cycle
         arguments_deprecation_warning(args)
@@ -209,25 +239,31 @@ module TwitterJekyll
       end
 
       url, *api_args = args
-      ApiRequest.new(url, parse_args(api_args))
+      ApiRequest.new(url, hash_from_args(api_args))
+    end
+
+    # Take input arguments, remove quotes & return array of argument values
+    # @api private
+    def normalize_string_params(str)
+      str.to_s.gsub(/"|'/, "").split(/\s+/).map(&:strip)
     end
 
     # Transform 'a=b x=y' tag arguments into { "a" => "b", "x" => "y" }
     # @api private
-    def parse_args(args)
-      args.each_with_object({}) do |arg, params|
+    def hash_from_args(args)
+      args.each_with_object({}) do |arg, results|
         k, v = arg.split("=").map(&:strip)
         if k && v
           v = Regexp.last_match[1] if v =~ /^'(.*)'$/
-          params[k] = v
+          results[k] = v
         end
       end
     end
 
     # Format a response hash
     # @api private
-    def build_response(h)
-      OpenStruct.new(h)
+    def build_response(response_hash)
+      OpenStruct.new(response_hash)
     end
 
     # TODO: remove after deprecation cycle

data/spec/api_request_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 RSpec.describe TwitterJekyll::ApiRequest do
   subject(:api_request) { described_class.new(url, params) }
   let(:url) { "https://twitter.com/twitter_user/status/12345" }
@@ -23,7 +24,7 @@ RSpec.describe TwitterJekyll::ApiRequest do
       let(:params) { { align: "right" } }
 
       it "has encoded query params" do
-        expect(URI.decode_www_form(uri.query)).to match_array [["url", url], %w(align right)]
+        expect(URI.decode_www_form(uri.query)).to match_array [["url", url], %w[align right]]
       end
     end
 

data/spec/integration_tests.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 # Basic integration example - run code to produce html output
 #
-# * Requires .env populated with valid Twitter API creds.
-#
 $LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
 require_relative "./support/jekyll_template"
 require "jekyll-twitter-plugin"
@@ -47,16 +45,15 @@ class TwitterRenderer
   def render
     ERB.new(template)
        .result(binding)
-       .gsub!("src=\"//", "src=\"https://")
   end
 
   private
 
   attr_reader :options, :jekyll_context
 
-  def render_twitter_tag(params)
-    say_with_colour "Fetching with params: #{params}", :yellow
-    TwitterJekyll::TwitterTag.new(nil, params, nil).render(jekyll_context)
+  def render_twitter_tag(option)
+    say_with_colour "Fetching with option: #{option}", :yellow
+    TwitterJekyll::TwitterTag.new(nil, option, nil).render(jekyll_context)
   end
 
   def template
@@ -76,9 +73,9 @@ class TwitterRenderer
 end
 
 def main
-  rederer = TwitterRenderer.new(OPTIONS)
+  renderer = TwitterRenderer.new(OPTIONS)
   File.open(OUTPUT_FILENAME, "w") do |f|
-    f.write rederer.render
+    f.write renderer.render
   end
 end
 

data/spec/spec_helper.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
-$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
 require "webmock/rspec"
 require "support/jekyll_template"
-require "support/shared_contexts"
 require "jekyll-twitter-plugin"
 require "byebug" if RUBY_VERSION >= "2.0"
 

data/spec/support/jekyll_template.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Hack ...or stub Liquid classes and methods used in plugin
 module Liquid
   class Tag

data/spec/twitter_tag_spec.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
+
 RSpec.describe TwitterJekyll::TwitterTag do
-  let(:context) { empty_jekyll_context }
-  let(:arguments) { "" }
   let(:api_response_hash) do
     {
       "url" => "https://twitter.com/twitter_user/status/12345",
@@ -17,17 +16,77 @@ RSpec.describe TwitterJekyll::TwitterTag do
       "version" => "1.0"
     }
   end
-  subject { described_class.new(nil, arguments, nil) }
 
-  describe "output from oembed request" do
+  shared_context "without cached response" do
+    let(:cache) { null_cache }
+
+    before do
+      subject.cache = cache
+    end
+
+    def null_cache
+      double("TwitterJekyll::NullCache", read: nil, write: nil)
+    end
+  end
+
+  shared_context "called with deprecated oembed argument url" do
+    # {% twitter oembed https://twitter.com/twitter_user/status/12345 option=value %}
+    let(:arguments) { "oembed https://twitter.com/twitter_user/status/12345" }
+    let(:context) { empty_jekyll_context }
+
+    subject { described_class.new(nil, arguments, nil) }
+  end
+
+  shared_context "called with url" do
+    # {% twitter https://twitter.com/twitter_user/status/12345 option=value %}
     let(:arguments) { "https://twitter.com/twitter_user/status/12345" }
+    let(:context) { empty_jekyll_context }
 
+    subject { described_class.new(nil, arguments, nil) }
+  end
+
+  shared_context "called with a page var" do
+    # {% twitter page.tweet option=value %}
+    let(:arguments) { "page.tweet" }
+    let(:context) { jekyll_context_with(arguments, params) }
+    let(:params) { "https://twitter.com/twitter_user/status/12345" }
+
+    subject { described_class.new(nil, arguments, nil) }
+  end
+
+  shared_context "called in a loop with a local var" do
+    # This is the same as above but ensures that same instance can render different contexts
+    # {% for tweet in page.tweets %}
+    #   {% twitter tweet option=value %}
+    # {% endfor %}
+    let(:arguments) { "tweet" }
+    let(:context) { jekyll_context_with(arguments, params) }
+    let(:params) { "https://twitter.com/twitter_user/status/12345" }
+
+    subject { described_class.new(nil, arguments, nil) }
+  end
+
+  shared_examples "it does not allow empty arguments" do
+    context "without any arguments" do
+      let(:arguments) { "" }
+
+      it "raises an exception" do
+        expect_to_raise_invalid_args_error(arguments) do
+          subject.render(context)
+        end
+      end
+    end
+  end
+
+  shared_examples "it uses a cached response" do
     context "with cached response" do
       let(:cache) { double("TwitterJekyll::FileCache") }
       before do
         subject.cache = cache
       end
 
+      let(:arguments) { "https://twitter.com/twitter_user/status/12345" }
+
       it "renders response from cache" do
         expect(cache).to receive(:read).with(an_instance_of(String)).and_return(api_response_hash)
 
@@ -35,128 +94,298 @@ RSpec.describe TwitterJekyll::TwitterTag do
         expect_output_to_match_tag_content(output, api_response_hash.fetch("html"))
       end
     end
+  end
 
-    context "without cached response" do
-      let(:cache) { double("TwitterJekyll::FileCache") }
+  shared_examples "it handles api responses" do
+    context "with successful api request" do
       before do
-        subject.cache = cache
-        allow(cache).to receive(:read).with(an_instance_of(String)).and_return(nil)
+        stub_api_request(status: 200, body: api_response_hash.to_json, headers: {})
       end
 
-      context "with successful api request" do
-        before do
-          stub_api_request(status: 200, body: api_response_hash.to_json, headers: {})
-        end
+      it "renders response from api and writes to cache" do
+        expect(cache).to receive(:write).with(an_instance_of(String), api_response_hash)
 
-        it "renders response from api and writes to cache" do
-          expect(cache).to receive(:write).with(an_instance_of(String), api_response_hash)
+        output = subject.render(context)
+        expect_output_to_match_tag_content(output, api_response_hash.fetch("html"))
+      end
+    end
 
-          output = subject.render(context)
-          expect_output_to_match_tag_content(output, api_response_hash.fetch("html"))
-        end
+    context "with a status not found api request" do
+      before do
+        stub_api_request(status: [404, "Not Found"], body: "", headers: {})
       end
 
-      context "with a status not found api request" do
-        before do
-          stub_api_request(status: [404, "Not Found"], body: "", headers: {})
-        end
+      it "renders error response and writes to cache" do
+        expect(cache).to receive(:write).with(an_instance_of(String), an_instance_of(Hash))
 
-        it "renders error response and writes to cache" do
-          expect(cache).to receive(:write).with(an_instance_of(String), an_instance_of(Hash))
+        output = subject.render(context)
+        expect_output_to_have_error(output, "Not Found")
+      end
+    end
 
-          output = subject.render(context)
-          expect_output_to_have_error(output, "Not Found")
-        end
+    context "with a status request not permitted api request" do
+      before do
+        stub_api_request(status: [403, "Forbidden"], body: "", headers: {})
       end
 
-      context "with a status request not permitted api request" do
-        before do
-          stub_api_request(status: [403, "Forbidden"], body: "", headers: {})
-        end
+      it "renders error response and writes to cache" do
+        expect(cache).to receive(:write).with(an_instance_of(String), an_instance_of(Hash))
 
-        it "renders error response and writes to cache" do
-          expect(cache).to receive(:write).with(an_instance_of(String), an_instance_of(Hash))
+        output = subject.render(context)
+        expect_output_to_have_error(output, "Forbidden")
+      end
+    end
 
-          output = subject.render(context)
-          expect_output_to_have_error(output, "Forbidden")
-        end
+    context "with a server error api request" do
+      before do
+        stub_api_request(status: [500, "Internal Server Error"], body: "", headers: {})
       end
 
-      context "with a server error api request" do
-        before do
-          stub_api_request(status: [500, "Internal Server Error"], body: "", headers: {})
-        end
+      it "renders error response and writes to cache" do
+        expect(cache).to receive(:write).with(an_instance_of(String), an_instance_of(Hash))
 
-        it "renders error response and writes to cache" do
-          expect(cache).to receive(:write).with(an_instance_of(String), an_instance_of(Hash))
+        output = subject.render(context)
+        expect_output_to_have_error(output, "Internal Server Error")
+      end
+    end
 
-          output = subject.render(context)
-          expect_output_to_have_error(output, "Internal Server Error")
-        end
+    context "with api request that times out" do
+      before do
+        stub_api.to_timeout
       end
 
-      context "with api request that times out" do
-        before do
-          stub_api.to_timeout
-        end
+      it "renders error response and writes to cache" do
+        expect(cache).to receive(:write).with(an_instance_of(String), an_instance_of(Hash))
 
-        it "renders error response and writes to cache" do
-          expect(cache).to receive(:write).with(an_instance_of(String), an_instance_of(Hash))
+        output = subject.render(context)
+        expect_output_to_have_error(output, "Net::OpenTimeout")
+      end
+    end
+  end
 
-          output = subject.render(context)
-          expect_output_to_have_error(output, "Timeout::Error")
-        end
+  describe "output from oembed request" do
+    include_context "called with deprecated oembed argument url"
+
+    it_behaves_like "it does not allow empty arguments"
+    it_behaves_like "it uses a cached response"
+
+    context "without cached response" do
+      include_context "without cached response"
+
+      it "uses correct twitter url and warns of deprecation" do
+        api_client = api_client_double
+        allow(api_client).to receive(:fetch).and_return({})
+        allow(TwitterJekyll::ApiClient).to receive(:new).and_return(api_client)
+        allow(TwitterJekyll::ApiRequest).to receive(:new).with("https://twitter.com/twitter_user/status/12345", {}).and_call_original
+        allow(cache).to receive(:write)
+
+        expect do
+          subject = described_class.new(nil, arguments, nil)
+          subject.render(context)
+        end.to output(/Passing 'oembed' as the first argument is not required anymore/).to_stderr
+
+        expect(TwitterJekyll::ApiRequest).to have_received(:new).with("https://twitter.com/twitter_user/status/12345", {})
       end
 
-      context "with the oembed api type as the first argument" do
-        let(:arguments) { "oembed https://twitter.com/twitter_user/status/12345" }
-        before do
-          stub_api_request(status: 200, body: api_response_hash.to_json, headers: {})
+      context "with options" do
+        let(:arguments) { "oembed https://twitter.com/twitter_user/status/12345 align=right width=350" }
+
+        it "passes options to api" do
+          api_client = api_client_double
+          allow(api_client).to receive(:fetch).and_return({})
+          allow(TwitterJekyll::ApiClient).to receive(:new).and_return(api_client)
+          allow(TwitterJekyll::ApiRequest).to receive(:new).with("https://twitter.com/twitter_user/status/12345", "align" => "right", "width" => "350").and_call_original
+          allow(cache).to receive(:write)
+
+          subject = described_class.new(nil, arguments, nil)
+          subject.cache = cache
+          subject.render(context)
+
+          expect(TwitterJekyll::ApiRequest).to have_received(:new)
+            .with("https://twitter.com/twitter_user/status/12345", "align" => "right", "width" => "350")
         end
+      end
+
+      it_behaves_like "it handles api responses"
+    end
+  end
+
+  describe "output from url request" do
+    include_context "called with url"
+
+    it_behaves_like "it does not allow empty arguments"
+    it_behaves_like "it uses a cached response"
+
+    context "without cached response" do
+      include_context "without cached response"
+
+      it "uses correct twitter url" do
+        api_client = api_client_double
+        allow(api_client).to receive(:fetch).and_return({})
+        allow(TwitterJekyll::ApiClient).to receive(:new).and_return(api_client)
+        allow(TwitterJekyll::ApiRequest).to receive(:new).with("https://twitter.com/twitter_user/status/12345", {}).and_call_original
+        allow(cache).to receive(:write)
+
+        subject = described_class.new(nil, arguments, nil)
+        subject.render(context)
+
+        expect(TwitterJekyll::ApiRequest).to have_received(:new).with("https://twitter.com/twitter_user/status/12345", {})
+      end
+
+      context "with options" do
+        let(:arguments) { "https://twitter.com/twitter_user/status/12345 align=right width=350" }
+
+        it "passes options to api" do
+          api_client = api_client_double
+          allow(api_client).to receive(:fetch).and_return({})
+          allow(TwitterJekyll::ApiClient).to receive(:new).and_return(api_client)
+          allow(TwitterJekyll::ApiRequest).to receive(:new).with("https://twitter.com/twitter_user/status/12345", "align" => "right", "width" => "350").and_call_original
+          allow(cache).to receive(:write)
 
-        it "renders response from api and writes to cache" do
-          expect(cache).to receive(:write).with(an_instance_of(String), api_response_hash)
+          subject = described_class.new(nil, arguments, nil)
+          subject.render(context)
 
-          output = subject.render(context)
-          expect_output_to_match_tag_content(output, api_response_hash.fetch("html"))
+          expect(TwitterJekyll::ApiRequest).to have_received(:new)
+            .with("https://twitter.com/twitter_user/status/12345", "align" => "right", "width" => "350")
         end
       end
+
+      it_behaves_like "it handles api responses"
     end
   end
 
-  describe "parsing arguments" do
-    context "without any arguments" do
-      let(:arguments) { "" }
+  describe "output from usage with front matter var" do
+    include_context "called with a page var"
 
-      it "raises an exception" do
-        expect_to_raise_invalid_args_error(arguments) do
-          tag = described_class.new(nil, arguments, nil)
-          tag.render(context)
+    it_behaves_like "it does not allow empty arguments" do
+      let(:arguments) { "page.tweet" }
+      let(:context) { empty_jekyll_context }
+      let(:params) { "" }
+    end
+
+    it_behaves_like "it uses a cached response"
+
+    context "without cached response" do
+      include_context "without cached response"
+
+      it "uses correct twitter url" do
+        api_client = api_client_double
+        allow(api_client).to receive(:fetch).and_return({})
+        allow(TwitterJekyll::ApiClient).to receive(:new).and_return(api_client)
+        allow(TwitterJekyll::ApiRequest).to receive(:new).with("https://twitter.com/twitter_user/status/12345", {}).and_call_original
+        allow(cache).to receive(:write)
+
+        subject = described_class.new(nil, arguments, nil)
+        subject.render(context)
+
+        expect(TwitterJekyll::ApiRequest).to have_received(:new).with("https://twitter.com/twitter_user/status/12345", {})
+      end
+
+      context "with options" do
+        let(:arguments) { "page.tweet align=left width=400" }
+        let(:context) { jekyll_context_with("page.tweet", params) }
+        let(:params) { "https://twitter.com/twitter_user/status/12345" }
+
+        it "passes options to api" do
+          api_client = api_client_double
+          allow(api_client).to receive(:fetch).and_return({})
+          allow(TwitterJekyll::ApiClient).to receive(:new).and_return(api_client)
+          allow(TwitterJekyll::ApiRequest).to receive(:new).with("https://twitter.com/twitter_user/status/12345", "align" => "left", "width" => "400").and_call_original
+          allow(cache).to receive(:write)
+
+          subject = described_class.new(nil, arguments, nil)
+          subject.render(context)
+
+          expect(TwitterJekyll::ApiRequest).to have_received(:new)
+            .with("https://twitter.com/twitter_user/status/12345", "align" => "left", "width" => "400")
         end
       end
+
+      it_behaves_like "it handles api responses"
     end
+  end
 
-    context "with the oembed api type as the first argument" do
-      let(:arguments) { "oembed https://twitter.com/twitter_user/status/12345" }
+  describe "output from usage in a loop with a local var" do
+    include_context "called in a loop with a local var"
 
-      it "uses correct twitter url and warns of deprecation" do
+    it_behaves_like "it does not allow empty arguments" do
+      let(:arguments) { "tweet" }
+      let(:context) { empty_jekyll_context }
+      let(:params) { "" }
+    end
+
+    it_behaves_like "it uses a cached response"
+
+    context "without cached response" do
+      include_context "without cached response"
+
+      it "uses correct twitter url" do
         api_client = api_client_double
         allow(api_client).to receive(:fetch).and_return({})
         allow(TwitterJekyll::ApiClient).to receive(:new).and_return(api_client)
-        expect(TwitterJekyll::ApiRequest).to receive(:new).with("https://twitter.com/twitter_user/status/12345", {}).and_call_original
+        allow(TwitterJekyll::ApiRequest).to receive(:new).with("https://twitter.com/twitter_user/status/12345", {}).and_call_original
+        allow(cache).to receive(:write)
 
-        expect do
-          tag = described_class.new(nil, arguments, nil)
-          tag.render(context)
-        end.to output(/Passing 'oembed' as the first argument is not required anymore/).to_stderr
+        subject = described_class.new(nil, arguments, nil)
+        subject.render(context)
+
+        expect(TwitterJekyll::ApiRequest).to have_received(:new).with("https://twitter.com/twitter_user/status/12345", {})
+      end
+
+      it "handles many contexts passed to same instance" do
+        api_client = api_client_double
+        allow(api_client).to receive(:fetch).and_return({})
+        allow(TwitterJekyll::ApiClient).to receive(:new).and_return(api_client)
+        allow(TwitterJekyll::ApiRequest).to receive(:new).with("https://twitter.com/twitter_user/status/first_url", {}).and_call_original
+        allow(TwitterJekyll::ApiRequest).to receive(:new).with("https://twitter.com/twitter_user/status/second_url", {}).and_call_original
+        allow(cache).to receive(:write)
+
+        context = double("context", registers: { site: double(config: {}) }).tap do |c|
+          allow(c).to receive(:[]).with(arguments).and_return(
+            "https://twitter.com/twitter_user/status/first_url",
+            "https://twitter.com/twitter_user/status/second_url"
+          )
+        end
+
+        subject = described_class.new(nil, arguments, nil)
+        subject.render(context)
+        subject.render(context)
+
+        expect(TwitterJekyll::ApiRequest).to have_received(:new).with("https://twitter.com/twitter_user/status/first_url", {})
+        expect(TwitterJekyll::ApiRequest).to have_received(:new).with("https://twitter.com/twitter_user/status/second_url", {})
+      end
+
+      context "with options" do
+        let(:arguments) { "tweet align=middle width=500" }
+        let(:context) { jekyll_context_with("tweet", params) }
+        let(:params) { "https://twitter.com/twitter_user/status/12345" }
+
+        it "passes options to api" do
+          api_client = api_client_double
+          allow(api_client).to receive(:fetch).and_return({})
+          allow(TwitterJekyll::ApiClient).to receive(:new).and_return(api_client)
+          allow(TwitterJekyll::ApiRequest).to receive(:new).with("https://twitter.com/twitter_user/status/12345", "align" => "middle", "width" => "500").and_call_original
+          allow(cache).to receive(:write)
+
+          subject = described_class.new(nil, arguments, nil)
+          subject.render(context)
+
+          expect(TwitterJekyll::ApiRequest).to have_received(:new)
+            .with("https://twitter.com/twitter_user/status/12345", "align" => "middle", "width" => "500")
+        end
       end
+
+      it_behaves_like "it handles api responses"
     end
   end
 
   describe "parsing api secrets" do
+    include_context "called with url"
     include_context "without cached response"
-    include_context "with a normal request and response"
-    let(:api_client) { api_client_double }
+
+    before do
+      stub_api_request(status: 200, body: api_response_hash.to_json, headers: {})
+    end
 
     context "with api secrets provided by ENV" do
       let(:context) { double("context", registers: { site: double(config: {}) }) }
@@ -177,7 +406,7 @@ RSpec.describe TwitterJekyll::TwitterTag do
 
     context "with api secrets provided by Jekyll config" do
       let(:context) do
-        api_secrets = %w(consumer_key consumer_secret access_token access_token_secret)
+        api_secrets = %w[consumer_key consumer_secret access_token access_token_secret]
                       .each_with_object({}) { |secret, h| h[secret] = secret }
         double("context", registers:
           { site: double(config: { "twitter" => api_secrets }) })
@@ -220,7 +449,13 @@ RSpec.describe TwitterJekyll::TwitterTag do
   end
 
   def empty_jekyll_context
-    double("context", registers: { site: double(config: {}) })
+    double("context", registers: { site: double(config: {}) }, :[] => nil)
+  end
+
+  def jekyll_context_with(var, params)
+    double("context", registers: { site: double(config: {}) }).tap do |c|
+      allow(c).to receive(:[]).with(var).and_return(params)
+    end
   end
 
   def api_client_double
@@ -237,10 +472,10 @@ RSpec.describe TwitterJekyll::TwitterTag do
     expect_output_to_match_tag_content(actual, "<p>There was a '#{error}' error fetching URL: '#{tweet_url}'</p>")
   end
 
-  def expect_to_raise_invalid_args_error(options)
+  def expect_to_raise_invalid_args_error(arguments)
     raise unless block_given?
 
-    message = "Invalid arguments '#{options}' passed to 'jekyll-twitter-plugin'. Please see 'https://github.com/rob-murray/jekyll-twitter-plugin' for usage."
+    message = "Invalid arguments '#{arguments}' passed to 'jekyll-twitter-plugin'. Please see 'https://github.com/rob-murray/jekyll-twitter-plugin' for usage."
     expect do
       yield
     end.to raise_error(ArgumentError, message)

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-twitter-plugin
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Rob Murray
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-23 00:00:00.000000000 Z
+date: 2019-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: 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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -105,7 +119,6 @@ files:
 - spec/integration_tests.rb
 - spec/spec_helper.rb
 - spec/support/jekyll_template.rb
-- spec/support/shared_contexts.rb
 - spec/twitter_tag_spec.rb
 homepage: https://github.com/rob-murray/jekyll-twitter-plugin
 licenses:
@@ -126,8 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A Liquid tag plugin for Jekyll blogging engine that embeds Tweets, Timelines
@@ -137,5 +149,4 @@ test_files:
 - spec/integration_tests.rb
 - spec/spec_helper.rb
 - spec/support/jekyll_template.rb
-- spec/support/shared_contexts.rb
 - spec/twitter_tag_spec.rb

data/spec/support/shared_contexts.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-RSpec.shared_context "without cached response" do
-  let(:cache) { null_cache }
-
-  before do
-    subject.cache = cache
-  end
-
-  def null_cache
-    double("TwitterJekyll::NullCache", read: nil, write: nil)
-  end
-end
-
-RSpec.shared_context "with a normal request and response" do
-  let(:arguments) { "https://twitter.com/twitter_user/status/12345" }
-  let(:response) { { html: "<p>tweet html</p>" } }
-
-  before do
-    allow(api_client).to receive(:fetch).and_return(response)
-    allow(TwitterJekyll::ApiClient).to receive(:new).and_return(api_client)
-  end
-end