contentful_middleman 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9139679962d383306d6e3bc2ac41003499bad3c
-  data.tar.gz: 7775dbb392e95e021cf9fa8adfb9a97a5e722ad2
+  metadata.gz: 702b32a151db22f1766007ab9037dd0f97514772
+  data.tar.gz: a1b77abea5946045d0ec3c0d78206a947cb91a37
 SHA512:
-  metadata.gz: f89ab95709e0510226915f0e3991d4561c193b80cb419a2f830206725c1a71c038852eb81d3e56bded678913e99f820b306700e4ddcd842c7ac7e57ff8e5b8fd
-  data.tar.gz: 118262ec63062c0962fce52c1ff643a40376c95668bf7fa219cc5ec8b8aee37313549e66d4cb3e9f4530f667facc2bcce7e041e11ac6d70bc18c12f54523277e
+  metadata.gz: 9347872cd447c2be6ba366e98578320239d5335957bbf41b263055fed811a4b7320493bdf4dc18a4c9928d0bdf147a593a0834bd4b3836acd73962e194dc2122
+  data.tar.gz: b481b2f37faee22a12a9bfbc172dff6d7fa76765d3f7b022564ec42bdca689c902a7bb67832ae329b2357fd821a99a149f7f4da71a6c7610abc4a943392e9e0f

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change Log
 
+## 1.1.0
+### Added
+* New extension option: `use_preview_api`
+* An example mapper that allows references from linked to linking entries
+
+### Changed
+* Make the all the entries available inside the mapper
+
+### Fixed
+* Calculate the version hash using the `updated_at` value of every entry instead of its revision
+
 ## 1.0.4
 ### Fixed
 * Typo in the require statements

data/README.md

@@ -1,6 +1,6 @@
 # Contentful Middleman
 
