rest_model 0.1.0 → 0.1.1

data/.gitignore

@@ -3,3 +3,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+*.DS_Store

data/README.md

@@ -1,19 +1,37 @@
 # RestModel
 
-**Map from one or more input hashes** to instances of your model classes.
+            [ THE INTERNETS ]
 
-**Map to restful responses** from these model instances. (Some hypermedia magic happens here).
+                /\    ||
+                ||    ||
+                ||    \/
+         #resource    .new
+        .resources    #update_attributes
+
+             Your < RestModel
+
+        #to_source    .from_source
+                ||    /\
+                ||    ||
+                \/    ||
+
+                 SOURCE
+
+
+### Map _from a data source_ to instances of your model class.
+
+### Map _to RESTful responses_ from these model instances.
 
 ## Usage
 
-### Input hash to model
+### Source hash to model instances
 
 Given you have:
 
     input = {
       "result" => [
         {
-          "id"       => 1938713897398,
+          "id"       => "1938713897398",
           "login"    => "jsmith180",
           "username" => "John Smith",
           "personal_info" => {
@@ -22,7 +40,7 @@ Given you have:
           }
         },
         {
-          "id"       => 92171987391873,
+          "id"       => "92171987391873",
           "login"    => "john_appleseed",
           "username" => "John Appleseed",
           "personal_info" => {
@@ -33,19 +51,19 @@ Given you have:
       ]
     }
 
-And you want to transform this input in some instances of a `class User;   attr_accessor :id, :login, :name, :birth;   end`
+And you want to transform this in some instances of a `class User;   attr_accessor :id, :login, :name, :birth;   end`
 
 With RestModel you can parse the input to instances of `User`:
 
-    users = User.parse(input, :result)  # starts looking input hash from 'result' key
+    users = User.from_source(input, start_key: 'result')  # starts looking hash from 'result' key
 
 Just define your `User` class like this:
 
     class User < RestModel
       id
       property :login
-      property :name,  field: :username                  # input hash key is different from resource key
-      property :birth, field: 'personal_info/birth_date' # digg hash path defined by '/', the last being the key
+      property :name,  field: :username                  # source key is different from model property
+      property :birth, field: 'personal_info.birth_date' # digg hash path defined by '.', the last being the key
     end
 
 ### Model instances array to restful response hash
@@ -56,14 +74,14 @@ Just define your `User` class like this:
     {
       entries: [
         {
-          id:    1938713897398,
+          id:    "1938713897398",
           login: "jsmith180",
           name:  "John Smith",
           birth: "1999-02-10",
           href:  "http://app/api/users/1938713897398"
         },
         {
-          id:    92171987391873,
+          id:    "92171987391873",
           login: "john_appleseed",
           name:  "John Appleseed",
           birth: "1999-02-10",
@@ -78,7 +96,7 @@ Just define your `User` class like this:
 =>
 
     {
-      id:    1938713897398,
+      id:    "1938713897398",
       login: "jsmith180",
       name:  "John Smith",
       birth: "1999-02-10",
@@ -101,7 +119,7 @@ Just define your `User` class like this:
     end
 
     {
-      id:    1938713897398,
+      id:    '1938713897398',
       address: {
         street:  'rest_client st.',
         number:  '39',
@@ -127,16 +145,16 @@ Just define your `User` class like this:
     end
 
     {
-      id: 739819813719387,
+      id: '739819813719387',
       items: [
         {
-          item_id:    1738917139871,
+          item_id:    '1738917139871',
           quantity:   18,
           unit_price: 0.2,
           amount:     3.6
         },
         {
-          item_id:    3987187398782,
+          item_id:    '3987187398782',
           quantity:   1,
           unit_price: 39.9,
           amount:     39.9
@@ -159,7 +177,7 @@ Just define your `User` class like this:
     end
 
     {
-      id:    19837139879,
+      id:    '19837139879',
       login: 'jsmith180',
       link: [
         {
@@ -181,10 +199,10 @@ Just define your `User` class like this:
 
 If you want your api to handle `http://app/api/users/19371897318937?include[]=avatar&include[]=guilda`
 
-    user = User.parse(input, include: [avatar_input, guilda_input]).first
+    user = User.from_source(input, include: [avatar_input, guilda_input]).first
 
     {
-      id:    19837139879,
+      id:    '19837139879',
       login: 'jsmith180',
       avatar: {
         name:   'K1ll3r',

data/examples/update_attributes/embeds_many.rb

@@ -0,0 +1,14 @@
+$:.push 'examples'; require 'helper'
+
+class Item < RestModel
+  property :id, type: Integer
+end
+
+class Root < RestModel
+  embeds_many :items
+end
+
+@root = Root.parse({items: [{id: 2000}, {id: 2001}]}).first
+@root.update_attributes({items: [{id: 3000}]})
+
+inspect_rest_model(@root)

data/examples/update_attributes/embeds_one.rb

@@ -0,0 +1,14 @@
+$:.push 'examples'; require 'helper'
+
+class Root < RestModel
+  embeds_one :item
+end
+
+class Item < RestModel
+  properties :id, :name
+end
+
+@root = Root.parse({item: {id: 2000}}).first
+@root.update_attributes({item: {name: "name"}})
+
+inspect_rest_model(@root)

data/examples/update_attributes/has_many.rb

@@ -0,0 +1,17 @@
+$:.push 'examples'; require 'helper'
+
+class Service < RestModel
+  property :name
+  belongs_to :customer
+end
+
+class Customer < RestModel
+  id field: :customer_id, type: Integer
+  property :login
+  has_many :services
+end
+
+@root = Customer.parse({customer_id: 123, login: 'jackiechan2010'}).first
+@root.update_attributes({services: [{name: "new_service_name"}]})
+
+inspect_rest_model(@root)

data/examples/update_attributes/has_one.rb

@@ -0,0 +1,17 @@
+$:.push 'examples'; require 'helper'
+
+class Billing < RestModel
+  property :login
+  belongs_to :customer
+end
+
+class Customer < RestModel
+  id field: :customer_id, type: Integer
+  property :login
+  has_one :billing
+end
+
+@root = Customer.parse({customer_id: 123, login: 'jackiechan2010'}).first
+@root.update_attributes({billing: {login: "new_billing_login"}})
+
+inspect_rest_model(@root)

data/examples/update_attributes/simple.rb

@@ -0,0 +1,10 @@
+$:.push 'examples'; require 'helper'
+
+class Customer < RestModel
+  property :login
+end
+
+@root = Customer.parse({login: 'jackiechan2010'}).first
+@root.update_attributes(login: 'newjackiechan2010')
+
+inspect_rest_model(@root)

data/lib/rest_model/key/association.rb

@@ -35,8 +35,23 @@ class RestModel
     end
 
     def update_from_hash(resource, attrs)
-      one? ? resource.update_attributes(attrs)
-           : resource.map {|item| item.update_attributes(item)}
+      if one?
+        resource.update_attributes(attrs)
+      else
+        if resource.count > attrs.count
+          resource = resource.to(attrs.count - 1)
+        end
+
+        attrs.each_with_index do |item, index|
+          if index < resource.count
+            resource[index].update_attributes(item)
+          else
+            resource << create_from_hash(item)
+          end
+        end
+
+        resource
+      end
     end
   end
 end

data/lib/rest_model/version.rb

@@ -1,3 +1,3 @@
 class RestModel
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/rest_model.rb

@@ -4,6 +4,7 @@ require "active_support/concern"
 require "active_support/core_ext/class/attribute_accessors"
 require "active_support/core_ext/object/try"
 require "active_support/core_ext/array/wrap"
+require "active_support/core_ext/array/access"
 require "active_support/core_ext/hash/slice"
 require "active_support/core_ext/hash/indifferent_access"
 

data/spec/integration/embeds_many_spec.rb

@@ -2,56 +2,76 @@
 
 require "spec_helper"
 
-describe_example "embeds_many/simple" do
-  it "parses first embedded item" do
-    root.items[0].id.should == 2000
-  end
+describe "embeds_many" do
+  describe_example "embeds_many/simple" do
+    it "parses first embedded item" do
+      root.items[0].id.should == 2000
+    end
 
-  it "parses second embedded item" do
-    root.items[1].id.should == 2001
+    it "parses second embedded item" do
+      root.items[1].id.should == 2001
+    end
   end
-end
 
-describe_example "embeds_many/invisible" do
-  it "parses invisible items correctly" do
-    root.locale.should == "pt-BR"
-    root.names.should == {"en"=>"Woot", "pt-BR"=>"Úia", "es"=>"Me gusta"}
+  describe_example "embeds_many/invisible" do
+    it "parses invisible items correctly" do
+      root.locale.should == "pt-BR"
+      root.names.should == {"en"=>"Woot", "pt-BR"=>"Úia", "es"=>"Me gusta"}
+    end
+
+    it "doesn't show embedded items in resource" do
+      root.resource.should_not have_key("locale")
+      root.resource.should_not have_key("names")
+    end
   end
 
-  it "doesn't show embedded items in resource" do
-    root.resource.should_not have_key("locale")
-    root.resource.should_not have_key("names")
+  describe_example "embeds_many/with_array" do
+    it "parses items" do
+      root.items.should == ["a", "b"]
+    end
   end
-end
 
-describe_example "embeds_many/with_array" do
-  it ""
-end
+  describe_example "embeds_many/with_class_name" do
+    it "parses embedded item" do
+      root.items.first.id.should == 2000
+    end
+  end
 
-describe_example "embeds_many/with_class_name" do
-  it "parses embedded item" do
-    root.items[0].id.should == 2000
+  describe_example "embeds_many/with_fields" do
+    it "parses fields" do
+      root.items.should == ["i1", "i2", "i3"]
+    end
   end
-end
 
-describe_example "embeds_many/with_if" do
-  context "when an embeddable has a conditional proc (:if)" do
-    context "and it evaluates to true" do
-      it "parses embedded item" do
-        root_with_items.items.first.id.should == "2000"
+  describe_example "embeds_many/with_if" do
+    context "when an embeddable has a conditional proc (:if)" do
+      context "and it evaluates to true" do
+        it "parses embedded item" do
+          root_with_items.items.first.id.should == "2000"
+        end
       end
-    end
 
-    context "and it evaluates to false" do
-      it "doesn't parse embedded item" do
-        root_without_items.items.should_not be
+      context "and it evaluates to false" do
+        it "doesn't parse embedded item" do
+          root_without_items.items.should_not be
+        end
       end
     end
   end
-end
 
-describe_example "embeds_many/with_start_key" do
-  it "parses embedded items" do
-    root.items.first.id.should == "2000"
+  describe_example "embeds_many/with_nil_value" do
+    it "has items nil" do
+      root.items.should_not be
+    end
+
+    it "returns an empty items list" do
+      root.resource[:items].should == []
+    end
+  end
+
+  describe_example "embeds_many/with_start_key" do
+    it "parses embedded items" do
+      root.items.first.id.should == "2000"
+    end
   end
 end

data/spec/integration/embeds_one_spec.rb

@@ -1,41 +1,43 @@
 require 'spec_helper'
 
-describe_example "embeds_one/simple" do
-  it 'parses embedded item' do
-    root.item.id.should == "2000"
-  end
-end
-
-describe_example "embeds_one/with_class_name" do
-  context 'when a different class name is used for embeddable' do
+describe "embeds_one" do
+  describe_example "embeds_one/simple" do
     it 'parses embedded item' do
       root.item.id.should == "2000"
     end
   end
-end
 
-describe_example "embeds_one/with_if" do
-  context 'when an embeddable has a conditional proc (:if)' do
-    context 'and it evaluates to true' do
+  describe_example "embeds_one/with_class_name" do
+    context 'when a different class name is used for embeddable' do
       it 'parses embedded item' do
-        root_with_item.id.should == "1"
-        root_with_item.item.id.should == "2000"
+        root.item.id.should == "2000"
       end
     end
+  end
+
+  describe_example "embeds_one/with_if" do
+    context 'when an embeddable has a conditional proc (:if)' do
+      context 'and it evaluates to true' do
+        it 'parses embedded item' do
+          root_with_item.id.should == "1"
+          root_with_item.item.id.should == "2000"
+        end
+      end
 
-    context 'and it evaluates to false' do
-      it "doesn't parse embedded item" do
-        root_without_item.id.should == "100"
-        root_without_item.item.should_not be
+      context 'and it evaluates to false' do
+        it "doesn't parse embedded item" do
+          root_without_item.id.should == "100"
+          root_without_item.item.should_not be
+        end
       end
     end
   end
-end
 
-describe_example "embeds_one/with_start_key" do
-  context 'when there is a start key to parse input' do
-    it 'parses embedded item' do
-      root.item.id.should == "2000"
+  describe_example "embeds_one/with_start_key" do
+    context 'when there is a start key to parse input' do
+      it 'parses embedded item' do
+        root.item.id.should == "2000"
+      end
     end
   end
 end

data/spec/integration/has_many_spec.rb

@@ -1,26 +1,28 @@
 require 'spec_helper'
 
-describe_example "has_many/simple" do
-  it 'parses properly' do
-    root.id.should == 123
-    root.login.should == 'jackiechan2010'
-  end
-
-  describe "#resource" do
-    subject {root.resource}
-
-    it 'has a link' do
-      subject[:link].should be_an(Array)
+describe "has_many" do
+  describe_example "has_many/simple" do
+    it 'parses properly' do
+      root.id.should == 123
+      root.login.should == 'jackiechan2010'
     end
 
-    [:services, :billing, :devops].each do |rel|
-      it "has a #{rel} relation" do
-        subject[:link].any? {|l| l[:rel] == rel}.should be_true
+    describe "#resource" do
+      subject {root.resource}
+
+      it 'has a link' do
+        subject[:link].should be_an(Array)
       end
 
-      it "has a href for #{rel} relation" do
-        link = subject[:link].find {|l| l[:rel] == rel}
-        link[:href].should =~ %r{/customers/123/#{rel}}
+      [:services, :billing, :devops].each do |rel|
+        it "has a #{rel} relation" do
+          subject[:link].any? {|l| l[:rel] == rel}.should be_true
+        end
+
+        it "has a href for #{rel} relation" do
+          link = subject[:link].find {|l| l[:rel] == rel}
+          link[:href].should =~ %r{/customers/123/#{rel}}
+        end
       end
     end
   end

data/spec/integration/property_spec.rb

@@ -6,64 +6,60 @@ def it_parses_property
   end
 end
 
-describe_example 'properties/simple' do
-  it_parses_property
-end
-
-describe_example 'properties/with_field' do
-  context 'when input has a different name for the property' do
+describe "properties" do
+  describe_example 'properties/simple' do
     it_parses_property
   end
-end
 
-describe_example 'properties/with_field_path' do
-  context 'when input has a different path for the property' do
-    it_parses_property
+  describe_example 'properties/with_field' do
+    context 'when input has a different name for the property' do
+      it_parses_property
+    end
   end
-end
 
-describe_example 'properties/with_id' do
-  context 'when property is an id' do
-    it 'parses id' do
-      root.id.should == "2000"
+  describe_example 'properties/with_field_path' do
+    context 'when input has a different path for the property' do
+      it_parses_property
     end
   end
-end
 
-describe_example 'properties/with_if' do
-  context 'when a property has a conditional proc (:if)' do
-    context 'and it evaluates to true' do
-      it 'parses property' do
-        root_with_description.description.should == "description"
+  describe_example 'properties/with_id' do
+    context 'when property is an id' do
+      it 'parses id' do
+        root.id.should == "2000"
       end
     end
+  end
 
-    context 'and it evaluates to false' do
-      it "doesn't parse property" do
-        root_without_description.description.should_not be
+  describe_example 'properties/with_if' do
+    context 'when a property has a conditional proc (:if)' do
+      context 'and it evaluates to true' do
+        it 'parses property' do
+          root_with_description.description.should == "description"
+        end
       end
-    end
-  end
-end
 
-describe_example 'properties/with_key_converter' do
-  after do
-    RestModel::Configuration.configure do |c|
-      c.convert_input_keys = nil
+      context 'and it evaluates to false' do
+        it "doesn't parse property" do
+          root_without_description.description.should_not be
+        end
+      end
     end
   end
 
-  context 'when a diferent key converter is configured on rest model' do
-    it_parses_property
+  describe_example 'properties/with_key_converter' do
+    context 'when a diferent key converter is configured on rest model' do
+      it_parses_property
+    end
   end
-end
 
-describe_example 'properties/with_two_key_converters' do
-  context 'when key converters are configured for each class' do
-    it_parses_property
+  describe_example 'properties/with_two_key_converters' do
+    context 'when key converters are configured for each class' do
+      it_parses_property
 
-    it 'parses other property with different key converter' do
-      root.product.unit_price.should == 29.9
+      it 'parses other property with different key converter' do
+        root.product.unit_price.should == 29.9
+      end
     end
   end
 end

data/spec/integration/summarization_spec.rb

@@ -1,12 +1,14 @@
 require 'spec_helper'
 
-describe_example 'summarization/simple' do
-  subject {root[:entries].first}
+describe "summarization" do
+  describe_example 'summarization/simple' do
+    subject {root[:entries].first}
 
-  it 'summarizes resources' do
-    subject.keys.count.should == 3
-    subject[:id].should    == '138911938'
-    subject[:login].should == 'jackiechan2010'
-    subject[:href].should  == 'http://example.com/customers/138911938'
+    it 'summarizes resources' do
+      subject.keys.count.should == 3
+      subject[:id].should    == '138911938'
+      subject[:login].should == 'jackiechan2010'
+      subject[:href].should  == 'http://example.com/customers/138911938'
+    end
   end
 end

data/spec/integration/update_attributes_spec.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+require "spec_helper"
+
+describe "update_attributes" do
+  describe_example "update_attributes/embeds_one" do
+    it "updates customer item name" do
+      root.item.id.should == "2000"
+      root.item.name.should == "name"
+    end
+  end
+
+  describe_example "update_attributes/simple" do
+    it "updates customer login" do
+      root.login.should == "newjackiechan2010"
+    end
+  end
+
+  describe_example "update_attributes/embeds_many" do
+    it "updates customer items" do
+      root.items.count.should == 1
+      root.items.first.id.should == 3000
+    end
+  end
+
+  describe_example "update_attributes/has_one" do
+    it "updates customer billing" do
+      root.billing.should_not be_nil
+      root.billing.login.should == "new_billing_login"
+    end
+  end
+
+  describe_example "update_attributes/has_many" do
+    it "updates customer services" do
+      root.services.should_not be_nil
+      root.services.count.should == 1
+      root.services.first.name.should == "new_service_name"
+    end
+  end
+end

data/spec/support/examples.rb

@@ -1,15 +1,15 @@
 module Examples
-  def describe_example(file, &block)
-    describe "example #{file}" do
+  def describe_example(file, tags = {}, &block)
+    describe "example #{file}", tags do
       [:Root, :Item, :Customer, :Entry].each do |klass|
         Examples.send(:remove_const, klass) if Examples.const_defined?(klass)
       end
 
-      # silently {
-
-        eval File.read("examples/#{file}.rb")
+      RestModel::Configuration.configure do |c|
+        c.convert_input_keys = RestModel::Configuration::DefaultHandler
+      end
 
-        # }
+      silently {eval File.read("examples/#{file}.rb")}
 
       variables = instance_variables.reject {|var| var.to_s =~ /metadata$/}
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rest_model
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-04 00:00:00.000000000Z
+date: 2011-10-05 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70114893435640 !ruby/object:Gem::Requirement
+  requirement: &70140255570300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -23,10 +23,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70114893435640
+  version_requirements: *70140255570300
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70114893432760 !ruby/object:Gem::Requirement
+  requirement: &70140255569800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +34,10 @@ dependencies:
         version: '0.5'
   type: :runtime
   prerelease: false
-  version_requirements: *70114893432760
+  version_requirements: *70140255569800
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70114893430600 !ruby/object:Gem::Requirement
+  requirement: &70140255569300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -45,10 +45,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70114893430600
+  version_requirements: *70140255569300
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70114893428100 !ruby/object:Gem::Requirement
+  requirement: &70140255568780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -56,10 +56,10 @@ dependencies:
         version: '0.5'
   type: :development
   prerelease: false
-  version_requirements: *70114893428100
+  version_requirements: *70140255568780
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70114893425000 !ruby/object:Gem::Requirement
+  requirement: &70140255568100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -67,10 +67,10 @@ dependencies:
         version: '0.4'
   type: :development
   prerelease: false
-  version_requirements: *70114893425000
+  version_requirements: *70140255568100
 - !ruby/object:Gem::Dependency
   name: growl
-  requirement: &70114893423020 !ruby/object:Gem::Requirement
+  requirement: &70140255567560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -78,7 +78,7 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70114893423020
+  version_requirements: *70140255567560
 description: ''
 email:
 - victorcrodrigues@gmail.com
@@ -136,6 +136,11 @@ files:
 - examples/to_input/with_fields.rb
 - examples/to_input/without_key.rb
 - examples/to_input/without_nil.rb
+- examples/update_attributes/embeds_many.rb
+- examples/update_attributes/embeds_one.rb
+- examples/update_attributes/has_many.rb
+- examples/update_attributes/has_one.rb
+- examples/update_attributes/simple.rb
 - lib/rest_model.rb
 - lib/rest_model/configuration.rb
 - lib/rest_model/key.rb
@@ -174,6 +179,7 @@ files:
 - spec/integration/has_many_spec.rb
 - spec/integration/property_spec.rb
 - spec/integration/summarization_spec.rb
+- spec/integration/update_attributes_spec.rb
 - spec/spec_helper.rb
 - spec/support/examples.rb
 - spec/support/out.rb
@@ -231,6 +237,7 @@ test_files:
 - spec/integration/has_many_spec.rb
 - spec/integration/property_spec.rb
 - spec/integration/summarization_spec.rb
+- spec/integration/update_attributes_spec.rb
 - spec/spec_helper.rb
 - spec/support/examples.rb
 - spec/support/out.rb