restful_objects 0.0.7 → 0.0.8

data/lib/restful_objects/router.rb

@@ -0,0 +1,6 @@
+module RestfulObjects::Router
+  autoload :Base, 'restful_objects/router/base'
+  autoload :SupportingResources, 'restful_objects/router/supporting_resources'
+  autoload :DomainObjectResources, 'restful_objects/router/domain_object_resources'
+  autoload :DomainTypeResources, 'restful_objects/router/domain_type_resources'
+end

data/lib/restful_objects/router/base.rb

@@ -1,41 +1,32 @@
-require_relative 'supporting_resources'
-require_relative 'domain_object_resources'
-require_relative 'domain_type_resources'
+class RestfulObjects::Router::Base < Sinatra::Base
+  register RestfulObjects::Router::SupportingResources
+  register RestfulObjects::Router::DomainObjectResources
+  register RestfulObjects::Router::DomainTypeResources
 
-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)
 
-      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
+  after do
+    headers['Access-Control-Allow-Origin'] = '*'
+  end
 
-      helpers do
-        def model
-          RestfulObjects::DomainModel.current
-        end
+  helpers do
+    def model
+      RestfulObjects::DomainModel.current
+    end
 
-        def objects
-          RestfulObjects::DomainModel.current.objects
-        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
+    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
-

data/lib/restful_objects/router/domain_object_resources.rb

@@ -1,97 +1,92 @@
-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
+module RestfulObjects::Router::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].ro_get_representation_response
+    end
+
+    # 14.2
+    router.put '/objects/:domain_type/:instance_id' do
+      objects[params[:instance_id].to_i].ro_put_multiple_properties_and_get_response(request.body.read)
+    end
+
+    # 14.3
+    router.delete '/objects/:domain_type/:instance_id' do
+      objects[params[:instance_id].to_i].ro_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]].ro_get_representation_response
+    end
+
+    # C.16 Property
+    router.get "/objects/:domain_type/:instance_id/properties/:property_id" do
+      objects[params[:instance_id].to_i].ro_get_property_response(params[:property_id])
+    end
+
+    router.put "/objects/:domain_type/:instance_id/properties/:property_id" do
+      objects[params[:instance_id].to_i].ro_put_property_and_get_response(params[:property_id], request.body.read)
+    end
+
+    router.delete "/objects/:domain_type/:instance_id/properties/:property_id" do
+      objects[params[:instance_id].to_i].ro_clear_property_and_get_response(params[:property_id])
+    end
+
+    # C.17 Collection #
+    router.get "/objects/:domain_type/:instance_id/collections/:collection_id" do
+      objects[params[:instance_id].to_i].ro_get_collection_response(params[:collection_id])
+    end
+
+    router.post "/objects/:domain_type/:instance_id/collections/:collection_id" do
+      objects[params[:instance_id].to_i].ro_add_to_collection_and_get_response(params[:collection_id], request.body.read)
+    end
+
+    router.put "/objects/:domain_type/:instance_id/collections/:collection_id" do
+      objects[params[:instance_id].to_i].ro_add_to_collection_and_get_response(params[:collection_id], request.body.read)
+    end
+
+    router.delete "/objects/:domain_type/:instance_id/collections/:collection_id" do
+      objects[params[:instance_id].to_i].ro_delete_from_collection_and_get_response(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].ro_get_action_response(params[:action_id])
+    end
+
+    router.get "/services/:service_id/actions/:action_id" do
+      model.services[params[:service_id]].ro_get_action_response(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].ro_invoke_action_and_get_response(params[:action_id], process_params)
+    end
+
+    router.get "/services/:service_id/actions/:action_id/invoke" do
+      model.services[params[:service_id]].ro_invoke_action_and_get_response(params[:action_id], process_params)
+    end
+
+    router.post "/objects/:domain_type/:instance_id/actions/:action_id/invoke" do
+      objects[params[:instance_id].to_i].ro_invoke_action_and_get_response(params[:action_id], request.body.read)
+    end
+
+    router.post "/services/:service_id/actions/:action_id/invoke" do
+      model.services[params[:service_id]].ro_invoke_action_and_get_response(params[:action_id], request.body.read)
     end
   end
 end
-

data/lib/restful_objects/router/domain_type_resources.rb

@@ -1,37 +1,32 @@
-module RestfulObjects
-  module Router
-    module DomainTypeResources
-      def self.registered(router)
-        # D.21 Domain Types
-        router.get "/domain-types" do
-          model.get_type_list_representation
-        end
+module RestfulObjects::Router::DomainTypeResources
+  def self.registered(router)
+    # D.21 Domain Types
+    router.get "/domain-types" do
+      model.get_type_list_representation
+    end
 
-        # D.22 Domain Type
-        router.get "/domain-types/:domain_type" do
-          model.types[params[:domain_type]].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.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.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.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.26 Domain Type Action Parameter
 
-        # D.27 Domain Type Action Invoke
-      end
-    end
+    # D.27 Domain Type Action Invoke
   end
 end
-

data/lib/restful_objects/router/supporting_resources.rb

@@ -1,39 +1,34 @@
-module RestfulObjects
-  module Router
-    module SupportingResources
-      def self.registered(router)
-        # B.5 Homepage
-        router.get '/' do
-          model.get_homepage
-        end
+module RestfulObjects::Router::SupportingResources
+  def self.registered(router)
+    # B.5 Homepage
+    router.get '/' do
+      model.get_homepage_representation_response
+    end
 
-        # B.6 User
-        router.get '/user' do
-          model.get_user_as_json
-        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.7 Services
+    router.get '/services' do
+      model.get_services
+    end
 
-        # B.8 Version
-        router.get '/version' do
-          model.get_version
-        end
+    # B.8 Version
+    router.get '/version' do
+      model.get_version_representation_response
+    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
+    # 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
+    # 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
-

data/lib/restful_objects/version.rb

@@ -1,3 +1,3 @@
 module RestfulObjects
-  VERSION = '0.0.7'
+  VERSION = '0.0.8'
 end

data/spec/integration/domain-types_actions_spec.rb

@@ -1,7 +1,6 @@
-# encoding: utf-8
 require_relative '../spec_helper'
 
-describe '/domain-types/:type/actions/:action' do
+describe '=> /domain-types/:type/actions/' do
   before(:all) do
     RestfulObjects::DomainModel.current.reset
   end
@@ -40,4 +39,3 @@ describe '/domain-types/:type/actions/:action' do
     last_response.body.should match_json_expression expected
   end
 end
-

data/spec/integration/domain-types_collections_spec.rb

@@ -1,45 +1,7 @@
-# encoding: utf-8
 require_relative '../spec_helper'
 
-describe '/domain-types/:type/collections/:collection' do
+describe '=> /domain-types/:type/collections/' do
   before(:all) do
     RestfulObjects::DomainModel.current.reset
   end
-
-  it 'should generate a collection description representation' do
-    class CollectionTest
-      include RestfulObjects::Object
-      collection :items, 'ItemClass', friendly_name: 'item collection', description: 'a collection description'
-    end
-
-    expected = {
-      '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' }
-      ],
-      'extensions' => wildcard_matcher
-    }
-
-    get '/domain-types/CollectionTest/collections/items'
-    last_response.body.should match_json_expression expected
-  end
 end
-