jekyll-onebox 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 624c7dda2f03f56d874a11c1267e31c0d644d326
+  data.tar.gz: b3f45233c80ca67dcf35a63955f9c1e8dbe03138
+SHA512:
+  metadata.gz: fa3d5dd4c48023efbe7919eecad0f7b69de7d79a265556612825ddde66848019e51ee5e947a595e32dc071cd55e6c4ac66c242772656a8c236ae99392e97ba5a
+  data.tar.gz: 905b334da84d8af392db1f6e879d826f87ac97d5ff0d81b5a2eeec02b69583dd72d3fd516c7c19b23d9d1506153bf92cf1d2355206ee038116748b9da5fc034f

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## HEAD
+
+## 0.1.0 / 2017-04-02
+
+  * Birthday!
+  * move monkey patched code to a proper Jekyll Tag plug-in

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+if ENV["GH_PAGES"]
+  gem "github-pages"
+elsif ENV["JEKYLL_VERSION"]
+  gem "jekyll", "~> #{ENV["JEKYLL_VERSION"]}"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2017-present Robert Riemann and jekyll-onebox contributors
+
+MIT License
+
+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::Onebox
+
+Liquid tag for displaying GitHub Gists in Jekyll sites: `{% gist %}`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    $ gem 'jekyll-onebox'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-onebox
+
+Then add the following to your site's `_config.yml`:
+
+```
+plugins:
+  - jekyll-onebox
+```
+
+💡 If you are using a Jekyll version less than 3.5.0, use the `gems` key instead of `plugins`.
+
+## Usage
+
+Use the tag as follows in your Jekyll pages, posts and collections:
+
+```liquid
+{% onebox http://github.com/rriemann/jekyll-onebox %}
+```
+
+This will create a html preview, i.e. an embed, for websites supported by the ruby gem [onebox](https://github.com/discourse/onebox).
+
+The html preview depends on the actual link and may be the [oEmbed](http://oembed.com/) or [Open Graph](https://developers.facebook.com/docs/opengraph/) of a (whitelisted) website with support for those previews. Onebox also comes with many engines to construct a custom preview for supported websites, such as IMDB, Amazon, Wikipedia, etc.
+
+**Pro-tip**: Onebox uses in most cases HTTP GET requests to fetch content from the provided link. With evolving website content or updates of the Onebox gem, the html preview of the same link may also evolve.
+
+## Custom Whitelisting
+
+If Onebox does not support a domain out of the box, but implements either [oEmbed](http://oembed.com/) or [Open Graph](https://developers.facebook.com/docs/opengraph/), than support can be added by simple whitelisting. Please find [in the Onebox code](https://github.com/discourse/onebox/blob/master/lib/onebox/engine/whitelisted_generic_onebox.rb) a list of all whitelisted domains.
+
+If a domain is not supported and does not implement oEmbed or Open Graph, than a new engine must be added to the Onebox gem.
+
+```yml
+onebox:
+  whitelist:
+    - blog.riemann.cc
+    - tagesschau.de
+```
+
+## TODO
+
+- add caching of previews to speed-up page builds
+
+## Similar Projects
+
+- <https://kalifi.org/2015/08/using-discourse-onebox-with-jekyll.html> uses the Onebox gem for a Jekyll Filter plug-in and inspired this Tag plug-in.
+
+## Contributing
+
+1. Fork it ( https://github.com/rriemann/jekyll-onebox/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"

data/jekyll-onebox.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jekyll-onebox/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-onebox"
+  spec.version       = Jekyll::Onebox::VERSION
+  spec.authors       = ["Robert Riemann"]
+  spec.email         = ["robert@riemann.cc"]
+  spec.summary       = "Liquid tag for displaying HTML previews (embeds) for links."
+  spec.homepage      = "https://github.com/rriemann/jekyll-onebox"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = ">= 2.1"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r!^bin/!) { |f| File.basename(f) }
+  # spec.test_files    = spec.files.grep(%r!^(test|spec|features)/!)
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "onebox", "~> 1.8"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "jekyll", ">= 3.0"
+  spec.add_development_dependency "rake"
+end

data/lib/jekyll-onebox.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "jekyll-onebox/version"
+require "jekyll-onebox/onebox_tag"
+
+module Jekyll
+  module Onebox
+  end
+end

data/lib/jekyll-onebox/onebox_tag.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "onebox"
+
+# Inspiration:
+# source: https://kalifi.org/2015/08/using-discourse-onebox-with-jekyll.html
+# Onebox::Engine::WhitelistedGenericOnebox.whitelist << "kalifi.org"
+
+# module Jekyll
+#   module OneboxFilter
+#     def preview(url)
+#       Onebox.preview(url).to_s
+#     end
+#   end
+# end
+#
+# Liquid::Template.register_filter(Jekyll::OneboxFilter)
+
+module Jekyll
+  module Onebox
+    class OneboxTag < Liquid::Tag
+      def initialize(tag_name, url, tokens)
+        super
+        # STDERR.puts url
+        @url = url.strip
+      end
+
+      def render(context)
+        @settings = context.registers[:site].config["onebox"]
+        if @settings && @settings["whitelist"]
+          whitelist = @settings["whitelist"]
+          if whitelist.kind_of?(Array)
+            whitelist.each do |domain|
+              Onebox::Engine::WhitelistedGenericOnebox.whitelist << domain
+            end
+          end
+        end
+        Onebox.preview(@url).to_s
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('onebox', Jekyll::Onebox::OneboxTag)

data/lib/jekyll-onebox/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Onebox
+    VERSION = "0.1.0".freeze
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-onebox
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robert Riemann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: onebox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: jekyll
+  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'
+- !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'
+description: 
+email:
+- robert@riemann.cc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll-onebox.gemspec
+- lib/jekyll-onebox.rb
+- lib/jekyll-onebox/onebox_tag.rb
+- lib/jekyll-onebox/version.rb
+homepage: https://github.com/rriemann/jekyll-onebox
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Liquid tag for displaying HTML previews (embeds) for links.
+test_files: []