jekyll-twitter-plugin 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da29e624fad543de4ea74ed5a5d44dd868ae9468
-  data.tar.gz: 6d01a8bdf2f03668f4848835cbda7e5f0edca03a
+  metadata.gz: d5cd33cbcbe9db1fff312ba25adb0dafa82b34d4
+  data.tar.gz: 6a1be3c2d7cab837a8b9a6a78575189f6ec2b423
 SHA512:
-  metadata.gz: 4e5545d32edf1ea675d569baff3907801619f8df5f9348a9f82a7c12097594ab94226cd70954a1eeda6da8c17ff1790cb05b15db8a8f81bad836b3c3968738b8
-  data.tar.gz: 56e1fede9de06facbe5cd41340448a5a316376979903afc1c75fa65a7aed2e94eb119732eb5c3413b54ecc6672c41ee52f29e1f014eda3725fad3bd5ef21de95
+  metadata.gz: ca3b17df94b100230807ae6efcf4c3d0983d63c68d3c629bb2cc2e2edac3452acfa9134ad92695f121ce1b3843fe5767cbbf20699dc589e7c687bba9ace263b6
+  data.tar.gz: ee194ec61bc5519e307789e095aa41618e213f4151792b2eff6d98c3d3fba9cc0fb11a275dbc136742dfb06b1f2a01b962b151629fea49d65c9983a08a4dff8b

data/README.md

@@ -9,7 +9,7 @@ A Liquid tag plugin for Jekyll that renders Tweets from Twitter API.
 
 A Liquid tag plugin for [Jekyll](http://jekyllrb.com/) that enables Twitter content to be used in any content served by Jekyll, content is fetched from the [Twitter API](https://dev.twitter.com/home).
 
-It is based on the original Jekyll Tweet Tag from [scottwb](https://github.com/scottwb/jekyll-tweet-tag) which has not been updated since Twitter updated their API to require Oauth. This version uses the excellent [Twitter gem](https://github.com/sferik/twitter) to make requests and handle authentication.
+It is based on the original Jekyll Tweet Tag from [scottwb](https://github.com/scottwb/jekyll-tweet-tag) which has not been updated since Twitter updated their API to require certain preconditions. This version uses the excellent [Twitter gem](https://github.com/sferik/twitter) to make requests and handle authentication.
 
 This plugin replaces the broken plugin mentioned above and uses a different tag name and API - this is by design so that the two plugins can be used, if the original gets fixed.
 
@@ -60,10 +60,10 @@ $ wget https://raw.githubusercontent.com/rob-murray/jekyll-twitter-plugin/master
 
 Your Twitter application authentication credentials are private - do not distribute these! As such this plugin requires your credentials as Environment variables, it requires the following keys to be set;
 
-* **TWITTER_CONSUMER_KEY**
-* **TWITTER_CONSUMER_SECRET**
-* **TWITTER_ACCESS_TOKEN**
-* **TWITTER_ACCESS_TOKEN_SECRET**
+* TWITTER_CONSUMER_KEY
+* TWITTER_CONSUMER_SECRET
+* TWITTER_ACCESS_TOKEN
+* TWITTER_ACCESS_TOKEN_SECRET
 
 ```bash
 $ export TWITTER_CONSUMER_KEY=foo etc.
@@ -73,13 +73,13 @@ $ export TWITTER_CONSUMER_KEY=foo etc.
 
 To use the plugin, in your source content use the tag `twitter` and then pass additional parameters to the plugin.
 
-```ruby
-{% plugin_type api_type params %}
+```liquid
+{% plugin_type api_type *params %}
 ```
 
 * `plugin_type` - Either `twitter` or `twitternocache`.
 * `api_type` - The Twitter API to use, check below for supported APIs.
-* `params` - Parameters for the API separated by spaces.
+* `*params` - Parameters for the API separated by spaces. Refer below and to respective Twitter API documentation for available parameters.
 
 ### Supported Twitter APIs
 
@@ -89,10 +89,13 @@ The following Twitter APIs are supported.
 
 The [oembed](https://dev.twitter.com/rest/reference/get/statuses/oembed) API returns html snippet to embed in your app, this will be rendered in the familiar Twitter style.
 
-```ruby
-{% twitter oembed status_url %}
+```liquid
+{% twitter oembed status_url *options %}
+
 # Example
 {% twitter oembed https://twitter.com/rubygems/status/518821243320287232 %}
+# With options
+{% twitter oembed https://twitter.com/rubygems/status/518821243320287232 align='right' width='350' %}
 ```
 
 ### Output

data/jekyll-twitter-plugin.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'jekyll-twitter-plugin'
-  spec.version       = '1.0.1'
+  spec.version       = '1.1.0'
   spec.authors       = ['Rob Murray']
   spec.email         = ['robmurray17@gmail.com']
   spec.summary       = 'A Liquid tag plugin for Jekyll that renders Tweets from Twitter API'

data/lib/jekyll-twitter-plugin.rb

@@ -37,8 +37,6 @@ module TwitterJekyll
   end
 
   class NullCache
-    def initialize; end
-
     def read(_key); end
 
     def write(_key, _data); end
@@ -52,7 +50,15 @@ module TwitterJekyll
     def key; end
   end
 
-  module TwitterApiMixin
+  class TwitterApi
+    def initialize(client, params)
+      @client = client
+      @status_url = params.shift
+      parse_args(params)
+    end
+
+    private
+
     def id_from_status_url(url)
       if url.to_s =~ /([^\/]+$)/
         Regexp.last_match[1]
@@ -66,25 +72,37 @@ module TwitterJekyll
     rescue Twitter::Error::NotFound
       nil
     end
+
+    def parse_args(args)
+      @params ||= begin
+        params = {}
+        args.each do |arg|
+          k, v = arg.split('=').map(&:strip)
+          if k && v
+            if v =~ /^'(.*)'$/
+              v = Regexp.last_match[1]
+            end
+            params[k] = v
+          end
+        end
+        params
+      end
+    end
   end
 
-  class Oembed
-    include TwitterJekyll::TwitterApiMixin
+  class Oembed < TwitterApi
     include TwitterJekyll::Cacheable
 
-    def initialize(client, params)
-      @client = client
-      @status_url = params
-    end
-
     def fetch
       tweet_id = id_from_status_url(@status_url)
 
       if tweet = find_tweet(tweet_id)
-        @client.oembed tweet
+        @client.oembed tweet, @params
       end
     end
 
+    private
+
     def key
       @status_url
     end
@@ -108,19 +126,19 @@ module TwitterJekyll
     end
 
     def render(_context)
-      api_type = @params.first
-      tweet_params  = @params.last
+      api_type = @params.dup.shift
 
-      api_client = create_api_client(api_type, tweet_params)
-      html_output_for(api_client)
+      api_client = create_api_client(api_type, @params)
+      response = cached_response(api_client) || live_response(api_client)
+      html_output_for(response)
     end
 
     private
 
-    def html_output_for(api_client)
+    def html_output_for(response)
       body = ERROR_BODY_TEXT
 
-      if response = cached_response(api_client) || live_response(api_client)
+      if response
         body = response.html || body
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-twitter-plugin
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Rob Murray
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-05 00:00:00.000000000 Z
+date: 2014-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler