jekyll-hive 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a498c5b88a46e157b96371105a23234fe02fbdc595ffe332615f92c5d8dbfb4
-  data.tar.gz: e34b162f75d5225851831bb24239be567ca3e336d58d29d6549d17481b1ad356
+  metadata.gz: 529a97b1677713768a1334a0f8efca5123ee363fb012d08c8d1b866f5fc83dc0
+  data.tar.gz: c854107108ff8a867091e8156f1236b840acf55f110ac22ae653a89f27645636
 SHA512:
-  metadata.gz: 7ba17593792b5d8f17339e20ba4ef1a6b77297ede9ced3925fa25d3b860dd70c78133df802024065b647e436df83ce9f9b07ad065c95f87c19af31fb531deaf7
-  data.tar.gz: f4529f539627e83f5e0e063cd5ab1892671c51c8756356c0b042cb405a3fc701899238289048fc192a6151458abb749cbe48e66d53153b2fa57d4f56783436ea
+  metadata.gz: 5196c21173e790479dd12cf979d80deb26d4243c0bbd6af7c5452baed0e4876f481c895fe4ad168fda6c3b924cee5c1c196af3a2b0bbd91af5c20c02014d6173
+  data.tar.gz: 2820d8010e9b966d20b9e4cd89b6efb903978c7afe549c9e4b6faa581b9587563bb26b13cedfaf8fb25c95e290072682038d4f07b96c6c8c99cfdf481f6c3d80

data/README.md

@@ -42,6 +42,14 @@ Use the tag as follows in your Jekyll pages, posts and collections:
 ```
 This will place the associated content on the page.
 
+## Note About Turbolinks
+
+If you're using Turbolinks on your Jekyll site, you should consider adding the following line to your main includes, e.g. `_includes/head.html`:
+
+```html
+<script src='https://unpkg.com/steem-content-renderer'></script>
+```
+
 ## Jekyll Build
 
 When building your site with jekyll, you can continue to use the default command:
@@ -56,6 +64,41 @@ If you would like to provide an alternate node:
 NODE_URL=https://anyx.io jekyll build
 ```
 
