jekyll-webmention_io 2.8.5 → 2.9.0

data/lib/jekyll/tags/rsvps.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: false
+
+#  (c) Aaron Gustafson
+#  https://github.com/aarongustafson/jekyll-webmention_io
+#  Licence : MIT
+#
+#  this liquid plugin insert a webmentions into your Octopress or Jekill blog
+#  using http://webmention.io/ and the following syntax:
+#
+#    {% webmention_rsvps post.url %}
+#
+module Jekyll
+  module WebmentionIO
+    class WebmentionRsvpsTag < Jekyll::WebmentionIO::WebmentionTag
+      def initialize(tag_name, text, tokens)
+        super
+        @text = text
+        self.template = "rsvps"
+      end
+
+      def set_data(data, _types)
+        webmentions = extract_type "rsvps", data
+        @data = { "webmentions" => webmentions.values }
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("webmention_rsvps", Jekyll::WebmentionIO::WebmentionRsvpsTag)

data/lib/jekyll/tags/webmentions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 #  (c) Aaron Gustafson
 #  https://github.com/aarongustafson/jekyll-webmention_io
 #  Licence : MIT
@@ -5,15 +7,15 @@
 #  this liquid plugin insert a webmentions into your Octopress or Jekill blog
 #  using http://webmention.io/ and the following syntax:
 #
-#    {% webmentions post.url [ likes | links | posts | replies | reposts ]*  %}
+#    {% webmentions post.url [ bookmarks | likes | links | posts | replies | reposts | rsvps ]*  %}
 #
 module Jekyll
   module WebmentionIO
     class WebmentionsTag < Jekyll::WebmentionIO::WebmentionTag
-      def initialize(tagName, text, tokens)
+      def initialize(tag_name, text, tokens)
         super
         @text = text
-        set_template "webmentions"
+        self.template = "webmentions"
       end
     end
   end

data/lib/jekyll/tags/webmentions_head.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 #  (c) Aaron Gustafson
 #  https://github.com/aarongustafson/jekyll-webmention_io
 #  Licence : MIT

data/lib/jekyll/tags/webmentions_js.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 #  (c) Aaron Gustafson
 #  https://github.com/aarongustafson/jekyll-webmention_io
 #  Licence : MIT
@@ -31,6 +33,7 @@ module Jekyll
           js << "<script src=\"#{js_file_path}\" async></script>"
         end
 
+        Jekyll::WebmentionIO.log "info", "Gathering templates for JavaScript."
         templates = ""
         template_files = Jekyll::WebmentionIO.types + %w(count webmentions)
         template_files.each do |template|

data/lib/jekyll/templates/bookmarks.html

@@ -0,0 +1,26 @@
+<div class="webmentions webmentions--bookmarks">
+  {% 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__content p-content">
+            {{ webmention.content }}
+          </div>
+          <div class="webmention__meta">
+            {% if webmention.author %}
+              <a class="webmention__author h-card u-url" href="{{ webmention.author.url }}">{{ webmention.author.name }}</a>
+            {% endif %}
+            {% if webmention.pubdate and webmention.url %}on{% endif %}
+            {% if webmention.pubdate %}
+              <a class="webmention__source u-url" href="{{ webmention.url }}">
+                <time class="webmention__pubdate dt-published" datetime="{{ webmention.pubdate | date: '%FT%T%:z' }}">{{ webmention.pubdate | date: '%d %B %Y' }}</time>
+              </a>
+            {% endif %}
+          </div>
+        </li>
+      {% endfor %}
+    </ol>
+  {% else %}
+    <p class="webmentions__not-found">No bookmarks were found.</p>
+  {% endif %}
+</div>

data/lib/jekyll/templates/links.html

@@ -21,6 +21,6 @@
       {% endfor %}
     </ol>
   {% else %}
-    <p class="webmentions__not-found">No webmentions were found.</p>
+    <p class="webmentions__not-found">No links were found.</p>
   {% endif %}
 </div>

data/lib/jekyll/templates/posts.html

@@ -13,6 +13,6 @@
       {% endfor %}
     </ol>
   {% else %}
-    <p class="webmentions__not-found">No webmentions were found.</p>
+    <p class="webmentions__not-found">No posts were found.</p>
   {% endif %}
 </div>

data/lib/jekyll/templates/replies.html

@@ -26,6 +26,6 @@
       {% endfor %}
     </ol>
   {% else %}
-    <p class="webmentions__not-found">No webmentions were found.</p>
+    <p class="webmentions__not-found">No replies were found.</p>
   {% endif %}
 </div>

data/lib/jekyll/templates/rsvps.html

@@ -0,0 +1,19 @@
+<div class="webmentions webmentions--rsvps">
+  {% 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="Avatar for {{ webmention.author.name }}" title="{{ webmention.author.name }}">
+              <b class="p-name">{{ webmention.author.name }}</b>
+              {{ webmention.content }}
+            </a>
+          </div>
+        </li>
+      {% endfor %}
+    </ol>
+  {% else %}
+    <p class="webmentions__not-found">No RSVPs were found.</p>
+  {% endif %}
+</div>

data/lib/jekyll/webmention_io/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: false
+
 module Jekyll
   module WebmentionIO
-    VERSION = "2.8.5".freeze
+    VERSION = "2.9.0".freeze
   end
 end

data/lib/jekyll/webmention_io/webmention.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: false
+
+#  (c) Aaron Gustafson
+#  https://github.com/aarongustafson/jekyll-webmention_io
+#  Licence : MIT
+#
+#  this liquid plugin insert a webmentions into your Octopress or Jekill blog
+#  using http://webmention.io/ and the following syntax:
+#
+module Jekyll
+  module WebmentionIO
+    class Webmention
+      attr_reader :id, :hash
+
+      def initialize(mention, site)
+        @raw = mention
+        @site = site
+
+        @uri = determine_uri
+        @source = determine_source
+        @id = determine_id
+        @type = determine_type
+      end
+
+      def to_hash
+        gather_content
+
+        the_hash = {
+          "id"      => @id,
+          "uri"     => @uri,
+          "source"  => @source,
+          "pubdate" => @pubdate,
+          "raw"     => @raw,
+          "author"  => @author,
+          "type"    => @type,
+        }
+
+        the_hash["title"] = @title if @title
+        the_hash["content"] = @content || ""
+
+        the_hash
+      end
+
+      private
+
+      def gather_content
+        @pubdate = determine_pubdate
+        @author = determine_author
+        @title = determine_title
+        @content = determine_content
+      end
+
+      def markdownify(string)
+        unless @converter
+          @converter = if defined? @site.find_converter_instance
+                         @site.find_converter_instance(::Jekyll::Converters::Markdown)
+                       else
+                         @site.getConverterImpl(::Jekyll::Converters::Markdown)
+                       end
+        end
+
+        if string
+          string = @converter.convert(string.to_s)
+          unless string.start_with?("<p")
+            string = string.sub(/^<[^>]+>/, "<p>").sub(/<\/[^>]+>$/, "</p>")
+          end
+          string.strip
+        else
+          string
+        end
+      end
+
+      def determine_uri
+        @raw["data"]["url"] || @raw["source"]
+      end
+
+      def determine_source
+        if @uri.include? "twitter.com/"
+          "twitter"
+        elsif @uri.include? "/googleplus/"
+          "googleplus"
+        else
+          false
+        end
+      end
+
+      def determine_id
+        id = @raw["id"].to_s
+        if @source == "twitter" && !@uri.include?("#favorited-by")
+          id = URI(@uri).path.split("/").last.to_s
+        end
+        unless id
+          time = Time.now
+          id = time.strftime("%s").to_s
+        end
+        id
+      end
+
+      def determine_type
+        type = @raw.dig("activity", "type")
+        unless type
+          type = "post"
+          if @source == "googleplus"
+            type = if @uri.include? "/like/"
+                     "like"
+                   elsif @uri.include? "/repost/"
+                     "repost"
+                   elsif @uri.include? "/comment/"
+                     "reply"
+                   else
+                     "link"
+                   end
+          end
+        end
+        type
+      end
+
+      def determine_pubdate
+        pubdate = @raw.dig("data", "published_ts")
+        if pubdate
+          pubdate = Time.at(pubdate)
+        elsif @raw["verified_date"]
+          pubdate = Time.parse(@raw["verified_date"])
+        end
+        pubdate
+      end
+
+      def determine_author
+        @raw.dig("data", "author")
+      end
+
+      def determine_title
+        title = false
+
+        if @type == "post"
+
+          html_source = Jekyll::WebmentionIO.get_uri_source(@uri)
+          unless html_source
+            return title
+          end
+
+          unless 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)
+            title = if matches
+                      matches[1].strip
+                    else
+                      title = "No title available"
+                    end
+          end
+
+          # cleanup
+          title = title.gsub(/<\/?[^>]+?>/, "")
+        end # if post
+
+        markdownify(title)
+      end
+
+      def determine_content
+        content = if %w(post reply link).include? @type
+                    @raw.dig("data", "content")
+                  else
+                    @raw.dig("activity", "sentence_html")
+                  end
+
+        markdownify(content)
+      end
+    end
+  end
+end

data/lib/jekyll/webmention_io.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 #  (c) Aaron Gustafson
 #  https://github.com/aarongustafson/jekyll-webmention_io
 #  Licence : MIT
@@ -6,6 +8,7 @@
 #  using http://webmention.io/ and the following syntax:
 #
 require_relative "webmention_io/version"
+require_relative "webmention_io/webmention"
 
 require "json"
 require "net/http"
@@ -23,7 +26,12 @@ module Jekyll
     @api_endpoint = @api_url
     @api_suffix = ""
 
-    @types = %w(likes links posts replies reposts)
+    @types = %w(bookmarks likes links posts replies reposts rsvps)
+
+    EXCEPTIONS = [  SocketError, Timeout::Error, Errno::EINVAL,
+                    Errno::ECONNRESET, Errno::ECONNREFUSED, EOFError,
+                    Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,
+                    Net::ProtocolError, OpenSSL::SSL::SSLError, ].freeze
 
     def self.bootstrap
       # @jekyll_config = Jekyll.configuration({ 'quiet' => true })
@@ -49,7 +57,7 @@ module Jekyll
       end
     end
 
-    # Attributes
+    # Getters
     def self.config
       @config
     end
@@ -74,6 +82,16 @@ module Jekyll
       @types
     end
 
+    # Setters
+    def self.api_path=(path)
+      @api_endpoint = "#{@api_url}/#{path}"
+    end
+
+    def self.api_suffix=(suffix)
+      @api_suffix = suffix
+    end
+
+    # Heplers
     def self.get_cache_file_path(key)
       path = false
       if @cache_files.key? key
@@ -82,24 +100,59 @@ module Jekyll
       return path
     end
 
-    # API helpers
-    # def uri_params_for(api_params)
-    #  api_params.keys.sort.map do |k|
-    #    "#{CGI::escape(k)}=#{CGI::escape(api_params[k])}"
-    #  end.join('&')
-    # end
+    def self.read_cached_webmentions(which)
+      unless %w(incoming outgoing).include? which
+        return {}
+      end
 
-    def self.set_api_endpoint(path)
-      @api_endpoint = "#{@api_url}/#{path}"
+      cache_file = get_cache_file_path which
+      cached_webmentions = open(cache_file) { |f| YAML.load(f) }
+
+      cached_webmentions
     end
 
-    def self.set_api_suffix(suffix)
-      @api_suffix = suffix
+    def self.cache_webmentions(which, webmentions)
+      if %w(incoming outgoing).include? which
+        cache_file = get_cache_file_path which
+        File.open(cache_file, "w") { |f| YAML.dump(webmentions, f) }
+
+        Jekyll::WebmentionIO.log "msg", "#{which.capitalize} webmentions have been cached."
+      end
+    end
+
+    def self.gather_documents(site)
+      documents = if Jekyll::VERSION >= "3.0.0"
+                    site.posts.docs.clone
+                  else
+                    site.posts.clone
+                  end
+
+      if @config.dig("pages") == true
+        Jekyll::WebmentionIO.log "info", "Including site pages."
+        documents.concat site.pages.clone
+      end
+
+      collections = @config.dig("collections")
+      if collections
+        Jekyll::WebmentionIO.log "info", "Adding collections."
+        site.collections.each do |name, collection|
+          # skip _posts
+          next if name == "posts"
+
+          unless collections.is_a?(Array) && !collections.include?(name)
+            documents.concat collection.docs.clone
+          end
+        end
+      end
+
+      return documents
     end
 
     def self.get_response(api_params)
       api_params << @api_suffix
-      source = get_uri_source(@api_endpoint + "?#{api_params}")
+      url = "#{@api_endpoint}?#{api_params}"
+      Jekyll::WebmentionIO.log "info", "Sending request to #{url}."
+      source = get_uri_source(url)
       if source
         JSON.parse(source)
       else
@@ -145,7 +198,7 @@ module Jekyll
     # supported: daily, weekly, monthly, yearly, every X days|weeks|months|years
     def self.get_date_from_string(text)
       today = Date.today
-      pattern = %r!every\s(?:(\d+)\s)?(day|week|month|year)s?!
+      pattern = /every\s(?:(\d+)\s)?(day|week|month|year)s?/
       matches = text.match(pattern)
       unless matches
         text = if text == "daily"
@@ -167,7 +220,7 @@ module Jekyll
     end
 
     def self.get_webmention_endpoint(uri)
-      # log 'info', "Looking for webmention endpoint at #{uri}"
+      # log "info", "Looking for webmention endpoint at #{uri}"
       begin
         endpoint = Webmention::Client.supports_webmention?(uri)
         unless endpoint
@@ -184,8 +237,8 @@ module Jekyll
       log "info", "Sending webmention of #{target} in #{source}"
       # return `curl -s -i -d \"source=#{source}&target=#{target}\" -o /dev/null #{endpoint}`
       response = Webmention::Client.send_mention(endpoint, source, target, true)
-      status = response.dig('parsed_response', 'data', 'status').to_s
-      if status == '200'
+      status = response.dig("parsed_response", "data", "status").to_s
+      if status == "200"
         log "info", "Webmention successful!"
         return response.response.body
       else
@@ -195,68 +248,25 @@ module Jekyll
     end
 
     def self.get_template_contents(template)
-      if Jekyll::WebmentionIO.config.dig("templates", 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.expand_path("templates/#{template}.html", __dir__)
-      end
-      # Jekyll::WebmentionIO::log 'info', "Template file: #{template_file}"
+      template_file = if Jekyll::WebmentionIO.config.dig("templates", template)
+                        Jekyll::WebmentionIO.log "info", "Using custom #{template} template"
+                        Jekyll::WebmentionIO.config["templates"][template]
+                      else
+                        File.expand_path("templates/#{template}.html", __dir__)
+                      end
+      Jekyll::WebmentionIO.log "info", "Template file: #{template_file}"
       handler = File.open(template_file, "rb")
       handler.read
     end
 
     # Connections
-    def self.uri_ok?(uri)
-      uri = URI.parse(URI.encode(uri))
-      now = Time.now.to_s
-      bad_uris = open(@cache_files["bad_uris"]) { |f| YAML.safe_load(f) }
-      if bad_uris.key? uri.host
-        last_checked = DateTime.parse(bad_uris[uri.host])
-        cache_bad_uris_for = @config["cache_bad_uris_for"] || 1 # in days
-        recheck_at = last_checked.next_day(cache_bad_uris_for).to_s
-        if recheck_at > now
-          return false
-        end
-      end
-      return true
-    end
-
-    # Cache bad URLs for a bit
-    def self.uri_is_not_ok(uri)
-      # Never cache webmention.io in here
-      if uri.host == 'webmention.io'
-        return
-      end
-      cache_file = @cache_files["bad_uris"]
-      bad_uris = open(cache_file) { |f| YAML.safe_load(f) }
-      bad_uris[uri.host] = Time.now.to_s
-      File.open(cache_file, "w") { |f| YAML.dump(bad_uris, f) }
-    end
-
     def self.get_uri_source(uri, redirect_limit = 10, original_uri = false)
       original_uri ||= uri
       unless uri_ok?(uri)
         return false
       end
-      if redirect_limit > 0
-        uri = URI.parse(URI.encode(uri))
-        http = Net::HTTP.new(uri.host, uri.port)
-        http.read_timeout = 10
-        if uri.scheme == "https"
-          http.use_ssl = true
-          http.ciphers = "ALL:!ADH:!EXPORT:!SSLv2:RC4+RSA:+HIGH:+MEDIUM:-LOW"
-          http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-        end
-        begin
-          request = Net::HTTP::Get.new(uri.request_uri)
-          response = http.request(request)
-        rescue SocketError, Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, Errno::ECONNREFUSED, EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError, OpenSSL::SSL::SSLError => e
-          log "warn", "Got an error checking #{original_uri}: #{e}"
-          uri_is_not_ok(uri)
-          return false
-        end
+      if redirect_limit.positive?
+        response = get_http_response(uri)
         case response
         when Net::HTTPSuccess then
           return response.body.force_encoding("UTF-8")
@@ -278,9 +288,63 @@ module Jekyll
     end
 
     def self.log(type, message)
-      Jekyll.logger.method(type).call("#{@logger_prefix} #{message}")
+      debug = !!@config.dig("debug")
+      if debug || %w(error msg).include?(type)
+        if type == "msg"
+          type = "info"
+        end
+        Jekyll.logger.method(type).call("#{@logger_prefix} #{message}")
+      end
     end
 
+    private
+
+    def self.get_http_response(uri)
+      uri = URI.parse(URI.encode(uri))
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.read_timeout = 10
+      if uri.scheme == "https"
+        http.use_ssl = true
+        http.ciphers = "ALL:!ADH:!EXPORT:!SSLv2:RC4+RSA:+HIGH:+MEDIUM:-LOW"
+        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      end
+      begin
+        request = Net::HTTP::Get.new(uri.request_uri)
+        response = http.request(request)
+        return response
+      rescue *EXCEPTIONS => e
+        log "warn", "Got an error checking #{original_uri}: #{e}"
+        uri_is_not_ok(uri)
+        return false
+      end
+    end
+
+    # Cache bad URLs for a bit
+    def self.uri_is_not_ok(uri)
+      # Never cache webmention.io in here
+      if uri.host == "webmention.io"
+        return
+      end
+      cache_file = @cache_files["bad_uris"]
+      bad_uris = open(cache_file) { |f| YAML.load(f) }
+      bad_uris[uri.host] = Time.now.to_s
+      File.open(cache_file, "w") { |f| YAML.dump(bad_uris, f) }
+    end
+
+    def self.uri_ok?(uri)
+      uri = URI.parse(URI.encode(uri))
+      now = Time.now.to_s
+      bad_uris = open(@cache_files["bad_uris"]) { |f| YAML.load(f) }
+      if bad_uris.key? uri.host
+        last_checked = DateTime.parse(bad_uris[uri.host])
+        cache_bad_uris_for = @config["cache_bad_uris_for"] || 1 # in days
+        recheck_at = last_checked.next_day(cache_bad_uris_for).to_s
+        if recheck_at > now
+          return false
+        end
+      end
+      return true
+    end
   end
 end