contentful 0.8.0 → 0.9.0

data/lib/contentful/resource/system_properties.rb

@@ -2,6 +2,8 @@ module Contentful
   module Resource
     # Adds the feature to have system properties to a Resource.
     module SystemProperties
+      # @private
+      # Coercions for System Properties to native types
       SYS_COERCIONS = {
         type: :string,
         id: :string,
@@ -15,11 +17,13 @@ module Contentful
       }
       attr_reader :sys
 
+      # @private
       def initialize(object = nil, *)
         super
         @sys = object ? extract_from_object(object['sys'], :sys) : {}
       end
 
+      # @private
       def inspect(info = nil)
         if sys.empty?
           super(info)
@@ -28,12 +32,15 @@ module Contentful
         end
       end
 
+      # @private
       module ClassMethods
+        # @private
         def sys_coercions
           SYS_COERCIONS
         end
       end
 
+      # @private
       def self.included(base)
         base.extend(ClassMethods)
 

data/lib/contentful/resource_builder.rb

@@ -14,6 +14,8 @@ module Contentful
   # Transforms a Contentful::Response into a Contentful::Resource or a Contentful::Error
   # See example/resource_mapping.rb for advanced usage
   class ResourceBuilder
+    # Default Resource Mapping
+    # @see _ README for more information on Resource Mapping
     DEFAULT_RESOURCE_MAPPING = {
       'Space' => Space,
       'ContentType' => ContentType,
@@ -24,11 +26,17 @@ module Contentful
       'DeletedEntry' => DeletedEntry,
       'DeletedAsset' => DeletedAsset
     }
+    # Default Entry Mapping
+    # @see _ README for more information on Entry Mapping
     DEFAULT_ENTRY_MAPPING = {}
 
     attr_reader :client, :response, :resource_mapping, :entry_mapping, :resource
 
-    def initialize(client, response, resource_mapping = {}, entry_mapping = {}, default_locale = Contentful::Client::DEFAULT_CONFIGURATION[:default_locale])
+    def initialize(client,
+                   response,
+                   resource_mapping = {},
+                   entry_mapping = {},
+                   default_locale = Contentful::Client::DEFAULT_CONFIGURATION[:default_locale])
       @response = response
       @client = client
       @included_resources = {}
@@ -39,7 +47,7 @@ module Contentful
     end
 
     # Starts the parsing process.
-    # Either returns an Error, or the parsed Resource
+    # @return [Contentful::Resource, Contentful::Error]
     def run
       if response.status == :ok
         create_all_resources!
@@ -93,9 +101,8 @@ module Contentful
 
     # Finds the proper DynamicEntry class for an entry
     def get_dynamic_entry(object)
-      if content_id = content_type_id_for_entry(object)
-        client.dynamic_entry_cache[content_id.to_sym]
-      end
+      content_id = content_type_id_for_entry(object)
+      client.dynamic_entry_cache[content_id.to_sym] if content_id
     end
 
     # Returns the id of the related ContentType, if there is one
@@ -131,7 +138,7 @@ module Contentful
       when Proc
         res_class[object]
       when nil
-        fail UnparsableResource.new(response)
+        fail UnparsableResource, response
       else
         res_class
       end
@@ -194,10 +201,10 @@ module Contentful
       if included_objects
         included_objects.each do |type, objects|
           @included_resources[type] = Hash[
-                                      objects.map do |object|
-                                        res = create_resource(object)
-                                        [res.id, res]
-                                      end
+            objects.map do |object|
+              res = create_resource(object)
+              [res.id, res]
+            end
           ]
         end
       end
@@ -206,15 +213,15 @@ module Contentful
     def replace_links_with_known_resources(res, seen_resource_ids = [])
       seen_resource_ids << res.id
 
-      [:properties, :sys, :fields].map do |property_container_name|
+      property_containers = [:properties, :sys, :fields].map do |property_container_name|
         res.public_send(property_container_name)
-      end.compact.each do |property_container|
+      end.compact
+
+      property_containers.each do |property_container|
         replace_links_in_properties(property_container, seen_resource_ids)
       end
 
-      if res.array?
-        replace_links_in_array res.items, seen_resource_ids
-      end
+      replace_links_in_array res.items, seen_resource_ids if res.array?
     end
 
     def replace_links_in_properties(property_container, seen_resource_ids)
@@ -242,8 +249,8 @@ module Contentful
     end
 
     def maybe_replace_link(link, parent, key)
-      if  @known_resources[link.link_type] &&
-          @known_resources[link.link_type].key?(link.id)
+      if @known_resources[link.link_type] &&
+         @known_resources[link.link_type].key?(link.id)
         parent[key] = @known_resources[link.link_type][link.id]
       end
     end

data/lib/contentful/support.rb

@@ -3,8 +3,12 @@ module Contentful
   module Support
     class << self
       # Transforms CamelCase into snake_case (taken from zucker)
+      #
+      # @param [String] object camelCaseName
+      #
+      # @return [String] snake_case_name
       def snakify(object)
-        snake = String(object).gsub(/(?<!^)[A-Z]/) { "_#$&" }
+        snake = String(object).gsub(/(?<!^)[A-Z]/) { "_#{$&}" }
         snake.downcase
       end
     end

data/lib/contentful/sync.rb

@@ -4,6 +4,8 @@ require_relative 'deleted_asset'
 require_relative 'sync_page'
 
 module Contentful
+  # Resource class for Sync.
+  # @see _ https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/synchronization
   class Sync
     attr_reader :next_sync_url
 
@@ -14,46 +16,50 @@ module Contentful
     end
 
     # Iterates over all pages of the current sync
-    # Please Keep in Mind: Iterating fires a new request for each page
-    def each_page(&block)
+    #
+    # @note Please Keep in Mind: Iterating fires a new request for each page
+    #
+    # @yield [Contentful::SyncPage]
+    def each_page
       page = first_page
-      block.call(page)
+      yield page if block_given?
 
       until completed?
         page = page.next_page
-        block.call(page)
+        yield page if block_given?
       end
     end
 
     # Returns the first sync result page
+    #
+    # @return [Contentful::SyncPage]
     def first_page
       get(@first_page_options_or_url)
     end
 
     # Returns false as long as last sync page has not been reached
+    #
+    # @return [Boolean]
     def completed?
+      # rubocop:disable Style/DoubleNegation
       !!next_sync_url
+      # rubocop:enable Style/DoubleNegation
     end
 
     # Directly iterates over all resources that have changed
+    #
+    # @yield [Contentful::Entry, Contentful::Asset]
     def each_item(&block)
       each_page do |page|
-        page.each_item do |item|
-          block.call item
-        end
+        page.each_item(&block)
       end
     end
 
+    # @private
     def get(options_or_url)
-      if options_or_url.is_a? String
-        page = Request.new(@client, options_or_url).get
-      else
-        page = Request.new(@client, '/sync', options_or_url).get
-      end
+      page = fetch_page(options_or_url)
 
-      if @client.configuration[:raw_mode]
-        return page
-      end
+      return page if @client.configuration[:raw_mode]
 
       link_page_to_sync! page
       update_sync_state_from! page
@@ -63,6 +69,11 @@ module Contentful
 
     private
 
+    def fetch_page(options_or_url)
+      return Request.new(@client, options_or_url).get if options_or_url.is_a? String
+      Request.new(@client, '/sync', options_or_url).get
+    end
+
     def link_page_to_sync!(page)
       page.instance_variable_set :@sync, self
     end

data/lib/contentful/sync_page.rb

@@ -2,6 +2,7 @@ require_relative 'resource'
 require_relative 'resource/array_like'
 
 module Contentful
+  # Wrapper Class for Sync results
   class SyncPage
     attr_reader :sync
 
@@ -13,14 +14,25 @@ module Contentful
     property :nextSyncUrl
     property :nextPageUrl
 
+    # Requests next sync page from API
+    #
+    # @return [Contentful::SyncPage, void]
     def next_page
       sync.get(next_page_url) if next_page?
     end
 
+    # Returns wether there is a next sync page
+    #
+    # @return [Boolean]
     def next_page?
+      # rubocop:disable Style/DoubleNegation
       !!next_page_url
+      # rubocop:enable Style/DoubleNegation
     end
 
+    # Returns wether it is the last sync page
+    #
+    # @return [Boolean]
     def last_page?
       !next_page_url
     end

data/lib/contentful/version.rb

@@ -1,3 +1,5 @@
+# Contentful Namespace
 module Contentful
-  VERSION = '0.8.0'
+  # Gem Version
+  VERSION = '0.9.0'
 end

data/spec/entry_spec.rb

@@ -82,4 +82,120 @@ describe Contentful::Entry do
       end
     end
   end
+
+  it '#raw' do
+    vcr('entry/raw') {
+      nyancat = create_client.entry('nyancat')
+      expect(nyancat.raw).to eq(create_client(raw_mode: true).entry('nyancat').object)
+    }
+  end
+
+  describe 'custom resources' do
+    class Kategorie < Contentful::Entry
+      include ::Contentful::Resource::CustomResource
+
+      property :title
+      property :slug
+      property :image
+      property :top
+      property :subcategories
+      property :featuredArticles
+      property :catIntroHead
+      property :catIntroduction
+      property :seoText
+      property :metaKeywords
+      property :metaDescription
+      property :metaRobots
+    end
+
+    it 'maps fields properly' do
+      vcr('entry/custom_resource') {
+        entry = create_client(
+          space: 'g2b4ltw00meh',
+          dynamic_entries: :auto,
+          entry_mapping: {
+            'kategorie' => Kategorie
+          }
+        ).entries.first
+
+        expect(entry).to be_a Kategorie
+        expect(entry.title).to eq "Some Title"
+        expect(entry.slug).to eq "/asda.html"
+        expect(entry.featured_articles.first.is_a?(Contentful::Link)).to be_truthy
+        expect(entry.top).to be_truthy
+      }
+    end
+
+    describe 'can be marshalled' do
+      class Cat < Contentful::Entry
+        include ::Contentful::Resource::CustomResource
+
+        property :name
+        property :lives
+        property :bestFriend, Cat
+        property :catPack
+      end
+
+      def test_dump(nyancat)
+        dump = Marshal.dump(nyancat)
+        new_cat = Marshal.load(dump)
+
+        # Attributes
+        expect(new_cat).to be_a Cat
+        expect(new_cat.name).to eq "Nyan Cat"
+        expect(new_cat.lives).to eq 1337
+
+        # Single linked objects
+        expect(new_cat.best_friend).to be_a Cat
+        expect(new_cat.best_friend.name).to eq "Happy Cat"
+
+        # Array of linked objects
+        expect(new_cat.cat_pack.count).to eq 2
+        expect(new_cat.cat_pack[0].name).to eq "Happy Cat"
+        expect(new_cat.cat_pack[1].name).to eq "Worried Cat"
+
+        # Nested Links
+        expect(new_cat.best_friend.best_friend).to be_a Cat
+        expect(new_cat.best_friend.best_friend.name).to eq "Worried Cat"
+
+        # Nested array of linked objects
+        expect(new_cat.best_friend.cat_pack.count).to eq 2
+        expect(new_cat.best_friend.cat_pack[0].name).to eq "Nyan Cat"
+        expect(new_cat.best_friend.cat_pack[1].name).to eq "Worried Cat"
+
+        # Array of linked objects in a nested array of linked objects
+        expect(new_cat.cat_pack.first.name).to eq "Happy Cat"
+        expect(new_cat.cat_pack.first.cat_pack[0].name).to eq "Nyan Cat"
+        expect(new_cat.cat_pack.first.cat_pack[1].name).to eq "Worried Cat"
+      end
+
+      it 'using entry_mapping' do
+        vcr('entry/marshall') {
+          nyancat = create_client(entry_mapping: {'cat' => Cat}).entries(include: 2, 'sys.id' => 'nyancat').first
+          test_dump(nyancat)
+        }
+      end
+
+      it 'using resource_mapping' do
+        vcr('entry/marshall') {
+          nyancat = create_client(resource_mapping: {
+            'Entry' => ->(_json_object) do
+              return Cat if _json_object.fetch('sys', {}).fetch('contentType', {}).fetch('sys', {}).fetch('id', nil) == 'cat'
+              Contentful::Entry
+            end
+          }).entries(include: 2, 'sys.id' => 'nyancat').first
+          test_dump(nyancat)
+        }
+      end
+
+      it 'newly created custom resources have property mappings' do
+        entry = Cat.new
+
+        expect(entry).to respond_to :name
+        expect(entry).to respond_to :lives
+        expect(entry).to respond_to :best_friend
+        expect(entry).to respond_to :cat_pack
+      end
+    end
+  end
 end

data/spec/fixtures/vcr_cassettes/entry/custom_resource.yml

@@ -0,0 +1,168 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://cdn.contentful.com/spaces/g2b4ltw00meh/content_types?limit=1000
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - RubyContentfulGem/0.8.0
+      Authorization:
+      - Bearer <ACCESS_TOKEN>
+      Content-Type:
+      - application/vnd.contentful.delivery.v1+json
+      Accept-Encoding:
+      - gzip
+      Connection:
+      - close
+      Host:
+      - cdn.contentful.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Headers:
+      - Accept,Accept-Language,Authorization,Cache-Control,Content-Length,Content-Range,Content-Type,DNT,Destination,Expires,If-Match,If-Modified-Since,If-None-Match,Keep-Alive,Last-Modified,Origin,Pragma,Range,User-Agent,X-Http-Method-Override,X-Mx-ReqToken,X-Requested-With,X-Contentful-Version,X-Contentful-Content-Type,X-Contentful-Organization,X-Contentful-Skip-Transformation
+      Access-Control-Allow-Methods:
+      - GET,HEAD,OPTIONS
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Expose-Headers:
+      - Etag
+      Access-Control-Max-Age:
+      - '86400'
+      Cache-Control:
+      - max-age=0
+      Content-Encoding:
+      - gzip
+      Content-Type:
+      - application/vnd.contentful.delivery.v1+json
+      Server:
+      - nginx
+      X-Contentful-Request-Id:
+      - 90a-2090959606
+      Content-Length:
+      - '653'
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Mon, 07 Dec 2015 17:08:37 GMT
+      Via:
+      - 1.1 varnish
+      Age:
+      - '5494'
+      Connection:
+      - close
+      X-Served-By:
+      - cache-atl6233-ATL
+      X-Cache:
+      - HIT
+      X-Cache-Hits:
+      - '1'
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA9VW3W/aMBB/569AeV6q8NF24o12VJXaaVLJXlpVlUkOsHDi
+        yL6syyr+99lOHAJxNg3Bw/KAsH0fv/P9fHcfvX7fk4X0Jv0P9VctsMhArbyp
+        EKTw1N72k5ZBjoSp/YFZyQ3N1CIwC0YTivooCMoNipBoiy/GYmlXyaUkMZYf
+        CMKKCwqeVjdOlxRYvFNpqplzqxoq06xWM0c01jaRItvZMwc2kBB+4r4K4xFh
+        9BdozSVhEioYVaxaewfb2LL+vz89urxLlq/2963zeZEs+AHi493fUBa7/NOE
+        rDqif6Tp5iB6tRPaJEsJJ7ucOyCYC/CnAunGnaZlKRJrkYiBdF9aST1LDpMA
+        SylLpjJHdY5bURpa7uKcpSgMme1nSG0/7/iMzGjKgGKeriQqnvXvgcTK8UEy
+        So5GBN+oAsLf1krKHfpp+XKAzkWdGlScR0h56oZ10jeUIohNqwboZFSPWeYL
+        BausEf8/RUKe+e2S1wgXeea+9RvOGZCDlBzP1XueQKYKxZ/RrCupf4AUU0kW
+        zJRTFDmc6GnNZ9/8Nu/KpySBt4/OUfC/zsKp/wDFOxeqP+2XJNN4EkDiPj9P
+        CzCAvoCMBM3a77W8HY2pU+SMsG5JylOqemvXRXUInBHSE19w7Eyc6/RIMFU7
+        ea1HmriRI8WT+ko89VoyRoo7PfK0R5e9YcwUCZmRSM9NzdbXkjKSFvrfuuHc
+        WGySuS69q+FizPA9CBJY7/VL14hUO7zlqqanaKaKndmqmrtKvSfgB5W63Uz6
+        w4ZGJNSAAPFUj5PeMBhc+oOhH1yHg8tJMJqMgovB9efnpos8i7sURsPJ+Opi
+        fDV+toFsTRD697W37f0G3Z/jL/sKAAA=
+    http_version: 
+  recorded_at: Mon, 07 Dec 2015 17:08:37 GMT
+- request:
+    method: get
+    uri: https://cdn.contentful.com/spaces/g2b4ltw00meh/entries
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - RubyContentfulGem/0.8.0
+      Authorization:
+      - Bearer <ACCESS_TOKEN>
+      Content-Type:
+      - application/vnd.contentful.delivery.v1+json
+      Accept-Encoding:
+      - gzip
+      Connection:
+      - close
+      Host:
+      - cdn.contentful.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Headers:
+      - Accept,Accept-Language,Authorization,Cache-Control,Content-Length,Content-Range,Content-Type,DNT,Destination,Expires,If-Match,If-Modified-Since,If-None-Match,Keep-Alive,Last-Modified,Origin,Pragma,Range,User-Agent,X-Http-Method-Override,X-Mx-ReqToken,X-Requested-With,X-Contentful-Version,X-Contentful-Content-Type,X-Contentful-Organization,X-Contentful-Skip-Transformation
+      Access-Control-Allow-Methods:
+      - GET,HEAD,OPTIONS
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Expose-Headers:
+      - Etag
+      Access-Control-Max-Age:
+      - '86400'
+      Cache-Control:
+      - max-age=0
+      Content-Encoding:
+      - gzip
+      Content-Type:
+      - application/vnd.contentful.delivery.v1+json
+      Server:
+      - nginx
+      X-Contentful-Request-Id:
+      - 90a-2090959610
+      Content-Length:
+      - '499'
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Mon, 07 Dec 2015 17:08:38 GMT
+      Via:
+      - 1.1 varnish
+      Age:
+      - '5494'
+      Connection:
+      - close
+      X-Served-By:
+      - cache-atl6233-ATL
+      X-Cache:
+      - HIT
+      X-Cache-Hits:
+      - '17'
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA91US4/aMBC+8yuQz4UGSFiVG9r20MelBVRpq9XKOAOx8nBq
+        T0KjFf+9fiTEobR72VN9iDKT8ffNN488j8ZjohpFVuNn/aoNbErQFllLSRui
+        fec3JgYF0kz7Z9ZSKS+1EVgj4zlH8ylwNkfIDeAPC+hgr1gskyopM1RdhHN6
+        uRiHdXY5feFFSgxnfzR7kW7bnDcW8SqAx0bOcb4PMzwFQQ6JUdWd8+Xd6nTn
+        QvihQNl4gISJAqHAlvD1Mr/3cG/mn1KEo5AcXk7eCV4kn9Zq98DuNj8/hio9
+        Ldny++6rr0VCzRUXhS7PwtPOJGiueG1aSubBLJrM5pPgbjuLVkG4CqNpFEYP
+        Pk5Vxn+9EK0WwTR8txxcyASjmR0yKCa7Tafo0gBy4JDF/UyaphDk6O5sRA7j
+        rbW8rFVWHQ3iW6piOk0wzwZto/jEdS/FUwLUzkOiy6kjmboZFlcMXWUIHuFQ
+        D5hAbOGXrQ7UhyFADkg/Q3MS0qZPalAq9i+bgPegmORlR1CDjvWUmJB7WoiC
+        6yo5FvZnxDexF9hysAHFQbevkrqBEjnLoN9EN9v+zN7YyqsFuLFxduP7nbte
+        kRbgn0M42OB+A/W/5vLl0e9ttWfd+P8HclCYfyfKClq1TrV5Po7Oo9/jOBmT
+        kwUAAA==
+    http_version: 
+  recorded_at: Mon, 07 Dec 2015 17:08:38 GMT
+recorded_with: VCR 2.9.3