restful_objects 0.0.7 → 0.0.8

data/lib/restful_objects/domain_model/types/collection_description.rb

@@ -1,47 +1,46 @@
-module RestfulObjects
-  class CollectionDescription
-    include LinkGenerator
-    attr_reader :id, :type, :read_only
-    attr_accessor :friendly_name, :description, :plural_form, :member_order, :disabled_reason
+class RestfulObjects::CollectionDescription
+  include RestfulObjects::LinkGenerator
 
-    def initialize(id, type, domain_type, options = {})
-      @id = id
-      @type = type
-      @domain_type = domain_type
-      @read_only = options[:read_only].nil? ? false : options[:read_only]
-      @disabled_reason = options[:disabled_reason] || 'read only collection' if read_only
-      @friendly_name = options[:friendly_name] || id
-      @description = options[:description] || id
-      @plural_form = options[:plural_form]
-      @member_order = options[:member_order]
-    end
+  attr_reader :id, :type, :read_only
+  attr_accessor :friendly_name, :description, :plural_form, :member_order, :disabled_reason
 
-    def get_representation
-      representation = {
-        'id' => id,
-        'memberOrder' => member_order,
-        'links' => [
-          link_to(:self, "/domain-types/#{@domain_type}/collections/#{@id}", :collection_description),
-          link_to(:up, "/domain-types/#{@domain_type}", :domain_type),
-          link_to(:return_type, "/domain-types/list", :domain_type),
-          link_to(:element_type, "/domain-types/#{@type}", :domain_type)
-        ],
-        'extensions' => metadata
-      }
+  def initialize(id, type, domain_type, options = {})
+    @id = id
+    @type = type
+    @domain_type = domain_type
+    @read_only = options[:read_only].nil? ? false : options[:read_only]
+    @disabled_reason = options[:disabled_reason] || 'read only collection' if read_only
+    @friendly_name = options[:friendly_name] || id
+    @description = options[:description] || id
+    @plural_form = options[:plural_form]
+    @member_order = options[:member_order]
+  end
+
+  def get_representation
+    representation = {
+      'id' => id,
+      'memberOrder' => member_order,
+      'links' => [
+        link_to(:self, "/domain-types/#{@domain_type}/collections/#{@id}", :collection_description),
+        link_to(:up, "/domain-types/#{@domain_type}", :domain_type),
+        link_to(:return_type, "/domain-types/list", :domain_type),
+        link_to(:element_type, "/domain-types/#{@type}", :domain_type)
+      ],
+      'extensions' => metadata
+    }
 
-      representation['friendlyName'] = friendly_name if friendly_name
-      representation['description'] = description if description
+    representation['friendlyName'] = friendly_name if friendly_name
+    representation['description'] = description if description
 
-      representation.to_json
-    end
+    representation.to_json
+  end
 
-    def metadata
-      { 'friendlyName' => friendly_name,
-        'description' => description,
-        'returnType' => 'list',
-        'elementType' => type,
-        'memberOrder' => member_order,
-        'pluralForm' => plural_form }
-    end
+  def metadata
+    { 'friendlyName' => friendly_name,
+      'description' => description,
+      'returnType' => 'list',
+      'elementType' => type,
+      'memberOrder' => member_order,
+      'pluralForm' => plural_form }
   end
 end

data/lib/restful_objects/domain_model/types/domain_type.rb

@@ -2,129 +2,126 @@ require_relative 'property_description'
 require_relative 'collection_description'
 require_relative 'action_description'
 
-module RestfulObjects
-  class DomainType
-    include LinkGenerator
-
-    attr_reader :id, :is_service, :properties, :collections, :actions
-    attr_accessor :friendly_name, :plural_name, :description
-
-    def initialize(id)
-      @id            = id
-      @properties    = {}
-      @collections   = {}
-      @actions       = {}
-      @is_service    = false
-      @friendly_name = ''
-      @plural_name   = ''
-      @description   = ''
-    end
+class RestfulObjects::DomainType
+  include RestfulObjects::LinkGenerator
+
+  attr_reader :id, :is_service, :properties, :collections, :actions
+  attr_accessor :friendly_name, :plural_name, :description
+
+  def initialize(id)
+    @id            = id
+    @properties    = {}
+    @collections   = {}
+    @actions       = {}
+    @is_service    = false
+    @friendly_name = ''
+    @plural_name   = ''
+    @description   = ''
+  end
 
-    def register_property(name, return_type, options = {})
-      options[:member_order] ||= @properties.count + 1
-      @properties[name]        = PropertyDescription.new(name, @id, return_type, options)
-    end
+  def register_property(name, return_type, options = {})
+    options[:member_order] ||= @properties.count + 1
+    @properties[name]        = RestfulObjects::PropertyDescription.new(name, @id, return_type, options)
+  end
 
-    def register_collection(name, type, options = {})
-      options[:member_order] ||= @collections.count + 1
-      @collections[name]       = CollectionDescription.new(name, type, @id, options)
-    end
+  def register_collection(name, type, options = {})
+    options[:member_order] ||= @collections.count + 1
+    @collections[name]       = RestfulObjects::CollectionDescription.new(name, type, @id, options)
+  end
 
-    def register_action(name, options = {})
-      options[:member_order] ||= @actions.count + 1
-      @actions[name]           = ActionDescription.new(name, @id, options)
-    end
+  def register_action(name, options = {})
+    options[:member_order] ||= @actions.count + 1
+    @actions[name]           = RestfulObjects::ActionDescription.new(name, @id, options)
+  end
 
-    def get_representation
-      { 'name' => @id,
-        'domainType' => @id,
-        'friendlyName' => @friendly_name,
-        'pluralName' => @plural_name,
-        'description' => @description,
-        'isService' => @is_service,
-        'members' => get_members,
-        'typeActions' => get_type_actions,
-        'links' => [ link_to(:self, "/domain-types/#{@id}", :domain_type) ],
-        'extensions' => {}
-      }.to_json
-    end
+  def get_representation
+    { 'name' => @id,
+      'domainType' => @id,
+      'friendlyName' => @friendly_name,
+      'pluralName' => @plural_name,
+      'description' => @description,
+      'isService' => @is_service,
+      'members' => get_members,
+      'typeActions' => get_type_actions,
+      'links' => [ link_to(:self, "/domain-types/#{@id}", :domain_type) ],
+      'extensions' => {}
+    }.to_json
+  end
 
-    def new_proto_persistent_object
-      persist_link = link_to(:persist, "/objects/#{id}", :object, method: 'POST')
-      persist_link['arguments'] = { 'members' => {} }
-      members = {}
-      properties.each do |name, property|
-        if not property.optional
-          persist_link['arguments']['members'][name] = {
-            'value' => nil,
-            'extensions' => property.metadata }
-        end
-        members[name] = { 'value' => nil }
+  def new_proto_persistent_object
+    persist_link = link_to(:persist, "/objects/#{id}", :object, method: 'POST')
+    persist_link['arguments'] = { 'members' => {} }
+    members = {}
+    properties.each do |name, property|
+      if not property.optional
+        persist_link['arguments']['members'][name] = {
+          'value' => nil,
+          'extensions' => property.metadata }
       end
-
-      { 'title' => "New #{id}",
-        'members' => members,
-        'links' => [ persist_link ],
-        'extensions' => {} }
+      members[name] = { 'value' => nil }
     end
 
-    def post_prototype_object(members_json)
-      members = JSON.parse(members_json)['members']
+    { 'title' => "New #{id}",
+      'members' => members,
+      'links' => [ persist_link ],
+      'extensions' => {} }
+  end
+
+  def post_prototype_object(members_json)
+    members = JSON.parse(members_json)['members']
 
-      new_object = Object.const_get(@id.to_sym).new
+    new_object = Object.const_get(@id.to_sym).new
 
-      members.each do |name, value|
-        if properties.include?(name) then
-          new_object.put_property_as_json(name, value.to_json)
-        else
-          raise "member of property '#{name}' not found in type '#{@id}'"
-        end
+    members.each do |name, value|
+      if properties.include?(name) then
+        new_object.ro_put_property_and_get_response(name, value.to_json)
+      else
+        raise "member of property '#{name}' not found in type '#{@id}'"
       end
-
-      new_object.get_representation
     end
 
-    def metadata
-      { 'domainType' => id,
-        'friendlyName' => friendly_name,
-        'pluralName' => plural_name,
-        'description' => description,
-        'isService' => is_service }
-    end
+    new_object.ro_get_representation_response
+  end
 
-    private
+  def metadata
+    { 'domainType' => id,
+      'friendlyName' => friendly_name,
+      'pluralName' => plural_name,
+      'description' => description,
+      'isService' => is_service }
+  end
 
-      def get_members
-        properties_members.merge(collections_members.merge(actions_members))
-      end
+  protected
 
-      def properties_members
-        result = Hash.new
-        @properties.each do |name, property|
-          result[name] = link_to(:property, "/domain-types/#{@id}/properties/#{name}", :property_description)
-        end
-        result
-      end
+  def get_members
+    ro_properties_members.merge(collections_members.merge(actions_members))
+  end
 
-      def collections_members
-        result = Hash.new
-        @collections.each do |name, collection|
-          result[name] = link_to(:collection, "/domain-types/#{@id}/collections/#{name}", :collection_description)
-        end
-        result
-      end
+  def properties_members
+    result = {}
+    @properties.each do |name, property|
+      result[name] = link_to(:property, "/domain-types/#{@id}/properties/#{name}", :property_description)
+    end
+    result
+  end
 
-      def actions_members
-        result = Hash.new
-        @actions.each do |name, action|
-          result[name] = link_to(:action, "/domain-types/#{@id}/actions/#{name}", :action_description)
-        end
-        result
-      end
+  def collections_members
+    result = {}
+    @collections.each do |name, collection|
+      result[name] = link_to(:collection, "/domain-types/#{@id}/collections/#{name}", :collection_description)
+    end
+    result
+  end
 
-      def get_type_actions
-        {}
-      end
+  def actions_members
+    result = {}
+    @actions.each do |name, action|
+      result[name] = link_to(:action, "/domain-types/#{@id}/actions/#{name}", :action_description)
+    end
+    result
   end
-end
 
+  def get_type_actions
+    {}
+  end
+end

data/lib/restful_objects/domain_model/types/parameter_description.rb

@@ -1,60 +1,55 @@
-module RestfulObjects
-  class ParameterDescription
-    include LinkGenerator
+class RestfulObjects::ParameterDescription
+  include RestfulObjects::LinkGenerator
 
-    attr_reader :id, :name, :number, :kind_type, :type
-    attr_accessor :friendly_name, :description, :optional, :max_length, :pattern, :format
+  attr_reader :id, :name, :number, :kind_type, :type
+  attr_accessor :friendly_name, :description, :optional, :max_length, :pattern, :format
 
-    def initialize(id, definition, number)
-      @id = id
-      @name = id
+  def initialize(id, definition, number)
+    @id = id
+    @name = id
 
-      if definition.is_a? Array # [type, options]
-        if [:string, :int, :decimal, :date, :blob].include?(definition.first) # scalar
-          @kind_type = :scalar
-          @type = definition.first
-        elsif definition.first.is_a?(Class) # object type
-          @kind_type = :object
-          @type = definition.first.name
-        elsif definition.first.is_a?(Strign) # object type
-          @kind_type = :object
-          @type = definition.first
-        else
-          raise "unssuported parameter definition type #{definition.class}"
-        end
-        options = definition.last
-      elsif definition.is_a? Symbol # scalar type
+    if definition.is_a?(Array)# [type, options]
+      if [:string, :int, :decimal, :date, :blob].include?(definition.first) # scalar
         @kind_type = :scalar
