jekyll-contentful-data-import 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6240e01bd316ec09f91d3ec93de0886cb6b550fb
-  data.tar.gz: a77e6bb3f7234b2d7aec8816251a23c627a27db7
+SHA256:
+  metadata.gz: 37c1c1b1bddb8164bcc950d2e370ae3e15327c44c5d4c34cbd5f7b38429414d7
+  data.tar.gz: c5aed758e4839abb2bc8dfe08ba883cd437d7c0c1c908b44a6362d35e84cac54
 SHA512:
-  metadata.gz: 479b3306559697cd362e4a371365c671b644c00f62cecc82d8eb3207a542fc999d547f800f421e3603fdea1b4107079233b42db81318ebfcacab93f5c9db07ca
-  data.tar.gz: 7cbae4efc303ff3b88cfa62227ad4c19ec828db56eab9f84424d084cad8d5eaa66ea066e1db89beb842acf52a1286f12cdebdf8f5f6da5eac77fe631f6aecfd9
+  metadata.gz: 3ceb1ae089f35241ff5b64a7069d5e00f0c13d890ca0608f2b63a2f0e20f110c013024893a629c4f1b1c7440169830365d234365ed76eae8535671bcdace34b4
+  data.tar.gz: d11c17b6f0a9479fe7e036bc424eb14b8b542764c9ce354e730db94f62859356b5feee21bdd55433c59884d27fdcf6a642c6994b81f1d32351b14917ea629015

data/.travis.yml

@@ -1,8 +1,7 @@
 rvm:
-  - 2.0.0
-  - 2.1.2
-  - 2.2.3
-  - jruby
+  - 2.3.1
+  - 2.4.0
+  - 2.5.1
 
 script: "bundle exec rake test"
 
@@ -12,7 +11,3 @@ env: TEST=true JRUBY_OPTS='--2.0'
 notifications:
   slack:
     secure: MMWxqKMT4m2UhZ+Ix4wgCs1nLvu9hUFCbyV/qJWmIFif7V4GUKXi6h9krMqGqBAd3YV3pP/InPlw3QoKBUGIAIr5GzDpSnU5ACv7E61v548qViEvPBqsfhRHha2M164rUHn32tpejJnIizVUyND/hIzNviIrab+G8uOaZXUtB5I=
-
-matrix:
-  allow_failures:
-    - rvm: jruby

data/CHANGELOG.md

@@ -2,8 +2,11 @@
 
 ## Unreleased
 
