contentful 0.2.0 → 0.3.0

data/.travis.yml

@@ -1,10 +1,7 @@
 language: ruby
 rvm:
   - 2.1.1
-  - 2.1.0
+  - 2.1
   - 2.0.0
   - 1.9.3
   - jruby-19mode
-notifications:
-  flowdock:
-    - secure: "jO51sETvF1Je7jLQibT5P2ty3KAC8Q9/jJKPUKLDHAaz927XhhkrMXVs6tjzVG1BmHc5A+Qhuni26XerFRsocR7CTrqKdmvmXLgWyMtpW5CvUbtUCeApRQE2K4k/fb+7mz3EBAE494AK5Fz8f3vk2WVu5ROj5shuuggiYhoOqHw="

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 0.3.0
+
+* Support Synchronization
+
+
 ### 0.2.0
 
 * Introduce new :entry_mapping configuration to enable custom Entry classes based on ContentTypes

data/README.md

@@ -168,7 +168,7 @@ You can register your custom class on client initialization:
       space: 'cfexampleapi',
       access_token: 'b4c0n73n7fu1',
       resource_mapping: {
-        'Asset' => MyBetterAsset,
+        'Asset' => MyBetterAsset
       }
     )
 
@@ -191,6 +191,46 @@ You can also register custom entry classes to be used based on the entry's conte
     client.entry('nyancat') # is instance of Cat
 
 
+## 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/documentation/content-delivery-api/#sync) or an URL you received from a previous sync:
+
+    client = Contentful::Client.new(
+      access_token: 'b4c0n73n7fu1',
+      space: 'cfexampleapi',
+      default_locale: 'en-US'
+    )
+    sync = client.sync(initial: true, type: 'Deletion') # Only returns deleted entries and assets
+    sync = client.sync("https://cdn.contentful.com/spaces/cfexampleapi/sync?sync_token=w5ZGw6JFwqZmVcKsE8Kow4gr...sGPg") # Continues a sync
+
+You can access the results either wrapped in `Contentful::SyncPage` objects:
+
+    sync.each_page do |page|
+      # Find resources at: page.items
+    end
+
+    # More explicit version:
+    page = sync.first_page
+    until sync.completed?
+      page = s.next_page
+    end
+
+Or directly iterative over all resources:
+
+    sync.each_item do |resource|
+      # ...
+    end
+
+When a sync is completed, the next sync url can be read from the Sync or SyncPage object:
+
+    sync.next_sync_url
+
+**Please note** that synchronization entries come in all locales, so make sure, you supply a :default_locale property to the client configuration, when using the sync feature. This locale will be returned by default, when you call `Entry#fields`. The other localized data will also be saved and can be accessed by calling the fields method with a locale parameter:
+
+    first_entry = client.sync(initial: true, type: 'Entry').first_page.items.first
+    first_entry.fields('de-DE') # Returns German localizations
+
+
 ## License
 
 Copyright (c) 2014 Contentful GmbH - Jan Lelis. See LICENSE.txt for further details.

data/TAGS

