contentful 2.0.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b88ce6b2f318329940d00e5caef099b4df98cdb3
-  data.tar.gz: a8f3faaad9fbf0dbfe570c8cf668300f48bda9bd
+  metadata.gz: 64ddb906124dfd977570b56271e874dd105bad5d
+  data.tar.gz: dc3c20c1dadf513ef9429ade5c0e7f796c4a5d1e
 SHA512:
-  metadata.gz: 70a46ff4f68e54e2b0f36d6a06d419e1b51d0624b03c4e28c8a06ecec78a1e3c3d74ecad99ad879fd3450271c489e1b77f072820fb87f294e75c205402285ba5
-  data.tar.gz: a8edabd0c40d9e73a9240352f7b7cef24ebc9f9735c5c69db22823ba8cdcbbf9306a917c5acc73dbb1d3e6caf5495ac5887b0382ca99a500e93b6dca7de416b1
+  metadata.gz: ba13149d7dc6794482c5950f2bb563511041731899f0b757d3efc8aeb7557e0e1670b273755b5c0b422efa7c3d7ed03f2343e014c6608541f6311a9d14e09900
+  data.tar.gz: 899dbabd938a143fba8190e3f1bacdf7c6d46482059a9b1370b393f86688a18535e81d33508b13da7e90d7e4c18c34f2f4daeb403832d2f8d7b0b592750e201f

data/.rubocop.yml

@@ -19,7 +19,7 @@ AllCops:
     - Rakefile
 
 Metrics/ClassLength:
-  Max: 230
+  Max: 250
 
 Style/MutableConstant:
   Enabled: false

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 2.1.0
+### Added
+* Added `X-Contentful-User-Agent` header for more information.
+
 ## 2.0.3
 
 ### Fixed

data/README.md

@@ -58,12 +58,6 @@ content_type = client.content_type 'cat'
 content_type.description # "Meow."
 ```
 
-Alternatively, the data can be accessed as Ruby `Hash` with symbolized keys (and in camelCase):
-
-```ruby
-content_type.properties # { name: '...', description: '...' }
-```
-
 System Properties behave the same and can be accessed via the `#sys` method.
 
 ```ruby
@@ -315,19 +309,6 @@ client = Contentful::Client.new(
 client.entry('nyancat') # is instance of Cat
 ```
 
-If you want to use the `property :field_name` syntax, you can do it the following way:
-
-```ruby
-class Cat < Contentful::Entry
-  include Contentful::Resource::CustomResource
-
-  property :name
-  property :lives
-  property :bestFriend
-  # ...
-end
-```
-
 ## Synchronization
 
 The client also includes a wrapper for the synchronization endpoint. You can initialize it with the options described in the [Delivery API Documentation](https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/synchronization) or an URL you received from a previous sync:
@@ -382,9 +363,25 @@ first_entry.fields('de-DE') # Returns German localizations
 
 - When an entry has related entries that are unpublished, they still end up in the resource as unresolved links. We consider this correct, because it is in line with the API responses and our other SDKs. However, you can use the workaround from [issue #60](/../../issues/60) if you happen to want this working differently.
 
-- While this library doesn't directly allow parsing Contentful webhook responses, you can check out [this code snippet](https://gist.github.com/neonichu/17a987aeeb256d4bf6f3) for a way to do it.
+## Migrating to 2.x
 
+If you're a `0.x` or a `1.x` user of this gem, and are planning to migrate to the current `2.x` branch.
+There are a few breaking changes you have to take into account:
+
+* `Contentful::Link#resolve` and `Contentful::Array#next_page` now require a `Contentful::Client` instance as a parameter.
+* `Contentful::CustomResource` does no longer exist, custom entry classes can now inherit from `Contentful::Entry` and have proper marshalling working.
+* `Contentful::Resource` does no longer exist, all resource classes now inherit from `Contentful::BaseResource`. `Contentful::Entry` and `Contentful::Asset` inherit from `Contentful::FieldsResource` which is a subclass of `Contentful::BaseResource`.
+* `Contentful::DynamicEntry` does no longer exist, if code checked against that base class, it should now check against `Contentful::Entry` instead.
+* `Contentful::Client#dynamic_entry_cache` _(private)_ has been extracted to it's own class, and can be now manually cleared by using `Contentful::ContentTypeCache::clear`.
+* `Contentful::BaseResource#sys` and `Contentful::FieldsResource#fields` internal representation for keys are now snake cased to match the instance accessors. E.g. `entry.fields[:myField]` previously had the accessor `entry.my_field`, now it is `entry.fields[:my_field]`. The value in both cases would correspond to the same field, only change is to unify the style. If code accessed the values through the `#sys` or `#fields` methods, keys now need to be snake cased.
+* Circular references are handled as individual objects to simplify marshalling and reduce stack errors, this introduces a performance hit on extremely interconnected content. Therefore, to limit the impact of circular references, an additional configuration flag `max_include_resolution_depth` has been added. It is set to 20 by default (which corresponds to the maximum include level value * 2). This allows for non-circular but highly connected content to resolve properly. In very interconnected content, it also allows to reduce this number to improve performance. For a more in depth look into this you can read [this issue](https://github.com/contentful/contentful.rb/issues/124#issuecomment-287002469).
+* `#inspect` now offers a clearer and better output for all resources. If your code had assertions based on the string representation of the resources, update to the new format `<Contentful::#{RESOURCE_CLASS}#{additional_info} id="#{RESOURCE_ID}">`.
+
+For more information on the internal changes present in the 2.x release, please read the [CHANGELOG](CHANGELOG.md)
 
 ## License
 
-Copyright (c) 2014 Contentful GmbH - Jan Lelis. See LICENSE.txt for further details.
+Copyright (c) 2014 Contentful GmbH - Jan Lelis.
+Copyright (c) 2016 Contentfuk GmbH - David Litvak.
+
+See LICENSE.txt for further details.

data/lib/contentful/client.rb

@@ -6,6 +6,7 @@ require_relative 'content_type_cache'
 
 require 'http'
 require 'logger'
+require 'rbconfig'
 
 module Contentful
   # The client object is initialized with a space and a key and then used
@@ -34,7 +35,11 @@ module Contentful
       proxy_port: nil,
       max_rate_limit_retries: 1,
       max_rate_limit_wait: 60,
-      max_include_resolution_depth: 20
+      max_include_resolution_depth: 20,
+      application_name: nil,
+      application_version: nil,
+      integration_name: nil,
+      integration_version: nil
     }
     # Rate Limit Reset Header Key
     RATE_LIMIT_RESET_HEADER_KEY = 'x-contentful-ratelimit-reset'
@@ -73,6 +78,10 @@ module Contentful
     # @option given_configuration [::Array<String>] :dynamic_entries
     # @option given_configuration [::Hash<String, Contentful::Resource>] :resource_mapping
     # @option given_configuration [::Hash<String, Contentful::Resource>] :entry_mapping
+    # @option given_configuration [String] :application_name
+    # @option given_configuration [String] :application_version
+    # @option given_configuration [String] :integration_name
+    # @option given_configuration [String] :integration_version
     def initialize(given_configuration = {})
       @configuration = default_configuration.merge(given_configuration)
       normalize_configuration!
@@ -184,10 +193,72 @@ module Contentful
       "http#{configuration[:secure] ? 's' : ''}://#{configuration[:api_url]}/spaces/#{configuration[:space]}"
     end
 
+    # Returns the formatted part of the X-Contentful-User-Agent header
+    # @private
+    def format_user_agent_header(key, values)
+      header = "#{key} #{values[:name]}"
+      header = "#{header}/#{values[:version]}" if values[:version]
+      "#{header};"
+    end
+
+    # Returns the X-Contentful-User-Agent sdk data
+    # @private
+    def sdk_info
+      { name: 'contentful.rb', version: ::Contentful::VERSION }
+    end
+
+    # Returns the X-Contentful-User-Agent app data
+    # @private
+    def app_info
+      { name: configuration[:application_name], version: configuration[:application_version] }
+    end
+
+    # Returns the X-Contentful-User-Agent integration data
+    # @private
+    def integration_info
+      { name: configuration[:integration_name], version: configuration[:integration_version] }
+    end
+
+    # Returns the X-Contentful-User-Agent platform data
+    # @private
+    def platform_info
+      { name: 'ruby', version: RUBY_VERSION }
+    end
+
+    # Returns the X-Contentful-User-Agent os data
+    # @private
+    def os_info
+      os_name = case ::RbConfig::CONFIG['host_os']
+                when /(cygwin|mingw|mswin|windows)/i then 'Windows'
+                when /(darwin|macruby|mac os)/i      then 'macOS'
+                when /(linux|bsd|aix|solarix)/i      then 'Linux'
+                end
+      { name: os_name, version: Gem::Platform.local.version }
+    end
+
+    # Returns the X-Contentful-User-Agent
+    # @private
+    def contentful_user_agent
+      header = {
+        'sdk' => sdk_info,
+        'app' => app_info,
+        'integration' => integration_info,
+        'platform' => platform_info,
+        'os' => os_info
+      }
+
+      result = []
+      header.each do |key, values|
+        next unless values[:name]
+        result << format_user_agent_header(key, values)
+      end
+      result.join(' ')
+    end
+
     # Returns the headers used for the HTTP requests
     # @private
     def request_headers
-      headers = { 'User-Agent' => "RubyContentfulGem/#{Contentful::VERSION}" }
+      headers = { 'X-Contentful-User-Agent' => contentful_user_agent }
       headers['Authorization'] = "Bearer #{configuration[:access_token]}" if configuration[:authentication_mechanism] == :header
       headers['Content-Type'] = "application/vnd.contentful.delivery.v#{configuration[:api_version].to_i}+json" if configuration[:api_version]
       headers['Accept-Encoding'] = 'gzip' if configuration[:gzip_encoded]

data/lib/contentful/version.rb

@@ -1,5 +1,5 @@
 # Contentful Namespace
 module Contentful
   # Gem Version
-  VERSION = '2.0.3'
+  VERSION = '2.1.0'
 end

data/spec/client_configuration_spec.rb

@@ -202,4 +202,149 @@ describe 'Client Configuration Options' do
       expect(finn).to be_a Contentful::Entry
     end
   end
+
+  describe 'X-Contentful-User-Agent headers' do
+    it 'default values' do
+      expected = [
+        "sdk contentful.rb/#{Contentful::VERSION};",
+        "platform ruby/#{RUBY_VERSION};",
+      ]
+
+      client = create_client
+      expected.each do |h|
+        expect(client.contentful_user_agent).to include(h)
+      end
+
+      expect(client.contentful_user_agent).to match(/os (Windows|macOS|Linux)(\/.*)?;/i)
+
+      ['integration', 'app'].each do |h|
+        expect(client.contentful_user_agent).not_to include(h)
+      end
+    end
+
+    it 'with integration name only' do
+      expected = [
+        "sdk contentful.rb/#{Contentful::VERSION};",
+        "platform ruby/#{RUBY_VERSION};",
+        "integration foobar;"
+      ]
+
+      client = create_client(integration_name: 'foobar')
+      expected.each do |h|
+        expect(client.contentful_user_agent).to include(h)
+      end
+
+      expect(client.contentful_user_agent).to match(/os (Windows|macOS|Linux)(\/.*)?;/i)
+
+      ['app'].each do |h|
+        expect(client.contentful_user_agent).not_to include(h)
+      end
+    end
+
+    it 'with integration' do
+      expected = [
+        "sdk contentful.rb/#{Contentful::VERSION};",
+        "platform ruby/#{RUBY_VERSION};",
+        "integration foobar/0.1.0;"
+      ]
+
+      client = create_client(integration_name: 'foobar', integration_version: '0.1.0')
+      expected.each do |h|
+        expect(client.contentful_user_agent).to include(h)
+      end
+
+      expect(client.contentful_user_agent).to match(/os (Windows|macOS|Linux)(\/.*)?;/i)
+
+      ['app'].each do |h|
+        expect(client.contentful_user_agent).not_to include(h)
+      end
+    end
+
+    it 'with application name only' do
+      expected = [
+        "sdk contentful.rb/#{Contentful::VERSION};",
+        "platform ruby/#{RUBY_VERSION};",
+        "app fooapp;"
+      ]
+
+      client = create_client(application_name: 'fooapp')
+      expected.each do |h|
+        expect(client.contentful_user_agent).to include(h)
+      end
+
+      expect(client.contentful_user_agent).to match(/os (Windows|macOS|Linux)(\/.*)?;/i)
+
+      ['integration'].each do |h|
+        expect(client.contentful_user_agent).not_to include(h)
+      end
+    end
+
+    it 'with application' do
+      expected = [
+        "sdk contentful.rb/#{Contentful::VERSION};",
+        "platform ruby/#{RUBY_VERSION};",
+        "app fooapp/1.0.0;"
+      ]
+
+      client = create_client(application_name: 'fooapp', application_version: '1.0.0')
+      expected.each do |h|
+        expect(client.contentful_user_agent).to include(h)
+      end
+
+      expect(client.contentful_user_agent).to match(/os (Windows|macOS|Linux)(\/.*)?;/i)
+
+      ['integration'].each do |h|
+        expect(client.contentful_user_agent).not_to include(h)
+      end
+    end
+
+    it 'with all' do
+      expected = [
+        "sdk contentful.rb/#{Contentful::VERSION};",
+        "platform ruby/#{RUBY_VERSION};",
+        "integration foobar/0.1.0;",
+        "app fooapp/1.0.0;"
+      ]
+
+      client = create_client(
+        integration_name: 'foobar',
+        integration_version: '0.1.0',
+        application_name: 'fooapp',
+        application_version: '1.0.0'
+      )
+
+      expected.each do |h|
+        expect(client.contentful_user_agent).to include(h)
+      end
+
+      expect(client.contentful_user_agent).to match(/os (Windows|macOS|Linux)(\/.*)?;/i)
+    end
+
+    it 'when only version numbers, skips header' do
+      expected = [
+        "sdk contentful.rb/#{Contentful::VERSION};",
+        "platform ruby/#{RUBY_VERSION};"
+      ]
+
+      client = create_client(
+        integration_version: '0.1.0',
+        application_version: '1.0.0'
+      )
+
+      expected.each do |h|
+        expect(client.contentful_user_agent).to include(h)
+      end
+
+      expect(client.contentful_user_agent).to match(/os (Windows|macOS|Linux)(\/.*)?;/i)
+
+      ['integration', 'app'].each do |h|
+        expect(client.contentful_user_agent).not_to include(h)
+      end
+    end
+
+    it 'headers include X-Contentful-User-Agent' do
+      client = create_client
+      expect(client.request_headers['X-Contentful-User-Agent']).to eq client.contentful_user_agent
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contentful
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.1.0
 platform: ruby
 authors:
 - Contentful GmbH (Jan Lelis)
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-25 00:00:00.000000000 Z
+date: 2017-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http