contentful 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 055e3549fae94399369cbf11af030345ecca06a2
-  data.tar.gz: afcffb79eb459aa3b7fb55092c5be10594d98c63
+  metadata.gz: be9193f04c4996121d4fc9ca04b4dc164fa2ef81
+  data.tar.gz: e7fbe7fde7897b9e148920026a149cfd50466d35
 SHA512:
-  metadata.gz: 74469eca51e340966a57bf3e7d2bd4880c3c0f988e5eba58eaef49fcecc52d7a3a3ab4ea092a6211beb353642686052c92636a7502e0ef714c15793ca4d4666d
-  data.tar.gz: 8ccc5ef2d39f5b9e3fdab75b8fe47d9b39d2e8c734b84a6638707143f5e5782abf34e9830d7f96d817531644b0ef4bf2d70f7ed536db0f835d8e4757c5fbb6e9
+  metadata.gz: 1a6ac299c0adbf1504a99f164170959020845d450961418caa9ae9dccb1d8097d0cb120be135288d5a195c404daded8a05ad68480a149921646dbc25aa7b260d
+  data.tar.gz: 634debe7bd43a3b4c8a9803441b1f20659121a9766a76146713a7d136033698e1a1e8d1a70e77408bb33d175b3805e8c50d12606c64fdf1f291236fd7f6a5582

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+### 0.2.0
+
+* Introduce new :entry_mapping configuration to enable custom Entry classes based on ContentTypes
+* Update HTTP gem dependency to 0.6
+* Convert arrays in query values to strings, separated by comma
+
+
 ### 0.1.3
 
 * Better link inclusion processing, prevent "stack level to deep" errors

data/README.md

@@ -20,7 +20,7 @@ Add to your Gemfile and bundle:
     )
 
 You can query for entries, assets, etc. very similar as described in the
-[Delivery API Documentation](https://www.contentful.com/developers/documentation/content-delivery-api/). Please note, that all methods of the Ruby client library are snake_cased, instead of JavaScript's camelCase:
+[Delivery API Documentation](https://www.contentful.com/developers/documentation/content-delivery-api/). Please note, that **all methods of the Ruby client library are snake_cased, instead of JavaScript's camelCase**:
 
     client.content_types
     client.entry 'nyancat'
@@ -37,7 +37,7 @@ The results are returned as Contentful::Resource objects. Multiple results will
     content_type.description # "Meow."
 
 
-Alternatively, the data can be accessed as Ruby `Hash` with symbolized keys:
+Alternatively, the data can be accessed as Ruby `Hash` with symbolized keys (and in camelCase):
 
     content_type.properties # { name: '...', description: '...' }
 
@@ -111,6 +111,7 @@ Resources, that have been requested directly (i.e. no child resources), can be f
     entries = client.entries
     entries.reload # Fetches the array of entries again
 
+
 ### Field Type "Object"
 
 While for known field types, the field data is accessible using methods or the `#fields` hash with symbol keys, it behaves differently for nested data of the type "Object". The client will treat them as arbitrary hashes and will not parse the data inside, which also means, this data is indexed by Ruby strings, not symbols.
@@ -173,21 +174,22 @@ You can register your custom class on client initialization:
 
 More information on `:resource_mapping` can be found in examples/resource_mapping.rb and more on custom classes in examples/custom_classes.rb
 
+You can also register custom entry classes to be used based on the entry's content_type using the :entry_mapping configuration:
 
-### Dynamic Entries
-
-In `dynamic_entries: :auto` mode, all entries are returned as specialized entry classes. However, you can also create these specialized classes by yourself, based on a content type:
+    class Cat < Contentful::Entry
+      # define methods based on :fields, etc
+    end
 
     client = Contentful::Client.new(
       space: 'cfexampleapi',
       access_token: 'b4c0n73n7fu1',
-      dynamice_entries: :manual, # default
+      entry_mapping: {
+        'cat' => Cat
+      }
     )
-    content_type = client.content_type 'cat'
-    MyCat = Contentful::DynamicEntry.create(content_type)
-    client.register_dynamic_entry 'cat', MyCat
 
-More information on dynamic entries are available in examples/dynamic_entries.rb
+    client.entry('nyancat') # is instance of Cat
+
 
 ## License
 

data/contentful.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^spec/})
   gem.require_paths = ['lib']
 
-  gem.add_dependency 'http', '~> 0', '< 0.6'
+  gem.add_dependency 'http', '~> 0.6'
   gem.add_dependency 'multi_json', '~> 1'
 
   gem.add_development_dependency 'bundler', '~> 1.5'

data/lib/contentful/client.rb

@@ -17,6 +17,7 @@ module Contentful
       authentication_mechanism: :header,
       resource_builder: ResourceBuilder,
       resource_mapping: {},
+      entry_mapping: {},
       raw_mode: false
     }
 
@@ -41,7 +42,7 @@ module Contentful
 
     # Returns the default configuration
     def default_configuration
-      DEFAULT_CONFIGURATION
+      DEFAULT_CONFIGURATION.dup
     end
 
     # Gets the client's space
@@ -130,7 +131,12 @@ module Contentful
 
       return response if !build_resource || configuration[:raw_mode]
 
-      result = configuration[:resource_builder].new(self, response, configuration[:resource_mapping]).run
+      result = configuration[:resource_builder].new(
+          self,
+          response, configuration[:resource_mapping],
+          configuration[:entry_mapping]
+      ).run
+
       raise result if result.is_a?(Error) && configuration[:raise_errors]
       result
     end

data/lib/contentful/request.rb

@@ -8,7 +8,9 @@ module Contentful
     def initialize(client, endpoint, query = {}, id = nil)
       @client = client
       @endpoint = endpoint
-      @query = !query || query.empty? ? nil : Support.symbolize_keys(query)
+      @query = if query && !query.empty?
+        normalize_query(query)
+      end
 
       if id
         @type = :single
@@ -33,5 +35,19 @@ module Contentful
     def copy
       Marshal.load(Marshal.dump(self))
     end
+
+
+    private
+
+    def normalize_query(query)
+      Hash[
+        query.map do |key, value|
+          [
+            key.to_sym,
+            value.is_a?(::Array) ? value.join(',') : value
+          ]
+        end
+      ]
+    end
   end
 end

data/lib/contentful/resource_builder.rb

@@ -15,21 +15,23 @@ module Contentful
     DEFAULT_RESOURCE_MAPPING = {
       'Space' => Space,
       'ContentType' => ContentType,
-      'Entry' => :try_dynamic_entry,
+      'Entry' => :find_entry_class,
       'Asset' => Asset,
       'Array' => Array,
       'Link' => Link,
     }
+    DEFAULT_ENTRY_MAPPING = {}
 
-    attr_reader :client, :response, :resource_mapping, :resource
+    attr_reader :client, :response, :resource_mapping, :entry_mapping, :resource
 
 
-    def initialize(client, response, resource_mapping = {})
+    def initialize(client, response, resource_mapping = {}, entry_mapping = {})
       @response = response
       @client = client
       @included_resources = {}
       @known_resources = Hash.new{ |h,k| h[k] = {} }
       @resource_mapping = default_resource_mapping.merge(resource_mapping)
+      @entry_mapping = default_entry_mapping.merge(entry_mapping)
     end
 
     # Starts the parsing process.
@@ -37,7 +39,7 @@ module Contentful
     def run
       case response.status
       when :contentful_error
-        Error[response.raw.response.status].new(response)
+        Error[response.raw.status].new(response)
       when :unparsable_json
         UnparsableJson.new(response)
       when :not_contentful
@@ -80,21 +82,30 @@ module Contentful
       res
     end
 
-    # When using Dynamic Entry Mode: Automatically converts Entry to DynamicEntry
+    # Checks in a custom class for an entry was defined in entry_mapping
+    def find_entry_class(object)
+      entry_mapping[content_type_id_for_entry(object)] || try_dynamic_entry(object)
+    end
+
+    # Automatically converts Entry to DynamicEntry if in cache
     def try_dynamic_entry(object)
       get_dynamic_entry(object) || Entry
     end
 
     # Finds the proper DynamicEntry class for an entry
     def get_dynamic_entry(object)
-      if id = object["sys"] &&
-          object["sys"]["contentType"] &&
-          object["sys"]["contentType"]["sys"] &&
-          object["sys"]["contentType"]["sys"]["id"]
-        client.dynamic_entry_cache[id.to_sym]
+      if content_id = content_type_id_for_entry(object)
+        client.dynamic_entry_cache[content_id.to_sym]
       end
     end
 
+    def content_type_id_for_entry(object)
+      object["sys"] &&
+      object["sys"]["contentType"] &&
+      object["sys"]["contentType"]["sys"] &&
+      object["sys"]["contentType"]["sys"]["id"]
+    end
+
     # Uses the resource mapping to find the proper Resource class to initialize
     # for this Response object type
     #
@@ -104,6 +115,7 @@ module Contentful
     # - Symbol: Will be called as method of the ResourceBuilder itself
     def detect_resource_class(object)
       type = object["sys"] && object["sys"]["type"]
+
       case res_class = resource_mapping[type]
       when Symbol
         public_send(res_class, object)
@@ -118,7 +130,12 @@ module Contentful
 
     # The default mapping for #detect_resource_class
     def default_resource_mapping
-      DEFAULT_RESOURCE_MAPPING
+      DEFAULT_RESOURCE_MAPPING.dup
+    end
+
+    # The default entry mapping
+    def default_entry_mapping
+      DEFAULT_ENTRY_MAPPING.dup
     end
 
 