@@ -0,0 +1,312 @@
+
+examples/custom_classes.rb,120
+class MyResourceMyResource
12,405
+class MyBetterArray < Contentful::ArrayMyBetterArray
36,919
+  def lastlast
38,1002
+
+examples/dynamic_entries.rb,0
+
+examples/example_queries.rb,0
+
+examples/raise_errors.rb,0
+
+examples/raw_mode.rb,0
+
+examples/resource_mapping.rb,84
+class MyBetterArray < Contentful::ArrayMyBetterArray
12,361
+  def lastlast
14,444
+
+lib/contentful/array.rb,95
+module ContentfulContentful
4,68
+  class ArrayArray
8,341
+    def next_pagenext_page
21,647
+
+lib/contentful/asset.rb,109
+module ContentfulContentful
4,70
+  class AssetAsset
7,203
+    def image_url(options = {})image_url
19,627
+
+lib/contentful/client.rb,1109
+module ContentfulContentful
10,256
+  class ClientClient
14,419
+    def self.get_http(url, query, headers = {})get_http
32,886
+    def initialize(given_configuration = {})initialize
36,987
+    def default_configurationdefault_configuration
49,1356
+    def space(query = {})space
56,1537
+    def content_type(id, query = {})content_type
63,1742
+    def content_types(query = {})content_types
70,1993
+    def entry(id, query = {})entry
77,2207
+    def entries(query = {})entries
84,2433
+    def asset(id, query = {})asset
91,2635
+    def assets(query = {})assets
98,2859
+    def base_urlbase_url
103,3001
+    def request_headersrequest_headers
108,3190
+    def request_query(query)request_query
117,3660
+    def get(request, build_resource = true)get
128,3998
+    def update_dynamic_entry_cache!update_dynamic_entry_cache!
154,4785
+    def register_dynamic_entry(key, klass)register_dynamic_entry
167,5115
+    def sync(options = { initial: true })sync
174,5355
+    def normalize_configuration!normalize_configuration!
181,5450
+    def validate_configuration!validate_configuration!
186,5700
+
+lib/contentful/content_type.rb,72
+module ContentfulContentful
4,54
+  class ContentTypeContentType
7,201
+
+lib/contentful/deleted_asset.rb,74
+module ContentfulContentful
3,29
+  class DeletedAssetDeletedAsset
6,185
+
+lib/contentful/deleted_entry.rb,74
+module ContentfulContentful
3,29
+  class DeletedEntryDeletedEntry
6,185
+
+lib/contentful/dynamic_entry.rb,130
+module ContentfulContentful
5,92
+  class DynamicEntry < EntryDynamicEntry
6,110
+    def self.create(content_type)create
18,397
+
+lib/contentful/entry.rb,60
+module ContentfulContentful
4,64
+  class EntryEntry
7,198
+
+lib/contentful/error.rb,547
+module ContentfulContentful
1,0
+  class Error < StandardErrorError
4,142
+    def initialize(response)initialize
7,199
+    def self.[](error_status_code)[]
14,396
+  class NotFound < Error; endNotFound
33,691
+  class BadRequest < Error; endBadRequest
36,730
+  class AccessDenied < Error; endAccessDenied
39,771
+  class Unauthorized < Error; endUnauthorized
42,814
+  class ServerError < Error; endServerError
45,857
+  class UnparsableJson < Error; endUnparsableJson
48,933
+  class UnparsableResource < Error; endUnparsableResource
51,1037
+
+lib/contentful/field.rb,60
+module ContentfulContentful
3,29
+  class FieldField
6,195
+
+lib/contentful/file.rb,57
+module ContentfulContentful
3,29
+  class FileFile
5,73
+
+lib/contentful/link.rb,101
+module ContentfulContentful
3,29
+  class LinkLink
6,160
+    def resolve(query = {})resolve
12,359
+
+lib/contentful/locale.rb,62
+module ContentfulContentful
3,29
+  class LocaleLocale
6,207
+
+lib/contentful/location.rb,66
+module ContentfulContentful
3,29
+  class LocationLocation
6,200
+
+lib/contentful/request.rb,301
+module ContentfulContentful
1,0
+  class RequestRequest
5,234
+    def initialize(client, endpoint, query = {}, id = nil)initialize
8,295
+    def urlurl
27,740
+    def getget
32,870
+    def absolute?absolute?
37,964
+    def copycopy
42,1064
+    def normalize_query(query)normalize_query
49,1139
+
+lib/contentful/resource/array_like.rb,235
+module ContentfulContentful
1,0
+  module ResourceResource
2,18
+    module ArrayLikeArrayLike
5,138
+      def array?array?
9,231
+      def each_item(&block)each_item
14,304
+      def empty?empty?
20,431
+      def sizesize
25,512
+
+lib/contentful/resource/asset_fields.rb,378
+module ContentfulContentful
3,28
+  module ResourceResource
4,46
+    module AssetFieldsAssetFields
8,212
+      def fieldsfields
15,345
+      def initialize(object, *)initialize
19,397
+      def inspect(info = nil)inspect
25,547
+      module ClassMethodsClassMethods
33,713
+        def fields_coercionsfields_coercions
34,739
+      def self.included(base)included
39,818
+
+lib/contentful/resource/fields.rb,482
+module ContentfulContentful
1,0
+  module ResourceResource
2,18
+    module FieldsFields
7,215
+      def fields(wanted_locale = default_locale)fields
9,273
+      def initialize(object, *)initialize
13,374
+      def inspect(info = nil)inspect
18,474
+      def extract_fields_from_object!(object)extract_fields_from_object!
29,656
+      module ClassMethodsClassMethods
46,1227
+        def fields_coercionsfields_coercions
48,1309
+      def self.included(base)included
53,1374
+
+lib/contentful/resource/system_properties.rb,350
+module ContentfulContentful
1,0
+  module ResourceResource
2,18
+    module SystemPropertiesSystemProperties
4,100
+      def initialize(object, *)initialize
18,406
+      def inspect(info = nil)inspect
23,518
+      module ClassMethodsClassMethods
31,675
+        def sys_coercionssys_coercions
32,701
+      def self.included(base)included
37,774
+
+lib/contentful/resource.rb,1041
+module ContentfulContentful
4,62
+  module ResourceResource
13,463
+    def initialize(object, request = nil, client = nil, nested_locale_fields = false, default_locale = Contentful::Client::DEFAULT_CONFIGURATION[:default_locale] )initialize
24,743
+    def inspect(info = nil)inspect
34,1184
+    def array?array?
40,1417
+    def nested_locale_fields?nested_locale_fields?
45,1544
+    def syssys
50,1686
+    def fieldsfields
55,1797
+    def reloadreload
61,1941
+    def extract_from_object(object, namespace, keys = nil)extract_from_object
71,2050
+    def coerce_value_or_array(value, what = nil)coerce_value_or_array
85,2459
+    def coerce_or_create_class(value, what)coerce_or_create_class
93,2669
+    module ClassMethodsClassMethods
105,2982
+      def nested_locale_fields?nested_locale_fields?
107,3098
+      def property_coercionsproperty_coercions
111,3155
+      def property(name, property_class = nil)property
126,3829
+      def update_coercions!update_coercions!
134,4100
+    def self.included(base)included
153,4689
+
+lib/contentful/resource_builder.rb,2028
+module ContentfulContentful
13,309
+  class ResourceBuilderResourceBuilder
16,470
+    def initialize(client, response, resource_mapping = {}, entry_mapping = {}, default_locale = Contentful::Client::DEFAULT_CONFIGURATION[:default_locale])initialize
32,904
+    def runrun
45,1502
+    def create_all_resources!create_all_resources!
69,2206
+    def create_resource(object)create_resource
82,2600
+    def find_entry_class(object)find_entry_class
95,3044
+    def try_dynamic_entry(object)try_dynamic_entry
100,3233
+    def get_dynamic_entry(object)get_dynamic_entry
105,3372
+    def content_type_id_for_entry(object)content_type_id_for_entry
112,3600
+    def array_or_sync_page(object)array_or_sync_page
120,3871
+    def detect_resource_class(object)detect_resource_class
135,4329
+    def default_resource_mappingdefault_resource_mapping
151,4728
+    def default_entry_mappingdefault_entry_mapping
156,4837
+    def detect_child_objects(object)detect_child_objects
163,4922
+    def detect_child_arrays(object)detect_child_arrays
171,5091
+    def add_to_known_resources(res)add_to_known_resources
184,5353
+    def replace_children(res, object)replace_children
188,5488
+    def replace_child_array(child_array)replace_child_array
200,5969
+    def create_included_resources!(included_objects)create_included_resources!
204,6097
+    def replace_links_with_known_resources(res, seen_resource_ids = [])replace_links_with_known_resources
217,6436
+    def replace_links_in_properties(property_container, seen_resource_ids)replace_links_in_properties
231,6892
+    def replace_links_in_array(property_container, seen_resource_ids)replace_links_in_array
241,7296
+    def replace_link_or_check_recursively(property_value, property_container, property_name, seen_resource_ids)replace_link_or_check_recursively
247,7574
+    def maybe_replace_link(link, parent, key)maybe_replace_link
255,8011
+    def replace_links_in_included_resources_with_known_resourcesreplace_links_in_included_resources_with_known_resources
262,8243
+
+lib/contentful/response.rb,228
+module ContentfulContentful
4,47
+  class ResponseResponse
22,837
+    def initialize(raw, request = nil)initialize
25,920
+    def parse_json!parse_json!
38,1113
+    def parse_contentful_error!parse_contentful_error!
48,1327
+
+lib/contentful/space.rb,60
+module ContentfulContentful
4,55
+  class SpaceSpace
7,188
+
+lib/contentful/support.rb,103
+module ContentfulContentful
1,0
+  module SupportSupport
3,65
+      def snakify(object)snakify
6,165
+
+lib/contentful/sync.rb,450
+module ContentfulContentful
6,132
+  class SyncSync
7,150
+    def initialize(client, options_or_url)initialize
10,195
+    def each_page(&block)each_page
18,468
+    def first_pagefirst_page
29,680
+    def completed?completed?
34,813
+    def each_item(&block)each_item
39,925
+    def get(options_or_url)get
47,1067
+    def link_page_to_sync!(page)link_page_to_sync!
63,1375
+    def update_sync_state_from!(page)update_sync_state_from!
67,1463
+
+lib/contentful/sync_page.rb,237
+module ContentfulContentful
4,68
+  class SyncPageSyncPage
5,86
+    def self.nested_locale_fields?nested_locale_fields
16,328
+    def next_pagenext_page
20,383
+    def next_page?next_page?
24,454
+    def last_page?last_page?
28,505
+
+lib/contentful/version.rb,33
+module ContentfulContentful
1,0
+
+lib/contentful.rb,0
+
+spec/array_spec.rb,0
+
+spec/asset_spec.rb,0
+
+spec/auto_includes_spec.rb,0
+
+spec/client_class_spec.rb,0
+
+spec/client_configuration_spec.rb,171
+      class MyBetterAsset < Contentful::AssetMyBetterAsset
180,5381
+        def https_image_urlhttps_image_url
181,5427
+      class Cat < Contentful::EntryCat
200,5922
+
+spec/coercions_spec.rb,0
+
+spec/content_type_spec.rb,0
+
+spec/deleted_asset_spec.rb,0
+
+spec/deleted_entry_spec.rb,0
+
+spec/dynamic_entry_spec.rb,0
+
+spec/entry_spec.rb,0
+
+spec/error_class_spec.rb,0
+
+spec/error_requests_spec.rb,0
+
+spec/field_spec.rb,0
+
+spec/file_spec.rb,0
+
+spec/link_spec.rb,0
+
+spec/locale_spec.rb,0
+
+spec/location_spec.rb,0
+
+spec/request_spec.rb,0
+
+spec/resource_building_spec.rb,0
+
+spec/resource_spec.rb,0
+
+spec/response_spec.rb,0
+
+spec/space_spec.rb,0
+
+spec/spec_helper.rb,0
+
+spec/support/client.rb,50
+def create_client(options = {})create_client
1,0
+
+spec/support/json_responses.rb,117
+def raw_fixture(which, as_json = false)raw_fixture
3,22
+def json_fixture(which, as_json = false)json_fixture
7,148
+
+spec/support/vcr.rb,80
+def vcr(name, &block)vcr
10,201
+def expect_vcr(name, &block)expect_vcr
14,261
+
+spec/sync_page_spec.rb,0
+
+spec/sync_spec.rb,0

data/lib/contentful/array.rb

@@ -1,4 +1,5 @@
 require_relative 'resource'
+require_relative 'resource/array_like'
 
 module Contentful
   # Resource Class for Arrays (e.g. search results)
@@ -9,18 +10,13 @@ module Contentful
 
     include Contentful::Resource
     include Contentful::Resource::SystemProperties
-    include Enumerable
+    include Contentful::Resource::ArrayLike
 
     property :total, :integer
     property :limit, :integer
     property :skip, :integer
     property :items
 
-    # Only returns true for Contentful::Array
-    def array?
-      true
-    end
-
     # Simplifies pagination
     def next_page
       if request
@@ -33,14 +29,5 @@ module Contentful
       end
     end
 
-    # Delegates to items#each
-    def each(&block)
-      items.each(&block)
-    end
-
-    # Delegates to items#empty?
-    def empty?
-      items.empty?
-    end
   end
 end

data/lib/contentful/client.rb

@@ -1,7 +1,11 @@
 require_relative 'request'
 require_relative 'response'
 require_relative 'resource_builder'
+require_relative 'sync'
+
 require 'http'
+# see: https://github.com/tarcieri/http/commit/6a2a9d22902572d672dfc7c7b250d022364c8e01#commitcomment-6192269
+require 'cgi'
 
 module Contentful
   # The client object is initialized with a space and a key and then used
