contentful 1.2.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0282a011ae90a4b76aad56ea87739191d7cfad3
-  data.tar.gz: 1a07148812c1bc8bb976f03e1816a5070790d880
+  metadata.gz: 3336395c12c33716d03ef5ccd4ca5662d0c9f0e4
+  data.tar.gz: ff41b0e879b3ab72bc0962abeac4dae2fb49496a
 SHA512:
-  metadata.gz: 98d2ad17326e6bdd452b49bf20494a54b19667b14e31962abdbc07864de7bf0e77ce5cf31ddb91cbf6bf0f396382ec30d2fdb3c6bd4ff8bd5123b1a0fd0abe83
-  data.tar.gz: 8f906415d0e28f43e6a996eb5caf68f2885ff605ad56a4fa9688ab612378a006ddac539dd190a6d956cd1572f6c4bbbe1d6a337cc456b45c6ff35bdaf177b4bc
+  metadata.gz: 39692cf6bc73f11ea37ede62a11fc70f9ca5ccc7346cfe415d88dc53c320a30443669b7585df78ef13b657697a7f91fe126f01e26cdbab280ab03ebd5bcbdc5b
+  data.tar.gz: a6d462ef93caf18c9179b36403911f255685bcacd3ff7a06c9f91eca40c5c8e1346474068f20766baa726513d9a63a0c5fee101f0037b6444230062bda5bf65a

data/CHANGELOG.md

@@ -2,6 +2,27 @@
 
 ## Unreleased
 
+## 2.0.0
+
+**ATTENTION**: Breaking Changes introduces in order to simplify code and improve the ability to add new features.
+
+## Changed
+
+* The removal of the Client and Request objects from the Resource objects, means that for example: Link#resolve and Array#next_page now require the client as a parameter.
+* Client#entry now uses /entries?sys.id=ENTRY_ID instead of /entries/ENTRY_ID to properly resolve includes.
+* Refactor locale handling code
+* Refactor ResourceBuilder
+* Update all specs to RSpec 3
+* Removed DynamicEntry and Resource
+* Moved ContentTypeCache outside of the client into it's own class
+* Added new base BaseResource and FieldsResource classes to handle common resource attributes and fields related attributes respectively
+* Coercions are now part of ContentType, each Field knows which coercion should be applied depending on Field#type
+* Resource #inspect now provides a clearer and better output, without all the noise that was previously there
+* CustomResource was removed, now subclasses of Entry should be used instead.
+* `max_include_resolution_depth` option added to the client, defaults to 20.
+* Updated LICENSE
+* Updated examples
+
 ## 1.2.2
 ### Fixed
 * Fixed Symbol/Text field serialization when value is `null` [#117](https://github.com/contentful/contentful.rb/issues/117)

data/LICENSE.txt

@@ -1,6 +1,7 @@
 The MIT License (MIT)
 
 Copyright (c) 2014 Contentful GmbH - Jan Lelis
+Copyright (c) 2016 Contentful GmbH - David Litvak
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -5,6 +5,8 @@ Ruby client for the [Contentful](https://www.contentful.com) Content Delivery AP
 
 [Contentful](https://www.contentful.com) is a content management platform for web applications, mobile apps and connected devices. It allows you to create, edit & manage content in the cloud and publish it anywhere via powerful API. Contentful offers tools for managing editorial teams and enabling cooperation between organizations.
 
+**IMPORTANT**: We're collecting feedback before releasing version 2.0.0 of the SDK, if you're interested in helping, please drop by this issue and help us improving: https://github.com/contentful/contentful.rb/issues/120
+
 ## Setup
 
 Add to your Gemfile and bundle:
@@ -248,6 +250,12 @@ Maximum time to wait for next available request (in seconds). Default value is 6
 can have up to 60 minutes of blocked requests. It is set to a default of 60 seconds in order to avoid blocking processes for too long, as rate limit retry behaviour
 is blocking per execution thread.
 
+### :max_include_resolution_depth
+
+Maximum amount of levels to resolve includes for SDK entities (this is independent of API-level includes - it represents the maximum depth the include resolution
+tree is allowed to resolved before falling back to `Link` objects). This include resolution strategy is in place in order to avoid having infinite circular recursion
+on resources with circular dependencies. Defaults to 20. _Note_: If you're using something like `Rails::cache` it's advisable to considerably lower this value
+(around 5 has proven to be a good compromise - but keep it higher or equal than your maximum API-level include parameter if you need the entire tree resolution).
 
 ### Proxy example
 

data/contentful.gemspec

@@ -35,9 +35,10 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'guard-rubocop'
   gem.add_development_dependency 'guard-yard'
   gem.add_development_dependency 'rubocop', '~> 0.41.0'
-  gem.add_development_dependency 'rspec', '~> 2'
+  gem.add_development_dependency 'rspec', '~> 3'
   gem.add_development_dependency 'rr'
   gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'simplecov'
   gem.add_development_dependency 'webmock', '~> 1', '>= 1.17.3'
   gem.add_development_dependency 'tins', '~> 1.6.0'
 end

data/examples/custom_classes.rb

@@ -1,42 +1,39 @@
-# Contentful resource classes are just plain Ruby classes that include the
-# Contentful::Resource module.
-#
-# You can then define properties of the class. This will create a getter method
-# with this name. You can optionally pass a type identifier (Symbol or Class).
-#
-# Classes will be instantiated for the properties,
-# Symbols will be looked up in Contentful::Resource::COERCIONS
-
 require 'contentful'
 
-class MyResource
-  include Contentful::Resource
-
-  property :some
-  property :age, :integer
-  property :country, Contentful::Locale
+# You can define your own custom classes that inherit from Contentful::Entry.
+# This allows you to define custom behaviour, for example, in this case, we want
+# the :country field to act as a Contentful::Locale
+class MyResource < Contentful::Entry
+  def country(locale = nil)
+    @country ||= Contentful::Locale.new(fields(locale)[:country])
+  end
 end
 
-res = MyResource.new(
+res = MyResource.new('fields' => {
   'some' => 'value',
   'age' => '25',
   'country' => { 'code' => 'de', 'name' => 'Deutschland' },
   'unknown_property' => 'ignored'
-)
+})
 
 p res.some # => "value"
 p res.age # => 25
 p res.country # #<Contentful::Locale: ...
 p res.unknown_property # NoMethodError
 
-# Another possibility to create customized resources is to just inherit from an
-# existing one:
+# To then have it mapped automatically from the client,
+# upon client instantiation, you set the :entry_mapping for your ContentType.
 
-class MyBetterArray < Contentful::Array
-  # e.g. define more methods that you need
-  def last
-    items.last
-  end
-end
+client = Contentful::Client.new(
+  space: 'your_space_id',
+  access_token: 'your_access_token',
+  entry_mapping: {
+    'myResource' => MyResource
+  }
+)
 
-# Read further in examples/resource_mapping.rb
+# We request the entries, entries of the 'myResource` content type,
+# will return MyResource class objects, while others will remain Contentful::Entry.
+client.entries.each { |e| puts e }
+# => <Contentful::Entry[other_content_type] id='foobar'>
+# => <MyResource[myResource] id='baz'>

data/examples/raise_errors.rb

@@ -6,7 +6,7 @@ client = Contentful::Client.new(
 )
 
 begin
-  p client.entry 'not found'
+  p client.asset 'not found'
 rescue => error
   p error
 end
@@ -17,4 +17,4 @@ client2 = Contentful::Client.new(
   raise_errors: false,
 )
 
-p client2.entry 'not found'
+p client2.asset 'not found'

data/lib/contentful.rb

@@ -1,4 +1,3 @@
 require 'contentful/version'
 require 'contentful/support'
 require 'contentful/client'
-require 'contentful/resource/custom_resource'

data/lib/contentful/array.rb

@@ -1,35 +1,43 @@
-require_relative 'resource'
-require_relative 'resource/array_like'
+require_relative 'base_resource'
+require_relative 'array_like'
 
 module Contentful
   # Resource Class for Arrays (e.g. search results)
   # @see _ https://www.contentful.com/developers/documentation/content-delivery-api/#arrays
   # @note It also provides an #each method and includes Ruby's Enumerable module (gives you methods like #min, #first, etc)
-  class Array
+  class Array < BaseResource
     # @private
     DEFAULT_LIMIT = 100
 
-    include Contentful::Resource
-    include Contentful::Resource::SystemProperties
-    include Contentful::Resource::ArrayLike
+    include Contentful::ArrayLike
 
-    property :total, :integer
-    property :limit, :integer
-    property :skip, :integer
-    property :items
+    attr_reader :total, :limit, :skip, :items, :endpoint
+
+    def initialize(item = nil,
+                   default_locale = Contentful::Client::DEFAULT_CONFIGURATION[:default_locale],
+                   endpoint = '', *)
+      super(item, { default_locale: default_locale })
+
+      @endpoint = endpoint
+      @total = item.fetch('total', nil)
+      @limit = item.fetch('limit', nil)
+      @skip = item.fetch('skip', nil)
+      @items = item.fetch('items', [])
+    end
+
+    # @private
+    def inspect
+      "<#{repr_name} total=#{total} skip=#{skip} limit=#{limit}>"
+    end
 
     # Simplifies pagination
     #
     # @return [Contentful::Array, false]
-    def next_page
-      if request
-        new_skip    = (skip || 0) + (limit || DEFAULT_LIMIT)
-        new_request = request.copy
-        new_request.query[:skip] = new_skip
-        new_request.get
-      else
-        false
-      end
+    def next_page(client = nil)
+      return false if client.nil?
+
+      new_skip = (skip || 0) + (limit || DEFAULT_LIMIT)
+      client.send(endpoint.delete('/'), limit: limit, skip: new_skip)
     end
   end
 end

data/lib/contentful/array_like.rb

@@ -0,0 +1,51 @@
+module Contentful
+  # Useful methods for array-like resources that can be included if an
+  # :items property exists
+  module ArrayLike
+    include Enumerable
+
+    # Returns true for array-like resources
+    #
+    # @return [true]
+    def array?
+      true
+    end
+
+    # Delegates to items#each
+    #
+    # @yield [Contentful::Entry, Contentful::Asset]
+    def each_item(&block)
+      items.each(&block)
+    end
+    alias each each_item
+
+    # Delegates to items#empty?
+    #
+    # @return [Boolean]
+    def empty?
+      items.empty?
+    end
+
+    # Delegetes to items#size
+    #
+    # @return [Number]
+    def size
+      items.size
+    end
+    alias length size
+
+    # Delegates to items#[]
+    #
+    # @return [Contentful::Entry, Contentful::Asset]
+    def [](index)
+      items[index]
+    end
+
+    # Delegates to items#last
+    #
+    # @return [Contentful::Entry, Contentful::Asset]
+    def last
+      items.last
+    end
+  end
+end

data/lib/contentful/asset.rb

@@ -1,14 +1,10 @@
-require_relative 'resource'
-require_relative 'resource/asset_fields'
+require_relative 'fields_resource'
+require_relative 'file'
 
 module Contentful
   # Resource class for Asset.
   # https://www.contentful.com/developers/documentation/content-delivery-api/#assets
-  class Asset
-    include Contentful::Resource
-    include Contentful::Resource::SystemProperties
-    include Contentful::Resource::AssetFields
-
+  class Asset < FieldsResource
     # @private
     def marshal_dump
       raw
@@ -16,10 +12,20 @@ module Contentful
 
     # @private
     def marshal_load(raw_object)
-      @properties = extract_from_object(raw_object, :property, self.class.property_coercions.keys)
-      @sys = raw_object.key?('sys') ? extract_from_object(raw_object['sys'], :sys) : {}
-      initialize_fields_for_localized_resource(raw_object)
-      @raw = raw_object
+      super(raw_object)
+      create_files!
+      define_asset_methods!
+    end
+
+    # @private
+    def inspect
+      "<#{repr_name} id='#{sys[:id]}' url='#{url}'>"
+    end
+
+    def initialize(*)
+      super
+      create_files!
+      define_asset_methods!
     end
 
     # Generates a URL for the Contentful Image API
@@ -54,5 +60,31 @@ module Contentful
     end
 
     alias url image_url
+
+    private
+
+    def create_files!
+      file_json = fields[:file]
+      return if file_json.nil?
+
+      is_localized = file_json.keys.none? { |f| %w(fileName contentType details url).include? f }
+      if is_localized
+        locales.each do |locale|
+          fields(locale)[:file] = ::Contentful::File.new(file_json[locale.to_s] || {})
+        end
+      else
+        fields[:file] = ::Contentful::File.new(file_json)
+      end
+    end
+
+    def define_asset_methods!
+      define_singleton_method :description do
+        fields.fetch(:description, nil)
+      end
+
+      define_singleton_method :file do |wanted_locale = nil|
+        fields(wanted_locale)[:file]
+      end
+    end
   end
 end

data/lib/contentful/base_resource.rb

@@ -0,0 +1,87 @@
+require_relative 'support'
+
+module Contentful
+  # Base definition of a Contentful Resource containing Sys properties
+  class BaseResource
+    attr_reader :raw, :default_locale, :sys
+
+    def initialize(item, configuration = {}, _localized = false, _includes = [], depth = 0)
+      @raw = item
+      @default_locale = configuration[:default_locale]
+      @depth = depth
+      @sys = hydrate_sys
+      @configuration = configuration
+
+      define_sys_methods!
+    end
+
+    # @private
+    def inspect
+      "<#{repr_name} id='#{sys[:id]}'>"
+    end
+
+    # Definition of equality
+    def ==(other)
+      self.class == other.class && sys[:id] == other.sys[:id]
+    end
+
+    # @private
+    def marshal_dump
+      raw
+    end
+
+    # @private
+    def marshal_load(raw_object)
+      @raw = raw_object
+      @sys = hydrate_sys
+      @depth = 0
+      define_sys_methods!
+    end
+
+    # Issues the request that was made to fetch this response again.
+    # Only works for Entry, Asset, ContentType and Space
+    def reload(client = nil)
+      return client.send(Support.snakify(self.class.name.split('::').last), id) unless client.nil?
+
+      false
+    end
+
+    private
+
+    def define_sys_methods!
+      @sys.each do |k, v|
+        define_singleton_method k do
+          v
+        end
+      end
+    end
+
+    def hydrate_sys
+      result = {}
+      raw.fetch('sys', {}).each do |k, v|
+        if %w(space contentType).include?(k)
+          v = build_link(v)
+        elsif %w(createdAt updatedAt deletedAt).include?(k)
+          v = DateTime.parse(v)
+        end
+        result[Support.snakify(k).to_sym] = v
+      end
+      result
+    end
+
+    protected
+
+    def repr_name
+      self.class
+    end
+
+    def internal_resource_locale
+      sys.fetch(:locale, nil) || default_locale
+    end
+
+    def build_link(item)
+      require_relative 'link'
+      ::Contentful::Link.new(item)
+    end
+  end
+end