jekyll-webmention_io 2.1.0 → 2.2.0

data/lib/jekyll/generators/gather_webmentions.rb

@@ -12,31 +12,31 @@ module Jekyll
     priority :high
     
     def generate(site)
-			if site.config['webmentions']['pause_lookups'] == true
-				Jekyll::WebmentionIO::log 'info', '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')
+      if site.config['webmentions']['pause_lookups'] == true
+        Jekyll::WebmentionIO::log 'info', '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')
       # add an arbitrarily high perPage to trump pagination
       Jekyll::WebmentionIO::set_api_suffix('&perPage=9999')
 
-			cache_file = Jekyll::WebmentionIO::get_cache_file_path 'incoming'
-			if File.exists?(cache_file)
+      cache_file = Jekyll::WebmentionIO::get_cache_file_path 'incoming'
+      if File.exists?(cache_file)
         @cached_webmentions = open(cache_file) { |f| YAML.load(f) }
       else
         @cached_webmentions = {}
       end
-			
-			if Jekyll::VERSION >= "3.0.0"
-				posts = site.posts.docs
-			else
-				posts = site.posts
-			end
-
-			# post Jekyll commit 0c0aea3
+      
+      if Jekyll::VERSION >= "3.0.0"
+        posts = site.posts.docs
+      else
+        posts = site.posts
+      end
+
+      # 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)
@@ -44,201 +44,208 @@ module Jekyll
       else
         @converter = site.getConverterImpl(::Jekyll::Converters::Markdown)
       end
-				
+        
       posts.each do |post|
-				# Gather the URLs
-				targets = get_webmention_target_urls(site, post)
+        # Gather the URLs
+        targets = get_webmention_target_urls(site, post)
+        
+        # execute the API
+        api_params = targets.collect { |v| "target[]=#{v}" }.join('&')
+        response = Jekyll::WebmentionIO::get_response(api_params)
+        # @webmention_io.log 'info', response.inspect
         
-				# execute the API
-      	api_params = targets.collect { |v| "target[]=#{v}" }.join('&')
-      	response = Jekyll::WebmentionIO::get_response(api_params)
-      	# @webmention_io.log 'info', response.inspect
-				
-				process_webmentions( post.url, response )
+        process_webmentions( post.url, response )
       end # posts loop
 
       File.open(cache_file, 'w') { |f| YAML.dump(@cached_webmentions, f) }
-			
-			Jekyll::WebmentionIO::log 'info', 'Webmentions have been gathered and cached.'
-		end # generate
+      
+      Jekyll::WebmentionIO::log 'info', 'Webmentions have been gathered and cached.'
+    end # generate
 
     def get_webmention_target_urls(site, post)
       targets = []
       uri = "#{site.config['url']}#{post.url}"
-			targets.push( uri )
-			
-			# Redirection?
-			redirected = false
-			if post.data.has_key? 'redirect_from'
-				redirected = uri.sub post.url, post.data['redirect_from']
-				targets.push( redirected )
-			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}"
-					targets.push(legacy)
-				end
-			end
+      targets.push( uri )
+      
+      # Redirection?
+      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|
+            redirected = uri.sub post.url, redirect
+            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}"
+          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
-		end
-
-		def process_webmentions( post_uri, response )
-
-			# Get cached webmentions
-			if @cached_webmentions.has_key? post_uri
-				webmentions = @cached_webmentions[post_uri]
-			else
-				webmentions = {}
-			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
-
-					# Do we already have it?
-					if webmentions.has_key? 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
+    def markdownify( string )
+      string = @converter.convert("#{string}")
+      if ! string.start_with?('<p')
+        string = string.sub(/^<[^>]+>/, '<p>').sub(/<\/[^>]+>$/, '</p>')
+      end
+      string.strip
+    end
+
+    def process_webmentions( post_uri, response )
+
+      # Get cached webmentions
+      if @cached_webmentions.has_key? post_uri
+        webmentions = @cached_webmentions[post_uri]
+      else
+        webmentions = {}
+      end
+
+      if response and response['links']
         
-        	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
+        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
+
+          # Do we already have it?
+          if webmentions.has_key? 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 have the webmention
-        	if ! 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 )
+          # end
+
+          # Make sure we have the webmention
+          if ! 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?
+              
+              if ! html_source.valid_encoding?
                 html_source = html_source.encode('UTF-16be', :invalid=>:replace, :replace=>"?").encode('UTF-8')
               end
 
-							# Check the `title` first
+              # 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 )
+                # Fall back to the first `h1`
+                matches = /<h1>(.*)<\/h1>/.match( html_source )
                 if matches
                   title = matches[1].strip
                 else
-									# No title found
+                  # No title found
                   title = 'No title available'
                 end
               end
               
-							# cleanup
+              # cleanup
               title = title.gsub(%r{</?[^>]+?>}, '')
-						end # if no title
-						webmention['title'] = markdownify( title ) if title
+            end # if no title
+            webmention['title'] = markdownify( title ) if title
 
-						# Everything else
-						content = link['data']['content']
-						if type != 'post' && type != 'reply' && type != 'link'
-							content = link['activity']['sentence_html']
-						end
-						webmention['content'] = markdownify( content )
+            # Everything else
+            content = link['data']['content']
+            if type != 'post' && type != 'reply' && type != 'link'
+              content = link['activity']['sentence_html']
+            end
+            webmention['content'] = markdownify( content )
 
-						# Add it to the list
-						# @webmention_io.log 'info', webmention.inspect
-						webmentions[id] = webmention
+            # Add it to the list
+            # @webmention_io.log 'info', webmention.inspect
+            webmentions[id] = webmention
 
-					end # if ID does not exist
-				
-				end # each link
+          end # if ID does not exist
+        
+        end # each link
 
-			end # if response
+      end # if response
 
-			@cached_webmentions[post_uri] = webmentions
+      @cached_webmentions[post_uri] = webmentions
 
-		end # process_webmentions
+    end # process_webmentions
 
   end
 end

data/lib/jekyll/tags/_.rb

@@ -49,8 +49,8 @@ module Jekyll
         # Jekyll::WebmentionIO::log 'info', "template: #{@template}"
       end
 
-      def set_data(data)
-        @data = { 'webmentions' => data }
+      def set_data( data, types )
+        @data = { 'webmentions' => data, 'types' => types }
       end
 
       def extract_type( type, webmentions )
@@ -83,6 +83,9 @@ module Jekyll
         uri = args.shift
         uri = lookup(context, uri)
 
+        # capture the types in case JS needs them
+        types = []
+
         if @cached_webmentions.has_key? uri
           all_webmentions =  @cached_webmentions[uri].clone
           # Jekyll::WebmentionIO::log 'info', "#{all_webmentions.length} total webmentions for #{uri}"
@@ -90,6 +93,7 @@ module Jekyll
             # Jekyll::WebmentionIO::log 'info', "Requesting only #{args.inspect}"
             webmentions = {}
             args.each do |type|
+              types.push type
               extracted = extract_type( type, all_webmentions )
               # Jekyll::WebmentionIO::log 'info', "Merging in #{extracted.length} #{type}"
               webmentions = webmentions.merge( extracted )
@@ -105,7 +109,7 @@ module Jekyll
 
           webmentions = sort_webmentions( webmentions )
           
-          set_data( webmentions )
+          set_data( webmentions, types )
         end
         
         args = nil

data/lib/jekyll/tags/count.rb

@@ -17,8 +17,8 @@ module Jekyll
         set_template 'count'
       end
 
-      def set_data(data)
-        @data = { 'count' => data.length }
+      def set_data( data, types )
+        @data = { 'count' => data.length, 'types' => types }
       end
 
     end

data/lib/jekyll/tags/likes.rb

@@ -17,7 +17,7 @@ module Jekyll
         set_template 'likes'
       end
 
-      def set_data(data)
+      def set_data( data, types )
         webmentions = extract_type 'likes', data
         @data = { 'webmentions' => webmentions.values }
       end

data/lib/jekyll/tags/links.rb

@@ -17,7 +17,7 @@ module Jekyll
         set_template 'links'
       end
 
-      def set_data(data)
+      def set_data( data, types )
         webmentions = extract_type 'links', data
         @data = { 'webmentions' => webmentions.values }
       end

data/lib/jekyll/tags/posts.rb

@@ -17,7 +17,7 @@ module Jekyll
         set_template 'posts'
       end
 
-      def set_data(data)
+      def set_data( data, types )
         webmentions = extract_type 'posts', data
         @data = { 'webmentions' => webmentions.values }
       end

data/lib/jekyll/tags/replies.rb

@@ -17,7 +17,7 @@ module Jekyll
         set_template 'replies'
       end
 
-      def set_data(data)
+      def set_data( data, types )
         webmentions = extract_type 'replies', data
         @data = { 'webmentions' => webmentions.values }
       end

data/lib/jekyll/tags/reposts.rb

@@ -17,7 +17,7 @@ module Jekyll
         set_template 'reposts'
       end
 
-      def set_data(data)
+      def set_data( data, types )
         webmentions = extract_type 'reposts', data
         @data = { 'webmentions' => webmentions.values }
       end

data/lib/jekyll/tags/webmentions_head.rb