data/lib/contentful/support.rb

@@ -7,14 +7,6 @@ module Contentful
         snake = String(object).gsub(/(?<!^)[A-Z]/) { "_#$&" }
         snake.downcase
       end
-
-      # Transforms each hash key into a symbol (like in AS)
-      def symbolize_keys(hash)
-        result = {}
-        # XXX remove inline rescue
-        hash.each_key { |key| result[(key.to_sym rescue key)] = hash[key] }
-        result
-      end
     end
   end
 end

data/lib/contentful/version.rb

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

data/spec/client_configuration_spec.rb

@@ -194,4 +194,23 @@ describe 'Client Configuration Options' do
       expect( nyancat.https_image_url ).to start_with 'https'
     end
   end
+
+  describe ':entry_mapping' do
+    it 'lets you register your own entry classes for certain entry types' do
+      class Cat < Contentful::Entry
+        # define methods based on :fields, etc
+      end
+
+      client = create_client(
+        entry_mapping: {
+          'cat' => Cat
+        }
+      )
+
+      nyancat = vcr('entry'){ client.entry 'nyancat' }
+      finn    = vcr('human'){ client.entry 'finn' }
+      expect( nyancat ).to be_a Cat
+      expect( finn    ).to be_a Contentful::Entry
+    end
+  end
 end

data/spec/fixtures/vcr_cassettes/human.yml

@@ -0,0 +1,95 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://cdn.contentful.com/spaces/cfexampleapi/entries/finn
+    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:
+      - Fri, 18 Apr 2014 17:56:56 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:
+      - "\"fcdc41e711c72e3cbc389211fde21287\""
+      X-Contentful-Request-Id:
+      - f1c-737727925
+      Content-Length:
+      - '591'
+      Accept-Ranges:
+      - bytes
+      Via:
+      - 1.1 varnish
+      Age:
+      - '0'
+      X-Served-By:
+      - cache-fra1229-FRA
+      X-Cache:
+      - MISS
+      X-Cache-Hits:
+      - '0'
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: UTF-8
+      string: |
+        {
+          "fields": {
+            "name": "Finn",
+            "description": "Fearless adventurer! Defender of pancakes.",
+            "likes": [
+              "adventure"
+            ]
+          },
+          "sys": {
+            "space": {
+              "sys": {
+                "type": "Link",
+                "linkType": "Space",
+                "id": "cfexampleapi"
+              }
+            },
+            "type": "Entry",
+            "contentType": {
+              "sys": {
+                "type": "Link",
+                "linkType": "ContentType",
+                "id": "human"
+              }
+            },
+            "id": "finn",
+            "revision": 6,
+            "createdAt": "2013-06-27T22:46:21.450Z",
+            "updatedAt": "2013-09-09T16:15:01.297Z",
+            "locale": "en-US"
+          }
+        }
+    http_version: 
+  recorded_at: Fri, 18 Apr 2014 17:56:56 GMT
+recorded_with: VCR 2.9.0

data/spec/request_spec.rb

@@ -11,6 +11,14 @@ describe Contentful::Request do
     end
   end
 
+  describe '#query' do
+    it 'converts arrays given in query to comma strings' do
+      client = create_client
+      request = Contentful::Request.new(client, '/entries', {'fields.likes[in]' => ['jake', 'finn']})
+      expect( request.query[:'fields.likes[in]'] ).to eq 'jake,finn'
+    end
+  end
+
   context '[single resource]' do
     let(:request){
       Contentful::Request.new(create_client, '/content_types', nil, 'nyancat')

metadata

@@ -1,23 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: contentful
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Contentful GmbH (Jan Lelis)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-16 00:00:00.000000000 Z
+date: 2014-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-    - - "<"
       - !ruby/object:Gem::Version
         version: '0.6'
   type: :runtime
@@ -25,9 +22,6 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-    - - "<"
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
@@ -225,6 +219,7 @@ files:
 - spec/fixtures/vcr_cassettes/entry.yml
 - spec/fixtures/vcr_cassettes/entry_cache.yml
 - spec/fixtures/vcr_cassettes/field.yml
+- spec/fixtures/vcr_cassettes/human.yml
 - spec/fixtures/vcr_cassettes/locale.yml
 - spec/fixtures/vcr_cassettes/location.yml
 - spec/fixtures/vcr_cassettes/not_found.yml
@@ -299,6 +294,7 @@ test_files:
 - spec/fixtures/vcr_cassettes/entry.yml
 - spec/fixtures/vcr_cassettes/entry_cache.yml
 - spec/fixtures/vcr_cassettes/field.yml
+- spec/fixtures/vcr_cassettes/human.yml
 - spec/fixtures/vcr_cassettes/locale.yml
 - spec/fixtures/vcr_cassettes/location.yml
 - spec/fixtures/vcr_cassettes/not_found.yml