jekyll-webmention_io 2.8.5 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b5797938c7edc67cf30f84ea7079aaf44293268
-  data.tar.gz: d0d64fa0c5d4c4d9dce060e3f4499793caff3b13
+  metadata.gz: c67e6633b782bf90538bbd1da5a0ee6edc8c5d82
+  data.tar.gz: e43d1c4535118b448c5fd904792a576cb2582ff3
 SHA512:
-  metadata.gz: 1571cab78b2e870e96f9ba8944a3ad7c2154e289b112c576d6feefd307aec0c58ab53ddbd5481609f83955216e2501809798539a049ee7ff7ac66f8cd43cde2a
-  data.tar.gz: 54c195772469964258f051dcc4cd13780a1321d125940a407a26f0a48c59dfd83848c8851734a31069fe89c312baa60bc1ab2da82dc7d5309b411608dcb8cee4
+  metadata.gz: 022432117c194e4a4062c829faeb5ecf9d93814ffa8637f00181be95a97a66d981fa5a38ab2d2787a9ec343efeeb78edbc4ed4c0c2ee37edeb01749626040b08
+  data.tar.gz: 5d291d9f6daa5517ed4e5884988e64ff23f562b900682c177a9622451e79be23014c40862aca4a551d7756f46b292b0dddffb1aa49b0b2923e3d2ed537c743db

data/lib/jekyll/assets/JekyllWebmentionIO.js

@@ -1,3 +1,4 @@
+// @ts-check
 (function(window, document){
   
   // prerequisites
@@ -20,7 +21,7 @@
     // console.log( 'incoming webmentions', data.links );
     if ( data && ! ( 'error' in data ) )
     {
-      webmentions = data.links.reverse();
+      var webmentions = data.links.reverse();
       
       webmentions = rationalizeIds( webmentions );
       
@@ -158,7 +159,11 @@
         webmention,
         incoming = {},
         queue_keys = Object.keys( webmention_receivers ),
-        plural_type;
+        plural_type,
+        typeFilter = function(key) {
+          return JekyllWebmentionIO.types[key] === this.type;
+        },
+        typeFilterLoop;
     
     // set up the queues
     i = queue_keys.length;
@@ -169,14 +174,14 @@
 
     // Assign the webmentions to their respective queues
     i = webmentions.length;
+    
     while ( i-- )
     {
       webmention = webmentions[i];
       // reverse lookup to get the plural from the singular
+      typeFilterLoop = typeFilter.bind(webmention);
       plural_type = Object.keys(JekyllWebmentionIO.types)
-                          .filter(function(key) {
-                            return JekyllWebmentionIO.types[key] === webmention.type;
-                          })[0];
+                          .filter(typeFilterLoop)[0];
       
       // Is there a specific queue requesting this?
       if ( queue_keys.indexOf( plural_type ) > -1 )
@@ -320,8 +325,21 @@
 
     var i = webmentions.length,
         webmention,
-        webmention_object;
-    
+        webmention_object,
+        uri,
+        source,
+        pubdate,
+        type,
+        title,
+        content,
+        read = function( html_source ){
+          if ( html_source )
+          {
+            updateTitle( this.id, this.uri, html_source );
+          }
+        },
+        loop_read;
+
     while ( i-- )
     {
       webmention = webmentions[i];
@@ -394,16 +412,15 @@
       title = false;
       if ( type == 'post' )
       {
-        readWebPage( uri, function( html_source ){
-          if ( html_source )
-          {
-            updateTitle( webmention_object.id, uri, html_source );
-          }
+        loop_read = read.bind({
+          id: webmention_object.id,
+          uri: uri
         });
+        readWebPage( uri, loop_read );
       }
 
       content = webmention.data.content;
-      if ( type != 'post' && type != 'reply' && type != 'link' )
+      if ( type != 'bookmark' && type != 'link' && type != 'post' && type != 'reply' )
       {
         content = webmention.activity.sentence_html;
       }
@@ -460,7 +477,7 @@
         // cleanup
         title = title.replace( /<\/?[^>]+?>}/, '' );
         $link_title = document.createElement('a');
-        $link_title.href = uri;
+        $link_title.href = url;
         $link_title.appendChild( document.createTextNode( title ) );
         // replace title contents
         $current_title.innerHTML = $link_title.outerHTML;
@@ -483,7 +500,7 @@
               callback( XHR.responseText );
             }
           };
-          xhr.onabort = function() {
+          XHR.onabort = function() {
             if ( ! done )
             {
               done = true;

data/lib/jekyll/assets/_utils.js

@@ -1,3 +1,4 @@
+// @ts-check
 /**
  *  WebMentions.io JS
  *  A re-tooling of Aaron Parecki’s recommended JS for using the WebMention.io API

data/lib/jekyll/assets/webmention_counters.js

@@ -1,4 +1,5 @@
-;(function(window, document){
+// @ts-check
+;(function(window, document, JekyllWebmentionIO){
   'use strict';
   
   // prerequisites

data/lib/jekyll/assets/webmention_loader.js

@@ -1,3 +1,4 @@
+// @ts-check
 (function(window, document){
   
   // prerequisites

data/lib/jekyll/commands/webmention.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 require "json"
 
 module Jekyll
@@ -19,31 +21,30 @@ module Jekyll
         count = 0
         cached_outgoing = Jekyll::WebmentionIO.get_cache_file_path "outgoing"
         if File.exist?(cached_outgoing)
-          outgoing = open(cached_outgoing) { |f| YAML.safe_load(f) }
+          outgoing = open(cached_outgoing) { |f| YAML.load(f) }
           outgoing.each do |source, targets|
             targets.each do |target, response|
-              next unless response === false
-              if target.index("//") == 0
+              next unless response == false
+              if target.index("//").zero?
                 target = "http:#{target}"
               end
               endpoint = Jekyll::WebmentionIO.get_webmention_endpoint(target)
               next unless endpoint
               response = Jekyll::WebmentionIO.webmention(source, target, endpoint)
-              if response
-                begin
-                  response = JSON.parse response
-                rescue JSON::ParserError => e  
-                  response = ''
-                end 
-                outgoing[source][target] = response
-                count += 1
+              next unless response
+              begin
+                response = JSON.parse response
+              rescue JSON::ParserError
+                response = ""
               end
+              outgoing[source][target] = response
+              count += 1
             end
           end
-          if count > 0
+          if count.positive?
             File.open(cached_outgoing, "w") { |f| YAML.dump(outgoing, f) }
           end
-          Jekyll::WebmentionIO.log "info", "#{count} webmentions sent."
+          Jekyll::WebmentionIO.log "msg", "#{count} webmentions sent."
         end # file exists (outgoing)
       end # def process
     end # WebmentionCommand

data/lib/jekyll/generators/compile_js.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 #  (c) Aaron Gustafson
 #  https://github.com/aarongustafson/jekyll-webmention_io
 #  Licence : MIT
@@ -26,7 +28,10 @@ module Jekyll
       priority :low
 
       def generate(site)
-        if site.config.dig("webmentions", "js") == false
+        @site = site
+        @file_name = "JekyllWebmentionIO.js"
+
+        if @site.config.dig("webmentions", "js") == false
           Jekyll::WebmentionIO.log "info", "Skipping JavaScript inclusion."
           return
         end
@@ -35,19 +40,29 @@ module Jekyll
           "destination" => "js",
           "uglify"      => true,
         }
-        site_config = site.config.dig("webmentions", "js") || {}
-
+        site_config = @site.config.dig("webmentions", "js") || {}
         config = config.merge(site_config)
 
-        source = File.expand_path("../assets/", __dir__)
+        @source_file_destination = (config["source"] == false ? Dir.mktmpdir : "#{@site.config["source"]}/#{config["destination"]}")
 
-        javascript = ""
-        Dir["#{source}/*.js"].each do |file|
-          handler = File.open(file, "rb")
-          javascript << File.read(handler)
+        @javascript = ""
+
+        concatenate_asset_files
+
+        add_webmention_types
+
+        unless config["uglify"] == false
+          uglify
+        end
+
+        create_js_file
+
+        unless config["deploy"] == false
+          deploy_js_file
         end
+      end
 
-        # Dump in types
+      private def add_webmention_types
         js_types = []
         Jekyll::WebmentionIO.types.each do |type|
           js_types.push "'#{type}': '#{type.to_singular}'"
@@ -58,24 +73,32 @@ module Jekyll
             JekyllWebmentionIO.types = { TYPES };
           }(this, this.JekyllWebmentionIO));
         EOF
-        javascript << types_js.sub(%r!TYPES!, js_types.join(","))
+        @javascript << types_js.sub(/TYPES/, js_types.join(","))
+      end
 
-        unless config["uglify"] == false
-          uglify_config = {
-            :harmony => true,
-          }
-          javascript = Uglifier.new(uglify_config).compile(javascript)
+      private def concatenate_asset_files
+        source = File.expand_path("../assets/", __dir__)
+        Dir["#{source}/*.js"].each do |file|
+          handler = File.open(file, "rb")
+          @javascript << File.read(handler)
         end
+      end
 
-        # Generate the file
-        file_name = "JekyllWebmentionIO.js"
-        source_file_destination = (config["source"] == false ? Dir.mktmpdir : "#{site.config["source"]}/#{config["destination"]}")
-        Dir.mkdir(source_file_destination) unless File.exist?(source_file_destination)
-        File.open("#{source_file_destination}/#{file_name}", "w") { |f| f.write(javascript) }
-        unless config["deploy"] == false
-          js_file = Jekyll::WebmentionIO::JavaScriptFile.new(site, source_file_destination, "", file_name)
-          site.static_files << js_file
-        end
+      private def uglify
+        uglify_config = {
+          :harmony => true,
+        }
+        @javascript = Uglifier.new(uglify_config).compile(@javascript)
+      end
+
+      private def create_js_file
+        Dir.mkdir(@source_file_destination) unless File.exist?(@source_file_destination)
+        File.open("#{@source_file_destination}/#{@file_name}", "w") { |f| f.write(@javascript) }
+      end
+
+      private def deploy_js_file
+        js_file = Jekyll::WebmentionIO::JavaScriptFile.new(@site, @source_file_destination, "", @file_name)
+        @site.static_files << js_file
       end
     end
   end

data/lib/jekyll/generators/gather_webmentions.rb

@@ -1,263 +1,148 @@
+# frozen_string_literal: false
+
 #  (c) Aaron Gustafson
-#  https://github.com/aarongustafson/jekyll-webmention_io 
+#  https://github.com/aarongustafson/jekyll-webmention_io
 #  Licence : MIT
-#  
+#
 #  This generator gathers webmentions of your pages
 #
 
+require "time"
+
 module Jekyll
   class GatherWebmentions < Generator
-    
     safe true
     priority :high
-    
+
     def generate(site)
-      if site.config.dig( 'webmentions', 'pause_lookups' ) == true
-        Jekyll::WebmentionIO::log 'info', 'Webmention lookups are currently paused.'
+      @site = site
+
+      if @site.config.dig("webmentions", "pause_lookups") == true
+        Jekyll::WebmentionIO.log "msg", "Webmention lookups are currently paused."
         return
       end
 
-      Jekyll::WebmentionIO::log 'info', 'Beginning to gather webmentions of your posts. This may take a while.'
-      
-      Jekyll::WebmentionIO::set_api_endpoint('mentions')
+      Jekyll::WebmentionIO.log "msg", "Beginning to gather webmentions of your posts. This may take a while."
+
+      Jekyll::WebmentionIO.api_path = "mentions"
       # add an arbitrarily high perPage to trump pagination
-      Jekyll::WebmentionIO::set_api_suffix('&perPage=9999')
+      Jekyll::WebmentionIO.api_suffix = "&perPage=9999"
 
-      cache_file = Jekyll::WebmentionIO::get_cache_file_path 'incoming'
-      @cached_webmentions = open(cache_file) { |f| YAML.load(f) }
-      
-      if Jekyll::VERSION >= "3.0.0"
-        posts = site.posts.docs
-      else
-        posts = site.posts
-      end
+      @cached_webmentions = Jekyll::WebmentionIO.read_cached_webmentions "incoming"
 
-      # post Jekyll commit 0c0aea3
-      # https://github.com/jekyll/jekyll/commit/0c0aea3ad7d2605325d420a23d21729c5cf7cf88
-      if defined? site.find_converter_instance
-        @converter = site.find_converter_instance(::Jekyll::Converters::Markdown)
-      # Prior to Jekyll commit 0c0aea3
-      else
-        @converter = site.getConverterImpl(::Jekyll::Converters::Markdown)
-      end
-        
+      posts = Jekyll::WebmentionIO.gather_documents(@site)
       posts.each do |post|
-        # get the last webmention
-        last_webmention = @cached_webmentions.dig( post.url,  @cached_webmentions.dig( post.url )&.keys&.last )
-        
-        # should we throttle?
-        if last_webmention && Jekyll::WebmentionIO::post_should_be_throttled?( post, post.date, last_webmention.dig( 'raw', 'verified_date' ) )
-          # Jekyll::WebmentionIO::log 'info', "Throttling #{post.url}"    
-          next
+        check_for_webmentions(post)
+      end
+
+      Jekyll::WebmentionIO.cache_webmentions "incoming", @cached_webmentions
+    end # generate
+
+    private
+
+    def check_for_webmentions(post)
+      Jekyll::WebmentionIO.log "info", "Checking for webmentions of #{post.url}."
+
+      # get the last webmention
+      last_webmention = @cached_webmentions.dig(post.url, @cached_webmentions.dig(post.url)&.keys&.last)
+
+      # should we throttle?
+      if post.respond_to? "date" # Some docs have no date
+        if last_webmention && Jekyll::WebmentionIO.post_should_be_throttled?(post, post.date, last_webmention.dig("raw", "verified_date"))
+          Jekyll::WebmentionIO.log "info", "Throttling this post."
+          return
         end
+      end
 
-        # past_webmentions.dig( past_webmentions&.keys&.last )
-        # past_webmentions[past_webmentions.keys.last]['raw']['verified_date']
+      # Get the last id we have in the hash
+      since_id = last_webmention ? last_webmention.dig("raw", "id") : false
 
-        # Get the last id we have in the hash
-        since_id = last_webmention ? last_webmention.dig( 'raw', 'id' ) : false
-        
-        # Gather the URLs
-        targets = get_webmention_target_urls(site, post)
+      # Gather the URLs
+      targets = get_webmention_target_urls(post)
 
-        # execute the API
-        api_params = targets.collect { |v| "target[]=#{v}" }.join('&')
-        api_params << "&since_id=#{since_id}" if since_id
-        response = Jekyll::WebmentionIO::get_response(api_params)
-        # Jekyll::WebmentionIO::log "info", response.inspect
-        
-        process_webmentions( post.url, response )
-      end # posts loop
+      # execute the API
+      response = Jekyll::WebmentionIO.get_response assemble_api_params(targets, since_id)
+      webmentions = response.dig("links")
+      if webmentions && !webmentions.empty?
+        Jekyll::WebmentionIO.log "info", "Here’s what we got back:\n\n#{response.inspect}\n\n"
+      else
+        Jekyll::WebmentionIO.log "info", "No webmentions found."
+      end
 
-      File.open(cache_file, 'w') { |f| YAML.dump(@cached_webmentions, f) }
-      
-      Jekyll::WebmentionIO::log 'info', 'Webmentions have been gathered and cached.'
-    end # generate
+      cache_new_webmentions(post.url, response)
+    end
 
-    def get_webmention_target_urls(site, post)
+    def get_webmention_target_urls(post)
       targets = []
-      uri = "#{site.config['url']}#{post.url}"
-      targets.push( uri )
-      
+      base_uri = @site.config["url"].chomp("/")
+      uri = "#{base_uri}#{post.url}"
+      targets.push(uri)
+
       # Redirection?
+      gather_redirected_targets(post, uri, targets)
+
+      # Domain changed?
+      gather_legacy_targets(uri, targets)
+
+      targets
+    end
+
+    def gather_redirected_targets(post, uri, targets)
       redirected = false
-      if post.data.has_key? 'redirect_from'
-        if post.data['redirect_from'].is_a? String
-          redirected = uri.sub post.url, post.data['redirect_from']
-          targets.push( redirected )
-        elsif post.data['redirect_from'].is_a? Array
-          post.data['redirect_from'].each do |redirect|
+      if post.data.key? "redirect_from"
+        if post.data["redirect_from"].is_a? String
+          redirected = uri.sub post.url, post.data["redirect_from"]
+          targets.push(redirected)
+        elsif post.data["redirect_from"].is_a? Array
+          post.data["redirect_from"].each do |redirect|
             redirected = uri.sub post.url, redirect
-            targets.push( redirected )
-          end					
+            targets.push(redirected)
+          end
         end
       end
-      
-      # Domain changed?
-      if Jekyll::WebmentionIO::config.has_key? 'legacy_domains'
-        # Jekyll::WebmentionIO::log 'info', 'adding legacy URIs'
-        Jekyll::WebmentionIO::config['legacy_domains'].each do |domain|
-          legacy = uri.sub site.config['url'], domain
-          # Jekyll::WebmentionIO::log 'info', "adding URI #{legacy}"
+    end
+
+    def gather_legacy_targets(uri, targets)
+      if Jekyll::WebmentionIO.config.key? "legacy_domains"
+        Jekyll::WebmentionIO.log "info", "adding legacy URIs"
+        Jekyll::WebmentionIO.config["legacy_domains"].each do |domain|
+          legacy = uri.sub @site.config["url"], domain
+          Jekyll::WebmentionIO.log "info", "adding URI #{legacy}"
           targets.push(legacy)
         end
       end
-      return targets
     end
 
-    def markdownify( string )
-      string = @converter.convert("#{string}")
-      if ! string.start_with?('<p')
-        string = string.sub(/^<[^>]+>/, '<p>').sub(/<\/[^>]+>$/, '</p>')
-      end
-      string.strip
+    def assemble_api_params(targets, since_id)
+      api_params = targets.collect { |v| "target[]=#{v}" }.join("&")
+      api_params << "&since_id=#{since_id}" if since_id
+      api_params << "&sort-by=published"
+      api_params
     end
 
-    def process_webmentions( post_uri, response )
-
+    def cache_new_webmentions(post_uri, response)
       # Get cached webmentions
-      if @cached_webmentions.has_key? post_uri
-        webmentions = @cached_webmentions[post_uri]
-      else
-        webmentions = {}
-      end
+      webmentions = if @cached_webmentions.key? post_uri
+                      @cached_webmentions[post_uri]
+                    else
+                      {}
+                    end
 
-      if response and response['links']
-        
-        response['links'].reverse_each do |link|
-          
-          uri = link['data']['url'] || link['source']
-
-          # set the source
-          source = false
-          if uri.include? 'twitter.com/'
-            source = 'twitter'
-          elsif uri.include? '/googleplus/'
-            source = 'googleplus'
-          end
-          
-          # set an id
-          id = link['id'].to_s
-          if source == 'twitter' and ! uri.include? '#favorited-by'
-            id = URI(uri).path.split('/').last.to_s
-          end
-          if ! id
-            time = Time.now();
-            id = time.strftime('%s').to_s
-          end
+      if response && response["links"]
+        response["links"].reverse_each do |link|
+          webmention = Jekyll::WebmentionIO::Webmention.new(link, @site)
 
           # Do we already have it?
-          if webmentions.has_key? id
+          if webmentions.key? webmention.id
             next
           end
 
-          # Get the mentioned URI, stripping fragments and query strings
-          #target = URI::parse( link['target'] )
-          #target.fragment = target.query = nil
-          #target = target.to_s
-        
-          pubdate = link['data']['published_ts']
-          if pubdate
-            pubdate = Time.at(pubdate)
-          elsif link['verified_date']
-            pubdate = Time.parse(link['verified_date'])
-          end
-          #the_date = pubdate.strftime('%s')
-
-          # Make sure we have the date
-          # if ! webmentions.has_key? the_date
-          # 	webmentions[the_date] = {}
-          # end
-
-          # Make sure we don’t have the webmention
-          unless webmentions.has_key? id
-            
-            # Scaffold the webmention
-            webmention = {
-              'id'			=> id,
-              'url'			=> uri,
-              'source'	=> source,
-              'pubdate' => pubdate,
-              'raw'			=> link
-            }
-
-            # Set the author
-            if link['data'].has_key? 'author'
-              webmention['author'] = link['data']['author']
-            end
-
-            # Set the type
-            type = link['activity']['type']
-            if ! type
-              if source == 'googleplus'
-                if uri.include? '/like/'
-                  type = 'like'
-                elsif uri.include? '/repost/'
-                  type = 'repost'
-                elsif uri.include? '/comment/'
-                  type = 'reply'
-                else
-                  type = 'link'
-                end
-              else
-                type = 'post'
-              end
-            end # if no type
-            webmention['type'] = type
-
-            # Posts
-            title = false
-            if type == 'post'
-
-              html_source = Jekyll::WebmentionIO::get_uri_source( uri )
-              if ! html_source
-                next
-              end
-              
-              if ! html_source.valid_encoding?
-                html_source = html_source.encode('UTF-16be', :invalid=>:replace, :replace=>"?").encode('UTF-8')
-              end
-
-              # Check the `title` first
-              matches = /<title>(.*)<\/title>/.match( html_source )
-              if matches
-                title = matches[1].strip
-              else
-                # Fall back to the first `h1`
-                matches = /<h1>(.*)<\/h1>/.match( html_source )
-                if matches
-                  title = matches[1].strip
-                else
-                  # No title found
-                  title = 'No title available'
-                end
-              end
-              
-              # cleanup
-              title = title.gsub(%r{</?[^>]+?>}, '')
-            end # if no title
-            webmention['title'] = markdownify( title ) if title
-
-            # Everything else
-            content = link['activity']['sentence_html']
-            if ['post', 'reply', 'link'].include? type
-              content = link['data']['content'] if link.dig( 'data', 'content' )
-            end
-            webmention['content'] = markdownify( content )
-
-            # Add it to the list
-            # @webmention_io.log 'info', webmention.inspect
-            webmentions[id] = webmention
-
-          end # Make sure we don’t have the webmention
-        
+          # Add it to the list
+          Jekyll::WebmentionIO.log "info", webmention.to_hash.inspect
+          webmentions[webmention.id] = webmention.to_hash
         end # each link
-
       end # if response
-
       @cached_webmentions[post_uri] = webmentions
-
     end # process_webmentions
-
   end
-end
+end