jekyll-fetch 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c48088f55e630fa5865535fdcf4eb47bfef25c876d965f1e254199d0977a5160
-  data.tar.gz: 96f9f13e4d5577f53d81c5697b2bf3298a5a8e5c8bb479ab61dcc9d57a3a053f
+  metadata.gz: f4434d6eccdd7106706ea9bc830e1112398ad65a2aeba36784b2329e910a2ff1
+  data.tar.gz: bfc916463dc0571bc8796bb40c7f561cc0ac1fe14726517a8b158d7c21ecd824
 SHA512:
-  metadata.gz: d3b8b051a198b602949f1100341291754f02ec9c479ffdb9c2936d081622fe9a0bcc4055bfe413a61bc80514c35fabe7b75da68066d94853abe69691c210cc8b
-  data.tar.gz: 518db64573f46664c8c39dc20ce9a60ec282b7d67ef2a23a24704f2a2032c1f2b39714ce763eac6810758b3eb69a36774fba49f2d47e5942309092e3ff51f76f
+  metadata.gz: 224200bbc378ba973f547545ec1a6cb382184ac79aec98d03b17da34b5bbabf8b90051cf3c003a233b37ce47a21ab487c06c557d38f1a1afc3ad50e4454223c5
+  data.tar.gz: 67f3dd59fa6215fcf957715fd451f9bd6385e7adf98b2569f04178f43716388e015e31526a6273021d2053a8f14ba96537f9433547cf43157ad1e37b7e918594

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Naming/FileName:
+  Enabled: false

data/README.md

@@ -29,6 +29,19 @@ The example above will render to the raw markdown of this readme. You can chain
 {{ "https://raw.githubusercontent.com/pcouy/jekyll-fetch/main/README.md" | fetch  | markdownify }}
 ```
 
+Additionally, this plugin contains helper filters that help you work with files from GitHub repositories :
+
+```
+{{ "gh_user/repo_name" | github_url }}
+Will render to : https://github.com/gh_user/repo_name
+
+{{ "gh_user/repo_name" | github_readme }}
+Will render to the content of the `README.md` file from the repository
+
+{{ "gh_user/repo_name" | github_file: "path/to/file/in/repo" }}
+Will render to the content of the specified file from the repository
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/jekyll-fetch/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllFetch
-  VERSION = "0.1.1"
+  VERSION = '0.2.0'
 end

data/lib/jekyll-fetch.rb

@@ -1,28 +1,77 @@
 # frozen_string_literal: true
 
-require_relative "jekyll-fetch/version"
-require "liquid"
-require "net/https"
+require_relative 'jekyll-fetch/version'
+require 'liquid'
+require 'net/https'
 
 module Jekyll
+  # Filters for transforming URL strings into the content at the URL
   module JekyllFetch
     class Error < StandardError; end
 
-    def fetch(uri_str, limit = 10)
-      # You should choose better exception.
-      raise ArgumentError, 'HTTP redirect too deep' if limit == 0
-
-      puts uri_str
-      url = URI.parse(uri_str)
-      req = Net::HTTP::Get.new(url.path, { 'User-Agent' => 'Mozilla/5.0 (etc...)' })
-      response = Net::HTTP.start(url.host, url.port, use_ssl: true) { |http| http.request(req) }
-      case response
-      when Net::HTTPSuccess     then response.body.force_encoding("UTF-8")
-      when Net::HTTPRedirection then fetch(response['location'], limit - 1)
-      else
-        response.error!
+    # Helper functions for HTTP requests
+    class Utils
+      class << self
+        def fetch(uri_str, limit = 10)
+          raise ArgumentError, 'Max retries reached' if limit.zero?
+
+          begin
+            unsafe_fetch(uri_str, limit)
+          rescue Errno::ECONNREFUSED
+            Jekyll.logger.warn "Connection refused for #{uri_str}, retrying in 2s..."
+            sleep 2
+            Jekyll.logger.warn "Retrying (#{limit - 1} tries left)"
+            fetch(uri_str, limit - 1)
+          end
+        end
+
+        private
+
+        def unsafe_fetch(uri_str, limit)
+          raise ArgumentError, 'Max retries reached' if limit.zero?
+
+          response_to_body(
+            uri_to_response(uri_str), limit - 1
+          )
+        end
+
+        def uri_to_response(uri_str)
+          url = URI.parse(uri_str)
+          req = Net::HTTP::Get.new(url.path, { 'User-Agent' => 'Mozilla/5.0 (etc...)' })
+          Net::HTTP.start(url.host, url.port, use_ssl: true) { |http| http.request(req) }
+        end
+
+        def response_to_body(response, limit)
+          case response
+          when Net::HTTPSuccess     then response.body.force_encoding('UTF-8')
+          when Net::HTTPRedirection then fetch(response['location'], limit)
+          else
+            response.error!
+          end
+        end
       end
     end
+
+    def fetch(uri_str, limit = 10)
+      raise ArgumentError, 'HTTP redirect too deep' if limit.zero?
+
+      Jekyll.logger.debug "fetch(#{uri_str})"
+      Utils.fetch(uri_str, limit)
+    end
+
+    def github_url(repo)
+      "https://github.com/#{repo}"
+    end
+
+    def github_readme(repo)
+      Jekyll.logger.debug "github_readme(#{repo})"
+      github_file repo, 'README.md'
+    end
+
+    def github_file(repo, file)
+      Jekyll.logger.debug "github_file(#{repo}, #{file})"
+      fetch "#{github_url(repo)}/raw/main/#{file}"
+    end
   end
 end
 

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-fetch
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - pcouy
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-11 00:00:00.000000000 Z
+date: 2023-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: jekyll
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-http
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -26,7 +40,7 @@ dependencies:
         version: '0'
 description:
 email:
-- couy.pierre@gmail.com
+- contact@pierre-couy.dev
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -39,12 +53,12 @@ files:
 - lib/jekyll-fetch.rb
 - lib/jekyll-fetch/version.rb
 - sig/jekyll_http.rbs
-homepage: https://github.com/pcouy/jekyll-fetch
+homepage: https://pierre-couy.dev/projects/jekyll-fetch.html
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/pcouy/jekyll-fetch
+  homepage_uri: https://pierre-couy.dev/projects/jekyll-fetch.html
   source_code_uri: https://github.com/pcouy/jekyll-fetch
 post_install_message:
 rdoc_options: []