restful_objects 0.0.1

data/lib/restful_objects/server.rb

@@ -0,0 +1,129 @@
+module RestfulObjects
+  class Server < Sinatra::Base
+    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

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

@@ -0,0 +1,110 @@
+module RestfulObjects
+  class Type
+    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
+      @friendly_name = ''
+      @plural_name = ''
+      @description = ''
+    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 }
+      end
+
+      { '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
+
+      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
+      end
+
+      new_object.get_representation
+    end
+
+    def metadata
+      { 'domainType' => id,
+        'friendlyName' => friendly_name,
+        'pluralName' => plural_name,
+        'description' => description,
+        'isService' => is_service }
+    end
+
+    private
+
+      def get_members
+        properties_members.merge(collections_members.merge(actions_members))
+      end
+
+      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 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 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 get_type_actions
+        {}
+      end
+  end
+end

data/lib/restful_objects/type_list.rb

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

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

data/lib/restful_objects/version.rb

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

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: restful_objects
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pablo Vizcay
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.1.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+- !ruby/object:Gem::Dependency
+  name: json_expressions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+description: This gem is a framework for implementing Restful Objects servers.
+email:
+- pabo.vizcay@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/restful_objects/action_description.rb
+- lib/restful_objects/action_list.rb
+- lib/restful_objects/collection_description.rb
+- lib/restful_objects/collection_list.rb
+- lib/restful_objects/http_response.rb
+- lib/restful_objects/link_generator.rb
+- lib/restful_objects/model.rb
+- lib/restful_objects/object.rb
+- lib/restful_objects/object_actions.rb
+- lib/restful_objects/object_collections.rb
+- lib/restful_objects/object_list.rb
+- lib/restful_objects/object_macros.rb
+- lib/restful_objects/object_properties.rb
+- lib/restful_objects/parameter_description.rb
+- lib/restful_objects/parameter_description_list.rb
+- lib/restful_objects/property_list.rb
+- lib/restful_objects/server.rb
+- lib/restful_objects/service_list.rb
+- lib/restful_objects/type.rb
+- lib/restful_objects/type_list.rb
+- lib/restful_objects/user.rb
+- lib/restful_objects/version.rb
+homepage: https://github.com/vizcay/RestfulObjectsRuby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.9
+signing_key: 
+specification_version: 4
+summary: This gem is a framework for implementing Restful Objects servers.
+test_files: []
+has_rdoc: