restful_objects 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab9347453b22d38c76c2ab4c8711d1c1bd825ea4
-  data.tar.gz: 85549e79dde2126e2871841d00d8ea64dfeced79
+  metadata.gz: 6daedde1839a6d282abef3882e0611a409206afc
+  data.tar.gz: b787995164e0c9beffde4e8cab005110daba1ffd
 SHA512:
-  metadata.gz: 935b685a0063195caa79387cb71c7cd51377c93de88dde3a285df92413a3c5289ef3586173d67da34a2e1ea41b840036de54e1a5f7bf90ea5b1efcb18703b3b7
-  data.tar.gz: d68969dfe27106b61abd847c742244e34160d498a1da0c44a6b0e34615aed0940edbd8c3cc3c53232e045f558384a285db4e15f44c10f32d80c712f17b516ee6
+  metadata.gz: ab0df304178a6f7b0a15915e13d9d8f84f279e454b1b59e374516ee6517523506d372058bd8a63fdd0fbcbc5aa78349840e24a648853c7aaabe91ea2ecb12152
+  data.tar.gz: d04efcf54e7e54c066117529ac0410efe3bc4c8b5cdfa56d65e8f926e0c789fb88a67c191dec05811c8aff0ce8fea076582729f6a18a98484ac781f9248cf0f6

data/lib/restful_objects.rb

@@ -7,6 +7,5 @@ require 'forwardable'
 require 'sinatra/base'
 
 require_relative 'restful_objects/version'
-require_relative 'restful_objects/router/base'
+require_relative 'restful_objects/router'
 require_relative 'restful_objects/domain_model/domain_model'
-

data/lib/restful_objects/domain_model/domain_model.rb

@@ -54,7 +54,11 @@ module RestfulObjects
       @types[name] = DomainType.new(name)
     end
 
-    def get_homepage
+    def get_homepage_representation_response
+      [HTTP_OK, { 'Content-Type' => 'application/json' }, get_homepage_representation.to_json]
+    end
+
+    def get_homepage_representation
       { 'links' => [
           link_to(:self, '/', :homepage),
           link_to(:user, '/user', :user),
@@ -62,15 +66,15 @@ module RestfulObjects
           link_to(:version, '/version', :version),
           link_to(:domain_types, '/domain-types', :type_list)
         ],
-       'extensions' => {}
-      }.to_json
+       'extensions' => {} }
     end
 
-    def get_version
-      { 'links' => [
-          link_to(:self, '/version', :version),
-          link_to(:up, '/', :homepage),
-        ],
+    def get_version_representation_response
+      [HTTP_OK, { 'Content-Type' => 'application/json' }, get_version_representation.to_json]
+    end
+
+    def get_version_representation
+      { 'links' => [ link_to(:self, '/version', :version), link_to(:up, '/', :homepage) ],
         'specVersion' => '1.0',
         'optionalCapabilities' => {
           'blobsClobs' => true,
@@ -79,8 +83,7 @@ module RestfulObjects
           'protoPersistentObjects' => true,
           'validateOnly' => false
         },
-        'extensions' => {}
-      }.to_json
+        'extensions' => {} }
     end
 
     def get_user
@@ -130,7 +133,7 @@ module RestfulObjects
       values = []
       @services.each do |name, service|
         element = link_to(:service, "/services/#{name}", :object, service_id: name)
-        element['title'] = service.title
+        element['title'] = service.ro_title
         values << element
       end
       values

data/lib/restful_objects/domain_model/helpers/link_generator.rb

@@ -1,104 +1,116 @@
-module RestfulObjects
-  module LinkGenerator
-      def link_to(rel, href, type, options = {})
-        link = {
-          'rel' => generate_rel(rel, options),
-          'href' => RestfulObjects::DomainModel.current.base_url + href,
-          'type' => generate_repr_type(type, options[:domain_type], options[:element_type]),
-          'method' => options[:method] || 'GET' }
+module RestfulObjects::LinkGenerator
+  HTTP_OK = 200
 
-        link['arguments'] = options[:arguments] if options[:arguments]
+  def link_to(rel, href, type, options = {})
+    link = {
+      'rel' => generate_rel(rel, options),
+      'href' => RestfulObjects::DomainModel.current.base_url + href,
+      'type' => generate_repr_type(type, options[:domain_type], options[:element_type]),
+      'method' => options[:method] || 'GET' }
 
