RubyGems - contentful - Versions diffs - 0.1.0 - Mend

contentful 0.1.0

Files changed (133) hide show

data/.README.md.swp +0 -0
data/.gitignore +2 -0
data/.rspec +1 -0
data/.travis.yml +10 -0
data/ChangeLog.md +3 -0
data/Gemfile +3 -0
data/LICENSE.txt +21 -0
data/README.md +193 -0
data/Rakefile +30 -0
data/contentful.gemspec +31 -0
data/do_request.sh +5 -0
data/doc/Contentful.html +131 -0
data/doc/Contentful/AccessDenied.html +158 -0
data/doc/Contentful/Array.html +346 -0
data/doc/Contentful/Asset.html +315 -0
data/doc/Contentful/BadRequest.html +158 -0
data/doc/Contentful/Client.html +1407 -0
data/doc/Contentful/ContentType.html +183 -0
data/doc/Contentful/DynamicEntry.html +333 -0
data/doc/Contentful/Entry.html +198 -0
data/doc/Contentful/Error.html +413 -0
data/doc/Contentful/Field.html +161 -0
data/doc/Contentful/File.html +160 -0
data/doc/Contentful/Link.html +275 -0
data/doc/Contentful/Locale.html +161 -0
data/doc/Contentful/NotFound.html +158 -0
data/doc/Contentful/Request.html +669 -0
data/doc/Contentful/Resource.html +606 -0
data/doc/Contentful/Resource/AssetFields.html +413 -0
data/doc/Contentful/Resource/AssetFields/ClassMethods.html +174 -0
data/doc/Contentful/Resource/ClassMethods.html +271 -0
data/doc/Contentful/Resource/Fields.html +398 -0
data/doc/Contentful/Resource/Fields/ClassMethods.html +187 -0
data/doc/Contentful/Resource/SystemProperties.html +444 -0
data/doc/Contentful/Resource/SystemProperties/ClassMethods.html +174 -0
data/doc/Contentful/ResourceBuilder.html +1400 -0
data/doc/Contentful/Response.html +546 -0
data/doc/Contentful/ServerError.html +158 -0
data/doc/Contentful/Space.html +183 -0
data/doc/Contentful/Support.html +198 -0
data/doc/Contentful/Unauthorized.html +158 -0
data/doc/Contentful/UnparsableJson.html +158 -0
data/doc/Contentful/UnparsableResource.html +158 -0
data/doc/_index.html +410 -0
data/doc/class_list.html +54 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +57 -0
data/doc/css/style.css +338 -0
data/doc/file.README.html +214 -0
data/doc/file_list.html +56 -0
data/doc/frames.html +26 -0
data/doc/index.html +214 -0
data/doc/js/app.js +219 -0
data/doc/js/full_list.js +178 -0
data/doc/js/jquery.js +4 -0
data/doc/method_list.html +533 -0
data/doc/top-level-namespace.html +112 -0
data/examples/custom_classes.rb +43 -0
data/examples/dynamic_entries.rb +126 -0
data/examples/example_queries.rb +27 -0
data/examples/raise_errors.rb +22 -0
data/examples/raw_mode.rb +15 -0
data/examples/resource_mapping.rb +33 -0
data/lib/contentful.rb +3 -0
data/lib/contentful/array.rb +47 -0
data/lib/contentful/asset.rb +34 -0
data/lib/contentful/client.rb +193 -0
data/lib/contentful/content_type.rb +16 -0
data/lib/contentful/dynamic_entry.rb +54 -0
data/lib/contentful/entry.rb +12 -0
data/lib/contentful/error.rb +52 -0
data/lib/contentful/field.rb +16 -0
data/lib/contentful/file.rb +13 -0
data/lib/contentful/link.rb +20 -0
data/lib/contentful/locale.rb +12 -0
data/lib/contentful/location.rb +12 -0
data/lib/contentful/request.rb +37 -0
data/lib/contentful/resource.rb +146 -0
data/lib/contentful/resource/asset_fields.rb +50 -0
data/lib/contentful/resource/fields.rb +39 -0
data/lib/contentful/resource/system_properties.rb +48 -0
data/lib/contentful/resource_builder.rb +197 -0
data/lib/contentful/response.rb +64 -0
data/lib/contentful/space.rb +14 -0
data/lib/contentful/support.rb +18 -0
data/lib/contentful/version.rb +3 -0
data/spec/array_spec.rb +69 -0
data/spec/asset_spec.rb +62 -0
data/spec/auto_includes_spec.rb +12 -0
data/spec/client_class_spec.rb +59 -0
data/spec/client_configuration_spec.rb +197 -0
data/spec/coercions_spec.rb +10 -0
data/spec/content_type_spec.rb +44 -0
data/spec/dynamic_entry_spec.rb +34 -0
data/spec/entry_spec.rb +53 -0
data/spec/error_class_spec.rb +60 -0
data/spec/error_requests_spec.rb +32 -0
data/spec/field_spec.rb +36 -0
data/spec/file_spec.rb +28 -0
data/spec/fixtures/json_responses/content_type.json +83 -0
data/spec/fixtures/json_responses/not_found.json +13 -0
data/spec/fixtures/json_responses/nyancat.json +48 -0
data/spec/fixtures/json_responses/unparsable.json +13 -0
data/spec/fixtures/vcr_cassettes/array.yml +288 -0
data/spec/fixtures/vcr_cassettes/array_page_1.yml +106 -0
data/spec/fixtures/vcr_cassettes/array_page_2.yml +73 -0
data/spec/fixtures/vcr_cassettes/asset.yml +96 -0
data/spec/fixtures/vcr_cassettes/bad_request.yml +76 -0
data/spec/fixtures/vcr_cassettes/content_type.yml +147 -0
data/spec/fixtures/vcr_cassettes/entries.yml +561 -0
data/spec/fixtures/vcr_cassettes/entry.yml +112 -0
data/spec/fixtures/vcr_cassettes/entry_cache.yml +288 -0
data/spec/fixtures/vcr_cassettes/field.yml +147 -0
data/spec/fixtures/vcr_cassettes/locale.yml +81 -0
data/spec/fixtures/vcr_cassettes/location.yml +305 -0
data/spec/fixtures/vcr_cassettes/not_found.yml +71 -0
data/spec/fixtures/vcr_cassettes/nyancat.yml +112 -0
data/spec/fixtures/vcr_cassettes/nyancat_include.yml +112 -0
data/spec/fixtures/vcr_cassettes/reloaded_entry.yml +112 -0
data/spec/fixtures/vcr_cassettes/space.yml +81 -0
data/spec/fixtures/vcr_cassettes/unauthorized.yml +64 -0
data/spec/link_spec.rb +40 -0
data/spec/locale_spec.rb +20 -0
data/spec/location_spec.rb +30 -0
data/spec/request_spec.rb +48 -0
data/spec/resource_spec.rb +52 -0
data/spec/response_spec.rb +50 -0
data/spec/space_spec.rb +36 -0
data/spec/spec_helper.rb +6 -0
data/spec/support/client.rb +6 -0
data/spec/support/json_responses.rb +11 -0
data/spec/support/vcr.rb +16 -0
metadata +374 -0

