Class: Contentful::ResourceBuilder
- Inherits:
-
Object
- Object
- Contentful::ResourceBuilder
- Defined in:
- lib/contentful/resource_builder.rb
Overview
Transforms a Contentful::Response into a Contentful::Resource or a Contentful::Error See example/resource_mapping.rb for advanced usage
Constant Summary collapse
- DEFAULT_RESOURCE_MAPPING =
{ 'Space' => Space, 'ContentType' => ContentType, 'Entry' => :find_entry_class, 'Asset' => Asset, 'Array' => :array_or_sync_page, 'Link' => Link, 'DeletedEntry' => DeletedEntry, 'DeletedAsset' => DeletedAsset }
- DEFAULT_ENTRY_MAPPING =
{}
Instance Attribute Summary collapse
-
#client ⇒ Object
readonly
Returns the value of attribute client.
-
#entry_mapping ⇒ Object
readonly
Returns the value of attribute entry_mapping.
-
#resource ⇒ Object
readonly
Returns the value of attribute resource.
-
#resource_mapping ⇒ Object
readonly
Returns the value of attribute resource_mapping.
-
#response ⇒ Object
readonly
Returns the value of attribute response.
Instance Method Summary collapse
-
#array_or_sync_page(object) ⇒ Object
Detects if a resource is an Contentful::Array or a SyncPage.
-
#content_type_id_for_entry(object) ⇒ Object
Returns the id of the related ContentType, if there is one.
-
#create_all_resources! ⇒ Object
PARSING MECHANISM - raise error if response not valid - look for included objects and parse them to resources - parse main object to resource - replace links in included resources with known resources - replace links in main resource with known resources - return main resource.
-
#create_resource(object) ⇒ Object
Creates a single resource from the response object.
-
#default_entry_mapping ⇒ Object
The default entry mapping.
-
#default_resource_mapping ⇒ Object
The default mapping for #detect_resource_class.
-
#detect_resource_class(object) ⇒ Object
Uses the resource mapping to find the proper Resource class to initialize for this Response object type.
-
#find_entry_class(object) ⇒ Object
Checks in a custom class for an entry was defined in entry_mapping.
-
#get_dynamic_entry(object) ⇒ Object
Finds the proper DynamicEntry class for an entry.
-
#initialize(client, response, resource_mapping = {}, entry_mapping = {}, default_locale = Contentful::Client::DEFAULT_CONFIGURATION[:default_locale]) ⇒ ResourceBuilder
constructor
A new instance of ResourceBuilder.
-
#run ⇒ Object
Starts the parsing process.
-
#try_dynamic_entry(object) ⇒ Object
Automatically converts Entry to DynamicEntry if in cache.
Constructor Details
#initialize(client, response, resource_mapping = {}, entry_mapping = {}, default_locale = Contentful::Client::DEFAULT_CONFIGURATION[:default_locale]) ⇒ ResourceBuilder
Returns a new instance of ResourceBuilder.
31 32 33 34 35 36 37 38 39 40 |
# File 'lib/contentful/resource_builder.rb', line 31 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 |
Instance Attribute Details
#client ⇒ Object (readonly)
Returns the value of attribute client.
29 30 31 |
# File 'lib/contentful/resource_builder.rb', line 29 def client @client end |
#entry_mapping ⇒ Object (readonly)
Returns the value of attribute entry_mapping.
29 30 31 |
# File 'lib/contentful/resource_builder.rb', line 29 def entry_mapping @entry_mapping end |
#resource ⇒ Object (readonly)
Returns the value of attribute resource.
29 30 31 |
# File 'lib/contentful/resource_builder.rb', line 29 def resource @resource end |
#resource_mapping ⇒ Object (readonly)
Returns the value of attribute resource_mapping.
29 30 31 |
# File 'lib/contentful/resource_builder.rb', line 29 def resource_mapping @resource_mapping end |
#response ⇒ Object (readonly)
Returns the value of attribute response.
29 30 31 |
# File 'lib/contentful/resource_builder.rb', line 29 def response @response end |
Instance Method Details
#array_or_sync_page(object) ⇒ Object
Detects if a resource is an Contentful::Array or a SyncPage
112 113 114 115 116 117 118 |
# File 'lib/contentful/resource_builder.rb', line 112 def array_or_sync_page(object) if object['nextPageUrl'] || object['nextSyncUrl'] SyncPage else Array end end |
#content_type_id_for_entry(object) ⇒ Object
Returns the id of the related ContentType, if there is one
104 105 106 107 108 109 |
# File 'lib/contentful/resource_builder.rb', line 104 def content_type_id_for_entry(object) object['sys'] && object['sys']['contentType'] && object['sys']['contentType']['sys'] && object['sys']['contentType']['sys']['id'] end |
#create_all_resources! ⇒ Object
PARSING MECHANISM
-
raise error if response not valid
-
look for included objects and parse them to resources
-
parse main object to resource
-
replace links in included resources with known resources
-
replace links in main resource with known resources
-
return main resource
59 60 61 62 63 64 65 66 67 68 69 70 71 |
# File 'lib/contentful/resource_builder.rb', line 59 def create_all_resources! create_included_resources! response.object['includes'] @resource = create_resource(response.object) unless @included_resources.empty? replace_links_in_included_resources_with_known_resources replace_links_with_known_resources @resource end @resource rescue UnparsableResource => error error end |
#create_resource(object) ⇒ Object
Creates a single resource from the response object
74 75 76 77 78 79 80 81 82 83 84 |
# File 'lib/contentful/resource_builder.rb', line 74 def create_resource(object) 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? res end |
#default_entry_mapping ⇒ Object
The default entry mapping
148 149 150 |
# File 'lib/contentful/resource_builder.rb', line 148 def default_entry_mapping DEFAULT_ENTRY_MAPPING.dup end |
#default_resource_mapping ⇒ Object
The default mapping for #detect_resource_class
143 144 145 |
# File 'lib/contentful/resource_builder.rb', line 143 def default_resource_mapping DEFAULT_RESOURCE_MAPPING.dup end |
#detect_resource_class(object) ⇒ Object
Uses the resource mapping to find the proper Resource class to initialize for this Response object type
The mapping value can be a
-
Class
-
Proc: Will be called, expected to return the proper Class
-
Symbol: Will be called as method of the ResourceBuilder itself
127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/contentful/resource_builder.rb', line 127 def detect_resource_class(object) type = object['sys'] && object['sys']['type'] case res_class = resource_mapping[type] when Symbol public_send(res_class, object) when Proc res_class[object] when nil fail UnparsableResource.new(response) else res_class end end |
#find_entry_class(object) ⇒ Object
Checks in a custom class for an entry was defined in entry_mapping
87 88 89 |
# File 'lib/contentful/resource_builder.rb', line 87 def find_entry_class(object) entry_mapping[content_type_id_for_entry(object)] || try_dynamic_entry(object) end |
#get_dynamic_entry(object) ⇒ Object
Finds the proper DynamicEntry class for an entry
97 98 99 100 101 |
# File 'lib/contentful/resource_builder.rb', line 97 def get_dynamic_entry(object) if content_id = content_type_id_for_entry(object) client.dynamic_entry_cache[content_id.to_sym] end end |
#run ⇒ Object
Starts the parsing process. Either returns an Error, or the parsed Resource
44 45 46 47 48 49 50 |
# File 'lib/contentful/resource_builder.rb', line 44 def run if response.status == :ok create_all_resources! else response.object end end |
#try_dynamic_entry(object) ⇒ Object
Automatically converts Entry to DynamicEntry if in cache
92 93 94 |
# File 'lib/contentful/resource_builder.rb', line 92 def try_dynamic_entry(object) get_dynamic_entry(object) || Entry end |