RubyGems - built.io - Versions diffs - 0.4 → 0.7 - Mend

built.io 0.4 → 0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (30) hide show

data/lib/built.rb +1 -0
data/lib/built/application.rb +9 -2
data/lib/built/class.rb +10 -3
data/lib/built/object.rb +20 -7
metadata +52 -29
data/doc/Built.html +0 -518
data/doc/Built/Application.html +0 -449
data/doc/Built/BuiltAPIError.html +0 -460
data/doc/Built/BuiltError.html +0 -138
data/doc/Built/Class.html +0 -685
data/doc/Built/Client.html +0 -397
data/doc/Built/Object.html +0 -1128
data/doc/Built/Query.html +0 -2788
data/doc/Built/QueryResponse.html +0 -386
data/doc/Built/Timestamps.html +0 -282
data/doc/Built/Util.html +0 -211
data/doc/_index.html +0 -228
data/doc/class_list.html +0 -54
data/doc/css/common.css +0 -1
data/doc/css/full_list.css +0 -57
data/doc/css/style.css +0 -338
data/doc/file.README.html +0 -131
data/doc/file_list.html +0 -56
data/doc/frames.html +0 -26
data/doc/index.html +0 -131
data/doc/js/app.js +0 -214
data/doc/js/full_list.js +0 -178
data/doc/js/jquery.js +0 -4
data/doc/method_list.html +0 -419
data/doc/top-level-namespace.html +0 -151

data/lib/built.rb CHANGED Viewed

@@ -1,5 +1,6 @@
 require "i18n"
 require "httmultiparty"
+require "dirty_hashy"
 module Built
   class << self

data/lib/built/application.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 module Built
-  class Application < Hash
+  class Application < DirtyHashy
     include Built::Timestamps
     # Get the uid of this application
@@ -24,10 +24,17 @@ module Built
     end
     class << self
+      def instantiate(data)
+        doc = new
+        doc.replace(data)
+        doc.clean_up!
+        doc
+      end
       # Get the application you are working with
       # @return [Application]
       def get
