api-presenter 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Álvaro Lara
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Api::Presenter
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'api-presenter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install api-presenter
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new('spec') do |t|
+  t.test_files = FileList['spec/*_spec.rb']
+  t.verbose = true
+end

data/api-presenter.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'api/presenter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "api-presenter"
+  spec.version       = Api::Presenter::VERSION
+  spec.authors       = ["Álvaro Lara"]
+  spec.email         = ["alvarola@gmail.com"]
+  spec.description   = 'A JSON resource presenter for a specific api media type'
+  spec.summary       = 'A JSON resource presenter for a specific api media type'
+  spec.homepage      = "https://github.com/guiman/api-presenter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  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

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

data/lib/api/presenter/hypermedia.rb

@@ -0,0 +1,54 @@
+module Api
+  module Presenter
+    class Hypermedia
+      def self.present(resource)
+        # Initialize representation with links
+        representation = build_links resource
+
+        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] << nested_resource.to_resource.links(embed: true)
+          end
+        end
+
+        properties[:simple].each do |property|
+          representation[property.to_s] = resource.send(property)
+        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"]
+        end
+      end
+
+      def self.build_links(resource, options = {})
+        { "links" => resource.links(options) }
+      end
+    end
+  end
+end

data/lib/api/presenter/resource.rb

@@ -0,0 +1,34 @@
+module Api
+  module Presenter
+    class Resource
+      def initialize(resource)
+        @resource = resource
+      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
+          @resource.send(method, *args, &block)
+        else
+          super
+        end
+      end
+  
+      def links(options = {})
+        links = {}
+
+        self.methods.grep(/_link$/).each do |link_method|
+          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
+    end
+  end
+end

data/lib/api/presenter/search_resource.rb

@@ -0,0 +1,25 @@
+module Api
+  module Presenter
+    class SearchResource < CollectionResource
+      attr_reader :query
+  
+      def initialize(resource, query = {})
+        @resource = resource
+        @query = query
+      end
+
+      def self.hypermedia_properties
+        properties = super
+
+        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("&")
+      end
+    end
+  end
+end

data/lib/api/presenter/version.rb

@@ -0,0 +1,5 @@
+module Api
+  module Presenter
+    VERSION = "0.0.1"
+  end
+end

data/lib/api/presenter.rb

@@ -0,0 +1,10 @@
+require "api/presenter/version"
+require "api/presenter/hypermedia"
+require "api/presenter/resource"
+require "api/presenter/collection_resource"
+require "api/presenter/search_resource"
+
+module Api
+  module Presenter
+  end
+end

data/spec/hypertext_presenter_mocks.rb

@@ -0,0 +1,82 @@
+module HypertextPresenterMocks
+  class MockData
+    attr_accessor :number, :string, :date
+  
+    def initialize(attributes = {})
+      @number = attributes[:number]
+      @string = attributes[:string]
+      @date = attributes[:date]
+    end
+  
+    def to_resource
+      MockSingleResource.new(self)
+    end
+  end
+
+  class Collection
+    def initialize(arr)
+      @arr = arr
+    end
+  
+    def offset
+      0
+    end
+  
+    def limit
+      15
+    end
+  
+    def total
+      @arr.count
+    end
+  
+    def each(&block)
+      @arr.each &block
+    end
+  end
+
+  class MockSingleResource < Api::Presenter::Resource
+    def self.hypermedia_properties
+      {
+       simple: [:number, :string, :date],
+       resource: [:sibling]
+      }
+    end
+  
+    def self_link
+      "/path/to/single_resource/#{@resource.number}"
+    end
+  
+    def custom_link
+      "/path/to/custom_link"
+    end
+  
+    def custom_link?(options = {})
+      options[:embed].nil? || !options[:embed]
+    end
+  
+    def sibling
+      MockSingleResource.new(MockData.new(number: 20, string: "I'm a sibling of someone", date: (Date.today + 1)))
+    end
+  end
+
+  class MockCollectionResource < Api::Presenter::CollectionResource
+    def self_link
+      "/path/to/collection_resource"
+    end
+  end
+
+  class MockSearchResource < Api::Presenter::SearchResource
+    def self.hypermedia_query_parameters
+      ["page", "param1","param2"]
+    end
+  
+    def self_link
+      "/path/to/search_resource#{query_string}"
+    end
+  
+    def current_page
+      1
+    end
+  end
+end

data/spec/hypertext_presenter_spec.rb

@@ -0,0 +1,157 @@
+require_relative './spec_helper'
+require_relative './hypertext_presenter_mocks'
+
+include HypertextPresenterMocks
+
+describe Api::Presenter::Hypermedia do
+  let(:collection_resource_standard)do
+    {
+      "links" =>
+      {
+        "self" =>
+        {
+          "href" => "/path/to/collection_resource"
+        }
+      },
+
+      "offset" => 0,
+      "limit" => 15,
+      "total" => 4,
+
+      "entries" =>
+      [
+        {
+          "self" =>
+          {
+            "href" => "/path/to/single_resource/1"
+          }
+        },
+        {
+          "self" =>
+          {
+            "href" => "/path/to/single_resource/2"
+          }
+        },
+        {
+          "self" =>
+          {
+            "href" => "/path/to/single_resource/3"
+          }
+        },
+        {
+          "self" =>
+          {
+            "href" => "/path/to/single_resource/4"
+          }
+        }
+      ]
+    }
+  end
+  let(:single_resource_standard) do
+    {
+      "links" =>
+      {
+        "self" =>
+        {
+          "href" => "/path/to/single_resource/1"
+        },
+        "custom" =>
+        {
+          "href" => "/path/to/custom_link"
+        },
+        "sibling" =>
+        {
+          "href" => "/path/to/single_resource/20"
+        }
+      },
+      "number" => 1,
+      "string" => 'This is a string',
+      "date" => Date.today.to_s
+    }
+  end
+  let(:search_resource_standard)do
+    {
+      "links" =>
+      {
+        "self" =>
+        {
+          "href" => "/path/to/search_resource?query[page]=1&query[param1]=1&query[param2]=string"
+        }
+      },
+
+      "offset" => 0,
+      "limit" => 15,
+      "total" => 4,
+      
+      "query" =>
+      {
+        "page" => 1,
+        "param1" => 1,
+        "param2" => "string"
+      },
+
+      "entries" =>
+      [ {
+          "self" =>
+          {
+            "href" => "/path/to/single_resource/1"
+          }
+        },
+        {
+          "self" =>
+          {
+            "href" => "/path/to/single_resource/2"
+          }
+        },
+        {
+          "self" =>
+          {
+            "href" => "/path/to/single_resource/3"
+          }
+        },
+        {
+          "self" =>
+          {
+            "href" => "/path/to/single_resource/4"
+          }
+        } ]
+    }
+  end
+  
+  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 }
+    
+    it "must respect the standard" do
+      MultiJson.load(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
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'bundler'
+require 'minitest/autorun'
+require 'multi_json'
+require 'date'
+require 'time'
+
+Bundler.require

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: api-presenter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Álvaro Lara
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- api-presenter.gemspec
+- lib/api/presenter.rb
+- lib/api/presenter/collection_resource.rb
+- lib/api/presenter/hypermedia.rb
+- lib/api/presenter/resource.rb
+- lib/api/presenter/search_resource.rb
+- lib/api/presenter/version.rb
+- spec/hypertext_presenter_mocks.rb
+- spec/hypertext_presenter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/guiman/api-presenter
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A JSON resource presenter for a specific api media type
+test_files:
+- spec/hypertext_presenter_mocks.rb
+- spec/hypertext_presenter_spec.rb
+- spec/spec_helper.rb
+has_rdoc: