restful_objects 0.0.2 → 0.0.3

data/lib/restful_objects/type.rb

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

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

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

data/spec/integration/domain-types_actions_spec.rb

@@ -1,43 +1,43 @@
-# encoding: utf-8
-require_relative '../spec_helper'
-
-describe '/domain-types/:type/actions/:action' do
-  before(:all) do
-    RestfulObjects::DomainModel.current.reset
-  end
-
-  it 'should generate an action description representation' do
-    class ActionTest
-      include RestfulObjects::Object
-      action :do_something, :int, {}, friendly_name: 'do something!', description: 'description of something'
-    end
-
-    expected = {
-      'id' => 'do_something',
-      'friendlyName' => 'do something!',
-      'description' => 'description of something',
-      'hasParams' => false,
-      'memberOrder' => :integer,
-      'parameters' => {},
-      'links' => [
-        { 'rel' => 'self',
-          'href' => 'http://localhost/domain-types/ActionTest/actions/do_something',
-          'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/action-description"',
-          'method' => 'GET' },
-        { 'rel' => 'up',
-          'href' => 'http://localhost/domain-types/ActionTest',
-          'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/domain-type"',
-          'method' => 'GET' },
-        { 'rel' => 'urn:org.restfulobjects:rels/return-type',
-          'href' => 'http://localhost/domain-types/int',
-          'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/domain-type"',
-          'method' => 'GET' }
-      ]
-    }
-
-    get '/domain-types/ActionTest/actions/do_something'
-
-    last_response.body.should match_json_expression expected
-  end
-end
-
+# encoding: utf-8
+require_relative '../spec_helper'
+
+describe '/domain-types/:type/actions/:action' do
+  before(:all) do
+    RestfulObjects::DomainModel.current.reset
+  end
+
+  it 'should generate an action description representation' do
+    class ActionTest
+      include RestfulObjects::Object
+      action :do_something, return_type: :int, friendly_name: 'do something!', description: 'description of something'
+    end
+
+    expected = {
+      'id' => 'do_something',
+      'friendlyName' => 'do something!',
+      'description' => 'description of something',
+      'hasParams' => false,
+      'memberOrder' => :integer,
+      'parameters' => {},
+      'links' => [
+        { 'rel' => 'self',
+          'href' => 'http://localhost/domain-types/ActionTest/actions/do_something',
+          'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/action-description"',
+          'method' => 'GET' },
+        { 'rel' => 'up',
+          'href' => 'http://localhost/domain-types/ActionTest',
+          'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/domain-type"',
+          'method' => 'GET' },
+        { 'rel' => 'urn:org.restfulobjects:rels/return-type',
+          'href' => 'http://localhost/domain-types/int',
+          'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/domain-type"',
+          'method' => 'GET' }
+      ]
+    }
+
+    get '/domain-types/ActionTest/actions/do_something'
+
+    last_response.body.should match_json_expression expected
+  end
+end
+

data/spec/integration/domain-types_collections_spec.rb

@@ -1,45 +1,45 @@
-# encoding: utf-8
-require_relative '../spec_helper'
-
-describe '/domain-types/:type/collections/:collection' do
-  before(:all) do
-    RestfulObjects::DomainModel.current.reset
-  end
-
-  it 'should generate a collection description representation' do
-    class CollectionTest
-      include RestfulObjects::Object
-      collection :items, 'ItemClass', friendly_name: 'item collection', description: 'a collection description'
-    end
-
-    expected = {
-      'id' => 'items',
-      'friendlyName' => 'item collection',
-      'description' => 'a collection description',
-      'memberOrder' => 1,
-      'links' => [
-        { 'rel' => 'self',
-          'href' => 'http://localhost/domain-types/CollectionTest/collections/items',
-          'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/collection-description"',
-          'method' => 'GET' },
-        { 'rel' => 'up',
-          'href' => 'http://localhost/domain-types/CollectionTest',
-          'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/domain-type"',
-          'method' => 'GET' },
-        { 'rel' => 'urn:org.restfulobjects:rels/return-type',
-          'href' => 'http://localhost/domain-types/list',
-          'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/domain-type"',
-          'method' => 'GET' },
-        { 'rel' => 'urn:org.restfulobjects:rels/element-type',
-          'href' => 'http://localhost/domain-types/ItemClass',
-          'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/domain-type"',
-          'method' => 'GET' }
-      ],
-      'extensions' => wildcard_matcher
-    }
-
-    get '/domain-types/CollectionTest/collections/items'
-    last_response.body.should match_json_expression expected
-  end
-end
-
+# encoding: utf-8
+require_relative '../spec_helper'
+
+describe '/domain-types/:type/collections/:collection' do
+  before(:all) do
+    RestfulObjects::DomainModel.current.reset
+  end
+
+  it 'should generate a collection description representation' do
+    class CollectionTest
+      include RestfulObjects::Object
+      collection :items, 'ItemClass', friendly_name: 'item collection', description: 'a collection description'
+    end
+
+    expected = {
+      'id' => 'items',
+      'friendlyName' => 'item collection',
+      'description' => 'a collection description',
+      'memberOrder' => 1,
+      'links' => [
+        { 'rel' => 'self',
+          'href' => 'http://localhost/domain-types/CollectionTest/collections/items',
+          'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/collection-description"',
+          'method' => 'GET' },
+        { 'rel' => 'up',
+          'href' => 'http://localhost/domain-types/CollectionTest',
+          'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/domain-type"',
+          'method' => 'GET' },
+        { 'rel' => 'urn:org.restfulobjects:rels/return-type',
+          'href' => 'http://localhost/domain-types/list',
+          'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/domain-type"',
+          'method' => 'GET' },
+        { 'rel' => 'urn:org.restfulobjects:rels/element-type',
+          'href' => 'http://localhost/domain-types/ItemClass',
+          'type' => 'application/json;profile="urn:org.restfulobjects:repr-types/domain-type"',
+          'method' => 'GET' }
+      ],
+      'extensions' => wildcard_matcher
+    }
+
+    get '/domain-types/CollectionTest/collections/items'
+    last_response.body.should match_json_expression expected
+  end
+end
+