restful_objects 0.0.1 → 0.0.2

data/spec/unit/object_collections_spec.rb

@@ -0,0 +1,190 @@
+# encoding: utf-8
+require_relative '../spec_helper'
+
+describe RestfulObjects::ObjectActions do
+  before :all do
+    RestfulObjects::DomainModel.current.reset
+
+    class Address
+      include RestfulObjects::Object
+
+      property :street, :string
+      property :number, :int
+    end
+
+    class CollectionsTest
+      include RestfulObjects::Object
+
+      collection :addresses, Address
+      collection :collection_full_metadata, Address
+    end
+  end
+
+  before :each do
+    @object = CollectionsTest.new
+  end
+
+  it 'should create a collection' do
+    @object.addresses.is_a?(Enumerable).should be_true
+    @object.addresses.empty?.should be_true
+
+    a = Address.new
+    a.street = 'Evergreen'
+    a.number = 1234
+
+    @object.addresses.push(a)
+    @object.addresses.empty?.should be_false
+    @object.addresses.count.should eq(1)
+  end
+
+  it 'should generate json for the collection' do
+    a1 = Address.new
+    @object.addresses.push a1
+    a2 = Address.new
+    @object.addresses.push a2
+    a3 = Address.new
+    @object.addresses.push a3
+
+    expected = { 'id' => 'addresses',
+                 'value' => [
+                    { 'rel' => 'urn:org.restfulobjects:rels/value;collection="addresses"',
+                      'href' => "http://localhost/objects/Address/#{a1.object_id}",
+                      'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object"',
+                      'method' => 'GET' },
+                    { 'rel' => 'urn:org.restfulobjects:rels/value;collection="addresses"',
+                      'href' => "http://localhost/objects/Address/#{a2.object_id}",
+                      'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object"',
+                      'method' => 'GET' },
+                    { 'rel' => 'urn:org.restfulobjects:rels/value;collection="addresses"',
+                      'href' => "http://localhost/objects/Address/#{a3.object_id}",
+                      'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object"',
+                      'method' => 'GET' }
+                    ],
+                 'links' => [
+                    { 'rel' => 'self',
+                      'href' => "http://localhost/objects/CollectionsTest/#{@object.object_id}/collections/addresses",
+                      'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object-collection"',
+                      'method' => 'GET' },
+                    { 'rel' => 'up',
+                      'href' => "http://localhost/objects/CollectionsTest/#{@object.object_id}",
+                      'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object"',
+                      'method' => 'GET' },
+                    { 'rel' => 'urn:org.restfulobjects:rels/add-to;collection="addresses"',
+                      'href' => "http://localhost/objects/CollectionsTest/#{@object.object_id}/collections/addresses",
+                      'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object-collection"',
+                      'method' => 'PUT',
+                      'arguments' => { 'value' => nil } },
+                    { 'rel' => 'urn:org.restfulobjects:rels/remove-from;collection="addresses"',
+                      'href' => "http://localhost/objects/CollectionsTest/#{@object.object_id}/collections/addresses",
+                      'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object-collection"',
+                      'method' => 'DELETE',
+                      'arguments' => { 'value' => nil } },
+                    ]
+               }
+
+    get "/objects/CollectionsTest/#{@object.object_id}/collections/addresses"
+
+    last_response.body.should match_json_expression expected
+  end
+
+  it 'should add an object to a collection' do
+    address = Address.new
+
+    json = { 'value' => { 'href' => "http://localhost/objects/Address/#{address.object_id}" } }.to_json
+
+    put "/objects/CollectionsTest/#{@object.object_id}/collections/addresses", {}, { input: json }
+
+    @object.addresses.include?(address).should be_true
+
+    expected = { 'id' => 'addresses',
+                 'value' => [
+                    { 'rel' => 'urn:org.restfulobjects:rels/value;collection="addresses"',
+                      'href' => "http://localhost/objects/Address/#{address.object_id}",
+                      'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object"',
+                      'method' => 'GET' } ],
+                 'links' => [
+                    { 'rel' => 'self',
+                      'href' => "http://localhost/objects/CollectionsTest/#{@object.object_id}/collections/addresses",
+                      'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object-collection"',
+                      'method' => 'GET' },
+                    { 'rel' => 'up',
+                      'href' => "http://localhost/objects/CollectionsTest/#{@object.object_id}",
+                      'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object"',
+                      'method' => 'GET' },
+                    { 'rel' => 'urn:org.restfulobjects:rels/add-to;collection="addresses"',
+                      'href' => "http://localhost/objects/CollectionsTest/#{@object.object_id}/collections/addresses",
+                      'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object-collection"',
+                      'method' => 'PUT',
+                      'arguments' => { 'value' => nil } },
+                    { 'rel' => 'urn:org.restfulobjects:rels/remove-from;collection="addresses"',
+                      'href' => "http://localhost/objects/CollectionsTest/#{@object.object_id}/collections/addresses",
+                      'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object-collection"',
+                      'method' => 'DELETE',
+                      'arguments' => { 'value' => nil } },
+                    ]
+               }
+
+    last_response.body.should match_json_expression expected
+  end
+
+  it 'should remove an object from a collection' do
+    address = Address.new
+
+    @object.addresses.push(address)
+
+    json = { 'value' => { 'href' => "http://localhost/objects/Address/#{address.object_id}" } }.to_json
+
+    delete "/objects/CollectionsTest/#{@object.object_id}/collections/addresses", {}, { input: json }
+
+    @object.addresses.include?(address).should be_false
+
+    expected = { 'id' => 'addresses',
+                 'value' => [],
+                 'links' => [
+                    { 'rel' => 'self',
+                      'href' => "http://localhost/objects/CollectionsTest/#{@object.object_id}/collections/addresses",
+                      'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object-collection"',
+                      'method' => 'GET' },
+                    { 'rel' => 'up',
+                      'href' => "http://localhost/objects/CollectionsTest/#{@object.object_id}",
+                      'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object"',
+                      'method' => 'GET' },
+                    { 'rel' => 'urn:org.restfulobjects:rels/add-to;collection="addresses"',
+                      'href' => "http://localhost/objects/CollectionsTest/#{@object.object_id}/collections/addresses",
+                      'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object-collection"',
+                      'method' => 'PUT',
+                      'arguments' => { 'value' => nil } },
+                    { 'rel' => 'urn:org.restfulobjects:rels/remove-from;collection="addresses"',
+                      'href' => "http://localhost/objects/CollectionsTest/#{@object.object_id}/collections/addresses",
+                      'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object-collection"',
+                      'method' => 'DELETE',
+                      'arguments' => { 'value' => nil } },
+                    ]
+               }
+
+    last_response.body.should match_json_expression expected
+  end
+
+  it 'should generate metadata in extensions' do
+    collection = @object.rs_type.collections['collection_full_metadata']
+    collection.friendly_name = 'Friendly Collection'
+    collection.description = 'Collection Description'
+    collection.plural_form = 'Collections'
+    expected = {
+      'id' => 'collection_full_metadata',
+      'extensions' => {
+        'friendlyName' => 'Friendly Collection',
+        'description' => 'Collection Description',
+        'returnType' => 'list',
+        'elementType' => 'Address',
+        'pluralForm' => 'Collections',
+        'memberOrder' => Fixnum
+      }.strict!
+    }
+
+    get "/objects/ActionsTest/#{@object.object_id}/collections/collection_full_metadata"
+
+    last_response.body.should match_json_expression expected
+  end
+end
+