@@ -18,6 +22,7 @@ module Contentful
       resource_builder: ResourceBuilder,
       resource_mapping: {},
       entry_mapping: {},
+      default_locale: 'en-US',
       raw_mode: false
     }
 
@@ -121,9 +126,10 @@ module Contentful
     # Set second parameter to false to deactivate Resource building and
     # return Response objects instead
     def get(request, build_resource = true)
+      url = request.absolute? ? request.url : base_url + request.url
       response = Response.new(
         self.class.get_http(
-          base_url + request.url,
+          url,
           request_query(request.query),
           request_headers
         ), request
@@ -133,8 +139,10 @@ module Contentful
 
       result = configuration[:resource_builder].new(
           self,
-          response, configuration[:resource_mapping],
-          configuration[:entry_mapping]
+          response,
+          configuration[:resource_mapping],
+          configuration[:entry_mapping],
+          configuration[:default_locale]
       ).run
 
       raise result if result.is_a?(Error) && configuration[:raise_errors]
@@ -160,10 +168,18 @@ module Contentful
       @dynamic_entry_cache[key.to_sym] = klass
     end
 
+    # Create a new synchronisation object
+    # Takes sync options or a sync_url
+    # You will need to call #each_page or #first_page on it
+    def sync(options = { initial: true })
+      Sync.new(self, options)
+    end
+
+
     private
 
     def normalize_configuration!
-      [:space, :access_token, :api_url].each { |s| configuration[s] = configuration[s].to_s }
+      [:space, :access_token, :api_url, :default_locale].each { |s| configuration[s] = configuration[s].to_s }
       configuration[:authentication_mechanism] = configuration[:authentication_mechanism].to_sym
     end
 
@@ -180,6 +196,10 @@ module Contentful
         raise ArgumentError, 'The client configuration needs to contain an :api_url'
       end
 
+      if configuration[:default_locale].empty?
+        raise ArgumentError, 'The client configuration needs to contain a :default_locale'
+      end
+
       unless configuration[:api_version].to_i >= 0
         raise ArgumentError, 'The :api_version must be a positive number or nil'
       end