restful_objects 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b9d5f9ab0b9191be431dcf51c8678a83b69def4
-  data.tar.gz: 2768a747a319c97a75d2cab86aa9728906d6d1d0
+  metadata.gz: acc457412078eadbb0d83af84afa695eb3abea02
+  data.tar.gz: 761377929fe4800901ee88b361cfe6b7e603a98e
 SHA512:
-  metadata.gz: a0287a4cead98bedbd4cfddad1dd9d6e96361e12e528f400c43ac33639e167fbcde3acc047b9d732f570dd28f4dcc5e5a09a2dd9fb56406b2fe7d5e35a4e1f32
-  data.tar.gz: dd0c7fe482409be9b111edc27d84bdc99072678946eadaca23a2744364b1ce5d9047e7a48b84fd4cec749ffeb1645f12f5c4aca9a73a3bad96226cd6bbc6a8a7
+  metadata.gz: 197315bdd45d57a1dea3ab04593561893106582eb5b7bdbd8da84116b4abc992dbb1ffc2390b568ceb12ddf5f5d5afd2d585ea578bebc16485ae4adcea9edf6d
+  data.tar.gz: 8e73987857c84cababd5eaa857b67b38041d7f8691f9ae7826c09f5da2bd2d24065a4a3212af13860375d827cfac358d70b050405b109b0ef507f88378451243

data/README.md

