jekyll-strapi-4 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b60b83febefc6dfb99cc3f9d41cc0e4e2f82bce56e1e166ca6a04045357794f9
+  data.tar.gz: a7a6f9c335cb714d7c52dc06ffd240eb70e18d3918c2b3eef0f9f8ab24dfb055
+SHA512:
+  metadata.gz: 47db6f927bd95d671ca094db0dd4d0ca591401b2b3a1b3ae141097ae43fa7bef1530355cc8192f6d63803b58f8f53c97a584b045fb9fac90b57e1bc16382d66d
+  data.tar.gz: 59e61272e81d10fff14524436f6a57cdee50518d3e9f699bdafdc486f001c62495c2c611c25d59fa7375edaf33651571978c019f13ae427b519b3c3079ff5523

data/LICENSE

@@ -0,0 +1,9 @@
+Copyright (c) 2022 Rafał Zawadzki, Michał Krajewski
+
+Copyright (c) 2015-2019 Strapi Solutions.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,132 @@
+# jekyll-strapi-4
+
+This plugin is based on the [jekyll-strapi](https://github.com/strapi-community/jekyll-strapi/) plugin. 
+
+## Features
+
+* Support for Strapi 4
+* Authentication
+* Permalinks
+* Caching and collecting assets from Strapi
+* Added UnitTests
+* Documentation in Jekyll format
+
+## Install
+
+Add the "jekyll-strapi" gem to your Gemfile:
+
+```
+gem "jekyll-strapi"
+```
+
+Then add "jekyll-strapi" to your plugins in `_config.yml`:
+
+```
+plugins:
+    - jekyll-strapi
+```
+
+## Configuration
+
+```yaml
+strapi:
+    # Your API endpoint (optional, default to http://localhost:1337)
+    endpoint: http://localhost:1337
+    # Collections, key is used to access in the strapi.collections
+    # template variable
+    collections:
+        # Example for a "Photo" collection
+        photos:
+            # Collection name (optional)
+            # type: photos
+            # Permalink used to generate the output files (eg. /articles/:id).
+            permalink: /photos/:id/
+            # Parameters (optional)
+            parameters:
+              sort: title:asc
+              pagination[pageSize]: 10
+            # Populate page (optional, default "*")
+            # populate: "*"
+            # Layout file for this collection
+            layout: photo.html
+            # Generate output files or not (default: false)
+            output: true
+```
+
+This works for the following collection *Photo* in Strapi:
+
+| Name    | Type  |
+| ------- | ----- |
+| Title   | Text  |
+| Image   | Media |
+| Comment | Text  |
+
+### Authentication
+
+To access non Public collections (and by default all Strapi collections are non Public) you must to generate a token inside your strapi instance and set it as enviromental variable `STRAPI_TOKEN`.
+
+It is recommended that you will use new Content API tokens for this task: https://strapi.io/blog/a-beginners-guide-to-authentication-and-authorization-in-strapi
+
+## Usage
+
+This plugin provides the `strapi` template variable. This template provides access to the collections defined in the configuration.
+
+### Using Collections
+
+Collections are accessed by their name in `strapi.collections`. The `articles` collections is available at `strapi.collections.articles`.
+
+To list all documents of the collection ```_layouts/home.html```:
+
+```
+---
+layout: default
+---
+<div class="home">
+  <h1 class="page-heading">Photos</h1>
+  {%- if strapi.collections.photos.size > 0 -%}
+  <ul>
+    {%- for photo in strapi.collections.photos -%}
+    <li>
+      <a href="{{ photo.url }}">Title: {{ photo.strapi_attributes.Title }}</a>
+    </li>
+    {%- endfor -%}
+  </ul>
+  {%- endif -%}
+</div>
+```
+
+### Attributes
+
+All object's data you can access through ``` {{ page.document.strapi_attributes }}```. This plugin also introduces new filter asset_url which perform downloading the asset into the assets folder and provides correct url. Thanks for this you have copies of your assets locally without extra dependency on Strapi ```_layouts/photo.html```:
+
+```
+---
+layout: default
+---
+
+<div class="home">
+  <h1 class="page-heading">{{ page.document.title }}</h1>
+  <h2>{{ page.document.strapi_attributes.Title }}</h2>
+  <p>{{ page.document.strapi_attributes.Comment }}</p>
+  <img src="{{ page.document.strapi_attributes.Image.data.attributes.formats.thumbnail| asset_url }}"/>
+</div>
+```
+
+### Request parameters
+
+Define your request parameters in config files (check configuration).
+
+If you want to add custom logic use custom_path_params method. You can use it by create _plugins/filename.rb.
+
+```ruby
+module Jekyll
+  module Strapi
+    class StrapiCollection
+      def custom_path_params
+        # ex. for multilanguage plugin you might want get request by page lang
+        "&locale=#{@site.config["lang"]}"
+      end
+    end
+  end
+end
+```

data/lib/jekyll/strapi/collection.rb

@@ -0,0 +1,94 @@
+require "net/http"
+require "ostruct"
+require "json"
+
+
+
+
+
+module Jekyll
+  module Strapi
+    class StrapiCollection
+      attr_accessor :collection_name, :config
+
+      def initialize(site, collection_name, config)
+        @site = site
+        @collection_name = collection_name
+        @config = config
+        Jekyll.logger.debug "Jekyll Collection init:" "#{site.config} #{collection_name} #{config}"
+      end
+
+      def generate?
+        @config['output'] || false
+      end
+
+      def get_data
+        # path = "/#{@config['type'] || @collection_name}?_limit=10000"
+        # This seems be not working anymore:
+        # https://docs.strapi.io/developer-docs/latest/developer-resources/database-apis-reference/rest-api.html#api-parameters
+        # and pagination is now done in following way:
+        # https://docs.strapi.io/developer-docs/latest/developer-resources/database-apis-reference/rest/sort-pagination.html#pagination-by-page
+        uri = URI("#{@site.endpoint}/api/#{endpoint}#{path_params}")
+        Jekyll.logger.debug "StrapiCollection get_document:" "#{collection_name} #{uri}"
+        response = strapi_request(uri)
+        response.data
+      end
+
+      def get_document(did)
+        uri_document = URI("#{@site.endpoint}/api/#{endpoint}/#{did}?populate=#{populate}")
+        Jekyll.logger.debug "StrapiCollection iterating uri_document:" "#{uri_document}"
+        strapi_request(uri_document)
+        # document
+      end
+
+      def each
+        data = get_data
+        data.each do |document|
+          Jekyll.logger.debug "StrapiCollection iterating over document:" "#{collection_name} #{document.id}"
+          document.type = collection_name
+          document.collection = collection_name
+          document.id ||= document._id
+          document_response = get_document(document.id)
+          # We will keep all the attributes in strapi_attributes
+          document.strapi_attributes = document_response['data']["attributes"]
+          document.url = @site.strapi_link_resolver(collection_name, document)
+        end
+        data.each {|x| yield(x)}
+      end
+
+      def endpoint
+        @config['type'] || @collection_name
+      end
+
+      def populate
+        @config["populate"] || "*"
+      end
+
+      def path_params
+        string = "?"
+        return_params = false
+
+        if @config["parameters"]
+          return_params = true
+
+          @config["parameters"].each do |k, v|
+            string += "&#{k}=#{v}"
+          end
+        end
+
+        if custom_path_params.length != 0
+          return_params = true
+
+          string += custom_path_params
+        end
+
+        return_params ? string : ""
+      end
+
+      def custom_path_params
+        # Define custom logic in your _plugins/file_name.rb
+        ""
+      end
+    end
+  end
+end

data/lib/jekyll/strapi/drops.rb

@@ -0,0 +1,62 @@
+module Jekyll
+  module Strapi
+    # Strapi Document access in Liquid
+    class StrapiDocumentDrop < Liquid::Drop
+      attr_accessor :document
+
+      def initialize(document)
+        @document = document
+      end
+
+      def [](attribute)
+        value = @document[attribute]
+
+        case value
+        when OpenStruct
+          StrapiDocumentDrop.new(value)
+        when Array
+          StrapiCollectionDrop.new(value)
+        else
+          value
+        end
+      end
+    end
+
+    # Handles a single Strapi collection in Liquid
+    class StrapiCollectionDrop < Liquid::Drop
+      def initialize(collection)
+        @collection = collection
+      end
+
+      def to_liquid
+        results = []
+        @collection.each do |result|
+          results << StrapiDocumentDrop.new(result)
+        end
+        results
+      end
+    end
+
+    # Handles Strapi collections in Liquid, and creates the collection on demand
+    class StrapiCollectionsDrop < Liquid::Drop
+      def initialize(collections)
+        @collections = collections
+      end
+
+      def [](collection_name)
+        StrapiCollectionDrop.new(@collections[collection_name])
+      end
+    end
+
+    # Main Liquid Drop, handles lazy loading of collections to drops
+    class StrapiDrop < Liquid::Drop
+      def initialize(site)
+        @site = site
+      end
+
+      def collections
+        @collections ||= StrapiCollectionsDrop.new(@site.strapi_collections)
+      end
+    end
+  end
+end

data/lib/jekyll/strapi/generator.rb

@@ -0,0 +1,52 @@
+module Jekyll
+  module Strapi
+    # Generates pages for all collections with have the "generate" option set to True
+    class StrapiGenerator < Generator
+      safe true
+
+      def generate(site)
+        site.strapi_collections.each do |collection_name, collection|
+          if collection.generate?
+            collection.each do |document|
+              site.pages << StrapiPage.new(site, site.source, document, collection)
+            end
+          end
+        end
+      end
+    end
+
+    class StrapiPage < Page
+      def initialize(site, base, document, collection)
+        @site = site
+        @base = base
+        @collection = collection
+        @document = document
+
+        @dir = @collection.config['output_dir'] || collection.collection_name
+        # Default file name, can be overwritten by permalink frontmatter setting
+        @name = "#{document.id}.html"
+        # filename_to_read = File.join(base, "_layouts"), @collection.config['layout']
+
+        self.process(@name)
+        self.read_yaml(File.join(base, "_layouts"), @collection.config['layout'])
+        if @collection.config.key? 'permalink'
+          self.data['permalink'] = @collection.config['permalink']
+        end
+
+        self.data['document'] = StrapiDocumentDrop.new(@document)
+      end
+
+      def url_placeholders
+        # This was not really providing :id for the mapping
+        # requiredValues = @document.strapi_attributes.to_h.select {|k, v|
+        #   v.class == String and @collection.config['permalink'].include? k.to_s
+        # }
+        my_hash =       {
+          :id       => @document.id.to_s,
+          :slug     => @document.attributes.slug
+        }
+        Utils.deep_merge_hashes(my_hash, super)
+      end
+    end
+  end
+end

data/lib/jekyll/strapi/hooks.rb

@@ -0,0 +1,8 @@
+module Jekyll
+  module Strapi
+    # Add Strapi Liquid variables to all templates
+    Jekyll::Hooks.register :site, :pre_render do |site, payload|
+      payload['strapi'] = StrapiDrop.new(site)
+    end
+  end
+end

data/lib/jekyll/strapi/site.rb

@@ -0,0 +1,46 @@
+module Jekyll
+  # Add helper methods for dealing with Strapi to the Site class
+  class Site
+    def strapi
+      return nil unless has_strapi?
+    end
+
+    def strapi_collections
+      return Array.new unless has_strapi_collections?
+      @strapi_collections ||= Hash[@config['strapi']['collections'].map {|name, config| [name, Strapi::StrapiCollection.new(self, name, config)]}]
+    end
+
+    def has_strapi?
+      @config['strapi'] != nil
+    end
+
+    def has_strapi_collections?
+      has_strapi? and @config['strapi']['collections'] != nil
+    end
+
+    def endpoint
+      has_strapi? and @config['strapi']['endpoint'] or "http://localhost:1337"
+    end
+
+    def strapi_link_resolver(collection = nil, document = nil)
+      return "/" unless collection != nil and @config['strapi']['collections'][collection]['permalink'] != nil
+      url = Jekyll::URL.new(
+        :template => @config['strapi']['collections'][collection]['permalink'],
+        :placeholders => {
+          :id => document.id.to_s,
+          :uid => document.uid,
+          :slug => document.attributes.slug,
+          :type => document.attributes.type,
+          :date => document.attributes.date,
+          :title => document.title
+        }
+      )
+
+      url.to_s
+    end
+
+    def strapi_collection(collection_name)
+      strapi_collections[collection_name]
+    end
+  end
+end

data/lib/jekyll/strapi/strapihttp.rb

@@ -0,0 +1,42 @@
+##
+# This is a helper method to authenticate during getting data from Strapi instance.
+require "json"
+
+def strapi_request(url)
+    uri = URI(url)
+    req = Net::HTTP::Get.new(uri)
+    strapi_token = ENV['STRAPI_TOKEN']
+    if strapi_token==nil
+        Jekyll.logger.info "STRAPI_TOKEN not set, non Authenticated request."
+        headers = {}
+    else
+        headers = {
+            'Authorization'=>"Bearer #{strapi_token}"
+        }
+        req['Authorization'] = "Bearer #{strapi_token}"
+    end
+    Jekyll.logger.info "Jekyll StrapiHTTP:", "Fetching entries from #{uri} using headers: #{headers.keys}"
+    response = Net::HTTP.get_response(uri, headers)
+
+    ##
+    # Response structure
+    # https://docs.strapi.io/developer-docs/latest/developer-resources/database-apis-reference/rest-api.html#unified-response-format
+    # - data
+    # - meta
+    # - error
+    # TODO: add checking error and the meta and act if necessart
+
+    # Check response code
+    if response.code == "200"
+        response_json = JSON.parse(response.body, object_class: OpenStruct)
+        return response_json
+    elsif response.code == "401"
+        raise "The Strapi server sent a error with the following status: 401. Please make sure that your credentials are correct or that you have access to the API."
+    elsif response.code == "403"
+        raise "The Strapi server sent a error with the following status: 403. Please provide STRAPI_TOKEN or allow public access for find and findOne actions."
+    elsif response.code == "403"
+        raise "The Strapi server sent a error with the following status: 404. Please make sure that name of your collection is correct."
+    else
+        raise "The Strapi server sent a error with the following status: #{response.code}. Please make sure it is correctly running."
+    end
+end

data/lib/jekyll/strapi/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module Strapi
+    VERSION = "1.0.0"
+  end
+end

data/lib/jekyll/tags/strapiimagefilter.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+require "down"
+
+module Jekyll
+  class StrapiStaticFile < Jekyll::StaticFile
+    def initialize(site, base, dir, name, collection = nil)
+      @site = site
+      @base = base
+      @dir  = dir
+      @name = name
+      @collection = collection
+      # TODO: Check if user can change 'assets' path
+      @relative_path = File.join(*["assets", @name].compact)
+      @extname = File.extname(@name)
+    end
+  end
+
+  module StrapiImageFilter
+    def asset_url(input)
+      # Sometimes to make this output visible in tests debug must be change for info
+      # Need to find switch of logging level during rake test TODO: <===
+      Jekyll.logger.debug "StrapiImageFilter 000 input:" " ==> YES"
+      Jekyll.logger.debug "StrapiImageFilter 111 input:" "#{input}"
+      Jekyll.logger.debug "StrapiImageFilter 222 context REGISTERS:" "#{@context.registers}"
+      strapi_endpoint = @context.registers[:site].config['strapi']['endpoint']
+      Jekyll.logger.debug "StrapiImageFilter strapi_endpoint:" "#{strapi_endpoint}"
+
+      uri_path = "#{strapi_endpoint}#{input['url']}"
+      if not Dir.exist?('_tmp_assets')
+        # TODO: Check if there is not ability to overwrite from the _config
+        Jekyll.logger.info "_tmp_assets directory does not exist, I am going to create one"
+        Dir.mkdir '_tmp_assets'
+      end
+      ##
+      # TODO: Investigate if there is a better way to download binaries
+      # Check if we need authenticate to get medias
+      Down.download(uri_path, destination: "_tmp_assets/#{input['name']}")
+      ##
+      # To perform copying of the assets in the cycle of Jenkins
+      # https://jekyllrb.com/docs/rendering-process/
+      site = Jekyll.sites.first 
+      site.static_files << StrapiStaticFile.new(site, site.source, "_tmp_assets", "#{input['name']}")
+      "/assets/#{input['name']}"
+    end
+  end
+end
+Liquid::Template.register_filter(Jekyll::StrapiImageFilter)

data/lib/jekyll-strapi.rb

@@ -0,0 +1,8 @@
+require 'jekyll/strapi/strapihttp'
+require 'jekyll/strapi/collection'
+require 'jekyll/strapi/drops'
+require 'jekyll/strapi/generator'
+require 'jekyll/strapi/hooks'
+require 'jekyll/strapi/site'
+require 'jekyll/strapi/version'
+require 'jekyll/tags/strapiimagefilter'

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-strapi-4
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Strapi Solutions
+- Rafał Zawadzki
+- Michał Krajewski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: down
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: "    A Jekyll plugin for retrieving content from a Strapi 4 API\n"
+email:
+- bluszcz@bluszcz.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/jekyll-strapi.rb
+- lib/jekyll/strapi/collection.rb
+- lib/jekyll/strapi/drops.rb
+- lib/jekyll/strapi/generator.rb
+- lib/jekyll/strapi/hooks.rb
+- lib/jekyll/strapi/site.rb
+- lib/jekyll/strapi/strapihttp.rb
+- lib/jekyll/strapi/version.rb
+- lib/jekyll/tags/strapiimagefilter.rb
+homepage: https://github.com/strapi/jekyll-strapi
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Strapi.io integration for Jekyll
+test_files: []