api-presenter 0.0.2 → 0.0.3

data/README.md

@@ -50,12 +50,9 @@ In order to be able to represent this resource we need to have a PersonResource
 
 ```ruby
 class PersonResource < Api::Presenter::Resource
-  def self.hypermedia_properties
-  {
-    simple: [:name, :age],
-    resource: []
-  }
-  end
+
+  property :name
+  property :age
   
   def self_link
     "/person/#{@resource.name}"
@@ -63,10 +60,7 @@ class PersonResource < Api::Presenter::Resource
 end
 ```
 
-The class method ```hypermedia_properties``` describes the model properties:
-
-* simple: An array containing method names that represent simple data (integers, strings, dates, etc.).
-* resource: An array containing method names thar represent related resources.
+We should use the property method to define each of our resource properties.
 
 The self_link definition tell which is the link that represents itself.
 
@@ -88,7 +82,7 @@ data = Person.new("Alvaro", 27)
 
 resource = data.to_resource # or just PersonResource.new(data)
 
-Api::Presenter::Hypermedia.present resource
+resource.present # or Api::Presenter::Hypermedia.present resource
 ```
 
 It will look like this:
@@ -115,12 +109,8 @@ Using the example above, now our person has a dog. So:
 
 ```ruby
 class DogResource < Api::Presenter::Resource
-  def self.hypermedia_properties
-  {
-    simple: [:name],
-    resource: [:owner]
-  }
-  end
+  property name
+  property owner
 
   def self_link
     "/dog/#{@resource.name}"
@@ -141,12 +131,9 @@ class Dog
 end
 
 class PersonResource < Api::Presenter::Resource
-  def self.hypermedia_properties
-  {
-    simple: [:name, :age],
-    resource: [:dog]
-  }
-  end
+  property :name
+  property :age
+  property :dog
 end
 ```
 
@@ -159,7 +146,7 @@ dog = Dog.new("Cleo", person)
 
 person_resource = person.to_resource # or just PersonResource.new(person)
 
-Api::Presenter::Hypermedia.present person_resource
+person_resource.present # Api::Presenter::Hypermedia.present person_resource
 ```
 
 It will look like this:

data/api-presenter.gemspec

@@ -20,7 +20,4 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  
-  spec.add_dependency "multi_json", "~> 1.7.4"
-  spec.add_dependency "json", "~> 1.8.0"
 end

data/lib/api/presenter/collection_resource.rb

@@ -1,13 +1,12 @@
 module Api
   module Presenter
-    class CollectionResource < Resource  
-      def self.hypermedia_properties
-        {
-          simple:  [:offset, :limit, :total,:entries],
-          resource: []
-        }
-      end
-  
+    class CollectionResource < Resource
+
+      property :offset
+      property :limit
+      property :total
+      property :entries
+
       def entries
         @resource
       end

data/lib/api/presenter/hypermedia.rb

@@ -1,54 +1,53 @@
 module Api
   module Presenter
     class Hypermedia
-      def self.present(resource)
-        # Initialize representation with links
-        representation = build_links resource
+      class << self
+        def present(resource)
+          # Initialize representation with links
+          representation = build_links resource
 
-        present_properties resource, representation
+          present_properties resource, representation
 
-        MultiJson.dump representation
-      end
-
-      # Process basic information from the resource such as
-      # simlple fields(Dates, numbers, etc.) and also more
-      # complex ones that may be subject of expansion.
-      def self.present_properties(resource, representation)
-        properties = resource.class.hypermedia_properties
-
-        present_simple_properties resource, properties, representation
-
-        present_resource_properties resource, properties, representation
-      end
-
-      def self.present_simple_properties(resource, properties, representation)
-        entries_property = properties[:simple].delete(:entries)
-
-        if entries_property
-          representation[entries_property.to_s] = []
-          resource.send(entries_property).each do |nested_resource|
-            representation[entries_property.to_s] << build_links(nested_resource.to_resource, embed: true)
-          end
+          representation
         end
 
