jekyll-contentful-data-import 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1babd5463d86525723186512d0a5ff1788b032c8
-  data.tar.gz: beedb4ade62bd19fa81a27afaf28070113018906
+  metadata.gz: 07ed83d764273aa31d35ff66ccf3b1bdfb4f8d63
+  data.tar.gz: 9a354c8e5337733a735d375129b0e7f0ed878677
 SHA512:
-  metadata.gz: 5757f7558659b94941ac13d42750943c428b0827eac1eb0d5c7465447676d84a8a3bcca25e14ee699d66c2ee620edd31162aeff9ac89551ac2f7b32c5de1aed1
-  data.tar.gz: 391ff1027438166c09188e906e334cb04ef99acdd0987e4417a54c5cb1b41d01e8de6511e0a27b351fc7dba7728d9e9fcc8b851025dfb5553dd4411cd5001a9a
+  metadata.gz: 785ea7b18d834a822eec3a6f884d422af77ad477b85a49e7deb0666857904b8a9ac7ac9b5c77d3d5dd780a7ebe533ce50b1f1139e28b99bc61ce5a143d5e3387
+  data.tar.gz: 5e5e68fb849d44072850b7ed712543f87acc8b142fa716204d2ff347d99231c535805abb93172a682d6122080c879d37c18a20fefadc3003030470c2b930b606

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## Unreleased
 
+## v1.4.0
+### Fixed
+* Fix Locale support [#29](https://github.com/contentful/jekyll-contentful-data-import/issues/29)
+
+### Added
+* Allow override destination directory using the `destination` key in the configuration [#27](https://github.com/contentful/jekyll-contentful-data-import/pull/27)
+
 ## v1.3.0
 ### Added
 * Added the possibility to use `space` and `access_token` from environment variables [#14](https://github.com/contentful/jekyll-contentful-data-import/issues/14)

data/README.md

@@ -54,7 +54,7 @@ contentful:
         client_options:             # Optional
           api_url: 'preview.contentful.com' # Defaults to 'api.contentful.com' which is Production
         base_path: app_path         # Optional - Defaults to Current directory
-
+        destination: destination_in_data # Optional - Defaults to _data/contentful/spaces
 ```
 
 Parameter             | Description
@@ -67,6 +67,7 @@ all_entries_page_size | Integer, the amount of maximum entries per CDA Request w
 content_types         | Hash describing the mapping applied to entries of the imported content types
 client_options        | Hash describing Contentful::Client configuration. See [contentful.rb](https://github.com/contentful/contentful.rb) for more info.
 base_path             | String with path to your Jekyll Application, defaults to current directory. Path is relative to your current location.
+destination           | String with path within _data under which to store the output yaml file. Defaults to contentful/spaces
 
 You can add multiple spaces to your configuration
 
@@ -99,27 +100,6 @@ class MySysMapper < ::Jekyll::Contentful::Mappers::Base
 end
 ```
 
-### Hiding Space and Access Token in Public Repositories
-
-In most cases you may want to avoid including your credentials in publicly available sites,
-therefore you can hide your `space` and `access_token` by replacing them with `ENV_` prepended variables.
-
-This will look for the values in your system.
-
-For example:
-
-```yaml
-contentful:
-  spaces:
-    - example:
-        space: ENV_CONTENTFUL_SPACE_ID
-        access_token: ENV_CONTENTFUL_ACCESS_TOKEN
-```
-
-With this setup, your Space ID will be looked upon on `ENV['CONTENTFUL_SPACE_ID']` and your Access Token
-on `ENV['CONTENTFUL_ACCESS_TOKEN']`. This way it is safe to share your code, without having to worry
-about your credentials.
-
 #### Caveats
 
 Jekyll itself only allows you to import code as plugins only for its recognized plugin entry points.
@@ -138,6 +118,43 @@ end
 
 Then proceed to run: `bundle exec rake contentful`
 
+### Hiding Space and Access Token in Public Repositories
+
+In most cases you may want to avoid including your credentials in publicly available sites,
+therefore you can do the following:
+
+1. `bundle update`—make sure your gem version supports ENV_ variables
+
+2. Set up your _config like so:
+
+   ```yaml
+   contentful:
+     spaces:
+       - example:
+           space:        ENV_CONTENTFUL_SPACE_ID
+           access_token: ENV_CONTENTFUL_ACCESS_TOKEN
+   ```
+   (Your Space ID will be looked upon on `ENV['CONTENTFUL_SPACE_ID']` and your Access Token
+   on `ENV['CONTENTFUL_ACCESS_TOKEN']`.)
+
+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
+   ```
+   (And run `source ~/.bashrc` or open new terminal to enable changes.)
+
+   Or specify them on the command line:
+
+   ```bash
+   CONTENTFUL_ACCESS_TOKEN=abc123 CONTENTFUL_SPACE_ID=abc123 jekyll contentful
+   ```
+4. Party.
+
+This way, it is safe to share your code without having to worry
+about your credentials.
+
 ## Examples
 
 You can find working examples of multiple uses [here](https://github.com/contentful/contentful_jekyll_examples).

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

@@ -31,7 +31,10 @@ module Jekyll
       end
 
       def destination_directory
-        File.join(base_directory, DATA_FOLDER, CONTENTFUL_FOLDER, SPACES_FOLDER)
+        destination_dir = File.join(base_directory, DATA_FOLDER, CONTENTFUL_FOLDER, SPACES_FOLDER)
+        destination_dir = File.join(base_directory, DATA_FOLDER, config['destination']) if config.key?('destination')
+
+        destination_dir
       end
 
       def destination_file

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

@@ -37,7 +37,7 @@ module Jekyll
         end
 
         def has_multiple_locales?
-          config.fetch('cda_query', {}).fetch(:locale, nil) == '*'
+          config.fetch('cda_query', {}).fetch('locale', nil) == '*'
         end
 
         def map_field(field_name, field_value)
@@ -57,6 +57,14 @@ module Jekyll
             map_entry(value)
           when ::Array
             map_array(value)
+          when ::Symbol
+            value.to_s
+          when ::Hash
+            result = {}
+            value.each do |k, v|
+              result[k.to_s] = map_value(v)
+            end
+            result
           else
             value
           end

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

@@ -1,5 +1,5 @@
 module Jekyll
   module Contentful
-    VERSION = "1.3.0"
+    VERSION = "1.4.0"
   end
 end

data/spec/jekyll-contentful/data_exporter_spec.rb

@@ -43,6 +43,13 @@ describe Jekyll::Contentful::DataExporter do
         expected = File.join(Dir.pwd, 'foo_dir', '_data', 'contentful', 'spaces', 'foo.yaml')
         expect(subject.destination_file).to eq(expected)
       end
+
+      it 'overridden destination' do
+        subject = described_class.new('foo', [], {'base_path' => 'foo_dir', 'destination' => 'bar_path'})
+
+        expected = File.join(Dir.pwd, 'foo_dir', '_data', 'bar_path', 'foo.yaml')
+        expect(subject.destination_file).to eq(expected)
+      end
     end
 
     describe '#setup_directory' do

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

@@ -106,4 +106,28 @@ describe Jekyll::Contentful::Mappers::Base do
       end
     end
   end
+
+  describe 'issues' do
+    describe '#29 - Fix localized entries' do
+      it 'should properly serialize a localized entry' do
+        config = {'cda_query' => { 'locale' => '*' } }
+        fields = {
+          'en-US' => { 'foo' => 'bar' },
+          'de-DE' => { 'foo' => 'baz' }
+        }
+        entry = EntryDouble.new('foo', ContentTypeDouble.new, fields, true)
+        mapper = described_class.new(entry, config)
+
+        expected = {
+          'sys' => { 'id' => 'foo' },
+          'foo' => {
+            'en-US' => 'bar',
+            'de-DE' => 'baz'
+          }
+        }
+
+        expect(mapper.map).to match expected
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -7,6 +7,11 @@ require 'rspec'
 require 'jekyll'
 require File.expand_path('../../lib/jekyll-contentful-data-import.rb', __FILE__)
 
+RSpec.configure do |config|
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end
+
 VCR.configure do |config|
   config.cassette_library_dir = "spec/fixtures/vcr_fixtures"
   config.hook_into :webmock
@@ -33,12 +38,21 @@ class ContentTypeDouble
 end
 
 class EntryDouble < Contentful::DynamicEntry
-  attr_reader :id, :content_type, :fields
+  attr_reader :id, :content_type
 
-  def initialize(id = '', content_type = ContentTypeDouble.new, fields = {})
+  def initialize(id = '', content_type = ContentTypeDouble.new, fields = {}, locales = false)
     @id = id
     @content_type = content_type
-    @fields = fields
+
+    if locales
+      @fields = fields
+    else
+      @fields = { 'en-US' => fields }
+    end
+  end
+
+  def locale
+    'en-US'
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-contentful-data-import
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Contentful GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-26 00:00:00.000000000 Z
+date: 2016-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll