restful_objects 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDhlYTM4MGRmZDMxOWQzM2JlYmQ5N2Q5NTFkM2YxZjhmYzQ1MDA1MQ==
+    ZTk4ZmFkNzBlZDBlZmIwNzkxMjVmYzY5Nzg1NGQ5N2IyMGIzODRiYg==
   data.tar.gz: !binary |-
-    ZGE4MmUxYTdiZTdiNDViNjI3NmIzMmIwZWMyZjJiYjAwZWIwMzFhMQ==
+    OGU3NDBlZDE3OWRhZmZmNThhN2YxM2Q4YTk5Mjk3NmRmMDI3Mzk1Yw==
 SHA512:
   metadata.gz: !binary |-
-    N2FhZjcwNzA2Mzc1YmQzZGRlZjliZGNjNjdhMjE4NzhiZDAwOGEzZTg4MmUx
-    NGRlYWYwOTU0NWM2OWZmZDVkNjA2YWZmNDM2ZjY3MDRmZTBjZmE2YTFjNDk5
-    OWIyZDllZjdjMjc4YWExZGFhOTIyM2I2NDBhMDYwN2M0NTIxNjA=
+    NDRmZDgzY2NkNzFiYzk1MjUyNTkyMTVkYzcyNzZmZjcyN2UwNDI1NWIwZjJk
+    ZjYzYjU2ZDFkZDNiMWRlZGMwYmM0Y2VlMzg0ZWFjMDcxMjQyNDhjMDU3MDVj
+    MDA5MGM2NmRiN2Q2MDNjYTgxYjc2MzhhZTU5ZDIxYzNlMDYzN2I=
   data.tar.gz: !binary |-
-    ZTU2ODM3N2RjODM0ZjBjNDU0YWVkNTYwN2U3MjFhZGI4OGQ3MDdkZWU0NmYx
-    ZjZlMTFjMTJjNzAxZWEyOWI1Yzg2MmMxMDliYTE3ZTNkYTI1YmE0ZjdmZWQx
-    MjExZDY2ZDk1MjM4NzBmODkyMTE1MDdkOTgxZDFkNzNkN2ZmMjE=
+    MGM4N2Y2MGU1MDMwNDk4MDJlMjE2MzZhODQ5Y2MxMDRjY2E2YmE0ZTYwYzQ4
+    M2JiODdhMDRkNzFjYjgwNTQxN2Y0ODJmNTlhOTZjNTFjYTJlNWZmMmE2NjQ0
+    NGJkZThmMTNkNzRmNGI4Y2U5YzcyYjExYWMwYmE3NTlkNjdmM2Q=

data/README.md

@@ -44,7 +44,8 @@ class Graph
   end
 end
 ```
- 
+You can check this example and more [here](https://github.com/vizcay/RestfulObjectsRubyExamples).
+
 ### How to install it?
 Run
 
@@ -64,7 +65,7 @@ to your's project Gemfile and 'bundle install' it.
 The source quality is at alpha state, and it was created mostly as a proof of concept. Still is has plenty of specs and a big percentage of the specification implemented, the grey areas are mostly related to errors and validations. It has been developed with MRI and hasn't been tested on other Ruby implementations.
 
 ### Dependencies
-- [Ruby 1.9.3 or higher](https://www.ruby-lang.org/‎)
+- [Ruby 1.9.3 or higher](https://www.ruby-lang.org/)
 - [Sinatra](http://www.sinatrarb.com/)
 - [RSpec](http://rspec.info/)
 - [json_expressions](https://github.com/chancancode/json_expressions) for json testing.

data/lib/restful_objects/action_description.rb

@@ -1,82 +1,96 @@
-module RestfulObjects
-  class ActionDescription
-    include LinkGenerator
-
-    attr_reader :id, :kind_result_type, :result_type, :parameters
-    attr_accessor :friendly_name, :description, :member_order, :disabled_reason
-
-    def initialize(id, result_type, domain_type, parameters = {}, options = {})
-      @id = id
-
-      if result_type == :void
-        result_type = [:void, :void]
-      elsif result_type.is_a?(Symbol)
-        result_type = [:scalar, result_type]
-      end
-      raise "result type should be a symbol or an array" if not result_type.is_a?(Array)
-      raise "result type kind '#{result_type.last}' unssuported" if
-        not [:void, :scalar, :object, :proto_object, :list].include?(result_type.first)
-      @kind_result_type = result_type.first
-      @result_type = result_type.last
-      case @kind_result_type
-        when :scalar
-          raise "result type for scalar '#{result_type.last}' unssuported" if
-            not [:string, :int, :decimal, :date, :blob].include?(@result_type)
-        when :object, :proto_object, :list
-          raise "result type should be a class or a string with a class name" if
-            not (@result_type.is_a?(Class) || @result_type.is_a?(String))
-      end
-
-      @parameters = ParameterDescriptionList.new
-      parameters.each { |name, definition| @parameters.add(name, definition) }
-
-      @domain_type = domain_type
-      @friendly_name = options[:friendly_name] || id
-      @description = options[:description] || id
-      @member_order = options[:member_order] || 0
-      @disabled_reason = options[:disabled_reason] || ''
-    end
-
-    def get_representation
-      representation = {
-        'id' => @id,
-        'hasParams' => has_params,
-        'memberOrder' => @member_order,
-        'parameters' => parameters_list,
-        'links' => [
-          link_to(:self, "/domain-types/#{@domain_type}/actions/#{@id}", :action_description),
-          link_to(:up, "/domain-types/#{@domain_type}", :domain_type),
-          link_to(:return_type, "/domain-types/#{result_type}", :domain_type)
-        ],
-        'extensions' => {}
-      }
-
-      representation['friendlyName'] = friendly_name if friendly_name
-      representation['description'] = description if description
-
-      representation.to_json
-    end
-
-    def metadata
-      result = { 'friendlyName' => friendly_name,
-                 'description' => description,
-                 'returnType' => result_type,
-                 'hasParams' => has_params,
-                 'memberOrder' => member_order }
-    end
-
-    def has_params
-      not @parameters.empty?
-    end
-
-    def parameters_list
-      result = {}
-      parameters.each do |name, parameter|
-        result[name] = {
-          'extension' => parameter.metadata
-        }
-      end
-      result
-    end
-  end
-end
+module RestfulObjects
+  class ActionDescription
+    include LinkGenerator
+
+    attr_reader :id, :kind_result_type, :result_type, :parameters
+    attr_accessor :friendly_name, :description, :member_order, :disabled_reason
+
+    def initialize(id, domain_type, options)
+      @id              = id
+      @domain_type     = domain_type
+      @friendly_name   = options[:friendly_name]   || id
+      @description     = options[:description]     || id
+      @member_order    = options[:member_order]    || 0
+      @disabled_reason = options[:disabled_reason] || ''
+
+      case options[:return_type]
+        when NilClass
+          @result_type      = :void
+          @kind_result_type = :void
+        when Symbol
+          if options[:return_type] == :void
+            @result_type      = :void
+            @kind_result_type = :void
+          else
+            raise "result type for scalar '#{options[:return_type]}' unssuported" unless [:string, :int, :bool, :decimal, :date, :blob].include?(options[:return_type])
+            @result_type      = options[:return_type]
+            @kind_result_type = :scalar
+          end
+        when Hash
+          options[:return_type]
+          if options[:return_type][:object]
+            @result_type      = options[:return_type][:object]
+            @kind_result_type = :object
+          elsif options[:return_type][:proto_object]
+            @result_type      = options[:return_type][:proto_object]
+            @kind_result_type = :proto_object
+          elsif options[:return_type][:list]
+            @result_type      = options[:return_type][:list]
+            @kind_result_type = :list
+          else
+            raise 'invalid return_type: object, proto_object or list key expected'
+          end
+          unless @result_type.is_a?(Class) or @result_type.is_a?(String)
+            raise 'return_type object, proto_object or list value should be a class or a string' 
+          end
+        else
+          raise 'invalid return_type: symbol or hash expected'
+      end
+
+      @parameters = ParameterDescriptionList.new
+      options[:parameters].each { |name, definition| @parameters.add(name, definition) } if options[:parameters]
+    end
+
+    def get_representation
+      representation = {
+        'id' => @id,
+        'hasParams' => has_params,
+        'memberOrder' => @member_order,
+        'parameters' => parameters_list,
+        'links' => [
+          link_to(:self, "/domain-types/#{@domain_type}/actions/#{@id}", :action_description),
+          link_to(:up, "/domain-types/#{@domain_type}", :domain_type),
+          link_to(:return_type, "/domain-types/#{result_type}", :domain_type)
+        ],
+        'extensions' => {}
+      }
+
+      representation['friendlyName'] = friendly_name if friendly_name
+      representation['description'] = description if description
+
+      representation.to_json
+    end
+
+    def metadata
+      result = { 'friendlyName' => friendly_name,
+                 'description' => description,
+                 'returnType' => result_type,
+                 'hasParams' => has_params,
+                 'memberOrder' => member_order }
+    end
+
+    def has_params
+      not @parameters.empty?
+    end
+
+    def parameters_list
+      result = {}
+      parameters.each do |name, parameter|
+        result[name] = {
+          'extension' => parameter.metadata
+        }
+      end
+      result
+    end
+  end
+end

data/lib/restful_objects/action_list.rb

@@ -1,17 +1,17 @@
-module RestfulObjects
-  class ActionList
-    extend Forwardable
-
-    def initialize(domain_type)
-      @actions = Hash.new
-      @domain_type = domain_type
-    end
-
-    def add(id, result_type, parameters = {}, options = {})
-      options[:member_order] ||= count + 1
-      @actions[id] = ActionDescription.new(id, result_type, @domain_type, parameters, options)
-    end
-
-    def_delegators :@actions, :[], :each, :include?, :count, :empty?
-  end
-end
+module RestfulObjects
+  class ActionList
+    extend Forwardable
+
+    def initialize(domain_type)
+      @actions = Hash.new
+      @domain_type = domain_type
+    end
+
+    def add(id, options = {})
+      options[:member_order] ||= count + 1
+      @actions[id] = ActionDescription.new(id, @domain_type, options)
+    end
+
+    def_delegators :@actions, :[], :each, :include?, :count, :empty?
+  end
+end

data/lib/restful_objects/collection_description.rb

@@ -1,47 +1,47 @@
-module RestfulObjects
-  class CollectionDescription
-    include LinkGenerator
-    attr_reader :id, :type, :read_only
-    attr_accessor :friendly_name, :description, :plural_form, :member_order, :disabled_reason
-
-    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.to_json
-    end
-
-    def metadata
-      { 'friendlyName' => friendly_name,
-        'description' => description,
-        'returnType' => 'list',
-        'elementType' => type,
-        'memberOrder' => member_order,
-        'pluralForm' => plural_form }
-    end
-  end
-end
+module RestfulObjects
+  class CollectionDescription
+    include LinkGenerator
+    attr_reader :id, :type, :read_only
+    attr_accessor :friendly_name, :description, :plural_form, :member_order, :disabled_reason
+
+    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.to_json
+    end
+
+    def metadata
+      { 'friendlyName' => friendly_name,
+        'description' => description,
+        'returnType' => 'list',
+        'elementType' => type,
+        'memberOrder' => member_order,
+        'pluralForm' => plural_form }
+    end
+  end
+end

data/lib/restful_objects/collection_list.rb

@@ -1,17 +1,17 @@
-module RestfulObjects
-  class CollectionList
-    extend Forwardable
-
-    def initialize(domain_type)
-      @domain_type = domain_type
-      @collections = Hash.new
-    end
-
-    def add(name, type, options = {})
-      options[:member_order] ||= count + 1
-      @collections[name] = CollectionDescription.new(name, type, @domain_type, options)
-    end
-
-    def_delegators :@collections, :[], :each, :each_key, :each_value, :include?, :count, :empty?, :clear
-  end
-end
+module RestfulObjects
+  class CollectionList
+    extend Forwardable
+
+    def initialize(domain_type)
+      @domain_type = domain_type
+      @collections = Hash.new
+    end
+
+    def add(name, type, options = {})
+      options[:member_order] ||= count + 1
+      @collections[name] = CollectionDescription.new(name, type, @domain_type, options)
+    end
+
+    def_delegators :@collections, :[], :each, :each_key, :each_value, :include?, :count, :empty?, :clear
+  end
+end

data/lib/restful_objects/domain_model.rb

@@ -1,79 +1,83 @@
-module RestfulObjects
-  class DomainModel
-    include LinkGenerator
-
-    attr_accessor :base_url, :compatible_mode
-    attr_reader :metadata_schema, :version, :user, :types, :services, :objects
-
-    def self.current
-      @current ||= DomainModel.new
-    end
-
-    def self.current=(value)
-      @current = value
-    end
-
-    def initialize
-      @base_url = 'http://localhost'
-      @metadata_schema = :selectable
-      @compatible_mode = false
-      @user = User.new(@base_url, 'anonymous')
-      @types = TypeList.new
-      @services = ServiceList.new(@base_url)
-      @objects = ObjectList.new(@base_url)
-    end
-
-    def get_homepage
-      { 'links' => [
-          link_to(:self, '/', :homepage),
-          link_to(:user, '/user', :user),
-          link_to(:services, '/services', :list),
-          link_to(:version, '/version', :version),
-          link_to(:domain_types, '/domain-types', :type_list)
-        ],
-       'extensions' => {}
-      }.to_json
-    end
-
-    def get_version
-      { 'links' => [
-          link_to(:self, '/version', :version),
-          link_to(:up, '/', :homepage),
-        ],
-        'specVersion' => '1.0',
-        'optionalCapabilities' => {
-          'blobsClobs' => true,
-          'deleteObjects' => true,
-          'domainModel' => metadata_schema.to_s,
-          'protoPersistentObjects' => true,
-          'validateOnly' => false
-        },
-        'extensions' => {}
-      }.to_json
-    end
-
-    def get_user
-      @user.get_as_json
-    end
-
-    def get_services
-      services.get_list
-    end
-
-    def metadata_schema=(value)
-      if not [:simple, :formal, :selectable].include?(value)
-        raise "invalid metadata schema, choose :simple, :formal or :selectable"
-      end
-      @metadata_schema = value
-    end
-
-    def reset
-      @base_url = 'http://localhost'
-      @user = nil
-      @types.clear
-      @services.clear
-      @objects.clear
-    end
-  end
-end
-
+module RestfulObjects
+  class DomainModel
+    include LinkGenerator
+
+    attr_accessor :base_url, :compatible_mode
+    attr_reader :metadata_schema, :version, :user, :types, :services, :objects
+
+    def self.current
+      @current ||= DomainModel.new
+    end
+
+    def self.current=(value)
+      @current = value
+    end
+
+    def initialize
+      @base_url = 'http://localhost'
+      @metadata_schema = :selectable
+      @compatible_mode = false
+      @user = User.new(@base_url, 'anonymous')
+      @types = TypeList.new
+      @services = ServiceList.new(@base_url)
+      @objects = ObjectList.new(@base_url)
+    end
+
+    def get_homepage
+      { 'links' => [
+          link_to(:self, '/', :homepage),
+          link_to(:user, '/user', :user),
+          link_to(:services, '/services', :list),
+          link_to(:version, '/version', :version),
+          link_to(:domain_types, '/domain-types', :type_list)
+        ],
+       'extensions' => {}
+      }.to_json
+    end
+
+    def get_version
+      { 'links' => [
+          link_to(:self, '/version', :version),
+          link_to(:up, '/', :homepage),
+        ],
+        'specVersion' => '1.0',
+        'optionalCapabilities' => {
+          'blobsClobs' => true,
+          'deleteObjects' => true,
+          'domainModel' => metadata_schema.to_s,
+          'protoPersistentObjects' => true,
+          'validateOnly' => false
+        },
+        'extensions' => {}
+      }.to_json
+    end
+
+    def get_user
+      @user.get_as_json
+    end
+
+    def get_services
+      services.get_list
+    end
+
+    def metadata_schema=(value)
+      if not [:simple, :formal, :selectable].include?(value)
+        raise "invalid metadata schema, choose :simple, :formal or :selectable"
+      end
+      @metadata_schema = value
+    end
+
+    def reset
+      @base_url = 'http://localhost'
+      @user = nil
+      @types.clear
+      @services.clear
+      @objects.clear
+    end
+
+    def reset_objects
+      @objects.clear
+    end
+  end
+end
+