jekyll-strapi 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 714d228234e6f85718179694c095944fad199cf3d9215c294f39450297b6f129
+  data.tar.gz: 490043482646332491d08dcecceae88fbe6eace1bb347ff2a9f3a60f2802e95e
+SHA512:
+  metadata.gz: 16210fe380082a464f1384ab5b6492cb6bc7ae165a9b24d0139263e76a0f2b7bcd1495affb52c23f9899b42d1c2380d3912baa0cea42009f3eacca35f6fdef2d
+  data.tar.gz: 898dd3592c5897a434222ddb03f66f43b22ca0ab4bbce7ef07500ef5ebf5d762b05ccf3548632ced26a4a0b814b4223ec6b89eac57f309706a47520145e4bc50

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2015-2018 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,60 @@
+# jekyll-strapi
+
+## 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 "articles" collection
+        articles:         
+            # Collection name (optional)
+            type: article
+            # Permalink used to generate the output files (eg. /articles/:id).
+            permalink: /articles/:id/
+            # Layout file for this collection
+            layout: strapi_article.html
+            # Generate output files or not (default: false)
+            output: true
+```
+
+## 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:
+
+```
+{% for post in strapi.collections.articles %}
+<article>
+    <header>
+        {{ post.title }}
+    </header>
+    <div class="body">
+        {{ post.content }}
+    </div>
+</article>
+{% endfor %}
+```

data/lib/jekyll-strapi.rb

@@ -0,0 +1,6 @@
+require 'jekyll/strapi/collection'
+require 'jekyll/strapi/drops'
+require 'jekyll/strapi/generator'
+require 'jekyll/strapi/hooks'
+require 'jekyll/strapi/site'
+require 'jekyll/strapi/version'

data/lib/jekyll/strapi/collection.rb

@@ -0,0 +1,52 @@
+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
+      end
+
+      def generate?
+        @config['output'] || false
+      end
+
+      def each
+        # Initialize the HTTP query
+        endpoint = URI.parse(@site.endpoint)
+        uri = URI::HTTP.build({:host => endpoint.host,
+                               :port => endpoint.port,
+                               :path => "/#{@config['type'] || @collection_name}",
+                               :query => "_limit=10000"})
+
+        # Get entries
+        response = Net::HTTP.get_response(uri)
+
+        # Check response code
+        if response.code == "200"
+          result = JSON.parse(response.body, object_class: OpenStruct)
+        elsif response.code == "401"
+          raise "The Strapi server sent a error with the following status: #{response.code}. Please make sure you authorized the API access in the Users & Permissions section of the Strapi admin panel."
+        else
+          raise "The Strapi server sent a error with the following status: #{response.code}. Please make sure it is correctly running."
+        end
+
+        # Add necessary properties
+        result.each do |document|
+          document.type = collection_name
+          document.collection = collection_name
+          document.id ||= document._id
+          document.url = @site.strapi_link_resolver(collection_name, document)
+        end
+
+        result.each {|x| yield(x)}
+      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,49 @@
+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"
+
+        self.process(@name)
+        self.read_yaml(File.join(base, "_layouts"), @collection.config['layout'])
+
+        # Use the permalink collection setting if it is set
+        if @collection.config.key? 'permalink'
+          self.data['permalink'] = @collection.config['permalink']
+        end
+
+        self.data['document'] = StrapiDocumentDrop.new(@document)
+      end
+
+      def url_placeholders
+        requiredValues = @document.to_h.select {|k, v|
+          v.class == String and @collection.config['permalink'].include? k.to_s
+        }
+
+        Utils.deep_merge_hashes(requiredValues, 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,45 @@
+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,
+          :uid => document.uid,
+          :slug => document.slug,
+          :type => document.type
+        }
+      )
+
+      url.to_s
+    end
+
+    def strapi_collection(collection_name)
+      strapi_collections[collection_name]
+    end
+  end
+end

data/lib/jekyll/strapi/version.rb

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

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-strapi
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Strapi Solutions
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !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 API\n"
+email:
+- hi@strapi.io
+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/version.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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Strapi.io integration for Jekyll
+test_files: []