jekyll-twitter-plugin 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 80e8d5cf8433bd544dd046d6305444676e9d07b5
-  data.tar.gz: 93421fcb83701f3960321ff34434116a5e381912
+  metadata.gz: da29e624fad543de4ea74ed5a5d44dd868ae9468
+  data.tar.gz: 6d01a8bdf2f03668f4848835cbda7e5f0edca03a
 SHA512:
-  metadata.gz: bf621b7035e5ad7da48b95130a9a0a61652c72dc216720b5251ae5df9ca605a8552125d162270728e5968ac790b2f3fca804be30b8b0324801967bb1b729be31
-  data.tar.gz: 46427dceea766f3bc1ccf28c5bae0e3e4507fac56c0b687c860986dbf3602d12f262dc55d792d4289b2b7c9daa6c687c07206f3d607eba0c93d3be7508fada69
+  metadata.gz: 4e5545d32edf1ea675d569baff3907801619f8df5f9348a9f82a7c12097594ab94226cd70954a1eeda6da8c17ff1790cb05b15db8a8f81bad836b3c3968738b8
+  data.tar.gz: 56e1fede9de06facbe5cd41340448a5a316376979903afc1c75fa65a7aed2e94eb119732eb5c3413b54ecc6672c41ee52f29e1f014eda3725fad3bd5ef21de95

data/README.md

@@ -4,26 +4,28 @@ A Liquid tag plugin for Jekyll that renders Tweets from Twitter API.
 
 [![Gem Version](https://badge.fury.io/rb/jekyll-twitter-plugin.svg)](http://badge.fury.io/rb/jekyll-twitter-plugin)
 
+
 ### Description
 
-A Liquid tag plugin for [Jekyll](http://jekyllrb.com/) 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. 
+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.
 
-This plugin replaces the broken plugin mentioned above and uses a different tag and API just in case the original gets fixed and to be more flexible.
+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.
 
 
 ### Features
 
-The plugin supports the following features from the Twitter API:
+The plugin supports the following features:
 
-* Oembed - Embed a Tweet in familiar Twitter styling.
-* Caching - API requests can be cached to avoid hitting request limits.
+* Installed via Rubygems
+* [Oembed](#oembed) - Embed a Tweet in familiar Twitter styling.
+* [Caching](#caching) - Twitter API responses can be cached to avoid hitting request limits.
 
 
 ### Requirements
 
-* You have set up a Twitter application and have auth credentials.
+* Twitter oauth credentials - Most Twitter api functions now require authentication. Set up your [application](https://dev.twitter.com/apps/new) and get the credentials.
 
 
 ### Usage
@@ -32,47 +34,78 @@ As mentioned by [Jekyll's documentation](http://jekyllrb.com/docs/plugins/#insta
 
 #### Require gem
 
+Install the gem, add it to your Gemfile;
+
+```ruby
+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]
+gems: ['jekyll-twitter-plugin']
 ```
 
 #### Manual import
 
 Just download the source file into your `_plugins` directory, e.g.
 
-TODO
+```bash
+# Create the _plugins dir if needed and download project_version_tag plugin
+$ mkdir -p _plugins && cd _plugins
+$ wget https://raw.githubusercontent.com/rob-murray/jekyll-twitter-plugin/master/lib/jekyll-twitter-plugin.rb
+```
+
+#### Credentials
+
+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**
+
+```bash
+$ export TWITTER_CONSUMER_KEY=foo etc.
+```
 
 #### Plugin tag usage
 
 To use the plugin, in your source content use the tag `twitter` and then pass additional parameters to the plugin.
 
 ```ruby
-{% twitter type params %}
+{% plugin_type api_type params %}
 ```
 
-##### type
+* `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.
 
-This is the type of Twitter API 
+### Supported Twitter APIs
+
+The following Twitter APIs are supported.
 
 #### Oembed
 
-{% twitter oembed url %}
+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.
 
-##### Output
+```ruby
+{% twitter oembed status_url %}
+# Example
+{% twitter oembed https://twitter.com/rubygems/status/518821243320287232 %}
+```
+
+### Output
 
 As with the original plugin, all content will be rendered inside a div with the classes 'embed' and 'twitter' 
 
-```
+```html
 <div class='embed twitter'>
-    content
+    -- content --
 </div>
 ```
 
-#### Output
-
-If the request cannot be processed 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
 

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.0'
+  spec.version       = '1.0.1'
   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

@@ -91,9 +91,9 @@ module TwitterJekyll
   end
 
   class UnknownTypeClient
-    def fetch; end
+    include TwitterJekyll::Cacheable
 
-    def cache_key; end
+    def fetch; end
   end
 
   class TwitterTag < Liquid::Tag
@@ -151,10 +151,10 @@ module TwitterJekyll
 
     def create_twitter_rest_client
       @twitter_client = Twitter::REST::Client.new do |config|
-        config.consumer_key        = ENV.fetch('twitter_consumer_key')
-        config.consumer_secret     = ENV.fetch('twitter_consumer_secret')
-        config.access_token        = ENV.fetch('twitter_access_token')
-        config.access_token_secret = ENV.fetch('twitter_access_token_secret')
+        config.consumer_key        = ENV.fetch('TWITTER_CONSUMER_KEY')
+        config.consumer_secret     = ENV.fetch('TWITTER_CONSUMER_SECRET')
+        config.access_token        = ENV.fetch('TWITTER_ACCESS_TOKEN')
+        config.access_token_secret = ENV.fetch('TWITTER_ACCESS_TOKEN_SECRET')
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-twitter-plugin
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Rob Murray