restful_objects 0.0.5 → 0.0.6

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restful_objects
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Pablo Vizcay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-05 00:00:00.000000000 Z
+date: 2014-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,36 +103,34 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/restful_server
-- lib/restful_objects/server.rb
-- lib/restful_objects/property_description.rb
-- lib/restful_objects/action_list.rb
-- lib/restful_objects/object_list.rb
-- lib/restful_objects/parameter_description_list.rb
-- lib/restful_objects/user.rb
-- lib/restful_objects/object_macros.rb
-- lib/restful_objects/domain_model.rb
-- lib/restful_objects/collection_list.rb
-- lib/restful_objects/link_generator.rb
-- lib/restful_objects/object_properties.rb
-- lib/restful_objects/service.rb
-- lib/restful_objects/action_description.rb
-- lib/restful_objects/http_response.rb
-- lib/restful_objects/object_collections.rb
-- lib/restful_objects/type_list.rb
-- lib/restful_objects/parameter_description.rb
+- lib/restful_objects/router/domain_type_resources.rb
+- lib/restful_objects/router/domain_object_resources.rb
+- lib/restful_objects/router/supporting_resources.rb
+- lib/restful_objects/router/base.rb
 - lib/restful_objects/version.rb
-- lib/restful_objects/object_base.rb
-- lib/restful_objects/type.rb
-- lib/restful_objects/object_actions.rb
-- lib/restful_objects/object.rb
-- lib/restful_objects/collection_description.rb
-- lib/restful_objects/property_list.rb
-- lib/restful_objects/service_list.rb
+- lib/restful_objects/domain_model/types/property_description.rb
+- lib/restful_objects/domain_model/types/parameter_description_list.rb
+- lib/restful_objects/domain_model/types/domain_type.rb
+- lib/restful_objects/domain_model/types/action_description.rb
+- lib/restful_objects/domain_model/types/parameter_description.rb
+- lib/restful_objects/domain_model/types/collection_description.rb
+- lib/restful_objects/domain_model/mixins/object_macros.rb
+- lib/restful_objects/domain_model/mixins/object_properties.rb
+- lib/restful_objects/domain_model/mixins/service.rb
+- lib/restful_objects/domain_model/mixins/object_collections.rb
+- lib/restful_objects/domain_model/mixins/object_base.rb
+- lib/restful_objects/domain_model/mixins/object_actions.rb
+- lib/restful_objects/domain_model/mixins/object.rb
+- lib/restful_objects/domain_model/user.rb
+- lib/restful_objects/domain_model/domain_model.rb
+- lib/restful_objects/domain_model/helpers/link_generator.rb
 - lib/restful_objects.rb
+- spec/integration/domain_model_spec.rb
 - spec/integration/domain-types_properties_spec.rb
 - spec/integration/domain-types_collections_spec.rb
 - spec/integration/domain-types_actions_spec.rb
 - spec/integration/server-root_spec.rb
+- spec/acceptance/generate_json_representations_spec.rb
 - spec/spec_helper.rb
 - spec/unit/service_spec.rb
 - spec/unit/object_collections_spec.rb
@@ -167,10 +165,12 @@ signing_key:
 specification_version: 4
 summary: This gem is a framework for implementing Restful Objects servers.
 test_files:
+- spec/integration/domain_model_spec.rb
 - spec/integration/domain-types_properties_spec.rb
 - spec/integration/domain-types_collections_spec.rb
 - spec/integration/domain-types_actions_spec.rb
 - spec/integration/server-root_spec.rb
+- spec/acceptance/generate_json_representations_spec.rb
 - spec/spec_helper.rb
 - spec/unit/service_spec.rb
 - spec/unit/object_collections_spec.rb

data/lib/restful_objects/action_list.rb

@@ -1,17 +0,0 @@
-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_list.rb

@@ -1,17 +0,0 @@
-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,83 +0,0 @@
-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
-

data/lib/restful_objects/http_response.rb

@@ -1,11 +0,0 @@
-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/object_list.rb

@@ -1,16 +0,0 @@
-module RestfulObjects
-  class ObjectList
-    extend Forwardable
-
-    def initialize(base_url)
-      @objects = Hash.new
-      @base_url = base_url
-    end
-
-    def register(instance, service = false)
-      @objects[instance.object_id] = instance
-    end
-
-    def_delegators :@objects, :[], :each, :include?, :count, :clear, :empty?, :keys, :values
-  end
-end

data/lib/restful_objects/property_list.rb

@@ -1,17 +0,0 @@
-module RestfulObjects
-  class PropertyList
-    extend Forwardable
-
-    def initialize(domain_type)
-      @properties = Hash.new
-      @domain_type = domain_type
-    end
-
-    def add(id, return_type, options = {})
-      options[:member_order] ||= count + 1
-      @properties[id] = PropertyDescription.new(id, @domain_type, return_type, options)
-    end
-
-    def_delegators :@properties, :[], :each, :include?, :count, :empty?
-  end
-end

data/lib/restful_objects/server.rb

@@ -1,131 +0,0 @@
-module RestfulObjects
-  class Server < Sinatra::Base
-    set :bind, '0.0.0.0' # listen at all networks (needed for using with vagrant port forwarding)
-
-    after do
-      headers['Access-Control-Allow-Origin'] = '*'
-    end
-
-    # B. SUPPORTING RESOURCES
-    # B.5 Homepage
-    get '/' do
-      model.get_homepage
-    end
-    # B.6 User
-    get "/user" do
-      model.get_user_as_json
-    end
-    # B.7 Services
-    get "/services" do
-      model.get_services
-    end
-    # B.8 Version
-    get '/version' do
-      model.get_version
-    end
-    # B.9 Objects of Type Resource
-    post '/objects/:domain_type' do
-      populate_response model.types[params[:domain_type]].post_prototype_object(request.body.read)
-    end
-    # C. DOMAIN OBJECT RESOURCES
-    # C.14 Domain Object
-    get "/objects/:domain_type/:instance_id" do
-      populate_response model.objects[params[:instance_id].to_i].get_representation
-    end
-    delete "/objects/:domain_type/:instance_id" do
-      model.objects[params[:instance_id].to_i].rs_delete
-    end
-    # C.15 Domain Services
-    get "/services/:service_id" do
-      populate_response model.services[params[:service_id]].get_representation
-    end
-    # C.16 Property
-    get "/objects/:domain_type/:instance_id/properties/:property_id" do
-      model.objects[params[:instance_id].to_i].get_property_as_json(params[:property_id])
-    end
-    put "/objects/:domain_type/:instance_id/properties/:property_id" do
-      model.objects[params[:instance_id].to_i].put_property_as_json(params[:property_id], request.body.read)
-    end
-    delete "/objects/:domain_type/:instance_id/properties/:property_id" do
-      model.objects[params[:instance_id].to_i].clear_property(params[:property_id])
-    end
-    # C.17 Collection #
-    get "/objects/:domain_type/:instance_id/collections/:collection_id" do
-      model.objects[params[:instance_id].to_i].get_collection_as_json(params[:collection_id])
-    end
-    put "/objects/:domain_type/:instance_id/collections/:collection_id" do
-      model.objects[params[:instance_id].to_i].add_to_collection(params[:collection_id], request.body.read)
-    end
-    delete "/objects/:domain_type/:instance_id/collections/:collection_id" do
-      model.objects[params[:instance_id].to_i].delete_from_collection(params[:collection_id], request.body.read)
-    end
-    # C.18 Action
-    get "/objects/:domain_type/:instance_id/actions/:action_id" do
-      model.objects[params[:instance_id].to_i].get_action(params[:action_id])
-    end
-    get "/services/:service_id/actions/:action_id" do
-      model.services[params[:service_id]].get_action(params[:action_id])
-    end
-    # C.19 Action Invoke
-    get "/objects/:domain_type/:instance_id/actions/:action_id/invoke" do
-      model.objects[params[:instance_id].to_i].get_action_invoke(params[:action_id], process_params)
-    end
-    get "/services/:service_id/actions/:action_id/invoke" do
-      model.services[params[:service_id]].get_action_invoke(params[:action_id], process_params)
-    end
-    post "/objects/:domain_type/:instance_id/actions/:action_id/invoke" do
-      model.objects[params[:instance_id].to_i].get_action_invoke(params[:action_id], request.body.read)
-    end
-    post "/services/:service_id/actions/:action_id/invoke" do
-      model.services[params[:service_id]].get_action_invoke(params[:action_id], request.body.read)
-    end
-    # D. DOMAIN TYPE RESOURCES #
-    # D.21 Domain Types
-    get "/domain-types" do
-      model.types.get_representation
-    end
-    # D.22 Domain Type
-    get "/domain-types/:domain_type" do
-      model.types[params[:domain_type]].get_representation
-    end
-    # D.23 Domain Type Property
-    get "/domain-types/:domain_type/properties/:property_id" do
-      model.types[params[:domain_type]].properties[params[:property_id]].get_representation
-    end
-    # D.24 Domain Type Collection
-    get "/domain-types/:domain_type/collections/:collection_id" do
-      model.types[params[:domain_type]].collections[params[:collection_id]].get_representation
-    end
-    # D.25 Domain Type Action
-    get "/domain-types/:domain_type/actions/:action_id" do
-      model.types[params[:domain_type]].actions[params[:action_id]].get_representation
-    end
-    # D.26 Domain Type Action Parameter
-
-    # D.27 Domain Type Action Invoke
-
-    # ------------------------------------------------------------------------------------------ #
-    helpers do
-      def model
-        RestfulObjects::DomainModel.current
-      end
-
-      def populate_response(http_response)
-        content_type http_response.content_type
-        status http_response.status
-        body http_response.body
-      end
-
-      def process_params
-        if request.query_string != ''
-          query_params = CGI.parse(request.query_string)
-          parameters = Hash.new
-          query_params.each { |key, value| parameters[key] = { 'value' => value.first } }
-          parameters.to_json
-        else
-          request.body.read
-        end
-      end
-    end
-  end
-end

data/lib/restful_objects/service_list.rb

@@ -1,55 +0,0 @@
-module RestfulObjects
-  class ServiceList
-    extend Forwardable
-    include LinkGenerator
-
-    def initialize(base_url)
-      @services = Hash.new
-      @base_url = base_url
-    end
-
-    def register(service)
-      raise 'service registration should be done with a class' if not service.is_a? Class
-      @services[service.name] = service
-    end
-
-    def get_list
-      representation = {
-        'links' => [
-          link_to(:self, '/services', :services),
-          link_to(:up, '/', :homepage),
-        ],
-        'value' => generate_values,
-        'extensions' => { }
-      }.to_json
-    end
-
-    def [](key)
-      value = @services[key]
-      if value.is_a? Class
-        value = value.new
-        @services[key] = value
-      end
-      value
-    end
-
-    def_delegators :@services, :each, :include?, :count, :empty?, :clear
-
-    private
-
-      def generate_values
-        ensure_all_created
-        values = []
-        each do |name, service|
-          element = link_to(:service, "/services/#{name}", :object, service_id: name)
-          element['title'] = service.title
-          values << element
-        end
-        values
-      end
-
-      def ensure_all_created
-        @services.each { |name, value| @services[name] = value.new if value.is_a? Class }
-      end
-  end
-end

data/lib/restful_objects/type_list.rb

@@ -1,30 +0,0 @@
-module RestfulObjects
-  class TypeList
-    extend Forwardable
-    include LinkGenerator
-
-    def initialize
-      @types = Hash.new
-    end
-
-    def add(name)
-      @types[name] = Type.new(name)
-    end
-
-    def get_representation
-      response =  {
-       'links' => [
-          link_to(:self, '/domain-types', :type_list),
-          link_to(:up, '/', :homepage),
-        ],
-        'value' => []
-      }
-
-      each { |name, type| response['value'] << link_to(:domain_type, "/domain-types/#{name}", :domain_type) }
-
-      response.to_json
-    end
-
-    def_delegators :@types, :[], :each, :include?, :size?, :clear, :empty?
-  end
-end

data/lib/restful_objects/user.rb

@@ -1,30 +0,0 @@
-module RestfulObjects
-  class User
-    include 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 = Array.new
-    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