jekyll-contentful-data-import 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c3583ff47a05314cd2914810223cad4e0ab01894
+  data.tar.gz: 21cfbb2ed72ad174e5d4613ea1aa3b101ba8ed5b
+SHA512:
+  metadata.gz: 5ce05d4e5b0a10b60b4dd35ee9ecbc6d35f9fd9546cb1eaf0800659c6ae7dba3db265433ac74d3823b8107b12d4d4a8839664bbe43565b86e0f2d6a0570b491e
+  data.tar.gz: 37c934537a139a0ffa9d19a6011044aa6af48cb66c7f474647fba0bbc632a477b40045a2c6386880cc2ed4eb02509f1c9dc91c4275b609ad15658dc9ffce65e5

data/.gitignore

@@ -0,0 +1,14 @@
+*.gem
+.bundle
+Gemfile*.lock
+pkg/*
+.rvmrc
+.DS_Store
+.rbenv-version
+.ruby-version
+tmp
+doc
+.yardoc
+build/
+.sass-cache
+coverage

data/.travis.yml

@@ -0,0 +1,18 @@
+rvm:
+  - 2.0.0
+  - 2.1.2
+  - 2.2.3
+  - jruby
+
+script: "bundle exec rake test"
+
+before_install: gem install bundler -v 1.10.6
+
+env: TEST=true JRUBY_OPTS='--2.0'
+notifications:
+  slack:
+    secure: MMWxqKMT4m2UhZ+Ix4wgCs1nLvu9hUFCbyV/qJWmIFif7V4GUKXi6h9krMqGqBAd3YV3pP/InPlw3QoKBUGIAIr5GzDpSnU5ACv7E61v548qViEvPBqsfhRHha2M164rUHn32tpejJnIizVUyND/hIzNviIrab+G8uOaZXUtB5I=
+
+matrix:
+  allow_failures:
+    - rvm: jruby

data/.yardopts

@@ -0,0 +1,3 @@
+lib/**/*.rb
+--no-private
+--hide-void-return

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+## Unreleased
+
+## v0.1.1
+### Changed
+
+* Some documented as Optional parameters now truly Optional
+
+## v0.1.0 [YANKED]
+
+* Initial Release

data/CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# Contributing
+In the spirit of [free software][free-sw], **everyone** is encouraged to help
+improve this project.
+
+[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing specifications
+* by writing code ( **no patch is too small** : fix typos, add comments, clean up inconsistent whitespace )
+* by refactoring code
+* by closing [issues][]
+* by reviewing patches
+
+[issues]: https://github.com/contentful/jekyll-contentful-data-import/issues
+
+## Submitting an Issue
+We use the [GitHub issue tracker][issues] to track bugs and features. Before
+submitting a bug report or feature request, check to make sure it hasn't
+already been submitted. When submitting a bug report, please include a [Gist][]
+that includes a stack trace and any details that may be necessary to reproduce
+the bug, including your gem version, Ruby version, and operating system.
+Ideally, a bug report should include a pull request with failing specs.
+
+[gist]: https://gist.github.com/
+
+## Submitting a Pull Request
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Add specs for your unimplemented feature or bug fix.
+4. Run `bundle exec rake test`. If your specs pass, return to step 3.
+5. Implement your feature or bug fix.
+6. Run `bundle exec rake test`. If your specs fail, return to step 5.
+7. Add, commit, and push your changes.
+8. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: http://learn.github.com/p/branching.html
+[pr]: http://help.github.com/send-pull-requests/

data/Gemfile

@@ -0,0 +1,6 @@
+# If you have OpenSSL installed, we recommend updating
+# the following line to use "https"
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in contentful_middleman.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: 'rspec --format documentation --color' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Contentful GmbH
+
+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,94 @@
+# Jekyll-Contentful-Data-Import
+
+[![Build Status](https://travis-ci.com/contentful/jekyll-contentful.svg?token=Nx7fXKYs7PbM7CcY2dS1)](https://travis-ci.org/contentful/jekyll-contentful)
+
+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).
+
+Experience the power of Jekyll while staying sane as a developer by letting end-users edit content in a web-based interface.
+
+
+## Installation
+Add the following line to the Gemfile of your Jekyll project:
+
+```ruby
+group :jekyll_plugins do
+  gem "jekyll-contentful-data-import"
+end
+```
+
+Then as usual, run:
+
+```bash
+bundle install
+```
+
+## Usage
+
+Run `jekyll contentful` in your terminal. This will fetch entries for the configured
+spaces and content types and put the resulting data in the
+[local data folder](http://jekyllrb.com/docs/datafiles/) as yaml files.
+
+### --rebuild option
+
+The `contentful` command has a `--rebuild` option which will trigger a rebuild of your site
+
+## Configuration
+
+To configure the extension, add the following configuration block to Jekyll's `_config.yml`:
+
+```yaml
+contentful:
+  spaces:
+    - example: # Jekyll _data folder identifier - Required
+        space: cfexampleapi        # Required
+        access_token: b4c0n73n7fu1 # Required
+        cda_query:                 # Optional
+          include: 2
+          limit: 100
+        content_types:             # Optional
+          cat: MyCoolMapper
+        client_options:            # Optional
+          :preview: false
+          :raise_errors: true
+          :dynamic_entries: :auto
+```
+
+Parameter           | Description
+----------          | ------------
+space               | Contentful Space ID
+access_token        | Contentful Delivery API access token
+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.
+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.
+
+You can add multiple spaces to your configuration
+
+## Entry mapping
+
+The extension will transform every fetched entry before storing it as a yaml file in the local
+data folder. If a custom mapper is not specified a default one will be used.
+
+The default mapper will map fields, assets and linked entries.
+
+### Custom mappers
+
+You can create your own mappers if you need so. The only requirement for a class to behave as a
+mapper is to have a `map` instance method.
+
+Following is an example of such custom mapper that adds all `sys` properties to the entry:
+
+```ruby
+class MySysMapper < ::Jekyll::Contentful::Mappers::Base
+  def map
+    result = super
+
+    entry.sys.each do |k, v|
+      name, value = map_field k, v
+      result['sys'][name] = value
+    end
+
+    result
+  end
+end
+```
+

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rake/clean'
+
+desc "Run tests, both RSpec and Cucumber"
+task :test => [:spec]
+
+require 'rspec/core/rake_task'
+desc "Run RSpec"
+RSpec::Core::RakeTask.new do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['--color']
+end
+
+require 'rake'
+
+require 'rubygems/tasks'
+Gem::Tasks.new

data/jekyll-contentful.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require File.expand_path('../lib/jekyll-contentful-data-import/version.rb', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "jekyll-contentful-data-import"
+  s.version     = Jekyll::Contentful::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Contentful GmbH']
+  s.email       = ["david.litvak@contentful.com"]
+  s.homepage    = "https://www.contentful.com"
+  s.summary     = %q{Include mangablable content from the Contentful CMS and API into your Jekyll projects}
+  s.description = %q{Load blog posts and other managed content into Jekyll}
+  s.license = "MIT"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # The version of middleman-core your extension depends on
+  s.add_dependency("jekyll", ">= 2.5.0", "< 4")
+
+  # Additional dependencies
+  s.add_dependency("contentful", '~> 0.8')
+
+  s.add_development_dependency 'rubygems-tasks', '~> 0.2'
+  s.add_development_dependency "guard"
+  s.add_development_dependency "guard-rspec"
+  s.add_development_dependency "bundler", "~> 1.6"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec", "~> 3.0"
+  s.add_development_dependency "vcr"
+  s.add_development_dependency "webmock"
+  s.add_development_dependency "pry"
+end

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

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

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

@@ -0,0 +1,47 @@
+require 'jekyll-contentful-data-import/serializer'
+
+module Jekyll
+  module Contentful
+    class DataExporter
+      DATA_FOLDER = '_data'
+      CONTENTFUL_FOLDER = 'contentful'
+      SPACES_FOLDER = 'spaces'
+
+      attr_reader :name, :entries, :config
+
+      def initialize(name, entries, config = {})
+        @name = name
+        @entries = entries
+        @config = config
+      end
+
+      def run
+        setup_directory
+
+        File.open(destination_file, 'w') do |file|
+          file.write(::Jekyll::Contentful::Serializer.new(entries, config).to_yaml)
+        end
+      end
+
+      def destination_directory
+        base_directory = File.expand_path(Dir.pwd)
+        File.join(base_directory, DATA_FOLDER, CONTENTFUL_FOLDER, SPACES_FOLDER)
+      end
+
+      def destination_file
+        File.join(destination_directory, "#{name}.yaml")
+      end
+
+      def setup_directory
+        data_folder = File.join(Dir.pwd, DATA_FOLDER)
+        Dir.mkdir(data_folder) unless Dir.exist?(data_folder)
+
+        contentful_folder = File.join(data_folder, CONTENTFUL_FOLDER)
+        Dir.mkdir(contentful_folder) unless Dir.exist?(contentful_folder)
+
+        spaces_folder = File.join(contentful_folder, SPACES_FOLDER)
+        Dir.mkdir(spaces_folder) unless Dir.exist?(spaces_folder)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+require 'contentful'
+require 'jekyll-contentful-data-import/data_exporter'
+
+module Jekyll
+  module Contentful
+    class Importer
+      attr_reader :config
+
+      def initialize(config)
+        @config = config
+      end
+
+      def run
+        spaces.each do |name, options|
+          space_client = client(
+            options['space'],
+            options['access_token'],
+            options.fetch('client_options', {})
+          )
+
+          Jekyll::Contentful::DataExporter.new(
+            name,
+            space_client.entries(options.fetch('cda_query', {})),
+            options
+          ).run
+        end
+      end
+
+      def spaces
+        config['spaces'].map { |space_data| space_data.first }
+      end
+
+      def client(space, access_token, options = {})
+        options = {
+          space: space,
+          access_token: access_token,
+          dynamic_entries: :auto,
+          raise_errors: true
+        }.merge(options)
+
+        ::Contentful::Client.new(options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1 @@
+require 'jekyll-contentful-data-import/mappers/base'

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

@@ -0,0 +1,87 @@
+require 'contentful'
+
+module Jekyll
+  module Contentful
+    module Mappers
+      class Base
+        def self.mapper_for(entry, config)
+          ct = entry.content_type
+
+          mapper_name = config.fetch(
+            'content_types', {}
+          ).fetch(
+            ct.id, ::Jekyll::Contentful::Mappers::Base.to_s
+          )
+
+          Module.const_get(mapper_name).new(entry, config)
+        end
+
+        attr_reader :entry, :config
+
+        def initialize(entry, config)
+          @entry = entry
+          @config = config
+        end
+
+        def map
+          result = {'sys' => {'id' => entry.id}}
+
+          fields = has_multiple_locales? ? entry.fields_with_locales : entry.fields
+
+          fields.each do |k, v|
+            name, value = map_field k, v
+            result[name] = value
+          end
+
+          result
+        end
+
+        def has_multiple_locales?
+          config.fetch('cda_query', {}).fetch(:locale, nil) == '*'
+        end
+
+        def map_field(field_name, field_value)
+          value_mapping = map_value(field_value)
+          return field_name.to_s, value_mapping
+        end
+
+        def map_value(value)
+          case value
+          when ::Contentful::Asset
+            map_asset(value)
+          when ::Contentful::Location
+            map_location(value)
+          when ::Contentful::Link
+            map_link(value)
+          when ::Contentful::DynamicEntry
+            map_entry(value)
+          when ::Array
+            map_array(value)
+          else
+            value
+          end
+        end
+
+        def map_asset(asset)
+          {'title' => asset.title, 'url' => asset.file.url}
+        end
+
+        def map_entry(child)
+          {'sys' => {'id' => child.id}}
+        end
+
+        def map_location(location)
+          location.properties
+        end
+
+        def map_link(link)
+          {'sys' => {'id' => link.id}}
+        end
+
+        def map_array(array)
+          array.map {|element| map_value(element)}
+        end
+      end
+    end
+  end
+end