-[![Build Status](https://travis-ci.org/contentful/contentful_middleman.png)](https://travis-ci.org/contentful/contentful_middleman)
+[![Build Status](https://travis-ci.org/contentful-labs/contentful_middleman.svg?branch=master)](https://travis-ci.org/contentful-labs/contentful_middleman)
 
 Contentful Middleman is a [Middleman](http://middlemanapp.com/) extension to use the Middleman 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).
 
@@ -44,12 +44,13 @@ activate :contentful do |f|
 end
 ```
 
-Parameter     | Description
-----------    |------------
-space         | Hash with an user choosen name for the space as key and the space id as value
-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)
-content_types | Hash describing the mapping applied to entries of the imported content types
+Parameter       | Description
+----------      | ------------
+space           | Hash with an user choosen name for the space as key and the space id as value
+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)
+content_types   | Hash describing the mapping applied to entries of the imported content types
+use_preview_api | Boolean to toogle the used API. Set it to `false` to use `cdn.contentful.com` (default value). Set it to `true` to use `preview.contentful.com`. More info in [the documentation](https://www.contentful.com/developers/documentation/content-delivery-api/#preview-api)
 
 You can activate the extension multiple times to import entries from different spaces.
 ## Entry mapping
@@ -81,7 +82,7 @@ end
 If you don't want to map all the fields by hand inherit from the Base mappper:
 
 ```ruby
-class MyAwesomeMapper < ContentfulMiddleman::Mappers::Base
+class MyAwesomeMapper < ContentfulMiddleman::Mapper::Base
   def map(context, entry)
     super
     # After calling super the context object
@@ -91,6 +92,8 @@ class MyAwesomeMapper < ContentfulMiddleman::Mappers::Base
 end
 ```
 
+There's also an example back-reference mapper in the examples directory for adding back-references onto entries that are linked to by other entries.
+
 ## Configuration: examples
 
 ```ruby

data/examples/mappers/backref.rb

@@ -0,0 +1,59 @@
+# A function that returns a Mapper class for adding back-references to
+# contentful data files.  If a Product content type had a "company" entry field
+# that referenced a Company content type, using the following BackrefMapper on
+# the Company content type would add a "products" field to the company data
+# files with a list of all Products that reference that Company:
+#
+# BackrefMapper(EMPLOYEE_CONTENT_TYPE_ID, 'department', 'employees')
+#
+# For example, given these two files:
+#
+# ---
+# :id: 12345
+# :name: Jet-Propelled Tennis Shoes
+# :company:
+# - :id: 54321
+#   :name: Acme
+#
+# ---
+# :id: 54321
+# :name: Acme
+# :website: http://acme.example.com/
+#
+# The Acme company YAML file would become:
+#
+# ---
+# :id: 54321
+# :name: Acme
+# :website: http://acme.example.com/
+# :products:
+# - :id: 12345
+#   :name: Jet-Propelled Tennis Shoes
+#   :company:
+#   - :id: 54321
+#     :name: Acme
+#
+# Params:
+# +content_type_id+:: The ID of the content_type that references the
+# content_type that this mapper is being applied to
+# +content_type_field+:: The field name on the content_type to look for
+# references
+# +backref_field+:: The new field to create to hold the list of references
+def self.BackrefMapper(content_type_id, content_type_field, backref_field)
+  klass = Class.new ContentfulMiddleman::Mapper::Base do
+
+    @@content_type_id = content_type_id
+    @@content_type_field = content_type_field
+    @@backref_field = backref_field
+
+    def map(context, entry)
+      super
+      content_type_entries = @entries.select { |e| e.sys[:contentType].id == @@content_type_id }
+      referencing_entries = content_type_entries.select{ |e| e.send(@@content_type_field).map{|x| x.id}.include? entry.id }
+      referencing_ids = referencing_entries.map{ |e| e.id }
+      context.set(@@backref_field, map_value(referencing_ids))
+    end
+  end
+
+  return klass
+end

data/lib/contentful_middleman/commands/contentful.rb

@@ -71,7 +71,9 @@ module Middleman
         end
 
         def shared_instance
-          @shared_instance ||= ::Middleman::Application.server.inst
+          @shared_instance ||= ::Middleman::Application.server.inst do
+            set :environment, :contentful
+          end
         end
     end
 

data/lib/contentful_middleman/core.rb

@@ -25,6 +25,9 @@ module ContentfulMiddleman
     option :content_types, {},
       'The mapping of Content Types names to ids'
 
+    option :use_preview_api, false,
+      'Use the Preview API when fetching content'
+
 
     helpers ContentfulMiddleman::Helpers
 

data/lib/contentful_middleman/import_task.rb

@@ -25,11 +25,12 @@ module ContentfulMiddleman
     private
     def local_data_files
       entries.map do |entry|
-        content_type_mapper = @content_type_mappers.fetch(entry.content_type.id)
-        content_type_name   = @content_type_names.fetch(entry.content_type.id).to_s
-        context             = ContentfulMiddleman::Context.new
+        content_type_mapper_class = @content_type_mappers.fetch(entry.content_type.id)
+        content_type_name         = @content_type_names.fetch(entry.content_type.id).to_s
+        context                   = ContentfulMiddleman::Context.new
 
-        content_type_mapper.new.map(context, entry)
+        content_type_mapper = content_type_mapper_class.new(entries)
+        content_type_mapper.map(context, entry)
 
         LocalData::File.new(context.to_yaml, File.join(@space_name, content_type_name, entry.id))
       end

data/lib/contentful_middleman/instance.rb

@@ -1,5 +1,7 @@
 module ContentfulMiddleman
   class Instance
+    API_PREVIEW_URL = 'preview.contentful.com'
+
     def initialize(extension)
       @extension = extension
     end
@@ -30,12 +32,19 @@ module ContentfulMiddleman
 
     private
     def client
-      @client ||= Contentful::Client.new(
-        access_token:     options.access_token,
-        space:            options.space.fetch(:id),
-        dynamic_entries:  :auto,
-        raise_errors:     true
-      )
+      @client ||= Contentful::Client.new(client_options)
+    end
+
+    def client_options
+      client_options = {
+          access_token:     options.access_token,
+          space:            options.space.fetch(:id),
+          dynamic_entries:  :auto,
+          raise_errors:     true
+      }
+
+      client_options[:api_url] = API_PREVIEW_URL if options.use_preview_api
+      client_options
     end
 
     def options

data/lib/contentful_middleman/mappers/base.rb

@@ -3,6 +3,12 @@ require_relative '../commands/context'
 module ContentfulMiddleman
   module Mapper
     class Base
+      attr_reader :entries
+
+      def initialize(entries)
+        @entries = entries
+      end
+
       def map(context, entry)
         context.id = entry.id
         entry.fields.each {|k, v| map_field context, k, v}

data/lib/contentful_middleman/version.rb

@@ -1,3 +1,3 @@
 module ContentfulMiddleman
-  VERSION = "1.0.4"
+  VERSION = "1.1.0"
 end

data/lib/contentful_middleman/version_hash.rb

@@ -12,7 +12,7 @@ module ContentfulMiddleman
 
       def write_for_space_with_entries(space_name, entries)
         sorted_entries           = entries.sort {|a, b| a.id <=> b.id}
-        ids_and_revisions_string = sorted_entries.map {|e| "#{e.id}#{e.revision}"}.join
+        ids_and_revisions_string = sorted_entries.map {|e| "#{e.id}#{e.updated_at}"}.join
         entries_hash             = Digest::SHA1.hexdigest( ids_and_revisions_string )
 
         File.open(hashfilename(space_name), 'w') { |file| file.write(entries_hash) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contentful_middleman
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Sascha Konietzke
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-10 00:00:00.000000000 Z
+date: 2015-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -86,6 +86,7 @@ files:
 - Rakefile
 - TODO
 - contentful_middleman.gemspec
+- examples/mappers/backref.rb
 - lib/contentful_middleman.rb
 - lib/contentful_middleman/commands/contentful.rb
 - lib/contentful_middleman/commands/context.rb