restful_objects 0.0.2 → 0.0.3

data/lib/restful_objects/http_response.rb

@@ -1,11 +1,11 @@
-module RestfulObjects
-  class HttpResponse
-    attr_accessor :body, :content_type, :status
-
-    def initialize(body, content_type, status = 200)
-      @body = body
-      @content_type = content_type
-      @status = status
-    end
-  end
-end
+module RestfulObjects
+  class HttpResponse
+    attr_accessor :body, :content_type, :status
+
+    def initialize(body, content_type, status = 200)
+      @body = body
+      @content_type = content_type
+      @status = status
+    end
+  end
+end

data/lib/restful_objects/link_generator.rb

@@ -1,104 +1,104 @@
-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' }
-
-        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}"
-              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]
-
-        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) + '"'
-
-        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
-
-      def underscore_to_hyphen_string(symbol)
-        symbol.to_s.sub('_', '-')
-      end
-  end
-end
+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' }
+
+        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}"
+              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]
+
+        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) + '"'
+
+        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
+
+      def underscore_to_hyphen_string(symbol)
+        symbol.to_s.sub('_', '-')
+      end
+  end
+end

data/lib/restful_objects/object.rb

@@ -1,20 +1,20 @@
-# encoding: utf-8
-
-module RestfulObjects
-  module Object
-    include LinkGenerator
-
-    def self.included(base)
-      RestfulObjects::DomainModel.current.types.add(base.name)
-
-      base.class_eval do
-        extend ObjectMacros
-        include ObjectBase
-        include ObjectProperties
-        include ObjectCollections
-        include ObjectActions
-      end
-    end
-  end
-end
-
+# encoding: utf-8
+
+module RestfulObjects
+  module Object
+    include LinkGenerator
+
+    def self.included(base)
+      RestfulObjects::DomainModel.current.types.add(base.name)
+
+      base.class_eval do
+        extend ObjectMacros
+        include ObjectBase
+        include ObjectProperties
+        include ObjectCollections
+        include ObjectActions
+      end
+    end
+  end
+end
+

data/lib/restful_objects/object_actions.rb

@@ -1,134 +1,134 @@
-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
-
-    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 generate_parameters(action)
-      parameters = Hash.new
-      rs_type.actions[action].parameters.each do |name, parameter|
-        parameters[name] = {
-          'links' => [],
-          'extensions' => parameter.metadata
-        }
-      end
-      parameters
-    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]['value'].to_i
-          else
-            parameters << arguments[name]['value']
-        end
-      end
-
-      result = send(action.to_sym, *parameters)
-
-      action_link = link_to(:self, "/objects/#{self.class.name}/#{object_id}/actions/#{action}/invoke", :action_result)
-      action_link['arguments'] = arguments
-
-      response = {
-        'links' => [ action_link ],
-        'resultType' => 'scalar',
-        'result' => {
-          'links' => [],
-          'extensions' => { }
-        },
-        '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
-
-      response.to_json
-    end
-
-    def action_return_type(action)
-      RestfulObjects::DomainModel.current.types[self.class.name].actions[action].result_type
-    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_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_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
-  end
-end
+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
+
+    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 generate_parameters(action)
+      parameters = Hash.new
+      rs_type.actions[action].parameters.each do |name, parameter|
+        parameters[name] = {
+          'links' => [],
+          'extensions' => parameter.metadata
+        }
+      end
+      parameters
+    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
+
+      result = send(action.to_sym, *parameters)
+
+      action_link = link_to(:self, "/objects/#{self.class.name}/#{object_id}/actions/#{action}/invoke", :action_result)
+      action_link['arguments'] = arguments
+
+      response = {
+        'links' => [ action_link ],
+        'resultType' => 'scalar',
+        'result' => {
+          'links' => [],
+          'extensions' => { }
+        },
+        '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
+
+      response.to_json
+    end
+
+    def action_return_type(action)
+      RestfulObjects::DomainModel.current.types[self.class.name].actions[action].result_type
+    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_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_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
+  end
+end