-        link
-      end
+    link['arguments'] = options[:arguments] if options[:arguments]
+
+    link
+  end
 
-      def generate_rel(rel, options = {})
-        if [:self, :up, :next, :previous, :icon, :help].include?(rel)
-          rel.to_s
-        elsif rel == :described_by
-          'describedby'
-        else
-          if [:action, :action_param, :collection, :delete, :domain_type, :domain_types, :element, :element_type, :persist,
-              :property, :return_type, :services, :update, :user, :version].include?(rel)
-            'urn:org.restfulobjects:rels/' + underscore_to_hyphen_string(rel)
-          else
-            'urn:org.restfulobjects:rels/' +
-              case rel
-                when :add_to
-                  'add-to;collection="' + options[:collection] + '"'
-                when :attachment
-                  'attachment;property="' + options[:property] + '"'
-                when :choice
-                  if options[:property]
-                    'choice;property="' + options[:property] + '"'
-                  elsif options[:action]
-                    'choice;action="' + options[:action] + '"'
-                  elsif options[:param]
-                    'choice;param="' + options[:param] + '"'
-                  else
-                    raise 'option not found for choice rel'
-                  end
-                when :clear
-                  'clear;property="' + options[:property] + '"'
-                when :details
-                  if options[:property]
-                    'details;property="' + options[:property] + '"'
-                  elsif options[:collection]
-                    'details;collection="' + options[:collection] + '"'
-                  elsif options[:action]
-                    'details;action="' + options[:action] + '"'
-                  else
-                    raise 'option not found for details rel'
-                  end
-                when :invoke
-                  if options[:action]
-                    'invoke;action="' + options[:action] + '"'
-                  elsif options[:type_action]
-                    'invoke;typeaction="' + options[:type_action] + '"'
-                  else
-                    raise 'option not found for invoke rel'
-                  end
-                when :modify
-                  'modify;property="' + options[:property] + '"'
-                when :remove_from
-                  'remove-from;collection="' + options[:collection] + '"'
-                when :service
-                  'service;serviceId="' + options[:service_id] + '"'
-                when :value
-                  if options[:property]
-                    'value;property="' + options[:property] + '"'
-                  elsif options[:collection]
-                    'value;collection="' + options[:collection] + '"'
-                  else
-                    raise 'option not found for value rel'
-                  end
-                else
-                  raise "rel invalid: #{rel}"
+  def generate_rel(rel, options = {})
+    if [:self, :up, :next, :previous, :icon, :help].include?(rel)
+      rel.to_s
+    elsif rel == :described_by
+      'describedby'
+    else
+      if [:action, :action_param, :collection, :delete, :domain_type, :domain_types, :element, :element_type, :persist,
+          :property, :return_type, :services, :update, :user, :version].include?(rel)
+        'urn:org.restfulobjects:rels/' + underscore_to_hyphen_string(rel)
+      else
+        'urn:org.restfulobjects:rels/' +
+          case rel
+            when :add_to
+              'add-to;collection="' + options[:collection] + '"'
+            when :attachment
+              'attachment;property="' + options[:property] + '"'
+            when :choice
+              if options[:property]
+                'choice;property="' + options[:property] + '"'
+              elsif options[:action]
+                'choice;action="' + options[:action] + '"'
+              elsif options[:param]
+                'choice;param="' + options[:param] + '"'
+              else
+                raise 'option not found for choice rel'
+              end
+            when :clear
+              'clear;property="' + options[:property] + '"'
+            when :details
+              if options[:property]
+                'details;property="' + options[:property] + '"'
+              elsif options[:collection]
+                'details;collection="' + options[:collection] + '"'
+              elsif options[:action]
+                'details;action="' + options[:action] + '"'
+              else
+                raise 'option not found for details rel'
               end
+            when :invoke
+              if options[:action]
+                'invoke;action="' + options[:action] + '"'
+              elsif options[:type_action]
+                'invoke;typeaction="' + options[:type_action] + '"'
+              else
+                raise 'option not found for invoke rel'
+              end
+            when :modify
+              'modify;property="' + options[:property] + '"'
+            when :remove_from
+              'remove-from;collection="' + options[:collection] + '"'
+            when :service
+              'service;serviceId="' + options[:service_id] + '"'
+            when :value
+              if options[:property]
+                'value;property="' + options[:property] + '"'
+              elsif options[:collection]
+                'value;collection="' + options[:collection] + '"'
+              else
+                raise 'option not found for value rel'
+              end
+            else
+              raise "rel invalid: #{rel}"
           end
-        end
       end
+    end
+  end
 
-      def generate_repr_type(type, domain_type = nil, element_type = nil)
-        valid_repr = [:homepage, :user, :version, :list, :object, :object_property, :object_collection, :object_action,
-         :object_result, :action_result, :type_list, :domain_type, :property_description, :collection_description,
-         :action_description, :action_param_description, :type_action_result, :error, :services]
+  def generate_repr_type(type, domain_type = nil, element_type = nil)
+    valid_repr = [:homepage, :user, :version, :list, :object, :object_property, :object_collection, :object_action,
+     :object_result, :action_result, :type_list, :domain_type, :property_description, :collection_description,
+     :action_description, :action_param_description, :type_action_result, :error, :services]
 
-        raise "repr-type invalid: #{type.to_s}" if not valid_repr.include?(type)
+    raise "repr-type invalid: #{type.to_s}" if not valid_repr.include?(type)
 
-        repr = 'application/json;profile="urn:org.restfulobjects:repr-types/' + underscore_to_hyphen_string(type) + '"'
+    repr = 'application/json;profile="urn:org.restfulobjects:repr-types/' + underscore_to_hyphen_string(type) + '"'
 
-        if domain_type && [:object, :action].include?(type)
-          repr += ';x-ro-domain-type="' + domain_type + '"'
-        elsif element_type && [:object_collection, :action].include?(type)
-          repr +=';x-ro-element-type="' + element_type + '"'
-        end
+    if domain_type && [:object, :action].include?(type)
+      repr += ';x-ro-domain-type="' + domain_type + '"'
+    elsif element_type && [:object_collection, :action].include?(type)
+      repr +=';x-ro-element-type="' + element_type + '"'
+    end
 
-        repr
-      end
+    repr
+  end
 
-      def underscore_to_hyphen_string(symbol)
-        symbol.to_s.sub('_', '-')
-      end
+  def underscore_to_hyphen_string(symbol)
+    symbol.to_s.sub('_', '-')
+  end
+
+  def ro_content_type_for_object(domain_type)
+    "application/json;profile=\"urn:org.restfulobjects:repr-types/object\";x-ro-domain-type=\"#{domain_type}\""
+  end
+
+  def ro_content_type_for_property
+    "application/json;profile=\"urn:org.restfulobjects:repr-types/object-property\""
+  end
+
+  def ro_content_type_for_object_collection(element_type)
+    "application/json;profile=\"urn:org.restfulobjects:repr-types/object-collection\";x-ro-element-type=\"#{element_type}\""
   end
 end

data/lib/restful_objects/domain_model/mixins/object.rb

@@ -4,21 +4,18 @@ require_relative 'object_properties'
 require_relative 'object_collections'
 require_relative 'object_actions'
 
-module RestfulObjects
-  module Object
-    include LinkGenerator
+module RestfulObjects::Object
+  include RestfulObjects::LinkGenerator
 
-    def self.included(base)
-      RestfulObjects::DomainModel.current.register_type(base.name)
+  def self.included(base)
+    RestfulObjects::DomainModel.current.register_type(base.name)
 
-      base.class_eval do
-        extend ObjectMacros
-        include ObjectBase
-        include ObjectProperties
-        include ObjectCollections
-        include ObjectActions
-      end
+    base.class_eval do
+      extend RestfulObjects::ObjectMacros
+      include RestfulObjects::ObjectBase
+      include RestfulObjects::ObjectProperties
+      include RestfulObjects::ObjectCollections
+      include RestfulObjects::ObjectActions
     end
   end
 end
-

data/lib/restful_objects/domain_model/mixins/object_actions.rb

@@ -1,135 +1,124 @@
-module RestfulObjects
-  module ObjectActions
-    def actions_members
-      members = {}
-      rs_type.actions.each do |name, action|
-        members[name] = {
-          'memberType' => 'action',
-          'links' => [
-            !is_service ?
-              link_to(:details, "/objects/#{self.class.name}/#{object_id}/actions/#{name}", :object_action, action: name)
-              :
-              link_to(:details, "/services/#{self.class.name}/actions/#{name}", :object_action, action: name)
-          ],
-          'extensions' => action.metadata
-        }
-      end
-      members
-    end
+module RestfulObjects::ObjectActions
+  def ro_get_action_type(name)
+    ro_domain_type.actions[name]
+  end
 
-    def get_action(action)
-      { 'id' => action,
-        'parameters' => generate_parameters(action),
-        'links' => [ rs_action_link(action), rs_action_up_link, rs_invoke_link(action) ],
-        'extensions' => rs_type.actions[action].metadata
-      }.to_json
-    end
+  def ro_get_action_response(name)
+    { 'id' => name,
+      'parameters' => generate_parameters(name),
+      'links' => [ rs_action_link(name), rs_action_up_link, rs_invoke_link(name) ],
+      'extensions' => ro_get_action_type(name).metadata
+    }.to_json
+  end
 
-    def generate_parameters(action)
-      parameters = Hash.new
-      rs_type.actions[action].parameters.each do |name, parameter|
-        parameters[name] = {
-          'links' => [],
-          'extensions' => parameter.metadata
-        }
+  def ro_parse_action_arguments(name, arguments, json)
+    result = []
+    ro_get_action_type(name).parameters.each do |name, parameter|
+      case parameter.type
+        when :int
+          result << arguments[name.to_s]['value'].to_i
+        else
+          result << arguments[name.to_s]['value']
       end
-      parameters
     end
+    result
+  end
 
-    def get_action_invoke(action, json)
-      raise 'action does not exists' if not rs_type.actions.include?(action)
-      action_description = rs_type.actions[action]
-      json == '' ? {} : arguments = JSON.parse(json)
-      parameters = []
-      action_description.parameters.each do |name, parameter|
-        case parameter.type
-          when :int
-            parameters << arguments[name.to_s]['value'].to_i
-          else
-            parameters << arguments[name.to_s]['value']
-        end
-      end
+  def ro_encode_action_result
 
-      result = send(action.to_sym, *parameters)
+  end
+
+  def ro_invoke_action_and_get_response(name, json)
+    raise 'action does not exists' unless ro_get_action_type(name)
+
+    arguments = json == '' ? {} : JSON.parse(json)
+
+    result = send(name, *ro_parse_action_arguments(name, arguments, json))
 
-      action_link = link_to(:self, "/objects/#{self.class.name}/#{object_id}/actions/#{action}/invoke", :action_result)
-      action_link['arguments'] = arguments
+    action_link = link_to(:self, "/objects/#{self.class.name}/#{object_id}/actions/#{name}/invoke", :action_result)
+    action_link['arguments'] = arguments
 
-      response = {
-        'links' => [ action_link ],
-        'resultType' => 'scalar',
-        'result' => {
-          'links' => [],
-          'extensions' => { }
-        },
+    response = {
+      'links' => [ action_link ],
+      'resultType' => 'scalar',
+      'result' => {
+        'links' => [],
         'extensions' => { }
-      }
-
-      response['resultType'] = action_description.kind_result_type.to_s
-      if result.nil?
-        response['result'] = nil
-      else
-        case action_description.kind_result_type
-          when :scalar
-            response['resultType'] = 'scalar'
-            response['result']['value'] = encode_value(result, action_description.result_type)
-            response['result']['links'] = [ link_to(:return_type, '/domain-types/int', :domain_type) ]
-          when :object
-            response['resultType'] = 'object'
-            response['result'] = result.representation
-          when :proto_object
-            response['resultType'] = 'object'
-            response['result'] = result
-          when :list
-            response['resultType'] = 'list'
-            response['result']['links'] =
-              [ link_to(:element_type, "/domain-types/#{action_description.result_type.to_s}", :domain_type) ]
-            list = []
-            result.each do |member|
-              member_link = link_to(:element, "/objects/#{action_description.result_type.to_s}/#{member.rs_instance_id}", :object)
-              member_link['title'] = member.title
-              list << member_link
-            end
-            response['result']['value'] = list
-        end
-      end
+      },
+      'extensions' => { }
+    }
 