@@ -0,0 +1,34 @@
+#  (c) Aaron Gustafson
+#  https://github.com/aarongustafson/jekyll-webmention_io 
+#  Licence : MIT
+#  
+#  Stuff for the `head`
+#
+
+module Jekyll
+  module WebmentionIO
+    class WebmentionHeadTag < Liquid::Tag
+      def render(context)
+        head = ''
+        head << '<link rel="dns-prefetch" href="//webmention.io">'
+        head << '<link rel="preconnect" href="//webmention.io">'
+        head << '<link rel="preconnect" href="ws://webmention.io:8080">'
+        
+        page = context['page']
+        site = context.registers[:site]
+        if page['redirect_from']
+          if page['redirect_from'].is_a? String
+            redirect = site.config['url'] + page['redirect_from']
+          elsif page['redirect_from'].is_a? Array
+            redirect = site.config['url'] + page['redirect_from'].join(",#{site.config['url']}")
+          end
+          head << "<meta property=\"webmention:redirected_from\" content=\"#{redirect}\">"
+        end
+
+        head
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('webmentions_head', Jekyll::WebmentionIO::WebmentionHeadTag)

data/lib/jekyll/tags/webmentions_js.rb

@@ -0,0 +1,56 @@
+#  (c) Aaron Gustafson
+#  https://github.com/aarongustafson/jekyll-webmention_io 
+#  Licence : MIT
+#  
+#  JS stuff
+#
+
+module Jekyll
+  module WebmentionIO
+    class WebmentionJSTag < Liquid::Tag
+      def render(context)
+        site = context.registers[:site]
+
+        # JS can be turned off too
+        if site.config['webmentions']['js'] == false
+          return
+        end
+
+        config = {
+          'destination' => "js",
+          'uglify'      => true
+        }
+        site_config = site.config['webmentions']['js'] || {}        
+        config = config.merge(site_config)
+
+        # JS file
+        js = ''
+        unless config['deploy'] == false
+          js_file_path = "#{site.config['baseurl']}/#{config['destination']}/JekyllWebmentionIO.js"
+          js << "<script src=\"#{js_file_path}\" async></script>"
+        end
+        
+        templates = ''
+        template_files = Jekyll::WebmentionIO::types + ['count', 'webmentions']
+        template_files.each do |template|
+          if Jekyll::WebmentionIO::config.has_key? 'templates' and Jekyll::WebmentionIO::config['templates'].has_key? template
+            # Jekyll::WebmentionIO::log 'info', "Using custom #{template} template"
+            template_file = Jekyll::WebmentionIO::config['templates'][template]
+          else
+            # Jekyll::WebmentionIO::log 'info', "Using default #{template} template"
+            template_file = File.join(File.dirname(File.expand_path(__FILE__)), "../templates/#{template}.html")
+          end
+          # Jekyll::WebmentionIO::log 'info', "Template file: #{template_file}"
+          handler = File.open(template_file, 'rb')
+          template_contents = handler.read
+
+          templates << "<template id=\"webmention-#{template}\">#{template_contents}</template>"
+        end
+        
+        "#{js}\n#{templates}"
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('webmentions_js', Jekyll::WebmentionIO::WebmentionJSTag)

data/lib/jekyll/templates/count.html

@@ -1 +1,2 @@
-<span class="webmention-count">{{ count }}</span>
+{% capture webmention_types %}{{ types | join: ',' }}{% endcapture %}
+<span class="webmention-count"{% unless webmention_types=="" %} data-webmention-types="{{ webmention_types }}"{% endunless %}>{{ count }}</span>

data/lib/jekyll/templates/likes.html

@@ -1,17 +1,17 @@
 <div class="webmentions webmentions--likes">
-	{% if webmentions.size > 0 %}
-		<ol class="webmentions__list">
-			{% for webmention in webmentions %}
-				<li id="webmention-{{ webmention.id }}" class="webmentions__item webmention webmention--{{ webmention.type }}">
-					<div class="webmention__author p-author h-card">
-						<a class="u-url" href="{{ webmention.author.url }}">
-							<img class="webmention__author__photo u-photo" src="{{ webmention.author.photo }}" alt="" title="{{ webmention.author.name }}">
-						</a>
-					</div>
-				</li>
-			{% endfor %}
-		</ol>
-	{% else %}
-		<p class="webmentions__not-found">No likes were found.</p>
-	{% endif %}
+  {% if webmentions.size > 0 %}
+    <ol class="webmentions__list">
+      {% for webmention in webmentions %}
+        <li id="webmention-{{ webmention.id }}" class="webmentions__item webmention webmention--{{ webmention.type }}">
+          <div class="webmention__author p-author h-card">
+            <a class="u-url" href="{{ webmention.author.url }}">
+              <img class="webmention__author__photo u-photo" src="{{ webmention.author.photo }}" alt="" title="{{ webmention.author.name }}">
+            </a>
+          </div>
+        </li>
+      {% endfor %}
+    </ol>
+  {% else %}
+    <p class="webmentions__not-found">No likes were found.</p>
+  {% endif %}
 </div>