-        @type = definition
-        raise "result type for scalar '#{@type}' unssuported" if not [:string, :int, :decimal, :date, :blob].include?(@type)
-      elsif definition.is_a? String # object type
+        @type = definition.first
+      elsif definition.first.is_a?(Class) # object type
         @kind_type = :object
-        @type = definition
-      elsif definition.is_a? Class # object type
+        @type = definition.first.name
+      elsif definition.first.is_a?(Strign) # object type
         @kind_type = :object
-        @type = definition.to_s
+        @type = definition.first
       else
         raise "unssuported parameter definition type #{definition.class}"
       end
-
-      options ||= {}
-      @number = options[:number] || number
-      @friendly_name = options[:friendly_name] || id
-      @description = options[:description] || id
-      @optional = options[:optional].nil? ? true : options[:optional]
-      @max_length = options[:max_length]
-      @pattern = options[:pattern]
+      options = definition.last
+    elsif definition.is_a?(Symbol) # scalar type
+      @kind_type = :scalar
+      @type = definition
+      raise "result type for scalar '#{@type}' unssuported" unless [:string, :int, :decimal, :date, :blob].include?(@type)
+    elsif definition.is_a?(String)# object type
+      @kind_type = :object
+      @type = definition
+    elsif definition.is_a?(Class)# object type
+      @kind_type = :object
+      @type = definition.to_s
+    else
+      raise "unssuported parameter definition type #{definition.class}"
     end
 
-    def metadata
-      result = { 'friendlyName' => friendly_name,
-                 'description' => description,
-                 'optional' => optional,
-                 'returnType' => type }
-      result['maxLength'] = max_length if max_length
-      result['pattern'] = pattern if pattern
-      result['format'] = format if format
-      result
-    end
+    options ||= {}
+    @number = options[:number] || number
+    @friendly_name = options[:friendly_name] || id
+    @description = options[:description] || id
+    @optional = options[:optional].nil? ? true : options[:optional]
+    @max_length = options[:max_length]
+    @pattern = options[:pattern]
+  end
+
+  def metadata
+    result = { 'friendlyName' => friendly_name, 'description' => description, 'optional' => optional, 'returnType' => type }
+    result['maxLength'] = max_length if max_length
+    result['pattern'] = pattern if pattern
+    result['format'] = format if format
+    result
   end
 end

data/lib/restful_objects/domain_model/types/parameter_description_list.rb

@@ -1,18 +1,15 @@
 require_relative 'parameter_description'
 
-module RestfulObjects
-  class ParameterDescriptionList
-    extend Forwardable
+class RestfulObjects::ParameterDescriptionList
+  extend Forwardable
 
-    def initialize
-      @parameters = Hash.new
-    end
-
-    def add(id, definition)
-      @parameters[id] = ParameterDescription.new(id, definition, count + 1)
-    end
+  def initialize
+    @parameters = Hash.new
+  end
 
-    def_delegators :@parameters, :[], :each, :include?, :count, :empty?
+  def add(id, definition)
+    @parameters[id] = RestfulObjects::ParameterDescription.new(id, definition, count + 1)
   end
-end
 
+  def_delegators :@parameters, :[], :each, :include?, :count, :empty?
+end

data/lib/restful_objects/domain_model/types/property_description.rb

@@ -1,75 +1,73 @@
-module RestfulObjects
-  class PropertyDescription
-    include LinkGenerator
+class RestfulObjects::PropertyDescription
+  include RestfulObjects::LinkGenerator
 
-    attr_accessor :id, :domain_type, :return_type, :is_reference, :friendly_name, :description, :optional, :read_only,
-                  :member_order, :max_length, :disabled_reason, :pattern
+  attr_accessor :id, :domain_type, :return_type, :is_reference, :friendly_name, :description, :optional, :read_only,
+                :member_order, :max_length, :disabled_reason, :pattern
 