data/doc/top-level-namespace.html ADDED Viewed

@@ -0,0 +1,112 @@
+<!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>
+  Top Level Namespace
+    &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</a> &raquo;
+    <span class="title">Top Level Namespace</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>Top Level Namespace
+</h1>
+<dl class="box">
+</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.html" title="Contentful (module)">Contentful</a></span>
+</p>
+</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>

data/examples/custom_classes.rb ADDED Viewed

@@ -0,0 +1,43 @@
+# Contentful resource classes are just plain Ruby classes that include the
+# Contentful::Resource module.
+#
+# You can then define properties of the class. This will create a getter method
+# with this name You can optionally pass a type identifier (Symbol or Class).
+#
+# Classes will be instantiated for the properties,
+# Symbols will be looked up in Contentful::Resource::COERCIONS
+require 'contentful'
+class MyResource
+  include Contentful::Resource
+  property :some
+  property :age, :integer
+  property :country, Contentful::Locale
+end
+res = MyResource.new(
+  'some' => 'value',
+  'age' => '25',
+  'country' => {'code' => 'de', 'name' => 'Deutschland'},
+  'unknown_property' => 'ignored'
+)
+p res.some # => "value"
+p res.age # => 25
+p res.country # #<Contentful::Locale: ...
+p res.unknown_property # NoMethodError
+# Another possibility to create customized resources is to just inherit from an
+# existing one:
+class MyBetterArray < Contentful::Array
+  # e.g. define more methods that you need
+  def last
+    items.last
+  end
+end
+# Read further in examples/resource_mapping.rb

data/examples/dynamic_entries.rb ADDED Viewed

@@ -0,0 +1,126 @@
+require 'contentful'
+# A DynamicEntry is a resource classes, specifically for one ContentType
+# This is the manual way of creating a dynamic class. This should not be
+# neceassary in :auto mode
+client = Contentful::Client.new(
+  space: 'cfexampleapi',
+  access_token: "b4c0n73n7fu1",
+  dynamic_entries: :manual,
+)
+cat = client.content_type('cat')
+CatEntry = Contentful::DynamicEntry.create(cat)
+client.register_dynamic_entry 'cat', CatEntry
+# The CatEntry behaves just like a normal entry, but it has knowlegde about the entry fields.
+# It will create getter methods and convert field contents to the proper type:
+nyancat = client.entry('nyancat')
+p nyancat.is_a? CatEntry # => true
+p nyancat.fields[:name] # => "Nyan Cat" # This would also be possible with a non-dynamic entry
+p nyancat.name # => "Nyan Cat"
+# You don't need to initialize a ContentType resource to create a DynamicEntry
+# You could also pass the content type's JSON representation:
+SuperCatEntry = Contentful::DynamicEntry.create <<JSON
+{
+  "fields": [
+    {
+      "id": "name",
+      "name": "Name",
+      "type": "Text",
+      "required": true,
+      "localized": true
+    },
+    {
+      "id": "likes",
+      "name": "Likes",
+      "type": "Array",
+      "required": false,
+      "localized": false,
+      "items": {
+        "type": "Symbol"
+      }
+    },
+    {
+      "id": "color",
+      "name": "Color",
+      "type": "Symbol",
+      "required": false,
+      "localized": false
+    },
+    {
+      "id": "bestFriend",
+      "name": "Best Friend",
+      "type": "Link",
+      "required": false,
+      "localized": false,
+      "linkType": "Entry"
+    },
+    {
+      "id": "birthday",
+      "name": "Birthday",
+      "type": "Date",
+      "required": false,
+      "localized": false
+    },
+    {
+      "id": "lifes",
+      "name": "Lifes left",
+      "type": "Integer",
+      "required": false,
+      "localized": false,
+      "disabled": true
+    },
+    {
+      "id": "lives",
+      "name": "Lives left",
+      "type": "Integer",
+      "required": false,
+      "localized": false
+    },
+    {
+      "id": "image",
+      "name": "Image",
+      "required": false,
+      "localized": false,
+      "type": "Link",
+      "linkType": "Asset"
+    }
+  ],
+  "name": "Cat",
+  "displayField": "name",
+  "description": "Meow.",
+  "sys": {
+    "space": {
+      "sys": {
+        "type": "Link",
+        "linkType": "Space",
+        "id": "cfexampleapi"
+      }
+    },
+    "type": "ContentType",
+    "id": "cat",
+    "revision": 2,
+    "createdAt": "2013-06-27T22:46:12.852Z",
+    "updatedAt": "2013-09-02T13:14:47.863Z"
+  }
+}
+JSON
+# AUTO MODE - All entries will be converted to dynamic entries
+client = Contentful::Client.new(
+  space: 'cfexampleapi',
+  access_token: "b4c0n73n7fu1",
+  dynamic_entries: :auto,
+)
+p happycat = client.entry('happycat') # #<Contentful::DynamicEntry[cat]:10078260 @fields={:name=>"Happy Cat" ...
+p happycat.is_a? Contentful::DynamicEntry # true
+p happycat.color # gray

data/examples/example_queries.rb ADDED Viewed

@@ -0,0 +1,27 @@
+require 'contentful'
+client = Contentful::Client.new(
+  space: 'cfexampleapi',
+  access_token: "b4c0n73n7fu1",
+)
+p client.space
+p client.content_types
+p client.entry 'nyancat', locale: 'tlh'
+p client.entries(
+  'content_type' => 'cat',
+  'fields.likes' => 'lasagna',
+)
+p client.entries(
+   query: 'bacon',
+)
+p client.content_types(
+  order: '-sys.updatedAt',
+  limit: 3,
+)

data/examples/raise_errors.rb ADDED Viewed

