contentful 0.3.0 → 0.3.1

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
+  - 2.1.2
   - 2.1.1
   - 2.1
   - 2.0.0

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 0.3.1
+* return nil when a value is not supplied, fixes #18
+* do not parse empty responses
+* remove CGI dependency for http gem
+
 ### 0.3.0
 
 * Support Synchronization

data/README.md

@@ -9,65 +9,78 @@ Ruby client for the [Contentful](https://www.contentful.com) Content Delivery AP
 
 Add to your Gemfile and bundle:
 
-    gem 'contentful'
-
+```bash
+gem 'contentful'
+```
 
 ## Usage
 
-    client = Contentful::Client.new(
-      access_token: 'b4c0n73n7fu1',
-      space: 'cfexampleapi'
-    )
+```ruby
+client = Contentful::Client.new(
+  access_token: 'b4c0n73n7fu1',
+  space: 'cfexampleapi'
+)
+```
 
 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**:
 
-    client.content_types
-    client.entry 'nyancat'
+```ruby
+client.content_types
+client.entry 'nyancat'
+```
 
 You can pass the usual filter options to the query:
 
-    client.entries('sys.id[ne]' => 'nyancat') # query for all entries except 'nyancat'
-    client.entries(include: 1) # include one level of linked resources
-
+```ruby
+client.entries('sys.id[ne]' => 'nyancat') # query for all entries except 'nyancat'
+client.entries(include: 1) # include one level of linked resources
+```
 
 The results are returned as Contentful::Resource objects. Multiple results will be returned as Contentful::Array. The properties of a resource can be accessed through Ruby methods.
 
-    content_type = client.content_type 'cat'
-    content_type.description # "Meow."
-
+```ruby
+content_type = client.content_type 'cat'
+content_type.description # "Meow."
+```
 
 Alternatively, the data can be accessed as Ruby `Hash` with symbolized keys (and in camelCase):
 
-    content_type.properties # { name: '...', description: '...' }
-
+```ruby
+content_type.properties # { name: '...', description: '...' }
+```
 
 System Properties behave the same and can be accessed via the `#sys` method.
 
-    content_type.id # => 'cat'
-    entry.type # => 'Entry'
-    asset.sys # { id: '...', type: '...' }
-
+```ruby
+content_type.id # => 'cat'
+entry.type # => 'Entry'
+asset.sys # { id: '...', type: '...' }
+```
 
 Entry Fields usually don't have direct method accessors, since they are based on individual content types. These fields can be accessed through the `#fields` method:
 
-    entry = client.entry 'nyancat'
-    entry.fields[:color] # rainbow
+```ruby
+entry = client.entry 'nyancat'
+entry.fields[:color] # rainbow
+```
 
 Please note, that no field type conversions will be done for entries by default.
 
-
 ### Dynamic Entries
 
 However, you can (and should) set `:dynamic_entries` to `:auto` in your client configuration. When using this option, the client will fetch all available content types and use them to create dynamic entries on the fly.
 
-    client = Contentful::Client.new(
-      access_token: 'b4c0n73n7fu1',
-      space: 'cfexampleapi',
-      dynamic_entries: :auto,
-    )
-    entry = client.entry 'nyancat' # => #<Contentful::DynamicEntry[cat]: ...>
-    entry.color # => 'rainbow'
+```ruby
+client = Contentful::Client.new(
+  access_token: 'b4c0n73n7fu1',
+  space: 'cfexampleapi',
+  dynamic_entries: :auto,
+)
+
+entry = client.entry 'nyancat' # => #<Contentful::DynamicEntry[cat]: ...>
+entry.color # => 'rainbow'
+```
 
 Dynamic entries will have getter classes for the fields and do type conversions properly.
 
@@ -85,32 +98,35 @@ Arrays also have a `#next_page` URL, which will rerun the request with a increas
 
 You can easily request a resource that is represented by a link by calling `#resolve`:
 
-    happycat = client.entry 'happycat'
-    happycat.fields[:image]
-    # => #<Contentful::Link: @sys={:type=>"Link", :linkType=>"Asset", :id=>"happycat"}>
-    happycat.fields[:image].resolve # => #<Contentful::Asset: @fields={ ...
-
+```ruby
+happycat = client.entry 'happycat'
+happycat.fields[:image]
+# => #<Contentful::Link: @sys={:type=>"Link", :linkType=>"Asset", :id=>"happycat"}>
+happycat.fields[:image].resolve # => #<Contentful::Asset: @fields={ ...
+```
 
 ### Assets
 
 There is a helpful method to add image resize options for an asset image:
 
-    client.asset('happycat').image_url
-    # => "//images.contentful.com/cfexampleapi/3MZPnjZTIskAIIkuuosCss/
-    #     382a48dfa2cb16c47aa2c72f7b23bf09/happycatw.jpg"
-
-    client.asset('happycat').image_url width: 300, height: 200, format: 'jpg', quality: 100
-    # => "//images.contentful.com/cfexampleapi/3MZPnjZTIskAIIkuuosCss/
-    #     382a48dfa2cb16c47aa2c72f7b23bf09/happycatw.jpg?w=300&h=200&fm=jpg&q=100"
+```ruby
+client.asset('happycat').image_url
+# => "//images.contentful.com/cfexampleapi/3MZPnjZTIskAIIkuuosCss/
+#     382a48dfa2cb16c47aa2c72f7b23bf09/happycatw.jpg"
 
+client.asset('happycat').image_url width: 300, height: 200, format: 'jpg', quality: 100
+# => "//images.contentful.com/cfexampleapi/3MZPnjZTIskAIIkuuosCss/
+#     382a48dfa2cb16c47aa2c72f7b23bf09/happycatw.jpg?w=300&h=200&fm=jpg&q=100"
+```
 
 ### Resource Options
 
 Resources, that have been requested directly (i.e. no child resources), can be fetched from the server again by calling `#reload`:
 
-    entries = client.entries
-    entries.reload # Fetches the array of entries again
-
+```ruby
+entries = client.entries
+entries.reload # Fetches the array of entries again
+```
 
 ### Field Type "Object"
 
@@ -156,80 +172,95 @@ See next paragraph for explanation
 
 You can define your own classes that will be returned instead of the predefined ones. Consider, you want to build a better Asset class. One way to do this is:
 
-    class MyBetterAsset < Contentful::Asset
-      def https_image_url
-        image_url.sub %r<\A//>, 'https://'
-      end
-    end
+```ruby
+class MyBetterAsset < Contentful::Asset
+  def https_image_url
+    image_url.sub %r<\A//>, 'https://'
+  end
+end
+```
 
 You can register your custom class on client initialization:
 
-    client = Contentful::Client.new(
-      space: 'cfexampleapi',
-      access_token: 'b4c0n73n7fu1',
-      resource_mapping: {
-        'Asset' => MyBetterAsset
-      }
-    )
+```ruby
+client = Contentful::Client.new(
+  space: 'cfexampleapi',
+  access_token: 'b4c0n73n7fu1',
+  resource_mapping: {
+    'Asset' => MyBetterAsset
+  }
+)
+```
 
 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:
 
-    class Cat < Contentful::Entry
-      # define methods based on :fields, etc
-    end
+```ruby
+class Cat < Contentful::Entry
+  # define methods based on :fields, etc
+end
 
-    client = Contentful::Client.new(
-      space: 'cfexampleapi',
-      access_token: 'b4c0n73n7fu1',
-      entry_mapping: {
-        'cat' => Cat
-      }
-    )
-
-    client.entry('nyancat') # is instance of Cat
+client = Contentful::Client.new(
+  space: 'cfexampleapi',
+  access_token: 'b4c0n73n7fu1',
+  entry_mapping: {
+    'cat' => Cat
+  }
+)
 
+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
+```ruby
+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
+```ruby
+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
+# More explicit version:
+page = sync.first_page
+until sync.completed?
+  page = sync.next_page
+end
+```
 
 Or directly iterative over all resources:
 
-    sync.each_item do |resource|
-      # ...
-    end
+```ruby
+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
+```ruby
+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
-
+```ruby
+first_entry = client.sync(initial: true, type: 'Entry').first_page.items.first
+first_entry.fields('de-DE') # Returns German localizations
+```
 
 ## License
 

data/lib/contentful/client.rb

@@ -4,8 +4,6 @@ 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

data/lib/contentful/resource.rb

@@ -8,8 +8,8 @@ module Contentful
   # You can define your own classes that behave like contentful resources:
   # See examples/custom_classes.rb to see how.
   #
-  # Take a look at examples/resource_mapping.rb on how to register them to be returned
-  # by the client by default
+  # Take a look at examples/resource_mapping.rb on how to register them
+  # to be returned by the client by default
   module Resource
     COERCIONS = {
       string:  ->(v) { v.to_s },
@@ -26,7 +26,8 @@ module Contentful
       @nested_locale_fields = nested_locale_fields
       @default_locale = default_locale
 
-      @properties = extract_from_object object, :property, self.class.property_coercions.keys
+      @properties = extract_from_object(object, :property,
+                                        self.class.property_coercions.keys)
       @request = request
       @client = client
     end
@@ -72,10 +73,9 @@ module Contentful
       if object
         keys ||= object.keys
         keys.each.with_object({}) do |name, res|
-          res[name.to_sym] = coerce_value_or_array(
-            object.is_a?(::Array) ? object : object[name.to_s],
-            self.class.public_send(:"#{namespace}_coercions")[name.to_sym]
-          )
+          value = object.is_a?(::Array) ? object : object[name.to_s]
+          kind = self.class.public_send(:"#{namespace}_coercions")[name.to_sym]
+          res[name.to_sym] = coerce_value_or_array(value, kind)
         end
       else
         {}
@@ -83,7 +83,9 @@ module Contentful
     end
 
     def coerce_value_or_array(value, what = nil)
-      if value.is_a? ::Array
+      if value.nil?
+        nil
+      elsif value.is_a? ::Array
         value.map { |v| coerce_or_create_class(v, what) }
       else
         coerce_or_create_class(value, what)

data/lib/contentful/response.rb

@@ -27,14 +27,20 @@ module Contentful
       @request = request
       @status  = :ok
 
-      if parse_json!
+      if no_content_response?
+        @status = :no_content
+        @object = true
+      elsif parse_json!
         parse_contentful_error!
       end
     end
 
-
     private
 
+    def no_content_response?
+      @raw.to_s == '' && @raw.status == 204
+    end
+
     def parse_json!
       @object = MultiJson.load(raw.to_s)
       true
@@ -61,4 +67,4 @@ module Contentful
     end
 
   end
-end
+end

data/lib/contentful/version.rb

@@ -1,3 +1,3 @@
 module Contentful
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

data/problem.rb

@@ -0,0 +1,39 @@
+require 'pry'
+module PlayboyContentful
+  class ContentType < Contentful::ContentType
+
+    def type_for_field_with_name(name)
+      fields.each do |field|
+        return field.type if field.id == name
+      end
+      return nil
+    end
+
+    # Depending on if the field supports full text search, the call needs may
+    # or may not need to append [eq] to the "fields.<field_name>" filter
+    def equality_string_for_field_with_name(name)
+      field_type = type_for_field_with_name(name)
+      raise "Could not build equality string for #{name} because field was not found." if field_type == nil
+      return "fields.#{name}" if field_type == "Symbol"
+      return "fields.#{name}[match]" if field_type == "Text"
+      "fields.#{name}[eq]"
+    end
+
+  end
+end
+
+CONTENTFUL_ACCESS_TOKEN="9b3b92d9929dc96744809e3b290bd1c6e6d9f10f7e4e7217ed50524fc0d9728d"
+CONTENTFUL_SPACE="t8g5epyvf6nt"
+
+client = Contentful::Client.new(
+                               access_token: CONTENTFUL_ACCESS_TOKEN,
+                               space: CONTENTFUL_SPACE,
+                               dynamic_entries: :auto,
+                               resource_mapping: {
+                                                  'ContentType' => PlayboyContentful::ContentType
+                                                 }
+                              )
+
+client.entry('2ks0eTNWoMw0026sUgsMWW')
+
+client.entries({"content_type"=>"3VZz9HnPy02usuACK08WUw", :limit=>1000})

data/spec/response_spec.rb

@@ -35,6 +35,13 @@ describe Contentful::Response do
     it 'returns :unparsable_json for unparsable json responses' do
       expect( unparsable_response.status ).to eq :unparsable_json
     end
+
+    it 'returns :no_content for responses without content' do
+      raw_response = ''
+      mock(raw_response).status {204}
+      no_content_response = Contentful::Response.new raw_response
+      expect( no_content_response.status).to eq :no_content
+    end
   end
 
   describe "#error_message" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contentful
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-02 00:00:00.000000000 Z
+date: 2014-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -211,6 +211,7 @@ files:
 - lib/contentful/version.rb
 - lib/contentful.rb
 - LICENSE.txt
+- problem.rb
 - Rakefile
 - README.md
 - spec/array_spec.rb
@@ -288,7 +289,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -620049112391953740
+      hash: -2280169027525600462
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -297,7 +298,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -620049112391953740
+      hash: -2280169027525600462
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23.2