contentful 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+pkg
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--color --format documentation

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.1.1
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode
+notifications:
+  flowdock:
+    - secure: "jO51sETvF1Je7jLQibT5P2ty3KAC8Q9/jJKPUKLDHAaz927XhhkrMXVs6tjzVG1BmHc5A+Qhuni26XerFRsocR7CTrqKdmvmXLgWyMtpW5CvUbtUCeApRQE2K4k/fb+7mz3EBAE494AK5Fz8f3vk2WVu5ROj5shuuggiYhoOqHw="

data/ChangeLog.md

@@ -0,0 +1,3 @@
+### 0.1.0
+
+* Initial release.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Contentful GmbH - Jan Lelis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,193 @@
+# contentful.rb
+
+Ruby client for the [Contentful](https://www.contentful.com) Content Delivery API.
+
+[Contentful](https://www.contentful.com) is a content management platform for web applications, mobile apps and connected devices. It allows you to create, edit & manage content in the cloud and publish it anywhere via powerful API. Contentful offers tools for managing editorial teams and enabling cooperation between organizations.
+
+## Setup
+
+Add to your Gemfile and bundle:
+
+    gem 'contentful'
+
+
+## Usage
+
+    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'
+
+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
+
+
+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."
+
+
+Alternatively, the data can be accessed as Ruby `Hash` with symbolized keys:
+
+    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: '...' }
+
+
+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
+
+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'
+
+Dynamic entries will have getter classes for the fields and do type conversions properly.
+
+The `:auto` mode will fetch all content types on initialization. If you want to do it by hand later, you will need to set the option to `:manual` and call `client.update_dynamic_entry_cache!` to initialize all dynamic entries.
+
+
+### Arrays
+
+Contentful::Array has an `#each` method that delegates to its items. It also includes Ruby's Enumerable module, providing methods like `#min` or `#first`. See the Ruby core documentation for further details.
+
+Arrays also have a `#next_page` URL, which will rerun the request with a increased skip parameter, as described in [the documentation](https://www.contentful.com/developers/documentation/content-delivery-api/#search-limit).
+
+
+### Links
+
+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={ ...
+
+
+### 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"
+
+
+### 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
+
+### 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.
+
+
+## Client Configuration Options
+### :space
+
+Required option. The name of the space you want to access.
+
+### :access_token
+
+Required option. The space's secret token.
+
+### :secure
+
+Whether to use https. Defaults to `true`.
+
+### :authentication_mechanism
+
+How to authenticate with the API. Supports `:header` (default) or `:query_string`.
+
+### :raise_errors
+
+If set to `true` (default), error responses will be raised. If set to `false`, the error objects will simply be returned.
+
+### :dynamic_entries
+
+`:auto` or `:manual`. See resource description above for details on usage.
+
+### :raw_mode
+
+Defaults to `false`. If enabled, the API responses will not be parsed to resource objects. Might be useful for debugging.
+
+### :resource_mapping
+
+See next paragraph for explanation
+
+
+## Advanced Usage
+### Custom Resource Classes
+
+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
+
+You can register your custom class on client initialization:
+
+    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
+
+
+### 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:
+
+    client = Contentful::Client.new(
+      space: 'cfexampleapi',
+      access_token: 'b4c0n73n7fu1',
+      dynamice_entries: :manual, # default
+    )
+    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
+
+## License
+
+Copyright (c) 2014 Contentful GmbH - Jan Lelis. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler."
+  exit -1
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :test    => :spec
+task :default => :spec

data/contentful.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/contentful/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "contentful"
+  gem.version       = Contentful::VERSION
+  gem.summary       = 'contentful'
+  gem.description   = 'Ruby client for the https://www.contentful.com Content Delivery API'
+  gem.license       = "MIT"
+  gem.authors       = ["Contentful GmbH (Jan Lelis)"]
+  gem.email         = "rubygems@contentful.com"
+  gem.homepage      = "https://github.com/contentful/contentful.rb"
+
+  gem.files         = Dir['{**/}{.*,*}'].select { |path| File.file?(path) && !path.start_with?("pkg") }
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^spec/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'http', '~> 0'
+  gem.add_dependency 'multi_json', '~> 1'
+
+  gem.add_development_dependency 'bundler', '~> 1.5'
+  gem.add_development_dependency 'rake', '~> 10'
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+
+  gem.add_development_dependency 'rspec', '~> 2'
+  gem.add_development_dependency 'rr'
+  gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'webmock', '~> 1', '>= 1.17.3'
+end

data/do_request.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+curl -v -X PUT https://api.contentful.com/spaces/4pc8kedrdxbj/content_types/announcements \
+-H 'Content-Type: application/vnd.contentful.management.v1+json' \
+-H 'Authorization: Bearer bc02f3f03b57cbe01518f131e7a75d0cc767f5874425a367205b93563a93d78b' \
+-d '{"name":"Announcements","description": "Announcements are delivered as push notifications directly to users devices", "displayField": "message", "fields":[ {"name": "Message", "id": "message", "type": "Text", "required": true}, {"name": "Description", "id": "description", "type": "Text"}, {"name": "Originator", "id": "originator", "type": "Symbol", "validations": [{"in": ["PGMC", "Clinical Lead for Acute Medicine", "Communications Team"]}]}]}'

data/doc/Contentful.html

@@ -0,0 +1,131 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Module: Contentful
+  
+    &mdash; Documentation by YARD 0.8.7.3
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!" + escape(window.location.href);
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+  
+    <a href="_index.html">Index (C)</a> &raquo;
+    
+    
+    <span class="title">Contentful</span>
+  
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+  
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+  
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><h1>Module: Contentful
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+  
+    
+  
+    
+  
+  
+  
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/contentful/link.rb<span class="defines">,<br />
+  lib/contentful/file.rb,<br /> lib/contentful/array.rb,<br /> lib/contentful/entry.rb,<br /> lib/contentful/asset.rb,<br /> lib/contentful/error.rb,<br /> lib/contentful/space.rb,<br /> lib/contentful/field.rb,<br /> lib/contentful/locale.rb,<br /> lib/contentful/client.rb,<br /> lib/contentful/request.rb,<br /> lib/contentful/version.rb,<br /> lib/contentful/support.rb,<br /> lib/contentful/response.rb,<br /> lib/contentful/resource.rb,<br /> lib/contentful/content_type.rb,<br /> lib/contentful/dynamic_entry.rb,<br /> lib/contentful/resource/fields.rb,<br /> lib/contentful/resource_builder.rb,<br /> lib/contentful/resource/asset_fields.rb,<br /> lib/contentful/resource/system_properties.rb</span>
+</dd>
+  
+</dl>
+<div class="clear"></div>
+
+<h2>Defined Under Namespace</h2>
+<p class="children">
+  
+    
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Contentful/Resource.html" title="Contentful::Resource (module)">Resource</a></span>, <span class='object_link'><a href="Contentful/Support.html" title="Contentful::Support (module)">Support</a></span>
+    
+  
+    
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Contentful/AccessDenied.html" title="Contentful::AccessDenied (class)">AccessDenied</a></span>, <span class='object_link'><a href="Contentful/Array.html" title="Contentful::Array (class)">Array</a></span>, <span class='object_link'><a href="Contentful/Asset.html" title="Contentful::Asset (class)">Asset</a></span>, <span class='object_link'><a href="Contentful/BadRequest.html" title="Contentful::BadRequest (class)">BadRequest</a></span>, <span class='object_link'><a href="Contentful/Client.html" title="Contentful::Client (class)">Client</a></span>, <span class='object_link'><a href="Contentful/ContentType.html" title="Contentful::ContentType (class)">ContentType</a></span>, <span class='object_link'><a href="Contentful/DynamicEntry.html" title="Contentful::DynamicEntry (class)">DynamicEntry</a></span>, <span class='object_link'><a href="Contentful/Entry.html" title="Contentful::Entry (class)">Entry</a></span>, <span class='object_link'><a href="Contentful/Error.html" title="Contentful::Error (class)">Error</a></span>, <span class='object_link'><a href="Contentful/Field.html" title="Contentful::Field (class)">Field</a></span>, <span class='object_link'><a href="Contentful/File.html" title="Contentful::File (class)">File</a></span>, <span class='object_link'><a href="Contentful/Link.html" title="Contentful::Link (class)">Link</a></span>, <span class='object_link'><a href="Contentful/Locale.html" title="Contentful::Locale (class)">Locale</a></span>, <span class='object_link'><a href="Contentful/NotFound.html" title="Contentful::NotFound (class)">NotFound</a></span>, <span class='object_link'><a href="Contentful/Request.html" title="Contentful::Request (class)">Request</a></span>, <span class='object_link'><a href="Contentful/ResourceBuilder.html" title="Contentful::ResourceBuilder (class)">ResourceBuilder</a></span>, <span class='object_link'><a href="Contentful/Response.html" title="Contentful::Response (class)">Response</a></span>, <span class='object_link'><a href="Contentful/ServerError.html" title="Contentful::ServerError (class)">ServerError</a></span>, <span class='object_link'><a href="Contentful/Space.html" title="Contentful::Space (class)">Space</a></span>, <span class='object_link'><a href="Contentful/Unauthorized.html" title="Contentful::Unauthorized (class)">Unauthorized</a></span>, <span class='object_link'><a href="Contentful/UnparsableJson.html" title="Contentful::UnparsableJson (class)">UnparsableJson</a></span>, <span class='object_link'><a href="Contentful/UnparsableResource.html" title="Contentful::UnparsableResource (class)">UnparsableResource</a></span>
+    
+  
+</p>
+
+  <h2>Constant Summary</h2>
+  
+    <dl class="constants">
+      
+        <dt id="VERSION-constant" class="">VERSION =
+          
+        </dt>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.1.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+      
+    </dl>
+  
+
+
+
+
+
+
+
+
+
+</div>
+
+    <div id="footer">
+  Generated on Tue Mar 11 09:25:52 2014 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.3 (ruby-1.9.3).
+</div>
+
+  </body>
+</html>