restful_objects 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YmE0NjFmNDUzNmFiODQ4MGM5YTNkZDUxZmNlM2EwOGQyZjExZmRiYg==
+    NDhlYTM4MGRmZDMxOWQzM2JlYmQ5N2Q5NTFkM2YxZjhmYzQ1MDA1MQ==
   data.tar.gz: !binary |-
-    MDk2MDgzNTRkNWU5OGQ0YTlhYmJjMmNmNjIyOTBhZTc2NzJlYjFmMQ==
+    ZGE4MmUxYTdiZTdiNDViNjI3NmIzMmIwZWMyZjJiYjAwZWIwMzFhMQ==
 SHA512:
   metadata.gz: !binary |-
-    NTc2M2UyZGRiOTVmMzA5ZjU3M2Q4MGFiY2M3MzNiNTM2MWMzNDJkNDNkMDJl
-    ODU1ZjUwZGQ1MzFlMGQ2ZDIwZGY3NGY2Mzk4YjI4N2RiZDdjY2M3N2I1MDY5
-    ZmViODRjMjk0M2ZkMzEwMzUxMmIzODgzMmE4OGQ2YTQwMTNlOTQ=
+    N2FhZjcwNzA2Mzc1YmQzZGRlZjliZGNjNjdhMjE4NzhiZDAwOGEzZTg4MmUx
+    NGRlYWYwOTU0NWM2OWZmZDVkNjA2YWZmNDM2ZjY3MDRmZTBjZmE2YTFjNDk5
+    OWIyZDllZjdjMjc4YWExZGFhOTIyM2I2NDBhMDYwN2M0NTIxNjA=
   data.tar.gz: !binary |-
-    NjA5OGE5YzYwYzFiMWNjYTBjYmEyMjZjYzljNzE0OGRiYTNmMjY1MGY5OTE0
-    ZDg5ZGJmMWE3MWQ2MzM0NTNmZDBmMTM3ZGE5NGZlMzQyMWNhZmJhNjQxYTAw
-    MTU4MDI5YzIyZDJjN2Y5NWE0OTE3OGIwMGM2NGZlM2YyOGU4MWE=
+    ZTU2ODM3N2RjODM0ZjBjNDU0YWVkNTYwN2U3MjFhZGI4OGQ3MDdkZWU0NmYx
+    ZjZlMTFjMTJjNzAxZWEyOWI1Yzg2MmMxMDliYTE3ZTNkYTI1YmE0ZjdmZWQx
+    MjExZDY2ZDk1MjM4NzBmODkyMTE1MDdkOTgxZDFkNzNkN2ZmMjE=

data/LICENSE

@@ -0,0 +1,191 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+"submitted" means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+You must retain, in the Source form of any Derivative Works that You distribute,
+all copyright, patent, trademark, and attribution notices from the Source form
+of the Work, excluding those notices that do not pertain to any part of the
+Derivative Works; and
+If the Work includes a "NOTICE" text file as part of its distribution, then any
+Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+6. Trademarks.
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+8. Limitation of Liability.
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same "printed page" as the copyright notice for easier identification within
+third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,83 @@
+![ProjectLogo](docs/project_logo.png)
+
+### What's it about?
+It's a framework for developing servers that adhere to the [Restful Objects specification](http://restfulobjects.org/). It's main purpose is to be completely transparent to the developer and let him focus mainly on the Domain Model that implements the business logic, thereby abstracting him from the API & HTTP issues of exposing the Restful resources.
+
+So it's like plain old ruby objects, with HTTP Restful steroids for free!
+
+### How it looks like?
+```ruby
+require 'restful_objects'
+
+class Node
+  include RestfulObjects::Object
+
+  property   :label, :string
+  property   :visited, :bool
+  collection :dendencies, Node
+end
+
+class Graph
+  include RestfulObjects::Object
+
+  collection :nodes, Nodo
+  action :topological_sort, return_value: { list: Nodo }
+
+  def topological_sort
+    list = []
+    nodex.each { |node| node.visited = false }
+    unvisited_nodes = nodes
+    while not unvisited_nodes.empty? do
+      visit(unvisited_nodes.pop, list)
+    end
+    list
+  end
+
+  private
+
+  def visit(node, list)
+    if !node.visited
+      node.dependencies.each { |dependent_node| visit(dependent_node, list) }
+      node.visited = true
+      list << node
+    end
+  end
+end
+```
+ 
+### How to install it?
+Run
+
+```shell
+gem install restful_objects
+```
+
+or add 
+
+```ruby
+gem 'restful_objects'
+```
+
+to your's project Gemfile and 'bundle install' it.
+
+### 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.
+
+### Dependencies
+- [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.
+
+### Resources
+- [Restful Objects Spec](http://restfulobjects.org/)
+- [Introduction to Restful Objects](http://www.infoq.com/articles/Intro_Restful_Objects)
+
+### License
+MIT License.
+
+### Credits
+This project has been developed as the main subject of Pablo Vizcay undergradute System's Engineering thesis, directed by [Dr. Alejandro Zunino](http://azunino.sites.exa.unicen.edu.ar/) for the [U.N.I.C.E.N. University in Tandil - Buenos Aires - Argentina](http://www.exa.unicen.edu.ar/).
+
+![UnicenLogo](docs/unicen_logo.png)
+

data/bin/restful_server.rb

@@ -0,0 +1,12 @@
+require 'restful_objects'
+
+if ARGV.first.nil? then
+  puts 'You must provide the script path to load: "restful_server script.rb"'
+  exit(1)
+end
+
+load ARGV.first
+
+RestfulObjects::DomainModel.current.base_url = 'http://localhost:4567'
+RestfulObjects::Server.run!
+

data/lib/restful_objects/object.rb

@@ -1,5 +1,4 @@
-require 'bigdecimal'
-require 'base64'
+# encoding: utf-8
 
 module RestfulObjects
   module Object
@@ -17,116 +16,5 @@ module RestfulObjects
       end
     end
   end
-
-  module ObjectBase
-    attr_accessor :is_service, :title
-
-    def initialize
-      super
-      @deleted = false
-      @is_service = self.class.ancestors.include? RestfulObjects::Service
-      @title = "#{self.class.name} (#{object_id})"
-      rs_register_in_model
-      rs_type.collections.each_value { |collection| instance_variable_set "@#{collection.id}".to_sym, Array.new }
-      on_after_create if respond_to? :on_after_create
-    end
-
-    def rs_register_in_model
-      rs_model.objects.register(self) if not @is_service
-    end
-
-    def rs_model
-      RestfulObjects::DomainModel.current
-    end
-
-    def rs_type
-      rs_model.types[self.class.name]
-    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 + '"')
-    end
-
-    def rs_instance_id
-      object_id
-    end
-
-    def representation
-      representation = {
-        'title' => title,
-        'members' => generate_members,
-        'links' => [ link_to(:described_by, "/domain-types/#{self.class.name}", :domain_type) ],
-        'extensions' => rs_type.metadata
-      }
-
-      if not is_service
-        representation['instanceId'] = object_id.to_s
-        representation['links'] << link_to(:self, "/objects/#{self.class.name}/#{object_id}", :object)
-      else
-        representation['serviceId'] = self.class.name
-        representation['links'] << link_to(:self, "/services/#{self.class.name}", :object)
-      end
-
-      representation
-    end
-
-    def generate_members
-      if is_service
-        actions_members
-      else
-        properties_members.merge(collections_members.merge(actions_members))
-      end
-    end
-
-    def rs_delete
-      on_before_delete if respond_to? :on_before_delete
-      @deleted = true
-      on_after_delete if respond_to? :on_after_delete
-    end
-
-    def deleted?
-      @deleted
-    end
-
-    def encode_value(value, type)
-      return nil if value.nil?
-      case type
-        when :string
-          value.to_s
-        when :int
-          value.to_i
-        when :decimal
-          value.to_f
-        when :date
-          value.strftime('%Y-%m-%d')
-        when :blob
-          Base64.encode64(value).strip
-        else
-          raise "encode_value unsupported property type: #{type}"
-      end
-    end
-
-    def decode_value(value, type)
-      return nil if value.nil?
-      case type
-        when :string
-          value.to_s
-        when :int
-          value.to_i
-        when :decimal
-          Float(value)
-        when :date
-          Date.parse(value)
-        when :blob
-          Base64.decode64(value)
-        else
-          raise "decode_value unsupported property type: #{type}"
-      end
-    end
-
-    def get_self_link
-      link_to(:self, "/objects/#{self.class.name}/#{self.object_id}", :object)
-    end
-  end
 end
+

data/lib/restful_objects/object_base.rb

@@ -0,0 +1,116 @@
+# encoding: utf-8
+
+module RestfulObjects
+  module ObjectBase
+    attr_accessor :is_service, :title
+
+    def initialize
+      super
+      @deleted    = false
+      @is_service = self.class.ancestors.include? RestfulObjects::Service
+      @title      = "#{self.class.name} (#{object_id})"
+      rs_register_in_model
+      rs_type.collections.each_value { |collection| instance_variable_set "@#{collection.id}".to_sym, Array.new }
+      on_after_create if respond_to?(:on_after_create)
+    end
+
+    def rs_register_in_model
+      rs_model.objects.register(self) unless @is_service
+    end
+
+    def rs_model
+      RestfulObjects::DomainModel.current
+    end
+
+    def rs_type
+      rs_model.types[self.class.name]
+    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 + '"')
+    end
+
+    def rs_instance_id
+      object_id
+    end
+
+    def representation
+      representation = {
+        'title' => title,
+        'members' => generate_members,
+        'links' => [ link_to(:described_by, "/domain-types/#{self.class.name}", :domain_type) ],
+        'extensions' => rs_type.metadata
+      }
+
+      if not is_service
+        representation['instanceId'] = object_id.to_s
+        representation['links'] << link_to(:self, "/objects/#{self.class.name}/#{object_id}", :object)
+      else
+        representation['serviceId'] = self.class.name
+        representation['links'] << link_to(:self, "/services/#{self.class.name}", :object)
+      end
+
+      representation
+    end
+
+    def generate_members
+      if is_service
+        actions_members
+      else
+        properties_members.merge(collections_members.merge(actions_members))
+      end
+    end
+
+    def rs_delete
+      on_before_delete if respond_to?(:on_before_delete)
+      @deleted = true
+      on_after_delete if respond_to?(:on_after_delete)
+    end
+
+    def deleted?
+      @deleted
+    end
+
+    def encode_value(value, type)
+      return nil if value.nil?
+      case type
+        when :string
+          value.to_s
+        when :int
+          value.to_i
+        when :decimal
+          value.to_f
+        when :date
+          value.strftime('%Y-%m-%d')
+        when :blob
+          Base64.encode64(value).strip
+        else
+          raise "encode_value unsupported property type: #{type}"
+      end
+    end
+
+    def decode_value(value, type)
+      return nil if value.nil?
+      case type
+        when :string
+          value.to_s
+        when :int
+          value.to_i
+        when :decimal
+          Float(value)
+        when :date
+          Date.parse(value)
+        when :blob
+          Base64.decode64(value)
+        else
+          raise "decode_value unsupported property type: #{type}"
+      end
+    end
+
+    def get_self_link
+      link_to(:self, "/objects/#{self.class.name}/#{self.object_id}", :object)
+    end
+  end
+end
+

data/lib/restful_objects/property_description.rb

@@ -0,0 +1,68 @@
+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
+
+    def initialize(id, domain_type, return_type, options)
+      raise "property type #{return_type} usupported" if not [:string, :int, :decimal, :date, :blob].include?(return_type)
+
+      @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]
+      @disabled_reason = options[:disabled_reason] || 'read-only property' if read_only
+      @pattern = options[:pattern]
+    end
+
+    def get_representation
+      representation = {
+        'id' => @id,
+        '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' => {}
+      }
+
+      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' => return_type,
+                 'format' => format,
+                 'optional' => optional,
+                 'memberOrder' => member_order }
+      result['maxLength'] = max_length if max_length
+      result['pattern'] = pattern if pattern
+      result
+    end
+
+    def format
+      case return_type
+        when :string
+          'string'
+      end
+    end
+
+    def get_value_as_json
+      { 'id' =>
+        { 'value' => '' }
+      }.to_json
+    end
+  end
+end