-## 1.6.0
+## v1.7.0
+### Added
+* Added top-level environment assignment, with support for `ENV_` access [#61](https://github.com/contentful/jekyll-contentful-data-import/issues/61)
 
+## v1.6.0
 ### Added
 * Independent file per entry [#45](https://github.com/contentful/jekyll-contentful-data-import/pull/45) [#10](https://github.com/contentful/jekyll-contentful-data-import/issues/10) [#23](https://github.com/contentful/jekyll-contentful-data-import/pull/23) [#25](https://github.com/contentful/jekyll-contentful-data-import/issues/25)
 * Added User Agent Integration Headers

data/README.md

@@ -2,7 +2,9 @@
 
 [![Build Status](https://travis-ci.org/contentful/jekyll-contentful-data-import.svg?branch=master)](https://travis-ci.org/contentful/jekyll-contentful-data-import)
 
-Jekyll-Contentful-Data-Import is a [Jekyll](http://jekyllrb.com/) extension to use the Jekyll static site generator together with the API-driven [Contentful CMS](https://www.contentful.com). It is powered by the [Contentful Ruby Gem](https://github.com/contentful/contentful.rb).
+[Contentful](https://www.contentful.com) provides a content infrastructure for digital teams to power content in websites, apps, and devices. Unlike a CMS, Contentful was built to integrate with the modern software stack. It offers a central hub for structured content, powerful management and delivery APIs, and a customizable web app that enable developers and content creators to ship digital products faster.
+
+Jekyll-Contentful-Data-Import is a [Jekyll](http://jekyllrb.com/) extension to use the Jekyll static site generator together with [Contentful](https://www.contentful.com). It is powered by the [Contentful Ruby Gem](https://github.com/contentful/contentful.rb).
 
 Experience the power of Jekyll while staying sane as a developer by letting end-users edit content in a web-based interface.
 
@@ -44,6 +46,7 @@ contentful:
     - example: # Jekyll _data folder identifier - Required
         space: cfexampleapi         # Required
         access_token: b4c0n73n7fu1  # Required
+        environment: master         # Optional
         cda_query:                  # Optional
           include: 2
           limit: 100
@@ -53,6 +56,7 @@ contentful:
           cat: MyCoolMapper
         client_options:             # Optional
           api_url: 'preview.contentful.com' # Defaults to 'api.contentful.com' which is Production
+          max_include_resolution_depth: 5 # Optional - Defaults to 20, maximum amount of levels to resolve includes
         base_path: app_path         # Optional - Defaults to Current directory
         destination: destination_in_data # Optional - Defaults to _data/contentful/spaces
         individual_entry_files: true # Optional - Defaults to false
@@ -62,6 +66,7 @@ Parameter              | Description
 ----------             | ------------
 space                  | Contentful Space ID
 access_token           | Contentful Delivery API access token
+environment            | Space environment, defaults to `master`
 cda_query              | Hash describing query configuration. See [contentful.rb](https://github.com/contentful/contentful.rb) for more info (look for filter options there). Note that by default only 100 entries will be fetched, this can be configured to up to 1000 entries using the `limit` option.
 all_entries            | Boolean, if true will run multiple queries to the API until it fetches all entries for the space
 all_entries_page_size  | Integer, the amount of maximum entries per CDA Request when fetching :all_entries
@@ -135,15 +140,17 @@ therefore you can do the following:
       - example:
           space:        ENV_CONTENTFUL_SPACE_ID
           access_token: ENV_CONTENTFUL_ACCESS_TOKEN
+          environment:  ENV_CONTENTFUL_ENVIRONMENT
   ```
 
-  (Your Space ID will be looked upon on `ENV['CONTENTFUL_SPACE_ID']` and your Access Token on `ENV['CONTENTFUL_ACCESS_TOKEN']`.)
+  (Your Space ID will be looked upon on `ENV['CONTENTFUL_SPACE_ID']`, your Access Token on `ENV['CONTENTFUL_ACCESS_TOKEN']` and your environment on `ENV['CONTENTFUL_ENVIRONMENT']`.)
 
 3. Either add the following variables to your shell's configuration file (.bashrc or .bash_profile, for example):
 
   ```bash
   export CONTENTFUL_ACCESS_TOKEN=abc123
   export CONTENTFUL_SPACE_ID=abc123
+  export CONTENTFUL_ENVIRONMENT=master
   ```
 
   (And run `source ~/.bashrc` or open new terminal to enable changes.)
@@ -151,7 +158,7 @@ therefore you can do the following:
   Or specify them on the command line:
 
   ```bash
-  CONTENTFUL_ACCESS_TOKEN=abc123 CONTENTFUL_SPACE_ID=abc123 jekyll contentful
+  CONTENTFUL_ACCESS_TOKEN=abc123 CONTENTFUL_SPACE_ID=abc123 CONTENTFUL_ENVIRONMENT=master jekyll contentful
   ```
 
 4. Party.

data/lib/jekyll-contentful-data-import.rb

@@ -1,5 +1,5 @@
 require 'jekyll-contentful-data-import/version'
 
-%w(contentful).each do |file|
+%w[contentful].each do |file|
   require File.expand_path("jekyll/commands/#{file}.rb", File.dirname(__FILE__))
 end

data/lib/jekyll-contentful-data-import/importer.rb

@@ -19,6 +19,7 @@ module Jekyll
           space_client = client(
             value_for(options, 'space'),
             value_for(options, 'access_token'),
+            value_for(options, 'environment'),
             client_options(options.fetch('client_options', {}))
           )
 
@@ -62,7 +63,7 @@ module Jekyll
 
       def value_for(options, key)
         potential_value = options[key]
-        return ENV[potential_value.gsub('ENV_', '')] if potential_value.start_with?('ENV_')
+        return ENV[potential_value.gsub('ENV_', '')] if !potential_value.nil? && potential_value.start_with?('ENV_')
         potential_value
       end
 
@@ -90,10 +91,11 @@ module Jekyll
         all
       end
 
-      def client(space, access_token, options = {})
+      def client(space, access_token, environment = nil, options = {})
         options = {
           space: space,
           access_token: access_token,
+          environment: environment || 'master',
           dynamic_entries: :auto,
           raise_errors: true,
           integration_name: 'jekyll',

data/lib/jekyll-contentful-data-import/mappers/base.rb

@@ -33,7 +33,8 @@ module Jekyll
             'id' => entry.sys.fetch(:id, nil),
             'created_at' => entry.sys.fetch(:created_at, nil),
             'updated_at' => entry.sys.fetch(:updated_at, nil),
-            'content_type_id' => content_type.nil? ? nil : content_type.id
+            'content_type_id' => content_type.nil? ? nil : content_type.id,
+            'revision' => entry.sys.fetch(:revision, nil)
           }
         end
 

data/lib/jekyll-contentful-data-import/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Contentful
-    VERSION = '1.6.0'.freeze
+    VERSION = '1.7.0'.freeze
   end
 end

data/spec/jekyll-contentful/importer_spec.rb

@@ -45,6 +45,7 @@ describe Jekyll::Contentful::Importer do
         expect(::Contentful::Client).to receive(:new).with(
           space: 'foo',
           access_token: 'foobar',
+          environment: 'master',
           dynamic_entries: :auto,
           raise_errors: true,
           integration_name: 'jekyll',
@@ -58,13 +59,14 @@ describe Jekyll::Contentful::Importer do
         expect(::Contentful::Client).to receive(:new).with(
           space: 'foo',
           access_token: 'foobar',
+          environment: 'master',
           dynamic_entries: :auto,
           raise_errors: false,
           integration_name: 'jekyll',
           integration_version: Jekyll::Contentful::VERSION
         )
 
-        subject.client('foo', 'foobar', raise_errors: false)
+        subject.client('foo', 'foobar', 'master', raise_errors: false)
       end
     end
 

data/spec/jekyll-contentful/mappers/base_spec.rb

@@ -83,7 +83,8 @@ describe Jekyll::Contentful::Mappers::Base do
             'id' => 'foo',
             'created_at' => nil,
             'updated_at' => nil,
-            'content_type_id' => 'content_type'
+            'content_type_id' => 'content_type',
+            'revision' => nil
           }
         }
         expect(subject.map).to eq expected
@@ -109,7 +110,8 @@ describe Jekyll::Contentful::Mappers::Base do
             'id' => 'foo',
             'created_at' => nil,
             'updated_at' => nil,
-            'content_type_id' => 'content_type'
+            'content_type_id' => 'content_type',
+            'revision' => nil
           },
           'asset' => {
             'sys' => {
@@ -133,7 +135,8 @@ describe Jekyll::Contentful::Mappers::Base do
               'id' => 'baz',
               'created_at' => nil,
               'updated_at' => nil,
-              'content_type_id' => 'content_type'
+              'content_type_id' => 'content_type',
+              'revision' => nil
             },
           },
           'array' => [
@@ -164,7 +167,8 @@ describe Jekyll::Contentful::Mappers::Base do
             'id' => 'foo',
             'created_at' => nil,
             'updated_at' => nil,
-            'content_type_id' => 'content_type'
+            'content_type_id' => 'content_type',
+            'revision' => nil
           },
           'foo' => {
             'en-US' => 'bar',
@@ -201,7 +205,8 @@ describe Jekyll::Contentful::Mappers::Base do
             'id' => 'foo',
             'created_at' => nil,
             'updated_at' => nil,
-            'content_type_id' => 'content_type'
+            'content_type_id' => 'content_type',
+            'revision' => nil
           },
           'asset' => {
             "en-US" => {

data/spec/jekyll-contentful/serializer_spec.rb

@@ -30,7 +30,8 @@ describe Jekyll::Contentful::Serializer do
                 'id' => 'foo',
                 'created_at' => nil,
                 'updated_at' => nil,
-                'content_type_id' => 'content_type'
+                'content_type_id' => 'content_type',
+                'revision' => nil
               }
             }
           ]
@@ -48,7 +49,8 @@ describe Jekyll::Contentful::Serializer do
                 'id' => 'foo',
                 'created_at' => nil,
                 'updated_at' => nil,
-                'content_type_id' => 'content_type'
+                'content_type_id' => 'content_type',
+                'revision' => nil
               },
               'foobar' => 'bar'
             }
@@ -73,14 +75,16 @@ describe Jekyll::Contentful::Serializer do
                 'id' => 'foo',
                 'created_at' => nil,
                 'updated_at' => nil,
-                'content_type_id' => 'content_type'
+                'content_type_id' => 'content_type',
+                'revision' => nil
               },
               'foobar' => {
                 'sys' => {
                   'id' => 'foobar',
                   'created_at' => nil,
                   'updated_at' => nil,
-                  'content_type_id' => 'content_type'
+                  'content_type_id' => 'content_type',
+                  'revision' => nil
                 },
                 'baz' => 1
               }
@@ -103,7 +107,8 @@ describe Jekyll::Contentful::Serializer do
                 'id' => 'foo',
                 'created_at' => nil,
                 'updated_at' => nil,
-                'content_type_id' => 'content_type'
+                'content_type_id' => 'content_type',
+                'revision' => nil
               },
               'foobar' => 'bar'
             },
@@ -112,7 +117,8 @@ describe Jekyll::Contentful::Serializer do
                 'id' => 'bar',
                 'created_at' => nil,
                 'updated_at' => nil,
-                'content_type_id' => 'content_type'
+                'content_type_id' => 'content_type',
+                'revision' => nil
               },
               'foobar' => 'baz'
             }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-contentful-data-import
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Contentful GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-19 00:00:00.000000000 Z
+date: 2018-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -270,7 +270,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Include mangablable content from the Contentful CMS and API into your Jekyll