data/spec/unit/object_properties_spec.rb

@@ -0,0 +1,206 @@
+require_relative '../spec_helper'
+
+describe RestfulObjects::ObjectProperties do
+  before :all do
+    RestfulObjects::DomainModel.current.reset
+
+    class PropertiesTest
+      include RestfulObjects::Object
+
+      property :id, :int, read_only: true
+      property :name, :string, max_length: 10
+      property :string_prop, :string
+      property :int_prop, :int
+      property :decimal_prop, :decimal
+      property :date_prop, :date
+      property :blob_prop, :blob
+
+      property :prop_full_metadata, :string, friendly_name: 'Meta Prop', description: 'To Test Metadata', max_length: 30,
+                                             pattern: '.*abc.*', optional: false
+
+      def initialize
+        super
+        @id = 99
+      end
+    end
+  end
+
+  before :each do
+    @object = PropertiesTest.new
+  end
+
+  it 'should respond to properties' do
+    @object.respond_to?(:string_prop).should be_true
+    @object.respond_to?(:string_prop=).should be_true
+  end
+
+  it 'should not generate writer for read-only property' do
+    @object.respond_to?(:id).should be_true
+    @object.respond_to?(:id=).should be_false
+  end
+
+  it 'should generate json for a read-only property' do
+    expected = { 'id' =>
+                 { 'value' => 99,
+                   'links' => [
+                      { 'rel' => 'self',
+                        'href' => "http://localhost/objects/PropertiesTest/#{@object.object_id}/properties/id",
+                        'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object-property"',
+                        'method' => 'GET'},
+                      { 'rel' => 'up',
+                        'href' => "http://localhost/objects/PropertiesTest/#{@object.object_id}",
+                        'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object"',
+                        'method' => 'GET'}
+                    ],
+                    'disabledReason' => 'read-only property'
+                 }
+               }
+
+    get "/objects/PropertiesTest/#{@object.object_id}/properties/id"
+
+    last_response.body.should match_json_expression expected
+  end
+
+  it 'should generate json for a writable property' do
+    @object.name = 'Mr. John'
+
+    expected = { 'name' =>
+                 { 'value' => 'Mr. John',
+                   'links' => [
+                      { 'rel' => 'self',
+                        'href' => "http://localhost/objects/PropertiesTest/#{@object.object_id}/properties/name",
+                        'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object-property"',
+                        'method' => 'GET' },
+                      { 'rel' => 'up',
+                        'href' => "http://localhost/objects/PropertiesTest/#{@object.object_id}",
+                        'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object"',
+                        'method' => 'GET' },
+                      { 'rel' => 'urn:org.restfulobjects:rels/modify;property="name"',
+                        'href' => "http://localhost/objects/PropertiesTest/#{@object.object_id}/properties/name",
+                        'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object-property"',
+                        'method' => 'PUT',
+                        'arguments' => { 'value' => nil } },
+                      { 'rel' => 'urn:org.restfulobjects:rels/clear;property="name"',
+                        'href' => "http://localhost/objects/PropertiesTest/#{@object.object_id}/properties/name",
+                        'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object-property"',
+                        'method' => 'DELETE' }
+                    ]
+                 }
+               }
+
+    get "/objects/PropertiesTest/#{@object.object_id}/properties/name"
+
+    last_response.body.should match_json_expression expected
+  end
+
+  it 'should enforce string property max_length' do
+    @object.name = 'x' * 10
+    @object.name.should eq('x' * 10)
+    expect { @object.name = 'x' * 11 }.to raise_error
+  end
+
+  it 'should process different property types get' do
+    @object.string_prop = 'A string'
+    @object.int_prop = 1234
+    @object.decimal_prop = 333.33
+    @object.date_prop = Date.new(2012, 2, 29)
+    @object.blob_prop = "\xE5\xA5\xB4\x30\xF2\x8C\x71\xD9"
+
+    expected = {
+      'string_prop' => 'A string',
+      'int_prop' => 1234,
+      'decimal_prop' => 333.33,
+      'date_prop' => '2012-02-29',
+      'blob_prop' => '5aW0MPKMcdk=' }
+
+    expected.each do |name, value|
+      get "/objects/PropertiesTest/#{@object.object_id}/properties/#{name}"
+      JSON.parse(last_response.body)[name]['value'].should eq value
+    end
+  end
+
+  it 'should process different property types set' do
+    values = {
+      'string_prop' => 'A string',
+      'int_prop' => 1234,
+      'decimal_prop' => 333.33,
+      'date_prop' => '2012-02-29',
+      'blob_prop' => '5aW0MPKMcdk=' }
+
+    values.each do |name, value|
+      put "/objects/PropertiesTest/#{@object.object_id}/properties/#{name}", { 'value' => value }.to_json
+    end
+
+    @object.string_prop.should eq 'A string'
+    @object.int_prop.should eq 1234
+    @object.decimal_prop.should eq 333.33
+    @object.date_prop.should eq Date.new(2012, 2, 29)
+    @object.blob_prop.should eq "\xE5\xA5\xB4\x30\xF2\x8C\x71\xD9"
+  end
+
+  it 'should process a property put with json' do
+    json = { 'value' => 'masterkey' }.to_json
+
+    expected = { 'name' =>
+                 { 'value' => 'masterkey',
+                   'links' => [
+                      { 'rel' => 'self',
+                        'href' => "http://localhost/objects/PropertiesTest/#{@object.object_id}/properties/name",
+                        'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object-property"',
+                        'method' => 'GET' },
+                      { 'rel' => 'up',
+                        'href' => "http://localhost/objects/PropertiesTest/#{@object.object_id}",
+                        'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object"',
+                        'method' => 'GET' },
+                      { 'rel' => 'urn:org.restfulobjects:rels/modify;property="name"',
+                        'href' => "http://localhost/objects/PropertiesTest/#{@object.object_id}/properties/name",
+                        'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object-property"',
+                        'method' => 'PUT',
+                        'arguments' => { 'value' => nil } },
+                      { 'rel' => 'urn:org.restfulobjects:rels/clear;property="name"',
+                        'href' => "http://localhost/objects/PropertiesTest/#{@object.object_id}/properties/name",
+                        'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object-property"',
+                        'method' => 'DELETE' }
+                    ]
+                 }
+               }
+
+    put "/objects/PropertiesTest/#{@object.object_id}/properties/name", json
+
+    last_response.body.should match_json_expression expected
+  end
+
+  it 'should process a property delete' do
+    @object.name = 'irrelevant'
+
+    delete "/objects/PropertiesTest/#{@object.object_id}/properties/name"
+
+    @object.name.should be_nil
+
+    expected = { 'name' => { 'value' => nil } }
+
+    last_response.body.should match_json_expression expected
+  end
+
+  it 'should generate metadata in extensions' do
+    expected = {
+      'prop_full_metadata' => {
+        'extensions' => {
+          'friendlyName' => 'Meta Prop',
+          'description' => 'To Test Metadata',
+          'returnType' => 'string',
+          'format' => 'string',
+          'optional' => false,
+          'maxLength' => 30,
+          'pattern' => '.*abc.*',
+          'memberOrder' => Fixnum
+        }.strict!
+      }
+    }
+
+    get "/objects/PropertiesTest/#{@object.object_id}/properties/prop_full_metadata"
+
+    last_response.body.should match_json_expression expected
+  end
+end
+

