jekyll-twitter-plugin 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6bc4b29e2c5e02dc8a97a086e7e6c1415de44a6a
-  data.tar.gz: ac9904cc1514de2397acbd7701d5bb597eabf877
+  metadata.gz: 102db3b0c516a3de0e93b84790b2d58df8394df7
+  data.tar.gz: 4a6ae787a08375f14a48dc4353b1fe588efd10c7
 SHA512:
-  metadata.gz: ce5bbf44ff966518bac79cc55f1fd60c4a1833cf9412c894228a6e1da3eb8ef6886c921bf98fee4487f67edae1c5db4c1660b81270f7ad92d218829da54a9cd3
-  data.tar.gz: ac27faf62b5faaf825e4c955c4eb2be53c81c06a925731b1373c2b63e6e6921f5e1ac8f6dfeae12487cd1db7517979a6dc32833dc2bd62e6b144f02ab274ea2d
+  metadata.gz: 49095924e9b819e0bfec51f453b8f5c32c5c47edb72f348d0dee43afd9f65731db4987e10291a3a5e56172c63b69f6346027ba2224a219ca0ee3a87288ceaad3
+  data.tar.gz: 0be6b6ba0671ec4b33590a7b4fc5d09a3ea46f26de8f3b9db307a62f57d04b0116ba507583245b03bb51759ecf7fae169a34e9aa0c801218847c492ba681c7e0

data/README.md

@@ -27,7 +27,6 @@ The plugin supports the following features:
 
 * 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
 
 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`.
@@ -58,7 +57,21 @@ $ wget https://raw.githubusercontent.com/rob-murray/jekyll-twitter-plugin/master
 
 #### 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;
+Your Twitter application authentication credentials are private - do not distribute these!
+
+You can set the authentication variables by adding them to `_config.yml`.
+
+```yaml
+# _config.yml
+twitter:
+  consumer_key: asdf
+  consumer_secret: asdf
+  access_token: asdf
+  access_token_secret: asdf
+```
+
+If the authentication variables are not present in `_config.yml` they can be gathered from
+environment variables.
 
 * TWITTER_CONSUMER_KEY
 * TWITTER_CONSUMER_SECRET
@@ -100,7 +113,7 @@ The [oembed](https://dev.twitter.com/rest/reference/get/statuses/oembed) API ret
 
 ### Output
 
-As with the original plugin, all content will be rendered inside a div with the classes 'embed' and 'twitter' 
+As with the original plugin, all content will be rendered inside a div with the classes 'embed' and 'twitter'
 
 ```html
 <div class='embed twitter'>
@@ -115,11 +128,24 @@ If something goes wrong then a basic error message will be displayed;
 
 ### Caching
 
-TODO
+Twitter API responses can be cached to speed up Jekyll site builds and avoid going over API limits. The reponses will be cached in a directory within your Jekyll project called `.tweet-cache`, ensure that this is not commit to source control.
+
+Caching is enabled by default.
 
+It is possible to disable caching by using the specific `twitternocache` tag.
+
+```liquid
+{% twitternocache oembed status_url *options %}
+
+# Example
+{% twitternocache oembed https://twitter.com/rubygems/status/518821243320287232 %}
+
+```
 
 ### Contributions
 
+I've tried hard to keep all classes and code in the one `lib/jekyll-twitter-plugin.rb` file so that people can just grab this file and include in their Jekyll `_plugins` directory if they do not want to use the Gem. This may have to be dropped if the one file gets too overwhelming.
+
 Please use the GitHub pull-request mechanism to submit contributions.
 
 ### License

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.1.1'
+  spec.version       = '1.2.0'
   spec.authors       = ['Rob Murray']
   spec.email         = ['robmurray17@gmail.com']
   spec.summary       = 'A Liquid tag plugin for Jekyll that renders Tweets from Twitter API'
@@ -15,7 +15,7 @@ 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', '~> 1.7'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'pry-byebug'
 

data/lib/jekyll-twitter-plugin.rb

@@ -4,6 +4,7 @@ require 'twitter'
 # A Liquid tag plugin for Jekyll that renders Tweets from Twitter API.
 # https://github.com/rob-murray/jekyll-twitter-plugin
 #
+
 module TwitterJekyll
   class FileCache
     def initialize(path)
@@ -104,7 +105,7 @@ module TwitterJekyll
     private
 
     def key
-      @status_url
+      '%s-%s' % [@status_url, @params.to_s]
     end
   end
 
@@ -123,11 +124,11 @@ module TwitterJekyll
       args      = params.split(/\s+/).map(&:strip)
       @api_type = args.shift
       @params   = args
-
-      create_twitter_rest_client
     end
 
-    def render(_context)
+    def render(context)
+      secrets = extract_twitter_secrets_from_context(context) || extract_twitter_secrets_from_env
+      create_twitter_rest_client(secrets)
       api_client = create_api_client(@api_type, @params)
       response = cached_response(api_client) || live_response(api_client)
       html_output_for(response)
@@ -167,14 +168,29 @@ module TwitterJekyll
       end
     end
 
-    def create_twitter_rest_client
+    def create_twitter_rest_client(secrets)
       @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        = secrets.consumer_key
+        config.consumer_secret     = secrets.consumer_secret
+        config.access_token        = secrets.access_token
+        config.access_token_secret = secrets.access_token_secret
       end
     end
+
+    TwitterSecrets = Struct.new(:consumer_key, :consumer_secret, :access_token, :access_token_secret)
+
+    def extract_twitter_secrets_from_context(context)
+      TwitterSecrets.new(context.registers[:site].config['twitter']['consumer_key'], context.registers[:site].config['twitter']['consumer_secret'], context.registers[:site].config['twitter']['access_token'], context.registers[:site].config['twitter']['access_token_secret']) if context_has_twitter_secrets?(context)
+    end
+
+    def context_has_twitter_secrets?(context)
+      twitter_secrets = context.registers[:site].config['twitter'] || {}
+      ['consumer_key', 'consumer_secret', 'access_token', 'access_token_secret'].all? {|s| twitter_secrets.key?(s)}
+    end
+
+    def extract_twitter_secrets_from_env
+      TwitterSecrets.new(ENV.fetch('TWITTER_CONSUMER_KEY'), ENV.fetch('TWITTER_CONSUMER_SECRET'), ENV.fetch('TWITTER_ACCESS_TOKEN'), ENV.fetch('TWITTER_ACCESS_TOKEN_SECRET'))
+    end
   end
 
   class TwitterTagNoCache < TwitterTag

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-twitter-plugin
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Rob Murray
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-25 00:00:00.000000000 Z
+date: 2014-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -100,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: A Liquid tag plugin for Jekyll that renders Tweets from Twitter API