jekyll-linkpreview 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e553cbd1585c7303612cb32a21651039f3ebba2f
-  data.tar.gz: 58bf7022cf2eb09e8661292b5143bd8b8750d201
+  metadata.gz: 597a9685dd537f7fddef541e75b596cdcda260cc
+  data.tar.gz: f4a9201088c0881410bf7e87d3963f04e9942de5
 SHA512:
-  metadata.gz: d41da5f3352c0fee0e9fcdb5c5d91f8b3f75d3943d2fe00f41593ed00b78f0d94e55d8d5bb8474022a815dcbf532622b6afc8a8df62d84bfde0cb0e39ae2075e
-  data.tar.gz: e6a23a9bb9c3170780aadd984af4977034055eaa4d53fc6ef008ce4bb92818057877894cb1bd43d2927b04e09c389d36af1572f6e054151272b74851d2b171aa
+  metadata.gz: e9affa10e185284257a77d68d44736f8c3f0f0d9a324aa4578fdb7fc454504dad883f69b0b2875ef5cdbd0766768709dc0c81a140b219c88bd607714cd1bbe9e
+  data.tar.gz: bd20c259e0becb55c2976f384f1e220b835e53778b7edc1a0382e37ccf49e00d6eb0aac38b77a453d9281f3cb11802925ac5095b1aa3a9d14c61e072afecf7db

data/README.md

@@ -2,7 +2,20 @@
 
 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`,
+You can pass url directly to the tag, 
+
+```
+{% linkpreview https://github.com %}
+```
+
+or, can pass a url variable.
+
+```
+{% assign github_toppage = 'https://github.com'%}
+{% linkpreview github_toppage %}
+```
+
+The tag above generates following HTML when you run `jekyll build`,
 
 ```html
 <div class="jekyll-linkpreview-wrapper">
@@ -38,7 +51,7 @@ See https://jekyllrb.com/docs/plugins/installation/ .
 
 ## Usage
 
-1. Create `_cache` directory in the same hierarchy as `_site` directory.
+1. Create `_cache` directory where you run `jekyll build` or `jekyll serve`.
 
 1. Embed [linkpreview.css](assets/css/linkpreview.css) into your Website.
 

data/lib/jekyll-linkpreview/version.rb

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

data/lib/jekyll-linkpreview.rb

@@ -6,31 +6,82 @@ require "jekyll-linkpreview/version"
 
 module Jekyll
   module Linkpreview
+    class OpenGraphProperties
+      def get(url)
+        og_properties = fetch(url)
+        og_url = get_og_property(og_properties, 'og:url')
+        domain = extract_domain(og_url)
+        image_url = get_og_property(og_properties, 'og:image')
+        {
+          'title'       => get_og_property(og_properties, 'og:title'),
+          'url'         => og_url,
+          'image'       => convert_to_absolute_url(image_url, domain),
+          'description' => get_og_property(og_properties, 'og:description'),
+          'domain'      => domain
+        }
+      end
+
+      private
+      def get_og_property(properties, key)
+        if !properties.key? key then
+          return nil
+        end
+        properties[key][0]
+      end
+
+      private
+      def fetch(url)
+        MetaInspector.new(url).meta_tags['property']
+      end
+
+      private
+      def convert_to_absolute_url(url, domain)
+        if url.nil? then
+          return nil
+        end
+        # root relative url
+        if url[0] == '/' then
+          return "//#{domain}#{url}"
+        end
+        url
+      end
+
+      private
+      def extract_domain(url)
+        if url.nil? then
+          return nil
+        end
+        url.match(%r{(http|https)://([^/]+).*})[-1]
+      end
+    end
+
     class LinkpreviewTag < Liquid::Tag
+      @@cache_dir = '_cache'
+
       def initialize(tag_name, markup, parse_context)
         super
         @markup = markup.rstrip()
-        @cache_filepath = "_cache/%s.json" % Digest::MD5.hexdigest(@markup)
+        @og_properties = OpenGraphProperties.new
       end
 
       def render(context)
-        properties = get_properties()
+        url = get_url_from(context)
+        properties = get_properties(url)
         title       = properties['title']
-        url         = properties['url']
         image       = properties['image']
         description = properties['description']
         domain      = properties['domain']
-        if title.nil? || url.nil? || image.nil? then
+        if title.nil? || image.nil? || description.nil? || domain.nil? then
           html = <<-EOS
 <div class="jekyll-linkpreview-wrapper">
-  <p><a href="#{@markup}" target="_blank">#{@markup}</a></p>
+  <p><a href="#{url}" target="_blank">#{url}</a></p>
 </div>
           EOS
           return html
         end
         html = <<-EOS
 <div class="jekyll-linkpreview-wrapper">
-  <p><a href="#{@markup}" target="_blank">#{@markup}</a></p>
+  <p><a href="#{url}" target="_blank">#{url}</a></p>
   <div class="jekyll-linkpreview-wrapper-inner">
     <div class="jekyll-linkpreview-content">
       <div class="jekyll-linkpreview-image">
@@ -46,7 +97,7 @@ module Jekyll
       </div>
     </div>
     <div class="jekyll-linkpreview-footer">
-      <a href="#{url}" target="_blank">#{domain}</a>
+      <a href="//#{domain}" target="_blank">#{domain}</a>
     </div>
   </div>
 </div>
@@ -54,53 +105,34 @@ module Jekyll
         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
+      def get_properties(url)
+        cache_filepath = "#{@@cache_dir}/%s.json" % Digest::MD5.hexdigest(url)
+        if File.exist?(cache_filepath) then
+          return load_cache_file(cache_filepath)
         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
+        properties = @og_properties.get(url)
+        if Dir.exists?(@@cache_dir) then
+          save_cache_file(cache_filepath, properties)
+        else
+          # TODO: This message will be shown at all linkprevew tag
+          warn "'#{@@cache_dir}' directory does not exist. Create it for caching."
         end
-        properties[key][0]
+        properties
       end
 
       private
-      def extract_domain(url)
-        if url.nil? then
-          return nil
-        end
-        url.match(%r{(http|https)://([^/]+).*})[-1]
+      def get_url_from(context)
+        context.scopes[0].key?(@markup) ? context.scopes[0][@markup] : @markup
       end
 
       private
-      def load_cache_file()
-        JSON.parse(File.open(@cache_filepath).read)
+      def load_cache_file(filepath)
+        JSON.parse(File.open(filepath).read)
       end
 
-      private
-      def save_cache_file(properties)
-        File.open(@cache_filepath, 'w').write(JSON.generate(properties))
+      protected
+      def save_cache_file(filepath, properties)
+        File.open(filepath, 'w').write(JSON.generate(properties))
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-linkpreview
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yusuke Nishioka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-04 00:00:00.000000000 Z
+date: 2019-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -120,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Jekyll tag plugin to generate link preview