-        properties[:simple].each do |property|
-          representation[property.to_s] = resource.send(property)
+        # Process basic information from the resource such as
+        # simlple fields(Dates, numbers, etc.) and also more
+        # complex ones that may be subject of expansion.
+        def present_properties(resource, representation)
+          resource_properties = resource.class.properties
+          
+          # Special treatment for entries
+          entries_property = resource_properties.delete(:entries)
+
+          if entries_property
+            representation[entries_property.to_s] = []
+            resource.send(entries_property).each do |nested_resource|
+              representation[entries_property.to_s] << build_links(nested_resource.to_resource, embed: true)
+            end
+          end
+          
+          # Now the other muggles   
+          resource_properties.each do |property_name|
+            property_value = resource.send(property_name)
+            
+            if property_value.kind_of?(Resource) || property_value.respond_to?(:to_resource)
+              # Resource like properties
+              property_value = property_value.to_resource if property_value.respond_to? :to_resource
+              representation["links"][property_name.to_s] = property_value.links(embed: resource.kind_of?(CollectionResource))
+              # we only need the "self" contents
+              representation["links"][property_name.to_s] = representation["links"][property_name.to_s]["self"] if representation["links"][property_name.to_s]["self"]              
+            else
+              # Non-Resource like properties
+              representation[property_name.to_s] = property_value
+            end
+          end
         end
-      end
 
-      def self.present_resource_properties(resource, properties, representation)
-        properties[:resource].each do |property|
-          relation = resource.send(property)
-          relation_resource = (relation.kind_of? Resource) ? relation : relation.to_resource
-          representation["links"][property.to_s] = relation_resource.links(embed: resource.kind_of?(CollectionResource))
-          # we only need the "self" contents
-          representation["links"][property.to_s] = representation["links"][property.to_s]["self"] if representation["links"][property.to_s]["self"]
+        def build_links(resource, options = {})
+          { "links" => resource.links(options) }
         end
       end
-
-      def self.build_links(resource, options = {})
-        { "links" => resource.links(options) }
-      end
     end
   end
 end

data/lib/api/presenter/resource.rb

@@ -4,17 +4,30 @@ module Api
       def initialize(resource)
         @resource = resource
       end
-  
+
+      class << self
+        def property(value)
+          properties << value unless properties.include? value
+        end
+
+        def properties
+          @properties ||= []
+        end
+
+        def inherited(subclass)
+          subclass.properties << properties
+          subclass.properties.flatten!
+        end
+      end
+
       def method_missing(method, *args, &block)
-        allowed_methods = self.class.hypermedia_properties[:simple].concat self.class.hypermedia_properties[:resource]
-    
-        if allowed_methods.include? method
+        if self.class.properties.include? method
           @resource.send(method, *args, &block)
         else
           super
         end
       end
-  
+
       def links(options = {})
         links = {}
 
@@ -22,13 +35,17 @@ module Api
           link_name = link_method.to_s.split("_").first
           links[link_name] = { "href" => self.send(link_method) } if self.send(link_method.to_s + "?", options)
         end
-    
+
         links
       end
-  
+
       def self_link?(options = {})
         true
       end
+      
+      def present
+        Api::Presenter::Hypermedia.present self
+      end
     end
   end
 end

data/lib/api/presenter/search_resource.rb

@@ -2,20 +2,14 @@ module Api
   module Presenter
     class SearchResource < CollectionResource
       attr_reader :query
-  
-      def initialize(resource, query = {})
+      
+      def initialize(resource, query)
         @resource = resource
         @query = query
       end
 
-      def self.hypermedia_properties
-        properties = super
+      property :query
 
-        properties[:simple] = properties[:simple].concat [:query]
-
-        properties
-      end
-  
       def query_string
         result = self.class.hypermedia_query_parameters.inject([]) { |col, query_parameter| col << "query[#{query_parameter}]=#{@query[query_parameter]}" }
         "?" + result.join("&")

data/lib/api/presenter/version.rb

