restful_objects 0.0.7 → 0.0.8

data/spec/integration/domain-types_properties_spec.rb

@@ -1,7 +1,6 @@
-# encoding: utf-8
 require_relative '../spec_helper'
 
-describe 'DomainObject properties' do
+describe '=> /domain-types/:type/properties/' do
   before(:all) do
     RestfulObjects::DomainModel.current.reset
   end
@@ -37,80 +36,4 @@ describe 'DomainObject properties' do
     get '/domain-types/PropertyTest/properties/name'
     last_response.body.should match_json_expression expected
   end
-
-  describe 'json representation of property reference' do
-    before :each do
-      class ReferenceType
-        include RestfulObjects::Object
-      end
-      class PropertyRefTest
-        include RestfulObjects::Object
-        property :reference, { object: ReferenceType }
-      end
-      @referenced = ReferenceType.new
-      @object     = PropertyRefTest.new
-    end
-
-    it 'gets representation' do
-      @object.reference = @referenced
-      expect(@object.get_property_as_json(:reference)).to match_json_expression(
-        { 'reference' =>
-          { 'value' =>
-            { 'rel'    => 'urn:org.restfulobjects:rels/value;property="reference"',
-              'href'   => "http://localhost/objects/ReferenceType/#{@referenced.object_id}",
-              'type'   => 'application/json;profile="urn:org.restfulobjects:repr-types/object"',
-              'method' => 'GET',
-              'title'  => @referenced.title
-            }
-          }
-        }
-      )
-    end
-
-    it 'lists choices' do
-      choices = [ReferenceType.new, ReferenceType.new, ReferenceType.new]
-      @object.define_singleton_method(:reference_choices) { choices }
-      expect(@object.get_property_as_json(:reference)).to match_json_expression(
-        { 'reference' =>
-          { 'value' => nil,
-            'choices' => [
-              { 'rel'    => 'urn:org.restfulobjects:rels/value;property="reference"',
-                'href'   => "http://localhost/objects/ReferenceType/#{choices[0].object_id}",
-                'type'   => 'application/json;profile="urn:org.restfulobjects:repr-types/object"',
-                'method' => 'GET',
-                'title'  => choices[0].title },
-              { 'rel'    => 'urn:org.restfulobjects:rels/value;property="reference"',
-                'href'   => "http://localhost/objects/ReferenceType/#{choices[1].object_id}",
-                'type'   => 'application/json;profile="urn:org.restfulobjects:repr-types/object"',
-                'method' => 'GET',
-                'title'  => choices[1].title },
-              { 'rel'    => 'urn:org.restfulobjects:rels/value;property="reference"',
-                'href'   => "http://localhost/objects/ReferenceType/#{choices[2].object_id}",
-                'type'   => 'application/json;profile="urn:org.restfulobjects:repr-types/object"',
-                'method' => 'GET',
-                'title'  => choices[2].title }
-            ]
-          }
-        }
-      )
-    end
-
-    it 'puts representation' do
-      json = { 'value' => { 'href' => @referenced.ro_absolute_url } }.to_json
-      expect(@object.put_property_as_json(:reference, json)).to match_json_expression(
-        { 'reference' =>
-          { 'value' =>
-            { 'rel'    => 'urn:org.restfulobjects:rels/value;property="reference"',
-              'href'   => "http://localhost/objects/ReferenceType/#{@referenced.object_id}",
-              'type'   => 'application/json;profile="urn:org.restfulobjects:repr-types/object"',
-              'method' => 'GET',
-              'title'  => @referenced.title
-            }
-          }
-        }
-      )
-      expect(@object.reference).to eq @referenced
-    end
-  end
 end
-

data/spec/integration/domain-types_spec.rb

@@ -0,0 +1,39 @@
+require_relative '../spec_helper'
+
+describe '=> /domain-types' do
+  before(:all) do
+    RestfulObjects::DomainModel.current.reset
+
+    class DomainObject
+      include RestfulObjects::Object
+    end
+  end
+
+  describe 'GET /domain-types' do
+    it 'generates response with a domain types in value arrray' do
+      get '/domain-types'
+      last_response.body.should match_json_expression(
+        { value:
+          [ { rel: 'urn:org.restfulobjects:rels/domain-type',
+            href: "http://localhost/domain-types/DomainObject",
+            type: 'application/json;profile="urn:org.restfulobjects:repr-types/domain-type"',
+            method: 'GET' } ]
+        })
+    end
+
+    it 'generates response links to homepage & sellf' do
+      get '/domain-types'
+      last_response.body.should match_json_expression(
+        { links: [
+            { rel: 'self',
+              href: 'http://localhost/domain-types',
+              type: 'application/json;profile="urn:org.restfulobjects:repr-types/type-list"',
+              method: 'GET' },
+            { rel: 'up',
+              href: 'http://localhost/',
+              type: 'application/json;profile="urn:org.restfulobjects:repr-types/homepage"',
+              method: 'GET' } ]
+        })
+    end
+  end
+end

data/spec/integration/{server-root_spec.rb → homepage_spec.rb}

@@ -1,7 +1,6 @@
-# encoding: utf-8
 require_relative '../spec_helper'
 
-describe '/' do
+describe '=> /' do
   before(:all) do
     RestfulObjects::DomainModel.current.reset
   end
@@ -69,7 +68,7 @@ describe '/' do
       include RestfulObjects::Service
     end
 