@@ -49,13 +49,13 @@ end
 - [Topological Sort Restful Objects server](https://github.com/vizcay/ro_topological_sort)
 
 ### How to install it?
-Run
+If you have a Ruby environment (> 1.9.3) with RubyGems installed, simply run:
 
 ```shell
 gem install restful_objects
 ```
 
-or add 
+or add,
 
 ```ruby
 gem 'restful_objects'
@@ -63,6 +63,10 @@ gem 'restful_objects'
 
 to your's project Gemfile and 'bundle install' it.
 
+If not, consider using Vagrant to setup a VM with all the dependencies and the latest version of the framework following the instructions here:
+
+[https://github.com/vizcay/restful_objects_vagrant](https://github.com/vizcay/restful_objects_vagrant)
+
 ### Project Status
 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.
 

data/bin/restful_server

@@ -10,5 +10,5 @@ end
 load ARGV[0]
 
 RestfulObjects::DomainModel.current.base_url = ARGV[1] || 'http://localhost:4567'
-RestfulObjects::Server.run!
+RestfulObjects::Router::Base.run!
 

data/lib/restful_objects/domain_model/domain_model.rb

@@ -0,0 +1,143 @@
+require_relative 'helpers/link_generator'
+require_relative 'user'
+require_relative 'mixins/object'
+require_relative 'mixins/service'
+require_relative 'types/domain_type'
+
+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           = {}
+      @services        = {}
+      @objects         = {}
+      @services.instance_eval do
+        alias :base_accesor :[]
+
+        def [](key)
+          value = base_accesor(key)
+          if value.is_a?(Class)
+            value = value.new
+            self[key] = value
+          end
+          value
+        end
+      end
+    end
+
+    def register_object(instance)
+      @objects[instance.object_id] = instance
+    end
+
+    def register_service(service)
+      raise 'service registration should be done with a class' unless service.is_a?(Class)
+      @services[service.name] = service
+    end
+
+    def register_type(name)
+      @types[name] = DomainType.new(name)
+    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
+      { 'links' => [
+           link_to(:self, '/services', :services),
+           link_to(:up, '/', :homepage),
+         ],
+         'value' => services_generate_values,
+         'extensions' => { }
+      }.to_json
+    end
+
+    def get_type_list_representation
+      { 'links'  => [link_to(:self, '/domain-types', :type_list), link_to(:up, '/', :homepage)],
+         'value' => @types.map { |name| link_to(:domain_type, "/domain-types/#{name}", :domain_type) }
+      }.to_json
+    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
+
+    private
+
+    def services_generate_values
+      services_ensure_all_created
+      values = []
+      @services.each do |name, service|
+        element = link_to(:service, "/services/#{name}", :object, service_id: name)
+        element['title'] = service.title
+        values << element
+      end
+      values
+    end
+
+    def services_ensure_all_created
+      @services.each { |name, value| @services[name] = value.new if value.is_a? Class }
+    end
+  end
+end
+

data/lib/restful_objects/{object.rb → domain_model/mixins/object.rb}

@@ -1,11 +1,15 @@
-# encoding: utf-8
+require_relative 'object_macros'
+require_relative 'object_base'
+require_relative 'object_properties'
+require_relative 'object_collections'
+require_relative 'object_actions'
 
 module RestfulObjects
   module Object
     include LinkGenerator
 
     def self.included(base)
-      RestfulObjects::DomainModel.current.types.add(base.name)
+      RestfulObjects::DomainModel.current.register_type(base.name)
 
       base.class_eval do
         extend ObjectMacros

data/lib/restful_objects/{object_actions.rb → domain_model/mixins/object_actions.rb}

@@ -132,3 +132,4 @@ module RestfulObjects
       end
   end
 end
+

data/lib/restful_objects/{object_base.rb → domain_model/mixins/object_base.rb}

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module RestfulObjects
   module ObjectBase
     attr_accessor :is_service, :title
@@ -15,7 +13,7 @@ module RestfulObjects
     end
 
     def rs_register_in_model
-      rs_model.objects.register(self) unless @is_service
+      rs_model.register_object(self) unless @is_service
     end
 
     def rs_model
@@ -27,15 +25,31 @@ module RestfulObjects
     end
 
     def get_representation
-      HttpResponse.new(representation.to_json,
-                       'application/json;profile="urn:org.restfulobjects:repr-types/object";x-ro-domain-type="' + rs_type.id + '"')
+      [200,
+       { 'Content-Type' =>
+           "application/json;profile=\"urn:org.restfulobjects:repr-types/object\";x-ro-domain-type=\"#{rs_type.id}\"" },
+       representation.to_json]
+    end
+
+    def put_properties_and_get_representation(json)
+      properties = JSON.parse(json)
+      properties.each do |property, container|
+        raise 'property not exists' unless rs_model.types[self.class.name].properties.include?(property)
+        raise 'read-only property' if rs_model.types[self.class.name].properties[property].read_only
+        set_property_value(property, container['value'])
+        on_after_update if respond_to?(:on_after_update)
+      end
+      [200,
+       { 'Content-Type' =>
+           "application/json;profile=\"urn:org.restfulobjects:repr-types/object\";x-ro-domain-type=\"#{rs_type.id}\"" },
+       representation(false).to_json]
     end
 
     def rs_instance_id
       object_id
     end
 
-    def representation
+    def representation(include_self_link = true)
       representation = {
         'title' => title,
         'members' => generate_members,
@@ -45,10 +59,10 @@ module RestfulObjects
 
       if not is_service
         representation['instanceId'] = object_id.to_s
-        representation['links'] << link_to(:self, "/objects/#{self.class.name}/#{object_id}", :object)
+        representation['links'] << link_to(:self, "/objects/#{self.class.name}/#{object_id}", :object) if include_self_link
       else
         representation['serviceId'] = self.class.name
-        representation['links'] << link_to(:self, "/services/#{self.class.name}", :object)
+        representation['links'] << link_to(:self, "/services/#{self.class.name}", :object) if include_self_link
       end
 
       representation
@@ -62,17 +76,24 @@ module RestfulObjects
       end
     end
 
+    def get_property_rel_representation(property_name)
+      representation = link_to(:value, "/objects/#{self.class.name}/#{object_id}", :object, property: property_name)
+      representation['title'] = @title
+      representation
+    end
+
     def rs_delete
       on_before_delete if respond_to?(:on_before_delete)
       @deleted = true
       on_after_delete if respond_to?(:on_after_delete)
+      {}.to_json
     end
 
     def deleted?
       @deleted
     end
 
-    def encode_value(value, type)
+    def encode_value(value, type, property_name = '')
       return nil if value.nil?
       case type
         when :string
@@ -88,7 +109,11 @@ module RestfulObjects
         when :blob
           Base64.encode64(value).strip
         else
-          raise "encode_value unsupported property type: #{type}"
+          if value.respond_to?(:get_property_rel_representation)
+            value.get_property_rel_representation(property_name)
+          else
+            raise "encode_value unsupported property type: #{type}"
+          end
       end
     end
 
@@ -100,9 +125,9 @@ module RestfulObjects
         when :int
           value.to_i
         when :bool
-          if value == 'true'
+          if [true, 'true'].include?(value)
             true
-          elsif value == 'false'
+          elsif [false, 'false'].include?(value)
             false
           else
             raise ArgumentError.new "invalid boolean value: #{value}"
@@ -118,8 +143,16 @@ module RestfulObjects
       end
     end
 
+    def ro_relative_url
+      "/objects/#{self.class.name}/#{self.object_id}"
+    end
+
+    def ro_absolute_url
+      RestfulObjects::DomainModel.current.base_url + ro_relative_url
+    end
+
     def get_self_link
-      link_to(:self, "/objects/#{self.class.name}/#{self.object_id}", :object)
+      link_to(:self, ro_relative_url, :object)
     end
   end
 end

data/lib/restful_objects/{object_collections.rb → domain_model/mixins/object_collections.rb}

@@ -82,3 +82,4 @@ module RestfulObjects
     end
   end
 end
+

data/lib/restful_objects/{object_macros.rb → domain_model/mixins/object_macros.rb}

@@ -1,7 +1,7 @@
 module RestfulObjects
   module ObjectMacros
     def property(name, type, options = {})
-      RestfulObjects::DomainModel.current.types[self.name].properties.add(name.to_s, type, options)
+      RestfulObjects::DomainModel.current.types[self.name].register_property(name.to_s, type, options)
       if options[:read_only]
         self.class_eval { attr_reader name }
       else
@@ -23,13 +23,14 @@ module RestfulObjects
     def collection(name, type, options = {})
       type = type.name if type.is_a? Class
 
-      RestfulObjects::DomainModel.current.types[self.name].collections.add(name.to_s, type, options)
+      RestfulObjects::DomainModel.current.types[self.name].register_collection(name.to_s, type, options)
 
       self.class_eval { attr_reader name }
     end
 
     def action(name, options = {})
-      RestfulObjects::DomainModel.current.types[self.name].actions.add(name.to_s, options)
+      RestfulObjects::DomainModel.current.types[self.name].register_action(name.to_s, options)
     end
   end
 end
+

data/lib/restful_objects/{object_properties.rb → domain_model/mixins/object_properties.rb}

@@ -12,12 +12,26 @@ module RestfulObjects
           'extensions' => property.metadata
         }
 
-        members[name]['disabledReason'] = property.disabled_reason if property.read_only
+        if property.read_only
+          members[name]['disabledReason'] = property.disabled_reason
+        else
+          if self.respond_to?("#{name}_choices")
+            choices = self.send("#{name}_choices")
+            raise "value returned by #{name}_choices method should be an Array" unless choices.is_a?(Array)
+            if property_description(name).is_reference
+              choices_json = choices.map { |object| object.get_property_rel_representation(name) }
+            else
+              choices_json = choices.map { |value| decode_value(value, property_type(name)) }
+            end
+            members[name]['choices'] = choices_json
+          end
+        end
       end
       members
     end
 
     def get_property_as_json(property)
+      property = property.to_s if property.is_a?(Symbol)
       raise "Property not exists" if not rs_model.types[self.class.name].properties.include?(property)
 
       representation = {
@@ -36,6 +50,17 @@ module RestfulObjects
             { property: property, method: 'PUT', arguments: { 'value' => nil } }),
           link_to(:clear, "/objects/#{self.class.name}/#{object_id}/properties/#{property}", :object_property,
             { property: property, method: 'DELETE'} ) ]
+
+        if self.respond_to?("#{property}_choices")
+          choices = self.send("#{property}_choices")
+          raise "value returned by #{property}_choices method should be an Array" unless choices.is_a?(Array)
+          if property_description(property).is_reference
+            choices_json = choices.map { |object| object.get_property_rel_representation(property) }
+          else
+            choices_json = choices.map { |value| decode_value(value, property_type(property)) }
+          end
+          representation[property]['choices'] = choices_json
+        end
       else
         representation[property]['disabledReason'] =
           rs_model.types[self.class.name].properties[property].disabled_reason
@@ -45,12 +70,13 @@ module RestfulObjects
     end
 
     def put_property_as_json(property, json)
-      raise "property not exists" if not rs_model.types[self.class.name].properties.include?(property)
-      raise "read-only property" if rs_model.types[self.class.name].properties[property].read_only
+      property = property.to_s if property.is_a?(Symbol)
+      raise 'property not exists' unless rs_model.types[self.class.name].properties.include?(property)
+      raise 'read-only property' if rs_model.types[self.class.name].properties[property].read_only
 
       value = JSON.parse(json)['value']
       set_property_value(property, value)
-      on_after_update if respond_to? :on_after_update
+      on_after_update if respond_to?(:on_after_update)
       get_property_as_json(property)
     end
 
@@ -59,20 +85,36 @@ module RestfulObjects
       raise "read-only property" if rs_model.types[self.class.name].properties[property].read_only
 
       send("#{property}=".to_sym, nil)
-      on_after_update if respond_to? :on_after_update
+      on_after_update if respond_to?(:on_after_update)
       get_property_as_json(property)
     end
 
+    def property_description(property)
+      rs_model.types[self.class.name].properties[property]
+    end
+
     def property_type(property)
       rs_model.types[self.class.name].properties[property].return_type
     end
 
     def get_property_value(property)
-      encode_value(send(property.to_sym), property_type(property))
+      encode_value(send(property.to_sym), property_type(property), property)
     end
 
     def set_property_value(property, value)
-      send("#{property}=".to_sym, decode_value(value, property_type(property)))
+      if property_description(property).is_reference
+        href_value = value['href']
+        match = Regexp.new(".*/objects/(?<domain-type>\\w*)/(?<object-id>\\d*)").match(href_value)
+        raise "invalid property reference format: '#{href_value}'" if not match
+        domain_type = match['domain-type']
+        id = match['object-id'].to_i
+        raise "value does not exists" if not rs_model.objects.include?(id)
+        raise "domain-type does not exists" if not rs_model.types.include?(domain_type)
+        send "#{property}=".to_sym, rs_model.objects[id]
+      else
+        send "#{property}=".to_sym, decode_value(value, property_type(property))
+      end
     end
   end
 end
+

data/lib/restful_objects/{service.rb → domain_model/mixins/service.rb}

@@ -3,7 +3,7 @@ module RestfulObjects
     include LinkGenerator
 
     def self.included(base)
-      RestfulObjects::DomainModel.current.types.add(base.name)
+      RestfulObjects::DomainModel.current.register_type(base.name)
 
       base.class_eval do
         extend ObjectMacros
@@ -15,7 +15,8 @@ module RestfulObjects
         end
       end
 
-      RestfulObjects::DomainModel.current.services.register(base)
+      RestfulObjects::DomainModel.current.register_service(base)
     end
   end
 end
+

data/lib/restful_objects/{action_description.rb → domain_model/types/action_description.rb}

@@ -1,3 +1,5 @@
+require_relative 'parameter_description_list'
+
 module RestfulObjects
   class ActionDescription
     include LinkGenerator

data/lib/restful_objects/{type.rb → domain_model/types/domain_type.rb}

@@ -1,19 +1,38 @@
+require_relative 'property_description'
+require_relative 'collection_description'
+require_relative 'action_description'
+
 module RestfulObjects
-  class Type
+  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 = PropertyList.new(id)
-      @collections = CollectionList.new(id)
-      @actions = ActionList.new(id)
-      @is_service = false
+      @id            = id
+      @properties    = {}
+      @collections   = {}
+      @actions       = {}
+      @is_service    = false
       @friendly_name = ''
-      @plural_name = ''
-      @description = ''
+      @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_collection(name, type, options = {})
+      options[:member_order] ||= @collections.count + 1
+      @collections[name]       = 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 get_representation
@@ -108,3 +127,4 @@ module RestfulObjects
       end
   end
 end
+

data/lib/restful_objects/{parameter_description_list.rb → domain_model/types/parameter_description_list.rb}

@@ -1,3 +1,5 @@
+require_relative 'parameter_description'
+
 module RestfulObjects
   class ParameterDescriptionList
     extend Forwardable
@@ -13,3 +15,4 @@ module RestfulObjects
     def_delegators :@parameters, :[], :each, :include?, :count, :empty?
   end
 end
+

data/lib/restful_objects/{property_description.rb → domain_model/types/property_description.rb}

@@ -2,23 +2,33 @@ module RestfulObjects
   class PropertyDescription
     include LinkGenerator
 
-    attr_accessor :id, :domain_type, :return_type, :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)
-      raise "property type #{return_type} usupported" if not [:string, :int, :bool, :decimal, :date, :blob].include?(return_type)
+      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
-      @return_type = return_type
-      @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]
+      @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]
+      @pattern         = options[:pattern]
     end
 
     def get_representation

data/lib/restful_objects/domain_model/user.rb

@@ -0,0 +1,31 @@
+module RestfulObjects
+  class User
+    include RestfulObjects::LinkGenerator
+
+    attr_reader :base_url, :user_name
+    attr_accessor :friendly_name, :email
+
+    def initialize(base_url, user_name)
+      @base_url      = base_url
+      @user_name     = user_name
+      @friendly_name = ''
+      @email         = ''
+      @roles         = []
+    end
+
+    def add_role(role)
+      @roles.push(role)
+    end
+
+    def get_as_json
+      { 'links'        => [ gen_link('self', '/user', 'user'), gen_link('up', '/', 'homepage') ],
+        'userName'     => @user_name,
+        'friendlyName' => @friendly_name,
+        'email'        => @email,
+        'roles'        => @roles,
+        'extensions'   => {}
+      }.to_json
+    end
+  end
+end
+