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/Contentful/Resource/ClassMethods.html ADDED Viewed

@@ -0,0 +1,271 @@
+<!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::Resource::ClassMethods
+    &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'><span class='object_link'><a href="../../Contentful.html" title="Contentful (module)">Contentful</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Resource.html" title="Contentful::Resource (module)">Resource</a></span></span>
+     &raquo;
+    <span class="title">ClassMethods</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::Resource::ClassMethods
+</h1>
+<dl class="box">
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/contentful/resource.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>Register the resources properties on class level by using the #property
+method</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#property-instance_method" title="#property (instance method)">- (Object) <strong>property</strong>(name, property_class = nil) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Defines which properties of a resource your class expects Define them in
+:camelCase, they will be available as #snake_cased methods.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#property_coercions-instance_method" title="#property_coercions (instance method)">- (Object) <strong>property_coercions</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'></div></span>
+</li>
+    </ul>
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="property-instance_method">
+    - (<tt>Object</tt>) <strong>property</strong>(name, property_class = nil)
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Defines which properties of a resource your class expects Define them in
+:camelCase, they will be available as #snake_cased methods</p>
+<p>You can pass in a second "type" argument:</p>
+<ul><li>
+<p>If it is a class, it will be initialized for the property</p>
+</li><li>
+<p>Symbols are looked up in the COERCION constant for a lambda that defines a
+type conversion to apply</p>
+</li></ul>
+<p>Note: This second argument is not meant for contentful sub-resources, but
+for structured objects (like locales in a space) Sub-resources are handled
+by the resource builder</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+92
+93
+94
+95
+96
+97</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/contentful/resource.rb', line 92</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_property'>property</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_property_class'>property_class</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_property_coercions'>property_coercions</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_property_class'>property_class</span>
+  <span class='id identifier rubyid_define_method'>define_method</span> <span class='const'>Contentful</span><span class='op'>::</span><span class='const'>Support</span><span class='period'>.</span><span class='id identifier rubyid_snakify'>snakify</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span> <span class='kw'>do</span>
+    <span class='id identifier rubyid_properties'>properties</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rbracket'>]</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="property_coercions-instance_method">
+    - (<tt>Object</tt>) <strong>property_coercions</strong>
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+77
+78
+79</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/contentful/resource.rb', line 77</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_property_coercions'>property_coercions</span>
+  <span class='ivar'>@property_coercions</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</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/doc/Contentful/Resource/Fields.html ADDED Viewed

@@ -0,0 +1,398 @@
+<!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::Resource::Fields
+    &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 (F)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../Contentful.html" title="Contentful (module)">Contentful</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Resource.html" title="Contentful::Resource (module)">Resource</a></span></span>
+     &raquo;
+    <span class="title">Fields</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::Resource::Fields
+</h1>
+<dl class="box">
+    <dt class="r1">Included in:</dt>
+    <dd class="r1"><span class='object_link'><a href="../Entry.html" title="Contentful::Entry (class)">Entry</a></span></dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/contentful/resource/fields.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>Include this module into your Resource class to enable it to deal with
+entry fields (but not asset fields)</p>
+<p>It depends on system properties being available</p>
+  </div>
+</div>
+<div class="tags">
+</div><h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Fields/ClassMethods.html" title="Contentful::Resource::Fields::ClassMethods (module)">ClassMethods</a></span>
+</p>
+    <h2>
+      Class Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#included-class_method" title="included (class method)">+ (Object) <strong>included</strong>(base) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'></div></span>
+</li>
+    </ul>
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#fields-instance_method" title="#fields (instance method)">- (Object) <strong>fields</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns all fields of the asset.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Object) <strong>initialize</strong>(object) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'></div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#inspect-instance_method" title="#inspect (instance method)">- (Object) <strong>inspect</strong>(info = nil) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'></div></span>
+</li>
+    </ul>
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="included-class_method">
+    + (<tt>Object</tt>) <strong>included</strong>(base)
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+34
+35
+36</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/contentful/resource/fields.rb', line 34</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_included'>included</span><span class='lparen'>(</span><span class='id identifier rubyid_base'>base</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_base'>base</span><span class='period'>.</span><span class='id identifier rubyid_extend'>extend</span><span class='lparen'>(</span><span class='const'>ClassMethods</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="fields-instance_method">
+    - (<tt>Object</tt>) <strong>fields</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns all fields of the asset</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+9
+10
+11</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/contentful/resource/fields.rb', line 9</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_fields'>fields</span>
+  <span class='ivar'>@fields</span><span class='lbracket'>[</span><span class='id identifier rubyid_locale'>locale</span><span class='rbracket'>]</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="initialize-instance_method">
+    - (<tt>Object</tt>) <strong>initialize</strong>(object)
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+13
+14
+15
+16
+17</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/contentful/resource/fields.rb', line 13</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_object'>object</span><span class='comma'>,</span> <span class='op'>*</span><span class='rparen'>)</span>
+  <span class='kw'>super</span>
+  <span class='ivar'>@fields</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
+  <span class='ivar'>@fields</span><span class='lbracket'>[</span><span class='id identifier rubyid_locale'>locale</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_extract_from_object'>extract_from_object</span> <span class='id identifier rubyid_object'>object</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>fields</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:fields</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="inspect-instance_method">
+    - (<tt>Object</tt>) <strong>inspect</strong>(info = nil)
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+19
+20
+21
+22
+23
+24
+25</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/contentful/resource/fields.rb', line 19</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_inspect'>inspect</span><span class='lparen'>(</span><span class='id identifier rubyid_info'>info</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
+  <span class='kw'>if</span> <span class='id identifier rubyid_fields'>fields</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
+    <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_info'>info</span><span class='rparen'>)</span>
+  <span class='kw'>else</span>
+    <span class='kw'>super</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_info'>info</span><span class='rbrace'>}</span><span class='tstring_content'> @fields=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_fields'>fields</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</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>