+## Jekyll Clean
+
+To completely rebuild your site without cache:
+
+```bash
+rm -rf .jekyll-hive-cache && jekyll clean && jekyll build
+```
+
+## Troubleshooting
+
+#### I saw several messages like:
+
+```
+Retrying: stoodkev/how-to-use-hivejs-or-other-modules-referencing-core-node-js-modules-on-react-native (Failed to open TCP connection to api.hive.blog:443 (getaddrinfo: nodename nor servname provided, or not known))
+Retrying: stoodkev/how-to-use-hivejs-or-other-modules-referencing-core-node-js-modules-on-react-native (Failed to open TCP connection to api.openhive.network:443 (getaddrinfo: nodename nor servname provided, or not known))
+.
+.
+.
+Gave up on: stoodkev/how-to-use-hivejs-or-other-modules-referencing-core-node-js-modules-on-react-native
+```
+
+Check your internet connection or provide an alternate node:
+
+```
+NODE_URL=https://anyx.io jekyll build
+```
+
+#### The post has changed on the blockchain, but `jekyll-hive` won't update to the latest post revision.
+
+The cached copy is out of date.  Try deleting the related post from the cache or remove the entire cache:
+
+```
+rm -rf .jekyll-hive-cache
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/inertia186/jekyll-hive/fork )

data/lib/jekyll-hive/hive_tag.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 require 'cgi'
-require 'steem'
+require 'hive'
+require 'open-uri'
+require 'fileutils'
 
 Net::OpenTimeout = Class.new(RuntimeError) unless Net.const_defined?(:OpenTimeout)
 Net::ReadTimeout = Class.new(RuntimeError) unless Net.const_defined?(:ReadTimeout)
@@ -19,8 +21,48 @@ module Jekyll
         
         if (tag_contents = determine_arguments(@markup.strip))
           hive_slug = tag_contents[0]
+          attempts = 0
+          content = nil
+          rebuild = ENV.fetch("JEKYLL_HIVE_REBUILD", 'false') == 'true'
           
-          hive_tag(hive_slug)
+          loop do
+            warn "Attempts for #{hive_slug}: #{attempts}" if attempts > 0
+            
+            if attempts > 4
+              warn "Gave up on: #{hive_slug}"
+              delete_content_cache(hive_slug)
+              break
+            end
+            
+            begin
+              attempts = attempts + 1
+              
+              if !!rebuild && !!content_cache(hive_slug)
+                if content_age(hive_slug) > 9000
+                  # TODO quickly check if the cache should be cleared
+                  
+                  warn "Checking for changes: #{hive_slug}"
+                  
+                  if content_changed?(hive_slug)
+                    warn "Refreshing: #{hive_slug}"
+                    delete_content_cache(hive_slug)
+                  end
+                end
+                
+                content_touch(hive_slug)
+              end
+              
+              content = content_cache(hive_slug) || hive_tag(hive_slug)
+              
+              break
+            rescue => e
+              warn "Retrying: #{hive_slug} (#{e})"
+              @api = nil
+              sleep 3
+            end
+          end
+          
+          content_cache(hive_slug, content)
         else
           raise ArgumentError, <<~ERROR
             Syntax error in tag 'hive' while parsing the following markup:
@@ -32,20 +74,105 @@ module Jekyll
         end
       end
     private
+      def cache_dir_path
+        ENV.fetch('JEKYLL_HIVE_CACHE', '.jekyll-hive-cache')
+      end
+      
+      def parse_key(hive_slug)
+        hive_slug.gsub('/', '-')
+      end
+      
+      def cached_file(hive_slug)
+        key = parse_key(hive_slug)
+        
+        cache_dir_path + "/#{key}"
+      end
+      
+      def content_cache(hive_slug, value = nil)
+        key = parse_key(hive_slug)
+        
+        unless !!@content_cache
+          @content_cache ||= {}
+
+          Dir.mkdir cache_dir_path unless Dir.exists? cache_dir_path
+          
+          Dir.glob("#{cache_dir_path}/*") do |filename|
+            next if File.directory? filename
+            
+            @content_cache[filename.split('/').last] = File.open(filename).read
+          end
+        end
+        
+        if !!value && value != ''
+          @content_cache[key] ||= value
+          
+          File.open(cached_file(hive_slug), 'wb') do |cache_file|
+            cache_file.write(value)
+          end
+        end
+        
+        if @content_cache[key] == ''
+          delete_content_cache(hive_slug)
+          
+          nil
+        else
+          @content_cache[key]
+        end
+      end
+      
+      def content_age(hive_slug)
+        age = Time.now - File.mtime(cached_file(hive_slug)) rescue 0
+        warn "Age for #{hive_slug}: #{age}"
+        
+        age
+      end
+      
+      def content_touch(hive_slug)
+        FileUtils.touch(cached_file(hive_slug))
+      end
+      
+      def delete_content_cache(hive_slug)
+        File.delete(cached_file(hive_slug)) rescue false
+      end
+      
       def determine_arguments(input)
         return unless input =~ /@?[^\/]+\/[^\/]+/i
         
         [input]
       end
       
-      def hive_tag(hive_slug)
+      def api
+        url = ENV.fetch('NODE_URL', 'https://api.hive.blog,https://api.openhive.network').split(',').sample
+        
+        @api ||= ::Hive::CondenserApi.new(url: url)
+      end
+      
+      def parse_slug(hive_slug)
         hive_slug = hive_slug.split('@').last
         hive_slug = hive_slug.split('/')
         author = hive_slug[0]
         permlink = hive_slug[1..-1].join('/')
         permlink = permlink.split('?').first
         permlink = permlink.split('#').first
-        api = ::Steem::CondenserApi.new(url: ENV.fetch('NODE_URL', 'https://api.openhive.network'))
+        
+        [author, permlink]
+      end
+      
+      def content_changed?(hive_slug)
+        author, permlink = parse_slug(hive_slug)
+        cached_created = File.mtime(cached_file(hive_slug)) rescue Time.now
+
+        # TODO find a better way to get the `created` timestamp, this is really
+        # no faster than just parsing the content.
+        api.get_content(author, permlink) do |content|
+          created = Time.parse(content.created + 'Z')
+          
+          cached_created > created
+        end
+      end
+      
+      def hive_tag(hive_slug)
+        author, permlink = parse_slug(hive_slug)
         
         api.get_content(author, permlink) do |content|
           body = content.body
@@ -57,24 +184,82 @@ module Jekyll
           
           body = body.gsub(/https:\/\/steemitimages.com\/[0-9]+x0\/https:\/\//, 'https://')
           body = body.gsub(/https:\/\/images.hive.blog\/[0-9]+x0\/https:\/\//, 'https://')
+          body = body.gsub(/https:\/\/images.esteem.app\/[0-9]+x0\/https:\/\//, 'https://')
           
-          # Although it works on hive.blog and many other markdown interpretors,
-          # kramdown doesn't like this, so we have to fix it:
-          # 
-          # <div>
-          #   This *won't* work.
-          # </div>
-          #
-          # See: https://stackoverflow.blog/2008/06/25/three-markdown-gotcha/
-          
-          body = body.gsub(/<([^\/].+)>(.+)<\/\1>/m) do
-            match = Regexp.last_match
-            html = Kramdown::Document.new(match[2]).to_html
-            
-            "<#{match[1]}>#{html.gsub("\n", "<br />")}</#{match[1]}>"
+          scrape = URI::open(canonical_url).read
+
+          if scrape.include? 'rel="canonical"'
+            canonical_url = scrape.split('rel="canonical"')[1].split('"')[1]
           end
-          
-          body + <<~DONE
+
+          "<div id=\"content-#{author}-#{permlink}\">" + body + <<~DONE
+          </div>
+          <script crossorigin='anonymous' integrity='sha256-4+XzXVhsDmqanXGHaHvgh1gMQKX40OUvDEBTu8JcmNs=' src='https://code.jquery.com/jquery-3.5.1.slim.min.js'></script>
+          <script src='https://unpkg.com/steem-content-renderer'></script>
+          <!-- <script src="https://cdn.jsdelivr.net/npm/hive-content-renderer/dist/hive-content-renderer.min.js"></script> -->
+          <script>
+            $(document).ready(function() {
+              try {
+                const renderer = new SteemContentRenderer.DefaultRenderer({
+                // const renderer = new HiveContentRenderer({
+                  baseUrl: "https://hive.blog/",
+                  breaks: true,
+                  skipSanitization: false,
+                  allowInsecureScriptTags: false,
+                  addNofollowToLinks: true,
+                  doNotShowImages: false,
+                  ipfsPrefix: "",
+                  assetsWidth: 640,
+                  assetsHeight: 480,
+                  imageProxyFn: (url) => url,
+                  usertagUrlFn: (account) => "/@#{author}",
+                  hashtagUrlFn: (hashtag) => "/#{permlink}",
+                  isLinkSafeFn: (url) => true,
+                });
+                
+                const inputElem = $('#content-#{author}-#{permlink}').html();
+                const outputElem = $('#content-#{author}-#{permlink}');
+                const output = renderer.render(inputElem);
+                
+                outputElem.html(output);
+              } catch(e) {
+                console.log(e);
+              }
+            });
+          </script>
+          <style>
+            #content-#{author}-#{permlink} {
+              padding: 0 3rem;
+              color: #444444;
+              font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif;
+              font-size: 16px;
+              line-height: 1.8;
+              text-shadow: 0 1px 0 #ffffff;
+              padding: 0.5rem;
+            }
+            #content-#{author}-#{permlink} code {
+              background: white;
+            }
+            #content-#{author}-#{permlink} a {
+              border-bottom: 1px solid #444444; color: #444444; text-decoration: none;
+            }
+            #content-#{author}-#{permlink} a:hover {
+              border-bottom: 0;
+            }
+            #content-#{author}-#{permlink} h1 {
+              font-size: 2.2em;
+            }
+            #content-#{author}-#{permlink} h2, h3, h4, h5 {
+              margin-bottom: 0;
+            }
+            #content-#{author}-#{permlink} header small {
+              color: #999;
+              font-size: 50%;
+            }
+            #content-#{author}-#{permlink} img {
+              max-width: 100%;
+            }
+          </style>
           \n<hr />
           <p>
             See: <a href="#{canonical_url}">#{content.title}</a>

data/lib/jekyll-hive/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Hive
-    VERSION = '1.0.0'
+    VERSION = '1.1.0'
   end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-hive
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Anthony Martin
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-01 00:00:00.000000000 Z
+date: 2022-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: steem-ruby
+  name: hive-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -150,7 +150,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - jekyll-hive@martin-studio.com
 executables: []
@@ -166,7 +166,7 @@ homepage: https://github.com/inertia186/jekyll-hive
 licenses:
 - CC0-1.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -181,9 +181,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.10
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Liquid tag for displaying Hive content in Jekyll sites.
 test_files: []