Class: Contentful::ResourceBuilder

Inherits:
Object
  • Object
show all
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 =

Default Resource Mapping

See Also:

  • README for more information on 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 =

Default Entry Mapping

See Also:

  • README for more information on Entry Mapping
{}

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client, response, resource_mapping = {}, entry_mapping = {}, default_locale = Contentful::Client::DEFAULT_CONFIGURATION[:default_locale]) ⇒ ResourceBuilder

Returns a new instance of ResourceBuilder.



35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/contentful/resource_builder.rb', line 35

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] = {} }
  @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.



33
34
35
 
# File 'lib/contentful/resource_builder.rb', line 33

def client
  @client
end

#entry_mapping ⇒ Object (readonly)

Returns the value of attribute entry_mapping.



33
34
35
 
# File 'lib/contentful/resource_builder.rb', line 33

def entry_mapping
  @entry_mapping
end

#resource ⇒ Object (readonly)

Returns the value of attribute resource.



33
34
35
 
# File 'lib/contentful/resource_builder.rb', line 33

def resource
  @resource
end

#resource_mapping ⇒ Object (readonly)

Returns the value of attribute resource_mapping.



33
34
35
 
# File 'lib/contentful/resource_builder.rb', line 33

def resource_mapping
  @resource_mapping
end

#response ⇒ Object (readonly)

Returns the value of attribute response.



33
34
35
 
# File 'lib/contentful/resource_builder.rb', line 33

def response
  @response
end

Instance Method Details

#array_or_sync_page(object) ⇒ Object

Detects if a resource is an Contentful::Array or a SyncPage



118
119
120
121
122
123
124
 
# File 'lib/contentful/resource_builder.rb', line 118

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



110
111
112
113
114
115
 
# File 'lib/contentful/resource_builder.rb', line 110

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/contentful/resource_builder.rb', line 66

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
  end

  replace_links_with_known_resources @resource

  @resource
rescue UnparsableResource => error
  error
end

#create_resource(object) ⇒ Object

Creates a single resource from the response object



82
83
84
85
86
87
88
89
90
91
 
# File 'lib/contentful/resource_builder.rb', line 82

def create_resource(object)
  res_class = detect_resource_class(object)
  res = res_class.new(object, response.request, client, @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



154
155
156
 
# File 'lib/contentful/resource_builder.rb', line 154

def default_entry_mapping
  DEFAULT_ENTRY_MAPPING.dup
end

#default_resource_mapping ⇒ Object

The default mapping for #detect_resource_class



149
150
151
 
# File 'lib/contentful/resource_builder.rb', line 149

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



133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/contentful/resource_builder.rb', line 133

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, response
  else
    res_class
  end
end

#find_entry_class(object) ⇒ Object

Checks in a custom class for an entry was defined in entry_mapping



94
95
96
 
# File 'lib/contentful/resource_builder.rb', line 94

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



104
105
106
107
 
# File 'lib/contentful/resource_builder.rb', line 104

def get_dynamic_entry(object)
  content_id = content_type_id_for_entry(object)
  client.dynamic_entry_cache[content_id.to_sym] if content_id
end

#run ⇒ Contentful::Resource, Contentful::Error

Starts the parsing process.

Returns:



51
52
53
54
55
56
57
 
# File 'lib/contentful/resource_builder.rb', line 51

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



99
100
101
 
# File 'lib/contentful/resource_builder.rb', line 99

def try_dynamic_entry(object)
  get_dynamic_entry(object) || Entry
end