jekyll-linkpreview 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e553cbd1585c7303612cb32a21651039f3ebba2f
+  data.tar.gz: 58bf7022cf2eb09e8661292b5143bd8b8750d201
+SHA512:
+  metadata.gz: d41da5f3352c0fee0e9fcdb5c5d91f8b3f75d3943d2fe00f41593ed00b78f0d94e55d8d5bb8474022a815dcbf532622b6afc8a8df62d84bfde0cb0e39ae2075e
+  data.tar.gz: e6a23a9bb9c3170780aadd984af4977034055eaa4d53fc6ef008ce4bb92818057877894cb1bd43d2927b04e09c389d36af1572f6e054151272b74851d2b171aa

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

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.4.2
+before_install: gem install bundler -v 2.0.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Yusuke NISHIOKA
+
+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,61 @@
+# Jekyll::Linkpreview
+
+Jekyll plugin to generate link preview by `{% linkpreview %}` tag. The plugin fetches [Open Graph protocols](http://ogp.me/) of the designated page to generate preview. The og properties are saved as JSON for caching and it is used when rebuilding the site.
+
+For example, `{% linkpreview https://github.com %}` tag generates following HTML when you run `jekyll build`,
+
+```html
+<div class="jekyll-linkpreview-wrapper">
+  <p><a href="https://github.com" target="_blank">https://github.com</a></p>
+  <div class="jekyll-linkpreview-wrapper-inner">
+    <div class="jekyll-linkpreview-content">
+      <div class="jekyll-linkpreview-image">
+        <a href="https://github.com" target="_blank">
+          <img src="https://github.githubassets.com/images/modules/open_graph/github-logo.png" />
+        </a>
+      </div>
+      <div class="jekyll-linkpreview-body">
+        <h2 class="jekyll-linkpreview-title">
+          <a href="https://github.com" target="_blank">Build software better, together</a>
+        </h2>
+        <div class="jekyll-linkpreview-description">GitHub is where people build software. More than 31 million people use GitHub to discover, fork, and contribute to over 100 million projects.</div>
+      </div>
+    </div>
+    <div class="jekyll-linkpreview-footer">
+      <a href="https://github.com" target="_blank">github.com</a>
+    </div>
+  </div>
+</div>
+```
+
+Applying appropriate CSS, the link preview will be like this.
+
+<img width="613" alt="スクリーンショット 2019-04-03 20 52 50" src="https://user-images.githubusercontent.com/3449164/55479970-35baf100-565a-11e9-8c5d-709213917f74.png">
+
+## Installation
+
+See https://jekyllrb.com/docs/plugins/installation/ .
+
+## Usage
+
+1. Create `_cache` directory in the same hierarchy as `_site` directory.
+
+1. Embed [linkpreview.css](assets/css/linkpreview.css) into your Website.
+
+1. Use `{% linkpreview %}` tag.
+
+1. Run `jekyll build` or `jekyll serve`.
+
+## 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/ysk24ok/jekyll-linkpreview.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/assets/css/linkpreview.css

@@ -0,0 +1,46 @@
+.jekyll-linkpreview-wrapper {
+  max-width: 600px;
+  margin-bottom: 20px;
+}
+
+.jekyll-linkpreview-wrapper-inner {
+  border: 1px solid rgba(0,0,0,.1);
+  padding: 12px;
+}
+
+.jekyll-linkpreview-content {
+  position: relative;
+  height: 100px;
+  overflow: hidden;
+  margin-bottom: 10px;
+}
+
+.jekyll-linkpreview-image {
+  position: absolute;
+  top: 0;
+  right: 0;
+}
+
+.jekyll-linkpreview-image img {
+  width: 100px;
+  height: 100px;
+}
+
+.jekyll-linkpreview-body {
+  margin-right: 110px;
+}
+
+.jekyll-linkpreview-title {
+  font-size: 17px;
+  margin: 0 0 2px;
+  line-height: 1.3;
+}
+
+.jekyll-linkpreview-description {
+  line-height: 1.5;
+  font-size: 13px;
+}
+
+.jekyll-linkpreview-footer {
+  font-size: 11px;
+}

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jekyll/linkpreview"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jekyll-linkpreview.gemspec

@@ -0,0 +1,26 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jekyll-linkpreview/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-linkpreview"
+  spec.version       = Jekyll::Linkpreview::VERSION
+  spec.authors       = ["Yusuke Nishioka"]
+  spec.email         = ["yusuke.nishioka.0713@gmail.com"]
+
+  spec.summary       = %q{Jekyll tag plugin to generate link preview}
+  spec.homepage      = "https://github.com/ysk24ok/jekyll-linkpreview"
+  spec.license       = "MIT"
+
+  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.require_paths = ["lib"]
+
+  spec.add_dependency "jekyll", "~> 3.5"
+  spec.add_dependency "metainspector"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/jekyll-linkpreview.rb

@@ -0,0 +1,109 @@
+require "digest"
+require "json"
+
+require "metainspector"
+require "jekyll-linkpreview/version"
+
+module Jekyll
+  module Linkpreview
+    class LinkpreviewTag < Liquid::Tag
+      def initialize(tag_name, markup, parse_context)
+        super
+        @markup = markup.rstrip()
+        @cache_filepath = "_cache/%s.json" % Digest::MD5.hexdigest(@markup)
+      end
+
+      def render(context)
+        properties = get_properties()
+        title       = properties['title']
+        url         = properties['url']
+        image       = properties['image']
+        description = properties['description']
+        domain      = properties['domain']
+        if title.nil? || url.nil? || image.nil? then
+          html = <<-EOS
+<div class="jekyll-linkpreview-wrapper">
+  <p><a href="#{@markup}" target="_blank">#{@markup}</a></p>
+</div>
+          EOS
+          return html
+        end
+        html = <<-EOS
+<div class="jekyll-linkpreview-wrapper">
+  <p><a href="#{@markup}" target="_blank">#{@markup}</a></p>
+  <div class="jekyll-linkpreview-wrapper-inner">
+    <div class="jekyll-linkpreview-content">
+      <div class="jekyll-linkpreview-image">
+        <a href="#{url}" target="_blank">
+          <img src="#{image}" />
+        </a>
+      </div>
+      <div class="jekyll-linkpreview-body">
+        <h2 class="jekyll-linkpreview-title">
+          <a href="#{url}" target="_blank">#{title}</a>
+        </h2>
+        <div class="jekyll-linkpreview-description">#{description}</div>
+      </div>
+    </div>
+    <div class="jekyll-linkpreview-footer">
+      <a href="#{url}" target="_blank">#{domain}</a>
+    </div>
+  </div>
+</div>
+        EOS
+        html
+      end
+
+      def get_properties()
+        if File.exist?(@cache_filepath) then
+          return load_cache_file
+        else
+          og_properties = fetch_og_properties()
+          url = get_og_property(og_properties, 'og:url')
+          properties = {
+            'title'       => get_og_property(og_properties, 'og:title'),
+            'url'         => url,
+            'image'       => get_og_property(og_properties, 'og:image'),
+            'description' => get_og_property(og_properties, 'og:description'),
+            'domain'      => extract_domain(url)
+          }
+          save_cache_file(properties)
+          return properties
+        end
+      end
+
+      private
+      def fetch_og_properties()
+        MetaInspector.new(@markup).meta_tags['property']
+      end
+
+      private
+      def get_og_property(properties, key)
+        if !properties.key? key then
+          return nil
+        end
+        properties[key][0]
+      end
+
+      private
+      def extract_domain(url)
+        if url.nil? then
+          return nil
+        end
+        url.match(%r{(http|https)://([^/]+).*})[-1]
+      end
+
+      private
+      def load_cache_file()
+        JSON.parse(File.open(@cache_filepath).read)
+      end
+
+      private
+      def save_cache_file(properties)
+        File.open(@cache_filepath, 'w').write(JSON.generate(properties))
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("linkpreview", Jekyll::Linkpreview::LinkpreviewTag)

data/lib/jekyll-linkpreview/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module Linkpreview
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-linkpreview
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yusuke Nishioka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: metainspector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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:
+- yusuke.nishioka.0713@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- assets/css/linkpreview.css
+- bin/console
+- bin/setup
+- jekyll-linkpreview.gemspec
+- lib/jekyll-linkpreview.rb
+- lib/jekyll-linkpreview/version.rb
+homepage: https://github.com/ysk24ok/jekyll-linkpreview
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Jekyll tag plugin to generate link preview
+test_files: []