data/spec/unit/object_spec.rb

@@ -0,0 +1,228 @@
+# encoding: utf-8
+require_relative '../spec_helper'
+
+describe RestfulObjects::Object do
+  before :all do
+    RestfulObjects::DomainModel.current.reset
+
+    class Address
+      include RestfulObjects::Object
+
+      property :street, :string
+      property :number, :int
+    end
+
+    class ObjectTest
+      include RestfulObjects::Object
+
+      property :id, :int, read_only: true
+      property :password, :string, max_length: 10
+
+      action :hash_password, :string
+
+      collection :addresses, Address
+
+      def initialize
+        @id = 99
+        super
+      end
+    end
+  end
+
+  before(:each) do
+    @object = ObjectTest.new
+  end
+
+  it 'module should add class macros functionality' do
+    @object.class.respond_to?(:property).should be_true
+    @object.class.respond_to?(:action).should be_true
+    @object.class.respond_to?(:collection).should be_true
+  end
+
+  it 'should add the type information to the model' do
+    model.types.include?('ObjectTest').should be_true
+
+    domain_type = model.types['ObjectTest']
+
+    domain_type.properties.include?('id').should be_true
+    domain_type.properties['id'].return_type.should eq(:int)
+    domain_type.properties['id'].read_only.should be_true
+    domain_type.properties['id'].max_length.should be_nil
+
+    domain_type.properties.include?('password').should be_true
+    domain_type.properties['password'].return_type.should eq(:string)
+    domain_type.properties['password'].read_only.should be_false
+    domain_type.properties['password'].max_length.should eq(10)
+
+    domain_type.actions.include?('hash_password').should be_true
+    domain_type.actions['hash_password'].parameters.count.should eq(0)
+    domain_type.actions['hash_password'].result_type.should eq(:string)
+  end
+
+  it 'should generate json for the object' do
+    @object.password = 'secret_key'
+    address = Address.new
+    @object.addresses.push(address)
+
+    expected = {
+      'instanceId' => @object.object_id.to_s,
+      'title' => "ObjectTest (#{@object.object_id})",
+      'members' => {
+        'id' =>
+          { 'memberType' => 'property',
+            'value' => 99,
+            'disabledReason' => 'read-only property',
+            'links' => [
+              { 'rel' => 'urn:org.restfulobjects:rels/details;property="id"',
+                'href' => "http://localhost/objects/ObjectTest/#{@object.object_id}/properties/id",
+                'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object-property"',
+                'method' => 'GET' }
+            ],
+          'extensions' => { }
+        },
+        'password' => {
+          'memberType' => 'property',
+          'value' => 'secret_key',
+          'links' => [
+            { 'rel' => 'urn:org.restfulobjects:rels/details;property="password"',
+              'href' => "http://localhost/objects/ObjectTest/#{@object.object_id}/properties/password",
+              'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object-property"',
+              'method' => 'GET' }
+          ],
+          'extensions' => { }
+        },
+        'addresses' => {
+          'memberType' => 'collection',
+          'size' => 1,
+          'links' => [
+            { 'rel' => 'urn:org.restfulobjects:rels/details;collection="addresses"',
+              'href' => "http://localhost/objects/ObjectTest/#{@object.object_id}/collections/addresses",
+              'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object-collection"',
+              'method' => 'GET' }
+          ],
+          'extensions' => { }
+        },
+        'hash_password' => {
+          'memberType' => 'action',
+          'links' => [
+            { 'rel' => 'urn:org.restfulobjects:rels/details;action="hash_password"',
+              'href' => "http://localhost/objects/ObjectTest/#{@object.object_id}/actions/hash_password",
+              'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object-action"',
+              'method' => 'GET' }
+          ],
+          'extensions' => { }
+        }
+      },
+      'links' => [
+        { 'rel' => 'self',
+          'href' => "http://localhost/objects/ObjectTest/#{@object.object_id}",
+          'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/object"',
+          'method' => 'GET' },
+        { 'rel' => 'describedby',
+          'href' => "http://localhost/domain-types/ObjectTest",
+          'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/domain-type"',
+          'method' => 'GET' }
+      ],
+      'extensions' => wildcard_matcher
+    }
+
+    get "/objects/ObjectTest/#{@object.object_id}"
+
+    last_response.body.should match_json_expression expected
+    last_response.content_type.should eq 'application/json;profile="urn:org.restfulobjects:repr-types/object";x-ro-domain-type="ObjectTest"'
+  end
+
+  it 'should generate metadata in extensions' do
+    @object.rs_type.plural_name = 'Test Objects'
+    @object.rs_type.friendly_name = 'Test Object Friendly'
+    @object.rs_type.description = 'An object to test'
+
+    expected = {
+      'instanceId' => @object.object_id.to_s,
+      'extensions' => {
+        'domainType' => 'ObjectTest',
+        'pluralName' => 'Test Objects',
+        'friendlyName' => 'Test Object Friendly',
+        'description' => 'An object to test',
+        'isService' => false
+      }.strict!
+    }
+
+    get "/objects/ObjectTest/#{@object.object_id}"
+
+    last_response.body.should match_json_expression expected
+  end
+
+  it 'should call initialize on object' do
+    class InitializedObject
+      include RestfulObjects::Object
+      attr_reader :init_called
+      def initialize
+        super
+        @init_called = true
+        @title = 'A title'
+      end
+    end
+    obj = InitializedObject.new
+    obj.init_called.should be_true
+    obj.title.should eq 'A title'
+  end
+
+  it 'should send on_after_create callback when object is created' do
+    class CreatedObject
+      include RestfulObjects::Object
+      attr_reader :called
+      def on_after_create
+        @called = true
+      end
+    end
+
+    CreatedObject.new.called.should be_true
+  end
+
+  it 'should send on_after_update callback when object property is updated or deleted' do
+    class UpdatableObject
+      include RestfulObjects::Object
+      attr_accessor :prop_updated
+      property :data, :string
+      def on_after_update
+        @prop_updated = true
+      end
+    end
+
+    obj = UpdatableObject.new
+
+    obj.prop_updated.should_not be_true
+
+    put "/objects/UpdatableObject/#{obj.object_id}/properties/data", {}, { input: { 'value' => 'irrelevant' }.to_json }
+
+    obj.prop_updated.should be_true
+
+    obj.prop_updated = false
+
+    delete "/objects/UpdatableObject/#{obj.object_id}/properties/data"
+
+    obj.prop_updated.should be_true
+  end
+
+  it 'should send on_after_delete callback when object is deleted' do
+    class DeletedObject
+      include RestfulObjects::Object
+      attr_reader :destroyed
+      def on_after_delete
+        @destroyed = true
+      end
+    end
+
+    obj = DeletedObject.new
+
+    obj.deleted?.should_not be_true
+    obj.destroyed.should_not be_true
+
+    delete "/objects/DeletedObject/#{obj.object_id}"
+
+    obj.deleted?.should be_true
+    obj.destroyed.should be_true
+  end
+end
+