data/lib/restful_objects/service.rb

@@ -0,0 +1,21 @@
+module RestfulObjects
+  module Service
+    include LinkGenerator
+
+    def self.included(base)
+      RestfulObjects::DomainModel.current.types.add(base.name)
+
+      base.class_eval do
+        extend ObjectMacros
+        include ObjectBase
+        include ObjectActions
+
+        def rs_register_in_model
+          # do_nothing
+        end
+      end
+
+      RestfulObjects::DomainModel.current.services.register(base)
+    end
+  end
+end

data/lib/restful_objects/version.rb

@@ -1,3 +1,3 @@
 module RestfulObjects
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/restful_objects.rb

@@ -0,0 +1,34 @@
+require 'cgi'
+require 'json'
+require 'base64'
+require 'singleton'
+require 'bigdecimal'
+require 'forwardable'
+require 'sinatra/base'
+
+require_relative "restful_objects/version"
+require_relative 'restful_objects/server'
+require_relative 'restful_objects/link_generator'
+require_relative 'restful_objects/http_response'
+require_relative 'restful_objects/user'
+require_relative 'restful_objects/property_list'
+require_relative 'restful_objects/property_description'
+require_relative 'restful_objects/collection_list'
+require_relative 'restful_objects/collection_description'
+require_relative 'restful_objects/action_list'
+require_relative 'restful_objects/action_description'
+require_relative 'restful_objects/parameter_description'
+require_relative 'restful_objects/parameter_description_list'
+require_relative 'restful_objects/object_list'
+require_relative 'restful_objects/object'
+require_relative 'restful_objects/object_base'
+require_relative 'restful_objects/object_macros'
+require_relative 'restful_objects/object_properties'
+require_relative 'restful_objects/object_collections'
+require_relative 'restful_objects/object_actions'
+require_relative 'restful_objects/type'
+require_relative 'restful_objects/type_list'
+require_relative 'restful_objects/service'
+require_relative 'restful_objects/service_list'
+require_relative 'restful_objects/domain_model'
+