contentful_middleman 1.5.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9f4cc17f613bedbda4d1c47204f5fb11212c2c1
-  data.tar.gz: 27f6a703690c874159b13366a75be793a7e36c30
+  metadata.gz: b7204295d8cde9e391d33b7bc656a09779c00f77
+  data.tar.gz: 6cd99474e752542dd354c12600dbe0589a8109aa
 SHA512:
-  metadata.gz: a92c016aed093ad6be4607c5720de5b6c58f826eb96c34280d9a2a3c36d0c3a8f113df3d307234d19acf67e13ae6d0a44f547cb165f3b576359553860eef128c
-  data.tar.gz: e29f82913048e350ef55898d7a27ba27efe9b00a6ba00483914e0ca530ed117dd07fe19c058dc097d961f7280d0b9c331a7064bcb4cf703ed2a09df17b75e963
+  metadata.gz: f1df4c1735ccafbff1ac1364244fd32b2ebb0e024404d5c8cf379dc0d9ca52b342bef4dd6601bac76978299f35ffde77852d7f76a70175e9d4fd4519d35a874c
+  data.tar.gz: b51f7dc9c107f3be63332fa42c8acfc95b5fe3f9de0d167e54d65998055575cc193b6d5ac1ce9c1a2c81bcb857ba9df1a8cc330167cc92757777bd82ad6a62f3

data/.travis.yml

@@ -1,7 +1,7 @@
 rvm:
-  - 2.0.0
   - 2.1.2
   - 2.2.3
+  - 2.3.1
   - jruby
 
 script: "bundle exec rake test"

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 # Change Log
 ## Unreleased
 