-    RestfulObjects::DomainModel.current.services['ServiceTest'].title = 'Service Test Title'
+    RestfulObjects::DomainModel.current.services['ServiceTest'].ro_title = 'Service Test Title'
 
     services_list = {
       'links' => [

data/spec/integration/objects_actions_spec.rb

@@ -0,0 +1,7 @@
+require_relative '../spec_helper'
+
+describe '=> /objects/:type/:instance_id/actions/' do
+  before(:all) do
+    RestfulObjects::DomainModel.current.reset
+  end
+end

data/spec/integration/objects_collections_spec.rb

@@ -0,0 +1,169 @@
+require_relative '../spec_helper'
+
+describe '=> /objects/:type/:instance_id/collections/' do
+  before(:all) do
+    RestfulObjects::DomainModel.current.reset
+
+    class ItemClass
+      include RestfulObjects::Object
+    end
+
+    class CollectionTest
+      include RestfulObjects::Object
+      collection :items, 'ItemClass', friendly_name: 'item collection', description: 'a collection description'
+    end
+  end
+
+  before(:each) do
+    @collection_object = CollectionTest.new
+    @item_a, @item_b, @item_c = ItemClass.new, ItemClass.new, ItemClass.new
+    @item_a.ro_title = 'Item A'
+    @item_b.ro_title = 'Item B'
+    @item_c.ro_title = 'Item C'
+  end
+
+  describe 'GET /objects/:type/collections/:collection' do
+    it 'generates response with status code 200' do
+      get "/objects/CollectionTest/#{@collection_object.ro_instance_id}/collections/items"
+      expect(last_response.status).to eq 200
+    end
+
+    it 'generates response with header Content-Type of object-collection' do
+      get "/objects/CollectionTest/#{@collection_object.ro_instance_id}/collections/items"
+      expect(last_response.headers['Content-Type']).to eq(
+        'application/json;profile="urn:org.restfulobjects:repr-types/object-collection";x-ro-element-type="ItemClass"')
+    end
+
+    context 'when collection is empty,' do
+      it 'generates response with an empty value array' do
+        get "/objects/CollectionTest/#{@collection_object.ro_instance_id}/collections/items"
+        expect(last_response.body).to match_json_expression({ value: [] })
+      end
+    end
+
+    context 'when there are items in the collection,' do
+      it 'generates response with a value array with the item list' do
+        @collection_object.items << @item_a << @item_b << @item_c
+
+        get "/objects/CollectionTest/#{@collection_object.ro_instance_id}/collections/items"
+
+        expect(last_response.body).to match_json_expression({
+          value: [
+            { href: "http://localhost/objects/ItemClass/#{@item_a.ro_instance_id}" },
+            { href: "http://localhost/objects/ItemClass/#{@item_b.ro_instance_id}" },
+            { href: "http://localhost/objects/ItemClass/#{@item_c.ro_instance_id}" },
+          ]
+        })
+      end
+
+      it 'generates response with a value array with the item metadata' do
+        item   = ItemClass.new
+        item.ro_title = 'An item'
+        object = CollectionTest.new
+        object.items << item
+
+        get "/objects/CollectionTest/#{object.ro_instance_id}/collections/items"
+
+        expect(last_response.body).to match_json_expression({
+          value: [ {
+            rel: 'urn:org.restfulobjects:rels/value;collection="items"',
+            href: "http://localhost/objects/ItemClass/#{item.ro_instance_id}",
+            method: 'GET',
+            type: 'application/json;profile="urn:org.restfulobjects:repr-types/object"',
+            title: 'An item'
+          } ]
+        })
+      end
+
+      it 'generates response with object list' do
+        a, b = ItemClass.new, ItemClass.new
+        object = CollectionTest.new
+        object.items << a << b
+
+        get '/domain-types/CollectionTest/collections/items'
+      end
+
+
+      it 'generates response with links' do
+
+      end
+    end
+  end
+
+  describe 'POST /objects/:type/:instance_id/collections/:collection' do
+    it 'appends objecto to collection with list semantics' do
+      collection = CollectionTest.new
+      item       = ItemClass.new
+
+      post "/objects/CollectionTest/#{collection.ro_instance_id}/collections/items",
+        '{ "value": { "href": "/objects/ItemClass/' + item.ro_instance_id.to_s + '" } }'
+
+      expect(collection.items).to include(item)
+    end
+  end
+
+  describe 'PUT /objects/:type/:instance_id/collections/:collection' do
+    it 'appends object to collection with set semantics' do
+      collection = CollectionTest.new
+      item       = ItemClass.new
+
+      put "/objects/CollectionTest/#{collection.ro_instance_id}/collections/items",
+        '{ "value": { "href": "/objects/ItemClass/' + item.ro_instance_id.to_s + '" } }'
+
+      expect(collection.items).to include(item)
+    end
+  end
+
+  describe 'DELETE /objects/:type/:instance_id/collections/:collection' do
+    it 'removes object from to collection' do
+      collection = CollectionTest.new
+      item       = ItemClass.new
+      collection.items << item
+
+      delete "/objects/CollectionTest/#{collection.ro_instance_id}/collections/items",
+        '{ "value": { "href": "/objects/ItemClass/' + item.ro_instance_id.to_s + '" } }'
+
+      expect(collection.items).not_to include(item)
+    end
+  end
+end
+
+describe '=> /domain-types/:type/collections/' do
+  before(:all) do
+    RestfulObjects::DomainModel.current.reset
+
+    class CollectionTest
+      include RestfulObjects::Object
+      collection :items, 'ItemClass', friendly_name: 'item collection', description: 'a collection description'
+    end
+  end
+
+  it 'generates response with collection metadata' do
+    get '/domain-types/CollectionTest/collections/items'
+
+    last_response.body.should match_json_expression({
+      'id' => 'items',
+      'friendlyName' => 'item collection',
+      'description' => 'a collection description',
+      'memberOrder' => 1,
+      'links' => [
+        { 'rel' => 'self',
+          'href' => 'http://localhost/domain-types/CollectionTest/collections/items',
+          'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/collection-description"',
+          'method' => 'GET' },
+        { 'rel' => 'up',
+          'href' => 'http://localhost/domain-types/CollectionTest',
+          'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/domain-type"',
+          'method' => 'GET' },
+        { 'rel' => 'urn:org.restfulobjects:rels/return-type',
+          'href' => 'http://localhost/domain-types/list',
+          'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/domain-type"',
+          'method' => 'GET' },
+        { 'rel' => 'urn:org.restfulobjects:rels/element-type',
+          'href' => 'http://localhost/domain-types/ItemClass',
+          'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/domain-type"',
+          'method' => 'GET' }
+      ]
+    })
+  end
+end

data/spec/integration/objects_properties_spec.rb

@@ -0,0 +1,122 @@
+require_relative '../spec_helper'
+
+describe '=> /objects/:type/:instance_id/properties/' do
+  describe 'simple properties,' do
+    it 'updates simple property' do
+      class TestObject
+        include RestfulObjects::Object
+        property :name, :string
+      end
+      test_object = TestObject.new
+
+      put "/objects/TestObject/#{test_object.ro_instance_id}", { 'name' => { 'value' => 'john smith' } }.to_json
+
+      expect(last_response.body).to match_json_expression({ members: { name: { value: 'john smith' } } })
+    end
+
+    it 'updates multiple properties' do
+      class TestObject
+        include RestfulObjects::Object
+        property :name,   :string
+        property :age,    :int
+        property :weight, :decimal
+      end
+      test_object = TestObject.new
+
+      json =  { 'name' => { 'value' => 'john smith' }, 'age' => { 'value' => '29' }, 'weight' => { 'value' => '71.5' } }.to_json
+
+      put "/objects/TestObject/#{test_object.ro_instance_id}", json
+
+      expect(last_response.body).to match_json_expression({
+        members: {
+          name:   { value: 'john smith' },
+          age:    { value: 29 },
+          weight: { value: 71.5 }
+        }
+      })
+    end
+  end
+
+  describe 'reference properties,' do
+    before(:each) do
+      class ReferenceType
+        include RestfulObjects::Object
+      end
+
+      class PropertyRefTest
+        include RestfulObjects::Object
+        property :reference, { object: ReferenceType }
+      end
+
+      @referenced = ReferenceType.new
+      @object     = PropertyRefTest.new
+    end
+
+    it 'gets representation' do
+      @object.reference = @referenced
+
+      get "/objects/PropertyRefTest/#{@object.ro_instance_id}/properties/reference"
+
+      expect(last_response.body).to match_json_expression(
+        { reference:
+          { value:
+            { rel:    'urn:org.restfulobjects:rels/value;property="reference"',
+              href:   "http://localhost/objects/ReferenceType/#{@referenced.object_id}",
+              type:   'application/json;profile="urn:org.restfulobjects:repr-types/object"',
+              method: 'GET',
+              title:  @referenced.ro_title
+            }
+          }
+        }
+      )
+    end
+
+    it 'lists choices' do
+      choices = [ReferenceType.new, ReferenceType.new, ReferenceType.new]
+      @object.define_singleton_method(:reference_choices) { choices }
+
+      get "/objects/PropertyRefTest/#{@object.ro_instance_id}/properties/reference"
+
+      expect(last_response.body).to match_json_expression(
+        { reference:
+          { value: nil,
+            choices: [
+              { rel:    'urn:org.restfulobjects:rels/value;property="reference"',
+                href:   "http://localhost/objects/ReferenceType/#{choices[0].object_id}",
+                type:   'application/json;profile="urn:org.restfulobjects:repr-types/object"',
+                method: 'GET',
+                title:  choices[0].ro_title },
+              { rel:    'urn:org.restfulobjects:rels/value;property="reference"',
+                href:   "http://localhost/objects/ReferenceType/#{choices[1].object_id}",
+                type:   'application/json;profile="urn:org.restfulobjects:repr-types/object"',
+                method: 'GET',
+                title:  choices[1].ro_title },
+              { rel:    'urn:org.restfulobjects:rels/value;property="reference"',
+                href:   "http://localhost/objects/ReferenceType/#{choices[2].object_id}",
+                type:   'application/json;profile="urn:org.restfulobjects:repr-types/object"',
+                method: 'GET',
+                title:  choices[2].ro_title }
+            ]
+          }
+        }
+      )
+    end
+
+    it 'puts representation' do
+      json = { 'value' => { 'href' => @referenced.ro_absolute_url } }.to_json
+      expect(@object.ro_put_property_and_get_response(:reference, json).last).to match_json_expression(
+        { 'reference' =>
+          { 'value' =>
+            { 'rel'    => 'urn:org.restfulobjects:rels/value;property="reference"',
+              'href'   => "http://localhost/objects/ReferenceType/#{@referenced.object_id}",
+              'type'   => 'application/json;profile="urn:org.restfulobjects:repr-types/object"',
+              'method' => 'GET',
+              'title'  => @referenced.ro_title
+            }
+          }
+        }
+      )
+      expect(@object.reference).to eq @referenced
+    end
+  end
+end