contentful 0.2.0 → 0.3.0

data/lib/contentful/deleted_asset.rb

@@ -0,0 +1,10 @@
+require_relative 'resource'
+
+module Contentful
+  # Resource class for deleted entries
+  # https://www.contentful.com/developers/documentation/content-delivery-api/http/#sync-item-types
+  class DeletedAsset
+    include Contentful::Resource
+    include Contentful::Resource::SystemProperties
+  end
+end

data/lib/contentful/deleted_entry.rb

@@ -0,0 +1,10 @@
+require_relative 'resource'
+
+module Contentful
+  # Resource class for deleted entries
+  # https://www.contentful.com/developers/documentation/content-delivery-api/http/#sync-item-types
+  class DeletedEntry
+    include Contentful::Resource
+    include Contentful::Resource::SystemProperties
+  end
+end

data/lib/contentful/request.rb

@@ -8,6 +8,8 @@ module Contentful
     def initialize(client, endpoint, query = {}, id = nil)
       @client = client
       @endpoint = endpoint
+      @absolute = true if @endpoint.start_with?('http')
+
       @query = if query && !query.empty?
         normalize_query(query)
       end
@@ -31,6 +33,11 @@ module Contentful
       client.get(self)
     end
 
+    # Returns true if endpoint is an absolute url
+    def absolute?
+      !! @absolute
+    end
+
     # Returns a new Request object with the same data
     def copy
       Marshal.load(Marshal.dump(self))

data/lib/contentful/resource.rb

@@ -19,10 +19,12 @@ module Contentful
       date:    ->(v) { DateTime.parse(v) }
     }
 
-    attr_reader :properties, :request, :client
+    attr_reader :properties, :request, :client, :default_locale
 
-    def initialize(object, request = nil, client = nil)
+    def initialize(object, request = nil, client = nil, nested_locale_fields = false, default_locale = Contentful::Client::DEFAULT_CONFIGURATION[:default_locale] )
       self.class.update_coercions!
+      @nested_locale_fields = nested_locale_fields
+      @default_locale = default_locale
 
       @properties = extract_from_object object, :property, self.class.property_coercions.keys
       @request = request
@@ -39,6 +41,11 @@ module Contentful
       false
     end
 
+    # By default, fields come flattened in the current locale. This is different for syncs
+    def nested_locale_fields?
+      !! @nested_locale_fields
+    end
+
     # Resources that don't include SystemProperties return nil for #sys
     def sys
       nil
@@ -96,6 +103,11 @@ module Contentful
 
     # Register the resources properties on class level by using the #property method
     module ClassMethods
+      # By default, fields come flattened in the current locale. This is different for sync
+      def nested_locale_fields?
+        false
+      end
+
       def property_coercions
         @property_coercions ||= {}
       end

data/lib/contentful/resource/array_like.rb

@@ -0,0 +1,32 @@
+module Contentful
+  module Resource
+    # 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
+      def array?
+        true
+      end
+
+      # Delegates to items#each
+      def each_item(&block)
+        items.each(&block)
+      end
+      alias each each_item
+
+      # Delegates to items#empty?
+      def empty?
+        items.empty?
+      end
+
+      # Delegetes to items#size
+      def size
+        items.size
+      end
+      alias length size
+
+    end
+  end
+end

data/lib/contentful/resource/fields.rb

@@ -6,14 +6,13 @@ module Contentful
     # It depends on system properties being available
     module Fields
       # Returns all fields of the asset
-      def fields
-        @fields[locale]
+      def fields(wanted_locale = default_locale)
+        @fields[locale || wanted_locale]
       end
 
       def initialize(object, *)
         super
-        @fields = {}
-        @fields[locale] = extract_from_object object["fields"], :fields
+        extract_fields_from_object! object
       end
 
       def inspect(info = nil)
@@ -24,6 +23,26 @@ module Contentful
         end
       end
 
+
+      private
+
+      def extract_fields_from_object!(object)
+        @fields = {}
+
+        if nested_locale_fields?
+          object["fields"].each do |field_name, nested_child_object|
+            nested_child_object.each do |object_locale, real_child_object|
+              @fields[object_locale] ||= {}
+              @fields[object_locale].merge! extract_from_object(
+                { field_name => real_child_object }, :fields
+              )
+            end
+          end
+        else
+          @fields[locale] = extract_from_object object["fields"], :fields
+        end
+      end
+
       module ClassMethods
         # No coercions, since no content type available
         def fields_coercions

data/lib/contentful/resource_builder.rb

@@ -7,6 +7,8 @@ require_relative 'dynamic_entry'
 require_relative 'asset'
 require_relative 'array'
 require_relative 'link'
+require_relative 'deleted_entry'
+require_relative 'deleted_asset'
 
 module Contentful
   # Transforms a Contentful::Response into a Contentful::Resource or a Contentful::Error
@@ -17,19 +19,23 @@ module Contentful
       'ContentType' => ContentType,
       'Entry' => :find_entry_class,
       'Asset' => Asset,
-      'Array' => Array,
+      'Array' => :array_or_sync_page,
       'Link' => Link,
+      'DeletedEntry' => DeletedEntry,
+      'DeletedAsset' => DeletedAsset,
     }
     DEFAULT_ENTRY_MAPPING = {}
 
     attr_reader :client, :response, :resource_mapping, :entry_mapping, :resource
 
 
-    def initialize(client, response, resource_mapping = {}, entry_mapping = {})
+    def initialize(client, response, resource_mapping = {}, entry_mapping = {}, default_locale = Contentful::Client::DEFAULT_CONFIGURATION[:default_locale])
       @response = response
       @client = client
       @included_resources = {}
       @known_resources = Hash.new{ |h,k| h[k] = {} }
+      @nested_locales = false
+      @default_locale = default_locale
       @resource_mapping = default_resource_mapping.merge(resource_mapping)
       @entry_mapping = default_entry_mapping.merge(entry_mapping)
     end
@@ -72,9 +78,12 @@ module Contentful
       @resource
     end
 
-    # Creates a single resource from the
+    # Creates a single resource from the response object
     def create_resource(object)
-      res = detect_resource_class(object).new(object, response.request, client)
+      res_class = detect_resource_class(object)
+      @nested_locales ||= res_class.nested_locale_fields?
+      res = res_class.new(object, response.request, client, @nested_locales, @default_locale)
+
       add_to_known_resources res
       replace_children res, object
       replace_child_array res.items if res.array?
@@ -99,6 +108,7 @@ module Contentful
       end
     end
 
+    # Returns the id of the related ContentType, if there is one
     def content_type_id_for_entry(object)
       object["sys"] &&
       object["sys"]["contentType"] &&
@@ -106,6 +116,15 @@ module Contentful
       object["sys"]["contentType"]["sys"]["id"]
     end
 
+    # Detects if a resource is an Contentful::Array or a SyncPage
+    def array_or_sync_page(object)
+      if object["nextPageUrl"] || object["nextSyncUrl"]
+        SyncPage
+      else
+        Array
+      end
+    end
+
     # Uses the resource mapping to find the proper Resource class to initialize
     # for this Response object type
     #
@@ -122,7 +141,7 @@ module Contentful
       when Proc
         res_class[object]
       when nil
-        raise UnsparsableResource.new(response)
+        raise UnparsableResource.new(response)
       else
         res_class
       end

data/lib/contentful/sync.rb

@@ -0,0 +1,72 @@
+require_relative 'resource_builder'
+require_relative 'deleted_entry'
+require_relative 'deleted_asset'
+require_relative 'sync_page'
+
+module Contentful
+  class Sync
+    attr_reader :next_sync_url
+
+    def initialize(client, options_or_url)
+      @client = client
+      @next_sync_url = nil
+      @first_page_options_or_url = options_or_url
+    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)
+      page = first_page
+      block.call(page)
+
+      until completed?
+        page = page.next_page
+        block.call(page)
+      end
+    end
+
+    # Returns the first sync result page
+    def first_page
+      get(@first_page_options_or_url)
+    end
+
+    # Returns false as long as last sync page has not been reached
+    def completed?
+      !! next_sync_url
+    end
+
+    # Directly iterates over all resources that have changed
+    def each_item(&block)
+      each_page do |page|
+        page.each_item do |item|
+          block.call item
+        end
+      end
+    end
+
+    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
+
+      link_page_to_sync! page
+      update_sync_state_from! page
+
+      page
+    end
+
+
+    private
+
+    def link_page_to_sync!(page)
+      page.instance_variable_set :@sync, self
+    end
+
+    def update_sync_state_from!(page)
+      @next_sync_url = page.next_sync_url
+    end
+
+  end
+end

data/lib/contentful/sync_page.rb

@@ -0,0 +1,33 @@
+require_relative 'resource'
+require_relative 'resource/array_like'
+
+module Contentful
+  class SyncPage
+    attr_reader :sync
+
+    include Contentful::Resource
+    include Contentful::Resource::SystemProperties
+    include Contentful::Resource::ArrayLike
+
+    property :items
+    property :nextSyncUrl
+    property :nextPageUrl
+
+    def self.nested_locale_fields?
+      true
+    end
+
+    def next_page
+      sync.get(next_page_url) if next_page?
+    end
+
+    def next_page?
+      !! next_page_url
+    end
+
+    def last_page?
+      ! next_page_url
+    end
+
+  end
+end

data/lib/contentful/version.rb

@@ -1,3 +1,3 @@
 module Contentful
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/client_class_spec.rb

@@ -56,4 +56,10 @@ describe Contentful::Client do
     end
 
   end
+
+  describe '#sync' do
+    it 'creates a new Sync object' do
+      expect( create_client.sync ).to be_a Contentful::Sync
+    end
+  end
 end

data/spec/deleted_asset_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+
+describe 'DeletedAsset' do
+  let(:deleted_asset){
+    vcr('sync_deleted_asset'){
+      create_client.sync(initial: true, type: 'DeletedAsset').first_page.items[0]
+    }
+  }
+
+  describe 'SystemProperties' do
+    it 'has a #sys getter returning a hash with symbol keys' do
+      expect( deleted_asset.sys ).to be_a Hash
+      expect( deleted_asset.sys.keys.sample ).to be_a Symbol
+    end
+
+    it 'has #id' do
+      expect( deleted_asset.id ).to eq "5c6VY0gWg0gwaIeYkUUiqG"
+    end
+
+    it 'has #type' do
+      expect( deleted_asset.type ).to eq "DeletedAsset"
+    end
+
+    it 'has #deleted_at' do
+      expect( deleted_asset.created_at ).to be_a DateTime
+    end
+  end
+end

data/spec/deleted_entry_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+
+describe 'DeletedEntry' do
+  let(:deleted_entry){
+    vcr('sync_deleted_entry'){
+      create_client.sync(initial: true, type: 'DeletedEntry').first_page.items[0]
+    }
+  }
+
+  describe 'SystemProperties' do
+    it 'has a #sys getter returning a hash with symbol keys' do
+      expect( deleted_entry.sys ).to be_a Hash
+      expect( deleted_entry.sys.keys.sample ).to be_a Symbol
+    end
+
+    it 'has #id' do
+      expect( deleted_entry.id ).to eq "CVebBDcQsSsu6yKKIayy"
+    end
+
+    it 'has #type' do
+      expect( deleted_entry.type ).to eq "DeletedEntry"
+    end
+
+    it 'has #deleted_at' do
+      expect( deleted_entry.created_at ).to be_a DateTime
+    end
+  end
+end

data/spec/fixtures/vcr_cassettes/sync_deleted_asset.yml

@@ -0,0 +1,174 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://cdn.contentful.com/spaces/cfexampleapi/sync?initial=true&type=DeletedAsset
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - RubyContentfulGem/0.1.3
+      Authorization:
+      - Bearer b4c0n73n7fu1
+      Content-Type:
+      - application/vnd.contentful.delivery.v1+json
+      Host:
+      - cdn.contentful.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 28 Apr 2014 17:19:53 GMT
+      Server:
+      - nginx/1.1.19
+      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
+      Access-Control-Allow-Methods:
+      - GET,HEAD,OPTIONS
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Max-Age:
+      - '86400'
+      Cache-Control:
+      - max-age=0
+      Content-Type:
+      - application/vnd.contentful.delivery.v1+json
+      Etag:
+      - '"df9f76f479ba20a61123c025da9126f9"'
+      X-Contentful-Request-Id:
+      - 71a-635793528
+      Content-Length:
+      - '2870'
+      Accept-Ranges:
+      - bytes
+      Via:
+      - 1.1 varnish
+      Age:
+      - '0'
+      X-Served-By:
+      - cache-fra1222-FRA
+      X-Cache:
+      - MISS
+      X-Cache-Hits:
+      - '0'
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: UTF-8
+      string: |
+        {
+          "sys": {
+            "type": "Array"
+          },
+          "items": [
+            {
+              "sys": {
+                "type": "DeletedAsset",
+                "id": "5c6VY0gWg0gwaIeYkUUiqG",
+                "space": {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "Space",
+                    "id": "cfexampleapi"
+                  }
+                },
+                "revision": 1,
+                "createdAt": "2013-09-09T16:17:12.600Z",
+                "updatedAt": "2013-09-09T16:17:12.600Z",
+                "deletedAt": "2013-09-09T16:17:12.600Z"
+              }
+            },
+            {
+              "sys": {
+                "type": "DeletedAsset",
+                "id": "finn",
+                "space": {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "Space",
+                    "id": "cfexampleapi"
+                  }
+                },
+                "revision": 1,
+                "createdAt": "2013-09-02T15:10:33.749Z",
+                "updatedAt": "2013-09-02T15:10:33.749Z",
+                "deletedAt": "2013-09-02T15:10:33.749Z"
+              }
+            },
+            {
+              "sys": {
+                "type": "DeletedAsset",
+                "id": "3MZPnjZTIskAIIkuuosCss",
+                "space": {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "Space",
+                    "id": "cfexampleapi"
+                  }
+                },
+                "revision": 1,
+                "createdAt": "2013-09-02T14:55:34.645Z",
+                "updatedAt": "2013-09-02T14:55:34.645Z",
+                "deletedAt": "2013-09-02T14:55:34.645Z"
+              }
+            },
+            {
+              "sys": {
+                "type": "DeletedAsset",
+                "id": "4gp6taAwW4CmSgumq2ekUm",
+                "space": {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "Space",
+                    "id": "cfexampleapi"
+                  }
+                },
+                "revision": 2,
+                "createdAt": "2013-09-02T14:55:34.623Z",
+                "updatedAt": "2013-09-02T14:55:34.623Z",
+                "deletedAt": "2013-09-02T14:55:34.623Z"
+              }
+            },
+            {
+              "sys": {
+                "type": "DeletedAsset",
+                "id": "1uf1qqyZuEuiwmigoUYkeu",
+                "space": {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "Space",
+                    "id": "cfexampleapi"
+                  }
+                },
+                "revision": 1,
+                "createdAt": "2013-09-02T14:55:34.323Z",
+                "updatedAt": "2013-09-02T14:55:34.323Z",
+                "deletedAt": "2013-09-02T14:55:34.323Z"
+              }
+            },
+            {
+              "sys": {
+                "type": "DeletedAsset",
+                "id": "4hlteQAXS8iS0YCMU6QMWg",
+                "space": {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "Space",
+                    "id": "cfexampleapi"
+                  }
+                },
+                "revision": 1,
+                "createdAt": "2013-09-02T14:55:34.282Z",
+                "updatedAt": "2013-09-02T14:55:34.282Z",
+                "deletedAt": "2013-09-02T14:55:34.282Z"
+              }
+            }
+          ],
+          "nextSyncUrl": "https://cdn.contentful.com/spaces/cfexampleapi/sync?sync_token=w5ZGw6JFwqZmVcKsE8Kow4grw45QdybDscOqw6vDvUcbEzolwqs8UsKNIsOuwozDjFbChi4dLE_DgRYLwpcDw7fCl8KWw4DCgMKDHWZ9IsKSwrd7PCPDnjjCuUNZUMK-wqHCuQkFaTHDtcKBw6ESVMKBB8OY"
+        }
+    http_version: 
+  recorded_at: Mon, 28 Apr 2014 17:19:54 GMT
+recorded_with: VCR 2.9.0