restful_objects 0.0.5 → 0.0.6

data/lib/restful_objects/router/base.rb

@@ -0,0 +1,41 @@
+require_relative 'supporting_resources'
+require_relative 'domain_object_resources'
+require_relative 'domain_type_resources'
+
+module RestfulObjects
+  module Router
+    class Base < Sinatra::Base
+      register RestfulObjects::Router::SupportingResources
+      register RestfulObjects::Router::DomainObjectResources
+      register RestfulObjects::Router::DomainTypeResources
+
+      set :bind, '0.0.0.0' # listen at all networks (needed for example using vagrant port forwarding)
+
+      after do
+        headers['Access-Control-Allow-Origin'] = '*'
+      end
+
+      helpers do
+        def model
+          RestfulObjects::DomainModel.current
+        end
+
+        def objects
+          RestfulObjects::DomainModel.current.objects
+        end
+
+        def process_params
+          if request.query_string != ''
+            query_params = CGI.parse(request.query_string)
+            parameters = Hash.new
+            query_params.each { |key, value| parameters[key] = { 'value' => value.first } }
+            parameters.to_json
+          else
+            request.body.read
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/restful_objects/router/domain_object_resources.rb

@@ -0,0 +1,97 @@
+module RestfulObjects
+  module Router
+    module DomainObjectResources
+      def self.registered(router)
+        # ** 14 Domain Object Resource & Representation **
+        # 14.1
+        router.get '/objects/:domain_type/:instance_id' do
+          objects[params[:instance_id].to_i].get_representation
+        end
+
+        # 14.2
+        router.put '/objects/:domain_type/:instance_id' do
+          objects[params[:instance_id].to_i].put_properties_and_get_representation(request.body.read)
+        end
+
+        # 14.3
+        router.delete '/objects/:domain_type/:instance_id' do
+          objects[params[:instance_id].to_i].rs_delete
+        end
+
+        # patch to allow cross-origin put & delete requests #
+        router.options "/objects/:domain_type/:instance_id" do
+          headers['Access-Control-Allow-Methods'] = 'GET, DELETE, PUT, OPTIONS'
+          headers['Access-Control-Allow-Headers'] = 'Origin, Content-Type, Methods'
+        end
+
+        # C.15 Domain Services
+        router.get "/services/:service_id" do
+          model.services[params[:service_id]].get_representation
+        end
+
+        # C.16 Property
+        router.get "/objects/:domain_type/:instance_id/properties/:property_id" do
+          objects[params[:instance_id].to_i].get_property_as_json(params[:property_id])
+        end
+
+        router.put "/objects/:domain_type/:instance_id/properties/:property_id" do
+          objects[params[:instance_id].to_i].put_property_as_json(params[:property_id], request.body.read)
+        end
+
+        router.delete "/objects/:domain_type/:instance_id/properties/:property_id" do
+          objects[params[:instance_id].to_i].clear_property(params[:property_id])
+        end
+
+        # C.17 Collection #
+        router.get "/objects/:domain_type/:instance_id/collections/:collection_id" do
+          objects[params[:instance_id].to_i].get_collection_as_json(params[:collection_id])
+        end
+
+        router.post "/objects/:domain_type/:instance_id/collections/:collection_id" do
+          objects[params[:instance_id].to_i].add_to_collection(params[:collection_id], request.body.read)
+        end
+
+        router.put "/objects/:domain_type/:instance_id/collections/:collection_id" do
+          objects[params[:instance_id].to_i].add_to_collection(params[:collection_id], request.body.read)
+        end
+
+        router.delete "/objects/:domain_type/:instance_id/collections/:collection_id" do
+          objects[params[:instance_id].to_i].delete_from_collection(params[:collection_id], request.body.read)
+        end
+
+        # patch to allow cross-origin put & delete requests #
+        router.options "/objects/:domain_type/:instance_id/collections/:collection_id" do
+          headers['Access-Control-Allow-Methods'] = 'GET, DELETE, PUT, OPTIONS'
+          headers['Access-Control-Allow-Headers'] = 'Origin, Content-Type, Methods'
+        end
+
+        # C.18 Action
+        router.get "/objects/:domain_type/:instance_id/actions/:action_id" do
+          objects[params[:instance_id].to_i].get_action(params[:action_id])
+        end
+
+        router.get "/services/:service_id/actions/:action_id" do
+          model.services[params[:service_id]].get_action(params[:action_id])
+        end
+
+        # C.19 Action Invoke
+        router.get "/objects/:domain_type/:instance_id/actions/:action_id/invoke" do
+          objects[params[:instance_id].to_i].get_action_invoke(params[:action_id], process_params)
+        end
+
+        router.get "/services/:service_id/actions/:action_id/invoke" do
+          model.services[params[:service_id]].get_action_invoke(params[:action_id], process_params)
+        end
+
+        router.post "/objects/:domain_type/:instance_id/actions/:action_id/invoke" do
+          objects[params[:instance_id].to_i].get_action_invoke(params[:action_id], request.body.read)
+        end
+
+        router.post "/services/:service_id/actions/:action_id/invoke" do
+          model.services[params[:service_id]].get_action_invoke(params[:action_id], request.body.read)
+        end
+      end
+    end
+  end
+end
+

data/lib/restful_objects/router/domain_type_resources.rb

@@ -0,0 +1,37 @@
+module RestfulObjects
+  module Router
+    module DomainTypeResources
+      def self.registered(router)
+        # D.21 Domain Types
+        router.get "/domain-types" do
+          model.types.get_representation
+        end
+
+        # D.22 Domain Type
+        router.get "/domain-types/:domain_type" do
+          model.types[params[:domain_type]].get_representation
+        end
+
+        # D.23 Domain Type Property
+        router.get "/domain-types/:domain_type/properties/:property_id" do
+          model.types[params[:domain_type]].properties[params[:property_id]].get_representation
+        end
+
+        # D.24 Domain Type Collection
+        router.get "/domain-types/:domain_type/collections/:collection_id" do
+          model.types[params[:domain_type]].collections[params[:collection_id]].get_representation
+        end
+
+        # D.25 Domain Type Action
+        router.get "/domain-types/:domain_type/actions/:action_id" do
+          model.types[params[:domain_type]].actions[params[:action_id]].get_representation
+        end
+
+        # D.26 Domain Type Action Parameter
+
+        # D.27 Domain Type Action Invoke
+      end
+    end
+  end
+end
+

data/lib/restful_objects/router/supporting_resources.rb

@@ -0,0 +1,39 @@
+module RestfulObjects
+  module Router
+    module SupportingResources
+      def self.registered(router)
+        # B.5 Homepage
+        router.get '/' do
+          model.get_homepage
+        end
+
+        # B.6 User
+        router.get '/user' do
+          model.get_user_as_json
+        end
+
+        # B.7 Services
+        router.get '/services' do
+          model.get_services
+        end
+
+        # B.8 Version
+        router.get '/version' do
+          model.get_version
+        end
+
+        # B.9 Objects of Type Resource
+        router.post '/objects/:domain_type' do
+          model.types[params[:domain_type]].post_prototype_object(request.body.read)
+        end
+
+        # patch to allow cross-origin put & delete requests #
+        router.options '/objects/:domain_type' do
+          headers['Access-Control-Allow-Methods'] = 'POST, OPTIONS'
+          headers['Access-Control-Allow-Headers'] = 'Origin, Content-Type, Methods'
+        end
+      end
+    end
+  end
+end
+

data/lib/restful_objects/version.rb

@@ -1,3 +1,3 @@
 module RestfulObjects
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/lib/restful_objects.rb

@@ -6,29 +6,7 @@ require 'bigdecimal'
 require 'forwardable'
 require 'sinatra/base'
 
-require_relative "restful_objects/version"
-require_relative 'restful_objects/server'
-require_relative 'restful_objects/link_generator'
-require_relative 'restful_objects/http_response'
-require_relative 'restful_objects/user'
-require_relative 'restful_objects/property_list'
-require_relative 'restful_objects/property_description'
-require_relative 'restful_objects/collection_list'
-require_relative 'restful_objects/collection_description'
-require_relative 'restful_objects/action_list'
-require_relative 'restful_objects/action_description'
-require_relative 'restful_objects/parameter_description'
-require_relative 'restful_objects/parameter_description_list'
-require_relative 'restful_objects/object_list'
-require_relative 'restful_objects/object'
-require_relative 'restful_objects/object_base'
-require_relative 'restful_objects/object_macros'
-require_relative 'restful_objects/object_properties'
-require_relative 'restful_objects/object_collections'
-require_relative 'restful_objects/object_actions'
-require_relative 'restful_objects/type'
-require_relative 'restful_objects/type_list'
-require_relative 'restful_objects/service'
-require_relative 'restful_objects/service_list'
-require_relative 'restful_objects/domain_model'
+require_relative 'restful_objects/version'
+require_relative 'restful_objects/router/base'
+require_relative 'restful_objects/domain_model/domain_model'
 

data/spec/acceptance/generate_json_representations_spec.rb

@@ -0,0 +1,102 @@
+require_relative '../spec_helper'
+
+describe RestfulObjects::Object do
+  before :each do
+    RestfulObjects::DomainModel.current.reset
+  end
+
+  it 'generates json representation for a complex object' do
+    class Address
+    end
+
+    class ObjectTest
+      include RestfulObjects::Object
+
+      property :id, :int, read_only: true
+      property :password, :string, max_length: 10
+
+      action :hash_password, return_type: :string
+
+      collection :addresses, Address
+
+      def initialize
+        @id = 99
+        super
+      end
+    end
+
+    object          = ObjectTest.new
+    object.password = 'secret_key'
+    address         = Address.new
+    object.addresses.push(address)
+
+    get "/objects/ObjectTest/#{object.object_id}"
+
+    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
+    }
+
+    CONTENT_TYPE = 'application/json;profile="urn:org.restfulobjects:repr-types/object";x-ro-domain-type="ObjectTest"'
+    expect(last_response.content_type).to eq CONTENT_TYPE
+    expect(last_response.body).to         match_json_expression expected
+  end
+end
+

data/spec/integration/domain-types_properties_spec.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 require_relative '../spec_helper'
 
-describe '/domain-types/:type/properties/:property' do
+describe 'DomainObject properties' do
   before(:all) do
     RestfulObjects::DomainModel.current.reset
   end
@@ -37,5 +37,80 @@ describe '/domain-types/:type/properties/:property' 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_model_spec.rb

@@ -0,0 +1,35 @@
+require_relative '../spec_helper'
+
+describe RestfulObjects::Object do
+  describe '#put_properties_and_get_representation' do
+    it 'updates simple property' do
+      class TestObject
+        include RestfulObjects::Object
+        property :name, :string
+      end
+      test_object = TestObject.new
+      response    = test_object.put_properties_and_get_representation({ 'name' => { 'value' => 'john smith' } }.to_json)
+      expect(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
+      response    = test_object.put_properties_and_get_representation({ 'name'   => { 'value' => 'john smith' },
+                                                                        'age'    => { 'value' => '29' },
+                                                                        'weight' => { 'value' => '71.5' } }.to_json)
+      expect(response.body).to match_json_expression({ 'members' => {
+                                                         'name'   => { 'value' => 'john smith' },
+                                                         'age'    => { 'value' => 29 },
+                                                         'weight' => { 'value' => 71.5 }
+                                                       }
+                                                     })
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -4,9 +4,23 @@ require 'pp'
 
 require_relative '../lib/restful_objects.rb'
 
+class Array
+  def status
+    self[0]
+  end
+
+  def headers
+    self[1]
+  end
+
+  def body
+    self[2]
+  end
+end
+
 module Helpers
   def app
-    RestfulObjects::Server
+    RestfulObjects::Router::Base
   end
 
   def model
@@ -48,5 +62,6 @@ end
 JsonExpressions::Matcher.assume_strict_arrays = false
 JsonExpressions::Matcher.assume_strict_hashes = false
 
-RestfulObjects::Server.set :show_exceptions, false
-RestfulObjects::Server.set :raise_errors, true
+RestfulObjects::Router::Base.set :show_exceptions, false
+RestfulObjects::Router::Base.set :raise_errors,    true
+

data/spec/unit/object_spec.rb

@@ -59,79 +59,6 @@ describe RestfulObjects::Object do
     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'

data/spec/unit/type_list_spec.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 require_relative '../spec_helper'
 
-describe RestfulObjects::TypeList do
+describe RestfulObjects::DomainModel do
   before(:all) do
     RestfulObjects::DomainModel.current.reset
 
@@ -31,7 +31,7 @@ describe RestfulObjects::TypeList do
       'extensions' => {}
     }.to_json
 
-    RestfulObjects::DomainModel.current.types.get_representation
+    RestfulObjects::DomainModel.current.get_type_list_representation
   end
 end