-    def initialize(id, domain_type, return_type, options)
-      if return_type.is_a?(Hash)
-        raise "hash with :object key expected for property reference" unless return_type.has_key?(:object)
-      else
-        raise "property type #{return_type} usupported" if not [:string, :int, :bool, :decimal, :date, :blob].include?(return_type)
-      end
-
-      @id              = id
-      @domain_type     = domain_type
-      if return_type.is_a?(Hash)
-        @return_type  = return_type[:object]
-        @is_reference = true
-      else
-        @return_type  = return_type
-        @is_reference = false
-      end
-      @friendly_name   = options[:friendly_name] || id
-      @description     = options[:description] || id
-      @optional        = options[:optional].nil? ? true : options[:optional]
-      @read_only       = options[:read_only].nil? ? false : options[:read_only]
-      @member_order    = options[:member_order] || 1
-      @max_length      = options[:max_length]
-      @disabled_reason = options[:disabled_reason] || 'read-only property' if read_only
-      @pattern         = options[:pattern]
+  def initialize(id, domain_type, return_type, options)
+    if return_type.is_a?(Hash)
+      raise "hash with :object key expected for property reference" unless return_type.has_key?(:object)
+    else
+      raise "property type #{return_type} usupported" unless [:string, :int, :bool, :decimal, :date, :blob].include?(return_type)
     end
 
-    def get_representation
-      {
-        'id'           => @id,
-        'friendlyName' => friendly_name || '',
-        'description'  => description || '',
-        'optional'     => optional,
-        'memberOrder'  => @member_order,
-        'links'        => [
-          link_to(:self, "/domain-types/#{@domain_type}/properties/#{@id}", :property_description),
-          link_to(:up, "/domain-types/#{@domain_type}", :domain_type),
-          link_to(:return_type, "/domain-types/#{@return_type}", :domain_type)
-        ],
-        'extensions' => {}
-      }.to_json
+    @id              = id
+    @domain_type     = domain_type
+    if return_type.is_a?(Hash)
+      @return_type  = return_type[:object]
+      @is_reference = true
+    else
+      @return_type  = return_type
+      @is_reference = false
     end
+    @friendly_name   = options[:friendly_name] || id
+    @description     = options[:description] || id
+    @optional        = options[:optional].nil? ? true : options[:optional]
+    @read_only       = options[:read_only].nil? ? false : options[:read_only]
+    @member_order    = options[:member_order] || 1
+    @max_length      = options[:max_length]
+    @disabled_reason = options[:disabled_reason] || 'read-only property' if read_only
+    @pattern         = options[:pattern]
+  end
 
-    def metadata
-      result = { 'friendlyName' => friendly_name,
-                 'description' => description,
-                 'returnType' => return_type,
-                 'format' => format,
-                 'optional' => optional,
-                 'memberOrder' => member_order }
-      result['maxLength'] = max_length if max_length
-      result['pattern'] = pattern if pattern
-      result
-    end
+  def get_representation
+    {
+      'id'           => @id,
+      'friendlyName' => friendly_name || '',
+      'description'  => description || '',
+      'optional'     => optional,
+      'memberOrder'  => @member_order,
+      'links'        => [
+        link_to(:self, "/domain-types/#{@domain_type}/properties/#{@id}", :property_description),
+        link_to(:up, "/domain-types/#{@domain_type}", :domain_type),
+        link_to(:return_type, "/domain-types/#{@return_type}", :domain_type)
+      ],
+      'extensions' => {}
+    }.to_json
+  end
 
-    def format
-      case return_type
-        when :string
-          'string'
-      end
-    end
+  def metadata
+    result = { 'friendlyName' => friendly_name,
+               'description' => description,
+               'returnType' => return_type,
+               'format' => format,
+               'optional' => optional,
+               'memberOrder' => member_order }
+    result['maxLength'] = max_length if max_length
+    result['pattern'] = pattern if pattern
+    result
+  end
 
-    def get_value_as_json
-      { 'id' =>
-        { 'value' => '' }
-      }.to_json
+  def format
+    case return_type
+      when :string
+        'string'
     end
   end
+
+  def get_value_as_json
+    { 'id' =>
+      { 'value' => '' }
+    }.to_json
+  end
 end