jekyll-twitter-plugin 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80e8d5cf8433bd544dd046d6305444676e9d07b5
+  data.tar.gz: 93421fcb83701f3960321ff34434116a5e381912
+SHA512:
+  metadata.gz: bf621b7035e5ad7da48b95130a9a0a61652c72dc216720b5251ae5df9ca605a8552125d162270728e5968ac790b2f3fca804be30b8b0324801967bb1b729be31
+  data.tar.gz: 46427dceea766f3bc1ccf28c5bae0e3e4507fac56c0b687c860986dbf3602d12f262dc55d792d4289b2b7c9daa6c687c07206f3d607eba0c93d3be7508fada69

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Robert Murray
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,92 @@
+## jekyll-twitter-plugin
+
+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.
+
+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 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.
+
+
+### Features
+
+The plugin supports the following features from the Twitter API:
+
+* Oembed - Embed a Tweet in familiar Twitter styling.
+* Caching - API requests can be cached to avoid hitting request limits.
+
+
+### Requirements
+
+* You have set up a Twitter application and have auth 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`.
+
+#### Require gem
+
+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]
+```
+
+#### Manual import
+
+Just download the source file into your `_plugins` directory, e.g.
+
+TODO
+
+#### 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 %}
+```
+
+##### type
+
+This is the type of Twitter API 
+
+#### Oembed
+
+{% twitter oembed url %}
+
+##### Output
+
+As with the original plugin, all content will be rendered inside a div with the classes 'embed' and 'twitter' 
+
+```
+<div class='embed twitter'>
+    content
+</div>
+```
+
+#### Output
+
+If the request cannot be processed then a basic error message will be displayed;
+
+> Tweet could not be processed
+
+
+### Caching
+
+TODO
+
+
+### Contributions
+
+Please use the GitHub pull-request mechanism to submit contributions.
+
+### License
+
+This project is available for use under the MIT software license.
+See LICENSE

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/jekyll-twitter-plugin.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$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.authors       = ['Rob Murray']
+  spec.email         = ['robmurray17@gmail.com']
+  spec.summary       = 'A Liquid tag plugin for Jekyll that renders Tweets from Twitter API'
+  spec.homepage      = 'https://github.com/rob-murray/jekyll-twitter-plugin'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 'rake'
+
+  spec.add_dependency 'twitter', '~> 5.11'
+end

data/lib/jekyll-twitter-plugin.rb

@@ -0,0 +1,171 @@
+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)
+      @cache_folder   = File.expand_path path
+      FileUtils.mkdir_p @cache_folder
+    end
+
+    def read(key)
+      file_to_read = cache_file(cache_filename(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.open(file_to_write, 'w') do |f|
+        f.write(data_to_write)
+      end
+    end
+
+    private
+
+    def cache_file(filename)
+      File.join(@cache_folder, filename)
+    end
+
+    def cache_filename(cache_key)
+      "#{cache_key}.cache"
+    end
+  end
+
+  class NullCache
+    def initialize; end
+
+    def read(_key); end
+
+    def write(_key, _data); end
+  end
+
+  module Cacheable
+    def cache_key
+      Digest::MD5.hexdigest("#{self.class.name}-#{key}")
+    end
+
+    def key; end
+  end
+
+  module TwitterApiMixin
+    def id_from_status_url(url)
+      if url.to_s =~ /([^\/]+$)/
+        Regexp.last_match[1]
+      end
+    end
+
+    def find_tweet(id)
+      return unless id
+
+      @client.status(id.to_i)
+    rescue Twitter::Error::NotFound
+      nil
+    end
+  end
+
+  class Oembed
+    include TwitterJekyll::TwitterApiMixin
+    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
+      end
+    end
+
+    def key
+      @status_url
+    end
+  end
+
+  class UnknownTypeClient
+    def fetch; end
+
+    def cache_key; end
+  end
+
+  class TwitterTag < Liquid::Tag
+    ERROR_BODY_TEXT = 'Tweet could not be processed'
+
+    def initialize(_name, params, _tokens)
+      super
+      @params  = params.split(/\s+/).map(&:strip)
+      @cache   = FileCache.new('./.tweet-cache')
+
+      create_twitter_rest_client
+    end
+
+    def render(_context)
+      api_type = @params.first
+      tweet_params  = @params.last
+
+      api_client = create_api_client(api_type, tweet_params)
+      html_output_for(api_client)
+    end
+
+    private
+
+    def html_output_for(api_client)
+      body = ERROR_BODY_TEXT
+
+      if response = cached_response(api_client) || live_response(api_client)
+        body = response.html || body
+      end
+
+      "<div class='embed twitter'>#{body}</div>"
+    end
+
+    def live_response(api_client)
+      if response = api_client.fetch
+        @cache.write(api_client.cache_key, response)
+        response
+      end
+    end
+
+    def cached_response(api_client)
+      response = @cache.read(api_client.cache_key)
+      OpenStruct.new(response) unless response.nil?
+    end
+
+    def create_api_client(api_type, params)
+      klass_name = api_type.capitalize
+      if TwitterJekyll.const_defined?(klass_name)
+        api_client_klass = TwitterJekyll.const_get(klass_name)
+        api_client_klass.new(@twitter_client, params)
+      else
+        UnknownTypeClient.new
+      end
+    end
+
+    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')
+      end
+    end
+  end
+
+  class TwitterTagNoCache < TwitterTag
+    def initialize(_tag_name, _text, _token)
+      super
+      @cache = NullCache.new
+    end
+  end
+end
+
+Liquid::Template.register_tag('twitter', TwitterJekyll::TwitterTag)
+Liquid::Template.register_tag('twitternocache', TwitterJekyll::TwitterTagNoCache)

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-twitter-plugin
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rob Murray
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-05 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: twitter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+description: 
+email:
+- robmurray17@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- jekyll-twitter-plugin.gemspec
+- lib/jekyll-twitter-plugin.rb
+homepage: https://github.com/rob-murray/jekyll-twitter-plugin
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A Liquid tag plugin for Jekyll that renders Tweets from Twitter API
+test_files: []