+## 2.0.0
+
+## Changed
+* Upgraded to 2.0.1 Ruby CDA SDK which solves a number of pre-existing bugs [#116](https://github.com/contentful/contentful_middleman/issues/116) [#113](https://github.com/contentful/contentful_middleman/issues/113) [#103](https://github.com/contentful/contentful_middleman/issues/103)
+* Field IDs will now be `snake_cased` following the 2.0.1 Ruby CDA SDK Upgrade
+
+## Added
+* Added `_meta` to all entries and assets [#117](https://github.com/contentful/contentful_middleman/issues/117) [#93](https://github.com/contentful/contentful_middleman/issues/93)
+* Added `client_options` to extension options to control Client instantiation
+
 ## 1.5.0
 
 ### Added

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,48 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at david.litvakb@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at [http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/DEPLOYING.md

@@ -0,0 +1,38 @@
+# Deploying to Specific Platforms
+
+> This document is intended for documenting caveats for deploying in different platforms.
+> It's contents are intended to be filled by users, submitting PR with their experiences, this will then be reviewed and merged if found it's indeed a best practice.
+
+* Format of the contribution:
+
+> # Name of the Platform
+>
+> ## Descriptive title of specific caveat
+>
+> > Description of the issue
+>
+> Steps to solve:
+>
+> 1. Do ...
+> 2. Then ...
+> 3. After ...
+>
+> Contributed by @your_username
+
+---
+
+# Placeholder Platform
+
+## Placeholder Caveat
+
+> Placeholder description
+
+Steps to solve:
+
+1. Do ...
+2. Then ...
+3. After ...
+
+> Contributed by @...
+
+---

data/Gemfile

@@ -9,7 +9,4 @@ gemspec
 
 gem "yard"
 
-# Test tools
-gem "simplecov"
-
 gem "cane", :platforms => [:mri_19, :mri_20], :require => false

data/README.md

@@ -54,6 +54,7 @@ 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). Note that by default only 100 entries will be fetched, this can be configured to up to 1000 entries using the `limit` option. Example: `f.cda_query = { limit: 1000 }`
+cda_query             | Hash describing client configuration. See [contentful.rb](https://github.com/contentful/contentful.rb#client-configuration-options) for more info. This option should commonly be used to change Rate Limit Management, Include Resolution, Logging and Proxies.
 content_types         | Hash describing the mapping applied to entries of the imported content types
 default_locale        | String with the value for the default locale for your space. Defaults to `'en-US'`.
 use_preview_api       | Boolean to toggle 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)
@@ -330,3 +331,7 @@ You can configure `:tries` and `:expires_in` in the `#with_preview` call like th
 <% end %>
 ```
 
+## Platform Specific Deployment Caveats
+
+For platform specific issues, please look into the [DEPLOYING](./DEPLOYING.md) document. This document is expected to grow with user contributions.
+Feel free to add your own discoveries to that file by issuing a Pull Request.

data/contentful_middleman.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
   s.add_dependency("middleman-core", ["~> 3.4"])
 
   # Additional dependencies
-  s.add_dependency("contentful", '~> 1.0')
+  s.add_dependency("contentful", '~> 2.0', '>= 2.0.1')
   s.add_dependency("contentful-webhook-listener", '~> 0.1')
 
   s.add_development_dependency 'rubygems-tasks', '~> 0.2'
@@ -32,6 +32,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec"
   s.add_development_dependency "vcr"
+  s.add_development_dependency "simplecov"
   s.add_development_dependency 'webmock', '~> 1', '>= 1.17.3'
   s.add_development_dependency 'tins', '~> 1.6.0'
 end

data/lib/contentful_middleman/core.rb

@@ -25,6 +25,9 @@ module ContentfulMiddleman
     option :cda_query, {},
       'The conditions that are used on the Content Delivery API to query for blog posts'
 
+    option :client_options, {},
+      'Additional configuration for the Contentful Client'
+
     option :content_types, {},
       'The mapping of Content Types names to ids'
 

data/lib/contentful_middleman/instance.rb

@@ -67,7 +67,7 @@ module ContentfulMiddleman
           dynamic_entries:  :auto,
           raise_errors:     true,
           default_locale:   options.default_locale
-      }
+      }.merge(options.client_options)
 
       client_options[:api_url] = API_PREVIEW_URL if options.use_preview_api
       client_options

data/lib/contentful_middleman/mappers/base.rb

@@ -50,7 +50,7 @@ module ContentfulMiddleman
           map_location(value)
         when Contentful::Link
           map_link(value)
-        when Contentful::DynamicEntry
+        when Contentful::Entry
           map_entry(value)
         when Array
           map_array(value, locale)
@@ -59,6 +59,15 @@ module ContentfulMiddleman
         end
       end
 
+      def map_asset_metadata(asset)
+        context = Context.new
+        context.updated_at = asset.sys[:updated_at].iso8601 unless asset.sys[:updated_at].nil?
+        context.created_at = asset.sys[:created_at].iso8601 unless asset.sys[:created_at].nil?
+        context.id = asset.sys[:id]
+
+        context
+      end
+
       def map_asset(asset, locale = nil)
         context = Context.new
         if locale
@@ -69,13 +78,26 @@ module ContentfulMiddleman
 
         context.title = asset.title unless context.has?(:title) && !context.title.nil?
         context.description = asset.description unless context.has?(:description) && !context.description.nil?
-        context.url = asset.file.url unless asset.file.nil? || (context.has?(:url) && !context.url.nil?)
+        context.url = asset.url unless asset.file.nil? || (context.has?(:url) && !context.url.nil?)
+
+        context._meta = map_asset_metadata(asset)
+
+        context
+      end
+
+      def map_entry_metadata(entry)
+        context = Context.new
+        context.content_type_id = entry.sys[:content_type].id unless entry.sys[:content_type].nil?
+        context.updated_at = entry.sys[:updated_at].iso8601 unless entry.sys[:updated_at].nil?
+        context.created_at = entry.sys[:created_at].iso8601 unless entry.sys[:created_at].nil?
+        context.id = entry.sys[:id]
 
         context
       end
 
       def map_entry_full(entry, context)
         context.id = entry.id
+        context._meta = map_entry_metadata(entry)
 
         fields = has_multiple_locales? ? entry.fields_with_locales : entry.fields
 

data/lib/contentful_middleman/tools/preview_proxy.rb

@@ -90,19 +90,19 @@ module ContentfulMiddleman
 
       def cache(name, super_call, query = {}, id = '')
         mapping = CACHE_MAPPINGS[name]
+        query_copy = Marshal.load(Marshal.dump(query))
 
-        if should_fetch_from_api?(name, query: query, id: id)
-          instance_variable_get("@#{mapping[:cache]}")[cache_key(name, query, id)] ||= {}
-          instance_variable_get("@#{mapping[:cache]}")[cache_key(name, query, id)][:tries] = 0
-          instance_variable_get("@#{mapping[:cache]}")[cache_key(name, query, id)][:expires] = DateTime.now + @expires_in
-
+        if should_fetch_from_api?(name, query: query_copy, id: id)
           new_resources = super_call.call(query, id)
-          instance_variable_get("@#{mapping[:cache]}")[cache_key(name, query, id)][:data] = new_resources
+          instance_variable_get("@#{mapping[:cache]}")[cache_key(name, query_copy, id)] ||= {}
+          instance_variable_get("@#{mapping[:cache]}")[cache_key(name, query_copy, id)][:tries] = 0
+          instance_variable_get("@#{mapping[:cache]}")[cache_key(name, query_copy, id)][:expires] = DateTime.now + @expires_in
+          instance_variable_get("@#{mapping[:cache]}")[cache_key(name, query_copy, id)][:data] = new_resources
           return new_resources
         end
 
-        instance_variable_get("@#{mapping[:cache]}")[cache_key(name, query, id)][:tries] += 1
-        instance_variable_get("@#{mapping[:cache]}")[cache_key(name, query, id)][:data]
+        instance_variable_get("@#{mapping[:cache]}")[cache_key(name, query_copy, id)][:tries] += 1
+        instance_variable_get("@#{mapping[:cache]}")[cache_key(name, query_copy, id)][:data]
       end
 
 

data/lib/contentful_middleman/version.rb

@@ -1,3 +1,3 @@
 module ContentfulMiddleman
-  VERSION = "1.5.0"
+  VERSION = "2.0.0"
 end

data/spec/contentful_middleman/instance_spec.rb

@@ -80,4 +80,19 @@ describe ContentfulMiddleman::Instance do
       end
     end
   end
+
+  describe 'client options' do
+    it 'respects the client configuration' do
+      options = OptionsDouble.new(client_options: {max_include_resolution_depth: 1})
+      extension = ExtensionDouble.new(options)
+      subject = described_class.new(extension)
+
+      vcr('instance/include_resolution_1') {
+        nyancat = subject.send(:client).entry('nyancat')
+
+        expect(nyancat.best_friend).to be_a ::Contentful::Entry
+        expect(nyancat.best_friend.best_friend).to be_a ::Contentful::Link
+      }
+    end
+  end
 end

data/spec/contentful_middleman/mappers/base_spec.rb

@@ -37,8 +37,19 @@ describe ContentfulMiddleman::Mapper::Base do
 
         expected = {
           :id=>"6KntaYXaHSyIw8M6eo26OK",
+          :_meta=> {
+            :content_type_id=> 'dog',
+            :updated_at=> '2013-11-18T09:13:37+00:00',
+            :created_at=> '2013-11-06T09:45:27+00:00',
+            :id=> '6KntaYXaHSyIw8M6eo26OK'
+          },
           :name=>"Doge",
           :image=> {
+            :_meta=> {
+              :updated_at=> "2013-12-18T13:27:14+00:00",
+              :created_at=> "2013-11-06T09:45:10+00:00",
+              :id=> "1x0xpXu4pSGS4OukSyWGUK"
+            },
             :title=>"Doge",
             :description=>"nice picture",
             :url=> "//images.contentful.com/cfexampleapi/1x0xpXu4pSGS4OukSyWGUK/cc1239c6385428ef26f4180190532818/doge.jpg"
@@ -48,7 +59,7 @@ describe ContentfulMiddleman::Mapper::Base do
 
         subject.map(context, entries.first)
 
-        expect(context.hashize).to eq(expected)
+        expect(context.hashize).to match(expected)
       end
 
       it 'maps entries with multiple locales' do
@@ -56,12 +67,23 @@ describe ContentfulMiddleman::Mapper::Base do
         expect(context.hashize).to eq({})
 
         expected = {
+          :_meta => {
+            :content_type_id=>"dog",
+            :updated_at=>"2013-11-18T09:13:37+00:00",
+            :created_at=>"2013-11-06T09:45:27+00:00",
+            :id=>"6KntaYXaHSyIw8M6eo26OK"
+          },
           :id=>"6KntaYXaHSyIw8M6eo26OK",
           :name=> {
             :'en-US'=>"Doge"
           },
-          :image=>{
-            :'en-US'=>{
+          :image=> {
+            :'en-US'=> {
+              :_meta=> {
+                :updated_at=> "2013-12-18T13:27:14+00:00",
+                :created_at=> "2013-11-06T09:45:10+00:00",
+                :id=>"1x0xpXu4pSGS4OukSyWGUK"
+              },
               :title=>"Doge",
               :description=>"nice picture",
               :url=>"//images.contentful.com/cfexampleapi/1x0xpXu4pSGS4OukSyWGUK/cc1239c6385428ef26f4180190532818/doge.jpg"
@@ -83,19 +105,40 @@ describe ContentfulMiddleman::Mapper::Base do
           expect(context.hashize).to eq({})
 
           expected = {
+            :_meta => {
+              :content_type_id=>"test",
+              :updated_at=>"2016-09-29T14:53:54+00:00",
+              :created_at=>"2016-09-29T14:53:54+00:00",
+              :id=>"42kEjzNj9mIci2eyGOISiQ"
+            },
             :id=>"42kEjzNj9mIci2eyGOISiQ",
             :image=>{
-              :'en-US'=>{
+              :'en-US'=> {
+                :_meta=> {
+                  :updated_at=> "2016-09-29T14:53:26+00:00",
+                  :created_at=> "2016-09-29T14:53:26+00:00",
+                  :id=> "6Rloj9MIxOwg0w2kqCaWS2"
+                },
                 title: "image-view-1139205 960 720",
                 description: nil,
                 url: "//images.contentful.com/1sjfpsn7l90g/6Rloj9MIxOwg0w2kqCaWS2/464b740a98d711905545f77d56fa3b2b/image-view-1139205_960_720.jpg"
               },
               :es=>{
+                :_meta=> {
+                  :updated_at=> "2016-09-29T14:53:26+00:00",
+                  :created_at=> "2016-09-29T14:53:26+00:00",
+                  :id=> "2WGPppy4laAWWgUiWG02SA"
+                },
                 title: "background-image-967820 960 720",
                 description: nil,
                 url: "//images.contentful.com/1sjfpsn7l90g/2WGPppy4laAWWgUiWG02SA/3951271109e19ae45b21bb044b24b3ec/background-image-967820_960_720.jpg"
               },
-              :zh=>{
+              :zh=> {
+                :_meta=> {
+                  :updated_at=> "2016-09-29T14:53:26+00:00",
+                  :created_at=> "2016-09-29T14:53:26+00:00",
+                  :id=>"6zkhmrCizKuQUG0UmYKe4W"
+                },
                 title: "image-view-1139204 960 720",
                 description: nil,
                 url: "//images.contentful.com/1sjfpsn7l90g/6zkhmrCizKuQUG0UmYKe4W/a8f90059b5bfd620791814f2c3edfaa4/image-view-1139204_960_720.jpg"
@@ -123,14 +166,30 @@ describe ContentfulMiddleman::Mapper::Base do
           expect(context.hashize).to eq({})
 
           expected = {
+            :_meta => {
+              :content_type_id=>"test",
+              :updated_at=>"2016-10-05T14:32:07+00:00",
+              :created_at=>"2016-10-05T14:32:07+00:00",
+              :id=>"2HjFERK39eeCYegCayUkMK"
+            },
             id: "2HjFERK39eeCYegCayUkMK",
             image: {
               :"en-US" => {
+                :_meta=> {
+                  :updated_at=> "2016-10-05T14:31:36+00:00",
+                  :created_at=> "2016-10-05T14:31:36+00:00",
+                  :id=>"14bZJKTr6AoaGyeg4kYiWq"
+                },
                 title: "EN Title",
                 description: "EN Description",
                 url: "//assets.contentful.com/bht13amj0fva/14bZJKTr6AoaGyeg4kYiWq/13f00bdf75c1320061ce471a3881e831/Flag_of_the_United_States.svg"
               },
               es: {
+                :_meta=> {
+                  :updated_at=> "2016-10-05T14:31:36+00:00",
+                  :created_at=> "2016-10-05T14:31:36+00:00",
+                  :id=>"14bZJKTr6AoaGyeg4kYiWq"
+                },
                 title: "ES Title",
                 description: "ES Description",
                 url: "//assets.contentful.com/bht13amj0fva/14bZJKTr6AoaGyeg4kYiWq/5501c98c296af77b9acba1146ea3e211/Flag_of_Spain.svg"
@@ -167,7 +226,13 @@ describe ContentfulMiddleman::Mapper::Base do
       context = ContentfulMiddleman::Context.new
 
       expect { subject.map(context, entry) }.not_to raise_error
-      expect(context.hashize).to eq(id: 'foo')
+      expect(context.hashize).to eq({
+        :_meta=> {
+          :content_type_id=> 'foo_ct',
+          :id=> 'foo'
+        },
+        id: 'foo'
+      })
     end
 
     it 'should not fail on missing asset file - #85' do
@@ -185,7 +250,7 @@ describe ContentfulMiddleman::Mapper::Base do
         expect(entry_with_nil_file.one_media.file).to be_nil
 
         expect { subject.map(context, entry_with_nil_file) }.not_to raise_error
-        expect(context.hashize[:oneMedia].keys.map(&:to_s)).not_to include('url')
+        expect(context.hashize[:one_media].keys.map(&:to_s)).not_to include('url')
       }
     end
 
@@ -203,11 +268,36 @@ describe ContentfulMiddleman::Mapper::Base do
         subject.map(context, entry_with_repeated_item)
         hash = YAML.load(context.to_yaml)
         expect(hash[:bars]).to match([
-          { id: "1Xq3cu45qguO4Uiwc2yycY", name: "bar_1" },
-          { id: "6jLRFVvafuM6E0QiCA8YMu", name: "bar_2" },
-          { id: "1Xq3cu45qguO4Uiwc2yycY", name: "bar_1" }
+          {
+            :id=>"1Xq3cu45qguO4Uiwc2yycY",
+            :_meta=> {
+              :content_type_id=>"bar",
+              :updated_at=>"2016-12-12T13:40:58+00:00",
+              :created_at=>"2016-12-12T13:40:58+00:00",
+              :id=>"1Xq3cu45qguO4Uiwc2yycY"},
+              :name=>"bar_1"
+          },
+          {
+            :id=>"6jLRFVvafuM6E0QiCA8YMu",
+             :_meta=> {
+              :content_type_id=>"bar",
+              :updated_at=>"2016-12-12T13:41:05+00:00",
+              :created_at=>"2016-12-12T13:41:05+00:00",
+              :id=>"6jLRFVvafuM6E0QiCA8YMu"
+            },
+            :name=>"bar_2"
+          },
+          {
+            :id=>"1Xq3cu45qguO4Uiwc2yycY",
+            :_meta=> {
+              :content_type_id=>"bar",
+              :updated_at=>"2016-12-12T13:40:58+00:00",
+              :created_at=>"2016-12-12T13:40:58+00:00",
+              :id=>"1Xq3cu45qguO4Uiwc2yycY"
+            },
+            :name=>"bar_1"
+          }
         ])
-
         expect(hash[:bars].first).to eq(hash[:bars].last)
       }
     end