Class: Contentful::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/contentful/client.rb

Overview

The client object is initialized with a space and a key and then used for querying resources from this space. See README for details

Constant Summary collapse

DEFAULT_CONFIGURATION = 
{
    secure: true,
    raise_errors: true,
    dynamic_entries: :manual,
    api_url: 'cdn.contentful.com',
    api_version: 1,
    authentication_mechanism: :header,
    resource_builder: ResourceBuilder,
    resource_mapping: {},
    entry_mapping: {},
    default_locale: 'en-US',
    raw_mode: false,
    gzip_encoded: false,
    logger: false,
    log_level: Logger::INFO
}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(given_configuration = {}) ⇒ Client

Returns a new instance of Client.



38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/contentful/client.rb', line 38

def initialize(given_configuration = {})
  @configuration = default_configuration.merge(given_configuration)
  normalize_configuration!
  validate_configuration!
  setup_logger

  if configuration[:dynamic_entries] == :auto
    update_dynamic_entry_cache!
  else
    @dynamic_entry_cache = {}
  end
end

Instance Attribute Details

#configuration ⇒ Object (readonly)

Returns the value of attribute configuration.



31
32
33
 
# File 'lib/contentful/client.rb', line 31

def configuration
  @configuration
end

#dynamic_entry_cache ⇒ Object (readonly)

Returns the value of attribute dynamic_entry_cache.



31
32
33
 
# File 'lib/contentful/client.rb', line 31

def dynamic_entry_cache
  @dynamic_entry_cache
end

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



31
32
33
 
# File 'lib/contentful/client.rb', line 31

def logger
  @logger
end

Class Method Details

.get_http(url, query, headers = {}) ⇒ Object

Wraps the actual HTTP request



34
35
36
 
# File 'lib/contentful/client.rb', line 34

def self.get_http(url, query, headers = {})
  HTTP[headers].get(url, params: query)
end

Instance Method Details

#asset(id, query = {}) ⇒ Object

Gets a specific asset Takes an id and an optional hash of query options Returns a Contentful::Asset



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

def asset(id, query = {})
  Request.new(self, '/assets', query, id).get
end

#assets(query = {}) ⇒ Object

Gets a collection of assets Takes an optional hash of query options Returns a Contentful::Array of Contentful::Asset



106
107
108
 
# File 'lib/contentful/client.rb', line 106

def assets(query = {})
  Request.new(self, '/assets', query).get
end

#base_url ⇒ Object

Returns the base url for all of the client’s requests



111
112
113
 
# File 'lib/contentful/client.rb', line 111

def base_url
  "http#{configuration[:secure] ? 's' : ''}://#{configuration[:api_url]}/spaces/#{configuration[:space]}"
end

#content_type(id, query = {}) ⇒ Object

Gets a specific content type Takes an id and an optional hash of query options Returns a Contentful::ContentType



71
72
73
 
# File 'lib/contentful/client.rb', line 71

def content_type(id, query = {})
  Request.new(self, '/content_types', query, id).get
end

#content_types(query = {}) ⇒ Object

Gets a collection of content types Takes an optional hash of query options Returns a Contentful::Array of Contentful::ContentType



78
79
80
 
# File 'lib/contentful/client.rb', line 78

def content_types(query = {})
  Request.new(self, '/content_types', query).get
end

#default_configuration ⇒ Object

Returns the default configuration



57
58
59
 
# File 'lib/contentful/client.rb', line 57

def default_configuration
  DEFAULT_CONFIGURATION.dup
end

#entries(query = {}) ⇒ Object

Gets a collection of entries Takes an optional hash of query options Returns a Contentful::Array of Contentful::Entry



92
93
94
 
# File 'lib/contentful/client.rb', line 92

def entries(query = {})
  Request.new(self, '/entries', query).get
end

#entry(id, query = {}) ⇒ Object

Gets a specific entry Takes an id and an optional hash of query options Returns a Contentful::Entry



85
86
87
 
# File 'lib/contentful/client.rb', line 85

def entry(id, query = {})
  Request.new(self, '/entries', query, id).get
end

#get(request, build_resource = true) ⇒ Object

Get a Contentful::Request object Set second parameter to false to deactivate Resource building and return Response objects instead



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/contentful/client.rb', line 136

def get(request, build_resource = true)
  url = request.absolute? ? request.url : base_url + request.url
  logger.info(request: {url: url, query: request.query, header: request_headers}) if logger
  response = Response.new(
      self.class.get_http(
          url,
          request_query(request.query),
          request_headers
      ), request
  )

  return response if !build_resource || configuration[:raw_mode]
  logger.debug(response: response) if logger
  result = configuration[:resource_builder].new(
      self,
      response,
      configuration[:resource_mapping],
      configuration[:entry_mapping],
      configuration[:default_locale]
  ).run

  fail result if result.is_a?(Error) && configuration[:raise_errors]
  result
end

#register_dynamic_entry(key, klass) ⇒ Object

Use this method to manually register a dynamic entry See examples/dynamic_entries.rb



176
177
178
 
# File 'lib/contentful/client.rb', line 176

def register_dynamic_entry(key, klass)
  @dynamic_entry_cache[key.to_sym] = klass
end

#request_headers ⇒ Object

Returns the headers used for the HTTP requests



116
117
118
119
120
121
122
 
# File 'lib/contentful/client.rb', line 116

def request_headers
  headers = {'User-Agent' => "RubyContentfulGem/#{Contentful::VERSION}"}
  headers['Authorization'] = "Bearer #{configuration[:access_token]}" if configuration[:authentication_mechanism] == :header
  headers['Content-Type'] = "application/vnd.contentful.delivery.v#{configuration[:api_version].to_i}+json" if configuration[:api_version]
  headers['Accept-Encoding'] = 'gzip' if configuration[:gzip_encoded]
  headers
end

#request_query(query) ⇒ Object

Patches a query hash with the client configurations for queries



125
126
127
128
129
130
131
 
# File 'lib/contentful/client.rb', line 125

def request_query(query)
  if configuration[:authentication_mechanism] == :query_string
    query['access_token'] = configuration[:access_token]
  end

  query
end

#setup_logger ⇒ Object 



51
52
53
54
 
# File 'lib/contentful/client.rb', line 51

def setup_logger
  @logger = configuration[:logger]
  logger.level = configuration[:log_level] if logger
end

#space(query = {}) ⇒ Object

Gets the client’s space Takes an optional hash of query options Returns a Contentful::Space



64
65
66
 
# File 'lib/contentful/client.rb', line 64

def space(query = {})
  Request.new(self, '', query).get
end

#sync(options = {initial: true}) ⇒ Object

Create a new synchronisation object Takes sync options or a sync_url You will need to call #each_page or #first_page on it



183
184
185
 
# File 'lib/contentful/client.rb', line 183

def sync(options = {initial: true})
  Sync.new(self, options)
end

#update_dynamic_entry_cache! ⇒ Object

Use this method together with the client’s :dynamic_entries configuration. See README for details.



163
164
165
166
167
168
169
170
171
172
 
# File 'lib/contentful/client.rb', line 163

def update_dynamic_entry_cache!
  @dynamic_entry_cache = Hash[
      content_types(limit: 1000).map do |ct|
        [
            ct.id.to_sym,
            DynamicEntry.create(ct)
        ]
      end
  ]
end