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/Response.html ADDED Viewed

@@ -0,0 +1,546 @@
+<!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>
+  Class: Contentful::Response
+    &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 (R)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../Contentful.html" title="Contentful (module)">Contentful</a></span></span>
+     &raquo;
+    <span class="title">Response</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>Class: Contentful::Response
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Object</span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">Contentful::Response</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/contentful/response.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>An object representing an answer by the contentful service. It is later
+used to build a Resource, which is done by the ResourceBuilder.</p>
+<p>The Response parses the http response (as returned by the underlying http
+library) to a JSON object. Responses can be asked the following methods:</p>
+<ul><li>
+<p>#raw (raw HTTP response by the HTTP library)</p>
+</li><li>
+<p>#object (the parsed JSON object)</p>
+</li></ul>
+<p>It also sets a #status which can be one of:</p>
+<ul><li>
+<p>:ok (seems to be a valid resource object)</p>
+</li><li>
+<p>:contentful_error (valid error object)</p>
+</li><li>
+<p>:not_contentful (valid json, but missing the contentful's sys property)</p>
+</li><li>
+<p>:unparsable_json (invalid json)</p>
+</li></ul>
+<p>Error Repsonses also contain a:</p>
+<ul><li>
+<p>:error_message</p>
+</li></ul>
+  </div>
+</div>
+<div class="tags">
+</div>
+  <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
+  <ul class="summary">
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#error_message-instance_method" title="#error_message (instance method)">- (Object) <strong>error_message</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute error_message.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#object-instance_method" title="#object (instance method)">- (Object) <strong>object</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute object.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#raw-instance_method" title="#raw (instance method)">- (Object) <strong>raw</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute raw.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#status-instance_method" title="#status (instance method)">- (Object) <strong>status</strong> </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute status.</p>
+</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="#initialize-instance_method" title="#initialize (instance method)">- (Response) <strong>initialize</strong>(raw) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'>
+<p>A new instance of Response.</p>
+</div></span>
+</li>
+    </ul>
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+    - (<tt><span class='object_link'><a href="" title="Contentful::Response (class)">Response</a></span></tt>) <strong>initialize</strong>(raw)
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns a new instance of Response</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+24
+25
+26
+27
+28
+29
+30
+31</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/contentful/response.rb', line 24</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_raw'>raw</span><span class='rparen'>)</span>
+  <span class='ivar'>@raw</span> <span class='op'>=</span> <span class='id identifier rubyid_raw'>raw</span>
+  <span class='ivar'>@status</span> <span class='op'>=</span> <span class='symbol'>:ok</span>
+  <span class='kw'>if</span> <span class='id identifier rubyid_parse_json!'>parse_json!</span>
+    <span class='id identifier rubyid_parse_contentful_error!'>parse_contentful_error!</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+</div>
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+      <span id=""></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="error_message-instance_method">
+    - (<tt>Object</tt>) <strong>error_message</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute error_message</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+22
+23
+24</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/contentful/response.rb', line 22</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_error_message'>error_message</span>
+  <span class='ivar'>@error_message</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="object-instance_method">
+    - (<tt>Object</tt>) <strong>object</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute object</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+22
+23
+24</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/contentful/response.rb', line 22</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_object'>object</span>
+  <span class='ivar'>@object</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="raw-instance_method">
+    - (<tt>Object</tt>) <strong>raw</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute raw</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+22
+23
+24</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/contentful/response.rb', line 22</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_raw'>raw</span>
+  <span class='ivar'>@raw</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="status-instance_method">
+    - (<tt>Object</tt>) <strong>status</strong>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute status</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+22
+23
+24</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/contentful/response.rb', line 22</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_status'>status</span>
+  <span class='ivar'>@status</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Tue Mar 11 09:25:53 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>