-        new.merge!(
+        instantiate(
           Built.client.request(uri)
             .parsed_response["application"]
         )

data/lib/built/class.rb CHANGED Viewed

@@ -1,7 +1,7 @@
 module Built
   # Built::Class provides the schema and provides grouping for
   # different classes of objects.
-  class Class < Hash
+  class Class < DirtyHashy
     include Built::Timestamps
     # Get the uid for this class
@@ -27,12 +27,19 @@ module Built
     end
     class << self
+      def instantiate(data)
+        doc = new
+        doc.replace(data)
+        doc.clean_up!
+        doc
+      end
       # Get all classes from built. Returns an array of classes.
       # @raise Built::BuiltAPIError
       # @return [Array] classes An array of classes
       def get_all
         Built.client.request(uri)
-          .parsed_response["classes"].map {|o| new.merge!(o)}
+          .parsed_response["classes"].map {|o| instantiate(o)}
       end
       # Get a single class by its uid
@@ -40,7 +47,7 @@ module Built
       # @param [String] uid The uid of the class
       # @return [Class] class An instance of Built::Class
       def get(uid)
-        new.merge!(
+        instantiate(
           Built.client.request(uri(uid))
             .parsed_response["class"]
         )

data/lib/built/object.rb CHANGED Viewed

@@ -1,6 +1,6 @@
 module Built
   # Built::Object is the unit of data in built.io
-  class Object < Hash
+  class Object < DirtyHashy
     include Built::Timestamps
     # Get the uid for this object
@@ -17,13 +17,13 @@ module Built
     # Fetch the latest instance of this object from built
     # @raise BuiltError If the uid is not set
     # @return [Object] self
-    def fetch
+    def sync
       if !uid
         # uid is not set
         raise BuiltError, I18n.t("objects.uid_not_set")
       end
-      self.merge!(
+      instantiate(
         Built.client.request(uri)
           .parsed_response["object"]
       )
@@ -40,7 +40,7 @@ module Built
     def save(options={})
       if is_new?
         # create
-        self.merge!(
+        instantiate(
           Built.client.request(uri, :post, wrap)
             .parsed_response["object"]
         )
@@ -51,7 +51,7 @@ module Built
         self["published"] = false if options[:draft]
         # update
-        self.merge!(
+        instantiate(
           Built.client.request(uri, :put, wrap, nil, headers)
             .parsed_response["object"]
         )
@@ -98,12 +98,19 @@ module Built
       @class_uid  = class_uid
       if data
-        self.merge!(data)
+        instantiate(data)
       end
       self
     end
+    # @api private
+    def instantiate(data)
+      replace(data)
+      clean_up!
+      self
+    end
     private
     def uri
@@ -115,7 +122,8 @@ module Built
     end
     def wrap
-      {"object" => self}
+      changed_keys = self.changes.keys
+      {"object" => self.select {|o| changed_keys.include?(o)}}
     end
     def to_s
@@ -123,6 +131,11 @@ module Built
     end
     class << self
+      def instantiate(data)
+        doc = new
+        doc.instantiate(data)
+      end
       # @api private
       def uri(class_uid)
         class_uri = Built::Class.uri(class_uid)

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: built.io
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: '0.7'
   prerelease:
 platform: ruby
 authors:
@@ -13,13 +13,61 @@ date: 2014-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: httmultiparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.10
+- !ruby/object:Gem::Dependency
+  name: dirty_hashy
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -28,14 +76,14 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: httmultiparty
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -62,31 +110,6 @@ files:
 - lib/built/object.rb
 - lib/locales/en.yml
 - lib/built.rb
-- doc/js/app.js
-- doc/js/full_list.js
-- doc/js/jquery.js
-- doc/index.html
-- doc/file.README.html
-- doc/Built/Util.html
-- doc/Built/Query.html
-- doc/Built/Client.html
-- doc/Built/BuiltAPIError.html
-- doc/Built/Timestamps.html
-- doc/Built/Object.html
-- doc/Built/BuiltError.html
-- doc/Built/Class.html
-- doc/Built/Application.html
-- doc/Built/QueryResponse.html
-- doc/top-level-namespace.html
-- doc/method_list.html
-- doc/_index.html
-- doc/Built.html
-- doc/file_list.html
-- doc/css/common.css
-- doc/css/style.css
-- doc/css/full_list.css
-- doc/frames.html
-- doc/class_list.html
 - MIT-LICENSE
 - README.md
 homepage: https://github.com/raweng/built.io-ruby-sdk

data/doc/Built.html DELETED Viewed

@@ -1,518 +0,0 @@
-<!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: Built
-    &mdash; Documentation by YARD 0.8.7.2
-</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 (B)</a> &raquo;
-    <span class="title">Built</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: Built
-</h1>
-<dl class="box">
-    <dt class="r1 last">Defined in:</dt>
-    <dd class="r1 last">lib/built.rb<span class="defines">,<br />
-  lib/built/util.rb,<br /> lib/built/class.rb,<br /> lib/built/query.rb,<br /> lib/built/error.rb,<br /> lib/built/client.rb,<br /> lib/built/object.rb,<br /> lib/built/timestamps.rb,<br /> lib/built/application.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="Built/Timestamps.html" title="Built::Timestamps (module)">Timestamps</a></span>
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Built/Application.html" title="Built::Application (class)">Application</a></span>, <span class='object_link'><a href="Built/BuiltAPIError.html" title="Built::BuiltAPIError (class)">BuiltAPIError</a></span>, <span class='object_link'><a href="Built/BuiltError.html" title="Built::BuiltError (class)">BuiltError</a></span>, <span class='object_link'><a href="Built/Class.html" title="Built::Class (class)">Class</a></span>, <span class='object_link'><a href="Built/Client.html" title="Built::Client (class)">Client</a></span>, <span class='object_link'><a href="Built/Object.html" title="Built::Object (class)">Object</a></span>, <span class='object_link'><a href="Built/Query.html" title="Built::Query (class)">Query</a></span>, <span class='object_link'><a href="Built/QueryResponse.html" title="Built::QueryResponse (class)">QueryResponse</a></span>, <span class='object_link'><a href="Built/Util.html" title="Built::Util (class)">Util</a></span>
-</p>
-  <h2>Constant Summary</h2>
-    <dl class="constants">
-        <dt id="client-classvariable" class="">@@client =
-          <div class="docstring">
-  <div class="discussion">
-    <p class="note private">
-  <strong>This classvariable is part of a private API.</strong>
-  You should avoid using this classvariable if possible, as it may be removed or be changed in the future.
-</p>
-<p>singleton http client</p>
-  </div>
-</div>
-<div class="tags">
-</div>
-        </dt>
-        <dd><pre class="code"><span class='kw'>nil</span></pre></dd>
-    </dl>
-    <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="#client-class_method" title="client (class method)">+ (Object) <strong>client</strong> </a>
-  </span>
-  <span class="private note title">private</span>
-    <span class="summary_desc"><div class='inline'>
-<p>Get the singleton client.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#init-class_method" title="init (class method)">+ (Object) <strong>init</strong>(options) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Initialize the SDK.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#root-class_method" title="root (class method)">+ (Object) <strong>root</strong> </a>
-  </span>
-  <span class="private note title">private</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="client-class_method">
-    + (<tt><span class='object_link'><a href="Built/Object.html" title="Built::Object (class)">Object</a></span></tt>) <strong>client</strong>
-</h3><div class="docstring">
-  <div class="discussion">
-    <p class="note private">
-  <strong>This method is part of a private API.</strong>
-  You should avoid using this method if possible, as it may be removed or be changed in the future.
-</p>
-<p>Get the singleton client</p>
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-44
-45
-46
-47
-48
-49
-50</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/built.rb', line 44</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
-  <span class='kw'>if</span> <span class='op'>!</span><span class='cvar'>@@client</span>
-    <span class='id identifier rubyid_raise'>raise</span> <span class='const'>BuiltError</span><span class='comma'>,</span> <span class='const'>I18n</span><span class='period'>.</span><span class='id identifier rubyid_t'>t</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>not_initialized</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
-  <span class='kw'>end</span>
-  <span class='cvar'>@@client</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="init-class_method">
-    + (<tt><span class='object_link'><a href="Built/Object.html" title="Built::Object (class)">Object</a></span></tt>) <strong>init</strong>(options)
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Initialize the SDK</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>options</span>
-        <span class='type'>(<tt>Hash</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>Options</p>
-</div>
-    </li>
-</ul>
-    <p class="tag_title">Options Hash (<tt>options</tt>):</p>
-    <ul class="option">
-        <li>
-          <span class="name">:application_api_key</span>
-          <span class="type">(<tt>String</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>Your app’s api_key. Required.</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:master_key</span>
-          <span class="type">(<tt>String</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>Your app’s master_key</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:authtoken</span>
-          <span class="type">(<tt>String</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>A user’s authtoken</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:host</span>
-          <span class="type">(<tt>String</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>built.io API host (defaults to <a
-href="https://api.built.io">api.built.io</a>)</p>
-</div>
-        </li>
-        <li>
-          <span class="name">:version</span>
-          <span class="type">(<tt>String</tt>)</span>
-          <span class="default">
-          </span>
-            &mdash; <div class='inline'>
-<p>built.io version delimiter (v1, v2, etc)</p>
-</div>
-        </li>
-    </ul>
-<p class="tag_title">Raises:</p>
-<ul class="raise">
-    <li>
-        <span class='type'>(<tt><span class='object_link'><a href="Built/BuiltError.html" title="Built::BuiltError (class)">BuiltError</a></span></tt>)</span>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-18
-19
-20
-21
-22
-23
-24
-25
-26
-27
-28
-29
-30
-31
-32
-33
-34
-35
-36
-37
-38
-39
-40</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/built.rb', line 18</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_init'>init</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_options'>options</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
-  <span class='id identifier rubyid_host'>host</span>        <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:host</span><span class='rbracket'>]</span>    <span class='op'>||</span> <span class='const'>API_URI</span>
-  <span class='id identifier rubyid_version'>version</span>     <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:version</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='const'>API_VERSION</span>
-  <span class='id identifier rubyid_master_key'>master_key</span>  <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:master_key</span><span class='rbracket'>]</span>
-  <span class='id identifier rubyid_api_key'>api_key</span>     <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:application_api_key</span><span class='rbracket'>]</span>
-  <span class='id identifier rubyid_authtoken'>authtoken</span>   <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:authtoken</span><span class='rbracket'>]</span>
-  <span class='kw'>if</span> <span class='const'>Util</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span><span class='lparen'>(</span><span class='id identifier rubyid_api_key'>api_key</span><span class='rparen'>)</span>
-    <span class='id identifier rubyid_raise'>raise</span> <span class='const'>BuiltError</span><span class='comma'>,</span> <span class='const'>I18n</span><span class='period'>.</span><span class='id identifier rubyid_t'>t</span><span class='lparen'>(</span>
-      <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>required_parameter</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='symbol'>:param</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>application_api_key</span><span class='tstring_end'>&quot;</span></span><span class='rbrace'>}</span><span class='rparen'>)</span>
-  <span class='kw'>end</span>
-  <span class='comment'># create the client
-</span>  <span class='cvar'>@@client</span> <span class='op'>=</span> <span class='const'>Client</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='lbrace'>{</span>
-    <span class='label'>host:</span>                 <span class='id identifier rubyid_host'>host</span><span class='comma'>,</span>
-    <span class='label'>version:</span>              <span class='id identifier rubyid_version'>version</span><span class='comma'>,</span>
-    <span class='label'>application_api_key:</span>  <span class='id identifier rubyid_api_key'>api_key</span><span class='comma'>,</span>
-    <span class='label'>master_key:</span>           <span class='id identifier rubyid_master_key'>master_key</span><span class='comma'>,</span>
-    <span class='label'>authtoken:</span>            <span class='id identifier rubyid_authtoken'>authtoken</span>
-  <span class='rbrace'>}</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="root-class_method">
-    + (<tt><span class='object_link'><a href="Built/Object.html" title="Built::Object (class)">Object</a></span></tt>) <strong>root</strong>
-</h3><div class="docstring">
-  <div class="discussion">
-    <p class="note private">
-  <strong>This method is part of a private API.</strong>
-  You should avoid using this method if possible, as it may be removed or be changed in the future.
-</p>
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-53
-54
-55</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/built.rb', line 53</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_root'>root</span>
-  <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_expand_path'>expand_path</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>..</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='kw'>__FILE__</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-    <div id="footer">
-  Generated on Mon Mar 24 18:29:44 2014 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.7.2 (ruby-1.9.3).
-</div>
-  </body>
-</html>