@@ -0,0 +1,22 @@
+require 'contentful'
+client = Contentful::Client.new(
+  space: 'cfexampleapi',
+  access_token: "b4c0n73n7fu1",
+)
+begin
+  p client.entry 'not found'
+rescue => error
+  p error
+end
+client2 = Contentful::Client.new(
+  space: 'cfexampleapi',
+  access_token: "b4c0n73n7fu1",
+  raise_errors: false,
+)
+p client2.entry 'not found'

data/examples/raw_mode.rb ADDED Viewed

@@ -0,0 +1,15 @@
+require 'contentful'
+client = Contentful::Client.new(
+  space: 'cfexampleapi',
+  access_token: "b4c0n73n7fu1",
+  raw_mode: true,
+)
+entry = client.entry 'nyancat'
+p entry.is_a? Contentful::Resource # false
+p entry.is_a? Contentful::Response # true
+p entry.status
+p entry
+puts entry.raw

data/examples/resource_mapping.rb ADDED Viewed

@@ -0,0 +1,33 @@
+# Using the :resource_mapping configuration, you can register your own classes to be used
+# for the results from contentful.
+#
+# The key of the array defines the resource type (object["sys"]["type"]) and the value is:
+# - the Class to use
+# - a Proc, that returns the Class to use
+# - a Symbol for a method of the ResourceBuilder object
+require 'contentful'
+class MyBetterArray < Contentful::Array
+  # e.g. define more methods that you need
+  def last
+    items.last
+  end
+end
+client = Contentful::Client.new(
+  space: 'cfexampleapi',
+  access_token: "b4c0n73n7fu1",
+  resource_mapping: {
+    'Array' => MyBetterArray,
+    'Asset' => ->(json_object){
+      # might return different class if some criteria is matched
+      Contentful::Asset
+    },
+  }
+)
+assets = client.assets
+p assets.class # => MyBetterArray
+p assets.last # => #<Contentful::Asset ...

data/lib/contentful.rb ADDED Viewed

@@ -0,0 +1,3 @@
+require 'contentful/version'
+require 'contentful/support'
+require 'contentful/client'

data/lib/contentful/array.rb ADDED Viewed

@@ -0,0 +1,47 @@
+require_relative 'resource'
+module Contentful
+  # Resource Class for Arrays (e.g. search results)
+  # https://www.contentful.com/developers/documentation/content-delivery-api/#arrays
+  # It also provides an #each method and includes Ruby's Enumerable module (gives you methods like #min, #first, etc)
+  class Array
+    DEFAULT_LIMIT = 100
+    include Contentful::Resource
+    include Contentful::Resource::SystemProperties
+    include Enumerable
+    property :total, :integer
+    property :limit, :integer
+    property :skip, :integer
+    property :items
+    # Only returns true for Contentful::Array
+    def array?
+      true
+    end
+    # Simplifies pagination
+    def next_page
+      if request
+        new_skip    = (skip || 0) + (limit || DEFAULT_LIMIT)
+        new_request = request.copy
+        new_request.query[:skip] = new_skip
+        new_request.get
+      else
+        false
+      end
+    end
+    # Delegates to items#each
+    def each(&block)
+      items.each(&block)
+    end
+    # Delegates to items#empty?
+    def empty?
+      items.empty?
+    end
+  end
+end

data/lib/contentful/asset.rb ADDED Viewed

@@ -0,0 +1,34 @@
+require_relative 'resource'
+require_relative 'resource/asset_fields'
+module Contentful
+  # Resource class for Asset.
+  # https://www.contentful.com/developers/documentation/content-delivery-api/#assets
+  class Asset
+    include Contentful::Resource
+    include Contentful::Resource::SystemProperties
+    include Contentful::Resource::AssetFields
+    # Returns the image url of an asset
+    # Allows you to pass in the following options for image resizing:
+    #   :width
+    #   :height
+    #   :format
+    #   :quality
+    # See https://www.contentful.com/developers/documentation/content-delivery-api/#image-asset-resizing
+    def image_url(options = {})
+      query = {
+        w:  options[:w]  || options[:width],
+        h:  options[:h]  || options[:height],
+        fm: options[:fm] || options[:format],
+        q:  options[:q]  || options[:quality],
+      }.reject{ |k,v| v.nil? }
+      if query.empty?
+        file.url
+      else
+        "#{file.url}?#{ URI.encode_www_form(query) }"
+      end
+    end
+  end
+end