-      response.to_json
+    response['resultType'] = ro_get_action_type(name).kind_result_type.to_s
+    if result.nil?
+      response['result'] = nil
+    else
+      case ro_get_action_type(name).kind_result_type
+        when :scalar
+          response['resultType'] = 'scalar'
+          response['result']['value'] = encode_value(result, ro_get_action_type(name).result_type)
+          response['result']['links'] = [ link_to(:return_type, '/domain-types/int', :domain_type) ]
+        when :object
+          response['resultType'] = 'object'
+          response['result'] = result.ro_get_representation
+        when :proto_object
+          response['resultType'] = 'object'
+          response['result'] = result
+        when :list
+          response['resultType'] = 'list'
+          response['result']['links'] =
+            [ link_to(:element_type, "/domain-types/#{ro_get_action_type(name).result_type.to_s}", :domain_type) ]
+          list = []
+          result.each do |member|
+            member_link = link_to(:element, "/objects/#{ro_get_action_type(name).result_type.to_s}/#{member.ro_instance_id}", :object)
+            member_link['title'] = member.ro_title
+            list << member_link
+          end
+          response['result']['value'] = list
+      end
     end
 
-    def action_return_type(action)
-      RestfulObjects::DomainModel.current.types[self.class.name].actions[action].result_type
+    response.to_json
+  end
+
+#   def action_return_type(name)
+#     ro_get_action_type(name).result_type
+#   end
+
+  protected
+
+  def generate_parameters(action_name)
+    result = {}
+    ro_get_action_type(action_name).parameters.each do |name, parameter|
+      result[name] = { 'links' => [], 'extensions' => parameter.metadata }
     end
+    result
+  end
 
-    private
-
-      def rs_invoke_link(action)
-        invoke_link = is_service ?
-          link_to(:invoke, "/services/#{rs_type.id}/actions/#{action}/invoke", :action_result, action: action)
-          :
-          link_to(:invoke, "/objects/#{rs_type.id}/#{object_id}/actions/#{action}/invoke", :action_result, action: action)
-        invoke_link['arguments'] = {}
-        rs_type.actions[action].parameters.each do |name, action|
-          invoke_link['arguments'][name] = { 'value' => nil }
-        end
-        invoke_link
-      end
+  def rs_invoke_link(action)
+    invoke_link = ro_is_service? ?
+      link_to(:invoke, "/services/#{ro_domain_type.id}/actions/#{action}/invoke", :action_result, action: action)
+      :
+      link_to(:invoke, "/objects/#{ro_domain_type.id}/#{object_id}/actions/#{action}/invoke", :action_result, action: action)
+    invoke_link['arguments'] = {}
+    ro_domain_type.actions[action].parameters.each do |name, action|
+      invoke_link['arguments'][name] = { 'value' => nil }
+    end
+    invoke_link
+  end
 
-      def rs_action_link(action)
-        if is_service
-          link_to(:self, "/services/#{self.class.name}/actions/#{action}", :object_action)
-        else
-          link_to(:self, "/objects/#{self.class.name}/#{object_id}/actions/#{action}", :object_action)
-        end
-      end
+  def rs_action_link(action)
+    if ro_is_service?
+      link_to(:self, "/services/#{self.class.name}/actions/#{action}", :object_action)
+    else
+      link_to(:self, "/objects/#{self.class.name}/#{object_id}/actions/#{action}", :object_action)
+    end
+  end
 
-      def rs_action_up_link
-        if is_service
-          link_to(:up, "/services/#{rs_type.id}", :object)
-        else
-          link_to(:up, "/objects/#{self.class.name}/#{object_id}", :object)
-        end
-      end
+  def rs_action_up_link
+    if ro_is_service?
+      link_to(:up, "/services/#{ro_domain_type.id}", :object)
+    else
+      link_to(:up, "/objects/#{self.class.name}/#{object_id}", :object)
+    end
   end
 end
-