jekyll-twitter-plugin-2 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 599231152a51e8176d2156ffbebdbe2901287f23305ba73449876e0ed81b8e12
+  data.tar.gz: 97225bacd9cf282ae16641132e86d21d274de9b4b84bd0fee5b27094a8b14538
+SHA512:
+  metadata.gz: de3702b4b658ab0adf0ea8a6c546965b1077f6276a1adb759da6a1cc743b07b96623a791e7dd39d2eaa98a40ae63b8349dbfa362df887feaaf1c136c56427f8e
+  data.tar.gz: d2e794654fbe5b15bbc17e0ecd8e10ffef8af79260ad6b7a6586f75338b877e63e61fd400cf7c9928d359b77153f21bad6a3c30e658e231c6c06103dbcfaf83a

data/.gitignore

@@ -0,0 +1,40 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+.byebug_history
+
+## 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
+
+# App specific
+.env
+output_test.html
+.tweet-cache

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.3

data/FORKED_FORMER_LICENCE

@@ -0,0 +1,21 @@
+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/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in jekyll-twitter-plugin-2.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 YuSan
+
+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,69 @@
+# Jekyll Twitter Plugin 2
+
+A Liquid tag plugin for the Jekyll blogging engine that embeds Tweets, Timelines and more from Twitter API.
+
+and, this repo derived from https://github.com/rob-murray/jekyll-twitter-plugin.  
+The License here : [FORKED_FORMER_LICENCE](/FORKED_FORMER_LICENCE)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll-twitter-plugin-2'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-twitter-plugin-2
+
+## Usage
+
+### Here are a few examples
+
+#### Tweet
+
+An example of a Tweet - `{% twitter https://twitter.com/rubygems/status/518821243320287232 %}`
+
+![Embedded tweet](https://raw.githubusercontent.com/rob-murray/jekyll-twitter-plugin/master/media/embedded-tweet.png "Screenshot of embedded tweet")
+
+#### Timeline
+
+An example of a Timeline - `{% twitter https://twitter.com/jekyllrb maxwidth=500 limit=5 %}`
+
+![Embedded timeline](https://raw.githubusercontent.com/rob-murray/jekyll-twitter-plugin/master/media/embedded-timeline.png "Screenshot of embedded timeline")
+
+#### Grid Timeline
+
+An example of a Grid Timeline - `{% twitter https://twitter.com/TwitterDev/timelines/539487832448843776 limit=5 widget_type=grid maxwidth=500 %}`
+
+![Embedded Grid Timeline](https://raw.githubusercontent.com/rob-murray/jekyll-twitter-plugin/master/media/embedded-grid.png "Screenshot of embedded Grid Timeline")
+
+#### Moment
+
+An example of a Moment - `{% twitter https://twitter.com/i/moments/650667182356082688 maxwidth=500 %}`
+
+![Embedded moment](https://raw.githubusercontent.com/rob-murray/jekyll-twitter-plugin/master/media/embedded-moment.png "Screenshot of embedded moment")
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jekyll-twitter-plugin-2. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Jekyll::Twitter::Plugin::2 project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/jekyll-twitter-plugin-2/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/jekyll-twitter-plugin-2.gemspec

@@ -0,0 +1,30 @@
+
+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-2"
+  spec.version       = "0.0.1"
+  spec.authors       = ["YuSan"]
+  spec.email         = ["ysoga19@gmail.com"]
+
+  spec.summary       = "A Liquid tag plugin for Jekyll to embed Twitter, Timelines and more from Twitter API."
+  spec.homepage      = "https://github.com/yu-san-19/jekyll-twitter-plugin-2"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/jekyll-twitter-plugin-2.rb

@@ -0,0 +1,287 @@
+# frozen_string_literal: true
+require "fileutils"
+require "net/http"
+require "uri"
+require "ostruct"
+require "json"
+require "digest"
+
+##
+# A Liquid tag plugin for Jekyll that renders Tweets from Twitter API.
+# 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
+
+  # Cache class that writes to filesystem
+  # TODO: Do i really need to cache?
+  # @api private
+  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
+
+  # Cache class that does nothing
+  # @api private
+  class NullCache
+    def initialize(*_args); end
+
+    def read(_key); end
+
+    def write(_key, _data); end
+  end
+
+  # Wrapper around an API
+  # @api private
+  class ApiClient
+    # Perform API request; return hash with html content
+    def fetch(api_request)
+      uri = api_request.to_uri
+      response = Net::HTTP.start(uri.host, use_ssl: api_request.ssl?) do |http|
+        http.read_timeout = 5
+        http.open_timeout = 5
+        http.get uri.request_uri, REQUEST_HEADERS
+      end
+
+      handle_response(api_request, response)
+
+    rescue Timeout::Error => e
+      ErrorResponse.new(api_request, e.class.name).to_h
+    end
+
+    private
+
+    def handle_response(api_request, response)
+      case response
+      when Net::HTTPSuccess
+        JSON.parse(response.body)
+      else
+        ErrorResponse.new(api_request, response.message).to_h
+      end
+    end
+  end
+
+  # @api private
+  ErrorResponse = Struct.new(:request, :message) do
+    def html
+      "<p>There was a '#{message}' error fetching URL: '#{request.entity_url}'</p>"
+    end
+
+    def to_h
+      { html: html }
+    end
+  end
+
+  # Holds the URI were going to request with any parameters
+  # @api private
+  ApiRequest = Struct.new(:entity_url, :params) do
+    TWITTER_API_URL = "https://publish.twitter.com/oembed".freeze
+
+    # Always;
+    def ssl?
+      true
+    end
+
+    # Return a URI for Twitter API with query params
+    def to_uri
+      URI.parse(TWITTER_API_URL).tap do |uri|
+        uri.query = URI.encode_www_form url_params
+      end
+    end
+
+    # A cache key applicable to the current request with params
+    def cache_key
+      Digest::MD5.hexdigest("#{self.class.name}-#{unique_request_key}")
+    end
+
+    private
+
+    def url_params
+      params.merge(url: entity_url)
+    end
+
+    def unique_request_key
+      format("%s-%s", entity_url, params.to_s)
+    end
+  end
+
+  # Class to respond to Jekyll tag; entry point to library
+  # @api public
+  class TwitterTag < Liquid::Tag
+    ERROR_BODY_TEXT = "<p>Tweet could not be processed</p>".freeze
+    OEMBED_ARG      = "oembed".freeze
+
+    attr_writer :cache # for testing
+
+    def initialize(_name, params, _tokens)
+      super
+      @api_request = parse_params(params)
+    end
+
+    # Class that implements caching strategy
+    # @api private
+    def self.cache_klass
+      FileCache
+    end
+
+    # Return html string for Jekyll engine
+    # @api public
+    def render(context)
+      api_secrets_deprecation_warning(context) # TODO: remove after deprecation cycle
+      response = cached_response || live_response
+      html_output_for(response)
+    end
+
+    private
+
+    def cache
+      @cache ||= self.class.cache_klass.new("./.tweet-cache")
+    end
+
+    def api_client
+      @api_client ||= ApiClient.new
+    end
+
+    # Return Twitter response or error html
+    # @api private
+    def html_output_for(response)
+      body = (response.html if response) || ERROR_BODY_TEXT
+      body
+    end
+
+    # Return response from API and write to cache
+    # @api private
+    def live_response
+      if response = api_client.fetch(@api_request)
+        cache.write(@api_request.cache_key, response)
+        build_response(response)
+      end
+    end
+
+    # Return response cache if present, otherwise nil
+    # @api private
+    def cached_response
+      response = cache.read(@api_request.cache_key)
+      build_response(response) unless response.nil?
+    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?
+
+      if args[0].to_s == OEMBED_ARG # TODO: remove after deprecation cycle
+        arguments_deprecation_warning(args)
+        args.shift
+      end
+
+      url, *api_args = args
+      ApiRequest.new(url, parse_args(api_args))
+    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|
+        k, v = arg.split("=").map(&:strip)
+        if k && v
+          v = Regexp.last_match[1] if v =~ /^'(.*)'$/
+          params[k] = v
+        end
+      end
+    end
+
+    # Format a response hash
+    # @api private
+    def build_response(h)
+      OpenStruct.new(h)
+    end
+
+    # TODO: remove after deprecation cycle
+    def arguments_deprecation_warning(args)
+      warn "#{LIBRARY_VERSION}: Passing '#{OEMBED_ARG}' as the first argument is not required anymore. This will result in an error in future versions.\nCalled with #{args.inspect}"
+    end
+
+    # TODO: remove after deprecation cycle
+    def api_secrets_deprecation_warning(context)
+      warn_if_twitter_secrets_in_context(context) || warn_if_twitter_secrets_in_env
+    end
+
+    # TODO: remove after deprecation cycle
+    def warn_if_twitter_secrets_in_context(context)
+      twitter_secrets = context.registers[:site].config.fetch("twitter", {})
+      return unless store_has_keys?(twitter_secrets, CONTEXT_API_KEYS)
+
+      warn_secrets_in_project("Jekyll _config.yml")
+    end
+
+    # TODO: remove after deprecation cycle
+    def warn_if_twitter_secrets_in_env
+      return unless store_has_keys?(ENV, ENV_API_KEYS)
+
+      warn_secrets_in_project("ENV")
+    end
+
+    # TODO: remove after deprecation cycle
+    def warn_secrets_in_project(source)
+      warn "#{LIBRARY_VERSION}: Found Twitter API keys in #{source}, this library does not require these keys anymore. You can remove these keys, if used for another library then ignore this message."
+    end
+
+    # TODO: remove after deprecation cycle
+    def store_has_keys?(store, keys)
+      keys.all? { |required_key| store.key?(required_key) }
+    end
+
+    # Raise error for invalid arguments
+    # @api private
+    def invalid_args!(arguments)
+      formatted_args = Array(arguments).join(" ")
+      raise ArgumentError, "Invalid arguments '#{formatted_args}' passed to 'jekyll-twitter-plugin'. #{REFER_TO_README}"
+    end
+  end
+
+  # Specialization of TwitterTag without any caching
+  # @api public
+  class TwitterTagNoCache < TwitterTag
+    def self.cache_klass
+      NullCache
+    end
+  end
+end
+
+Liquid::Template.register_tag("twitter", TwitterJekyll::TwitterTag)
+Liquid::Template.register_tag("twitternocache", TwitterJekyll::TwitterTagNoCache)

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-twitter-plugin-2
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- YuSan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- ysoga19@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- FORKED_FORMER_LICENCE
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- jekyll-twitter-plugin-2.gemspec
+- lib/jekyll-twitter-plugin-2.rb
+homepage: https://github.com/yu-san-19/jekyll-twitter-plugin-2
+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.7.3
+signing_key: 
+specification_version: 4
+summary: A Liquid tag plugin for Jekyll to embed Twitter, Timelines and more from
+  Twitter API.
+test_files: []