@@ -1,5 +1,5 @@
 module Api
   module Presenter
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/spec/hypertext_presenter_mocks.rb

@@ -36,12 +36,11 @@ module HypertextPresenterMocks
   end
 
   class MockSingleResource < Api::Presenter::Resource
-    def self.hypermedia_properties
-      {
-       simple: [:number, :string, :date],
-       resource: [:sibling]
-      }
-    end
+
+    property :number
+    property :string
+    property :date
+    property :sibling
   
     def self_link
       "/path/to/single_resource/#{@resource.number}"

data/spec/hypertext_presenter_spec.rb

@@ -59,6 +59,7 @@ describe Api::Presenter::Hypermedia do
       ]
     }
   end
+
   let(:single_resource_standard) do
     {
       "links" =>
@@ -78,9 +79,10 @@ describe Api::Presenter::Hypermedia do
       },
       "number" => 1,
       "string" => 'This is a string',
-      "date" => Date.today.to_s
+      "date" => Date.today
     }
   end
+
   let(:search_resource_standard)do
     {
       "links" =>
@@ -147,37 +149,39 @@ describe Api::Presenter::Hypermedia do
   describe "when presenting a single resource" do
     
     let(:mock_data) { MockData.new(number: 1, string: 'This is a string', date: Date.today) }
-    let(:single_resource){ MockSingleResource.new mock_data }
-    let(:presented_single_resource){ Api::Presenter::Hypermedia.present single_resource }
+    let(:single_resource) { MockSingleResource.new mock_data }
+    let(:presented_single_resource) { single_resource.present }
     
     it "must respect the standard" do
-      MultiJson.load(presented_single_resource).must_equal single_resource_standard
+      presented_single_resource.must_equal single_resource_standard
     end    
   end
 
-  describe "presenting a collection resource" do
-    
-    let(:mock_data_collection) do
-      collection = []
-      4.times { |number| collection << MockData.new(number: number + 1, string: 'This is a string', date: Date.today) }
-      Collection.new(collection)
-    end
-    
-    let(:collection_resource){ MockCollectionResource.new mock_data_collection }
-    
-    let(:presented_collection_resource){ Api::Presenter::Hypermedia.present collection_resource }
-
-    it "must respect the standard" do
-      MultiJson.load(presented_collection_resource).must_equal collection_resource_standard
-    end
-    
-    describe "presenting a search resource" do
-      let(:search_resource){ MockSearchResource.new mock_data_collection, "page" => 1, "param1" => 1, "param2" => "string" }
-      let(:presented_search_resource){ Api::Presenter::Hypermedia.present search_resource }
-    
-      it "must respect the standard" do
-        MultiJson.load(presented_search_resource).must_equal search_resource_standard
-      end
+   describe "presenting a collection resource" do
+     
+     let(:mock_data_collection) do
+       collection = []
+       4.times { |number| collection << MockData.new(number: number + 1, string: 'This is a string', date: Date.today) }
+       Collection.new(collection)
+     end
+     
+     let(:collection_resource) { MockCollectionResource.new mock_data_collection }
+     
+     let(:presented_collection_resource) { collection_resource.present }
+  
+     it "must respect the standard" do
+       presented_collection_resource.must_equal collection_resource_standard
+     end
+     
+     describe "presenting a search resource" do
+       
+       let(:search_resource) { MockSearchResource.new mock_data_collection, "page" => 1, "param1" => 1, "param2" => "string" }
+       
+       let(:presented_search_resource) { search_resource.present }
+     
+       it "must respect the standard" do
+         presented_search_resource.must_equal search_resource_standard
+       end
+     end
     end
-  end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,5 @@
 require 'bundler'
 require 'minitest/autorun'
-require 'multi_json'
 require 'date'
 require 'time'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api-presenter
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-04 00:00:00.000000000 Z
+date: 2013-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -43,38 +43,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.7.4
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.7.4
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.8.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.8.0
 description: A JSON resource presenter for a specific api media type
 email:
 - alvarola@gmail.com