api-presenter 0.1.0 → 0.1.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDg5ZTVjMDA3M2E4YWQxZjM4YzFmOTY3MzJlNjk5NmZlNjczMjE5ZQ==
+  data.tar.gz: !binary |-
+    YjJhY2EwMjM4NzdmNWNiMzNhN2FmN2Y4MGExZWQ5MTBlZjEyMzFhZQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NjQ1NzkyZTExODQxOWE3ZDA1ZWQyNzBjNjAzYjg0ZTAyYjVmNDFkMzcxZjNh
+    MzFlYzdjYTE0NjBkZmFhZDhkMzA0MWM3ZTA4NjFlZjc1Y2E3NjQ3YWY0MjIy
+    ZmEwMTg2OTI1YWJhZGEyN2VhOTk1ODMwZjRmZTVmODM4NzM3YTM=
+  data.tar.gz: !binary |-
+    MzM0ZmJjZGNhM2I0ZDdiYmY4MDc1MmI0MWI4NWFkNzBkNTc4OWRmNDQzZDFh
+    ZTJjZTIxOTZjY2UyMWYyZDdlMTI5MzgyNzA1NzFkYjEyMWUxNjExMGI5NmRj
+    OGQ4NWJlNzkyOTkxNGVjY2UwZWM3ZDJjMGRhNGFlMGZjZTM1MzU=

data/README.md

@@ -1,4 +1,6 @@
 # Api::Presenter
+[![Build Status](https://travis-ci.org/guiman/api-presenter.png?branch=complete_url_feature)](https://travis-ci.org/guiman/api-presenter)
+[![Code Climate](https://codeclimate.com/github/guiman/api-presenter.png)](https://codeclimate.com/github/guiman/api-presenter)
 
 This gem builds the basics for presenting your data using the media type described in the [api doc](https://github.com/ncuesta/api-doc). Here you will find classes to represent your resources
 and also the functions to convert them to a ruby hash. It's your decision how to export them.

data/lib/api/presenter/resource.rb

@@ -23,15 +23,23 @@ module Api
         def links
           @links ||= {}
         end
-        
+
         def host
           @@host ||= ''
         end
-        
+
         def host=(v)
           @@host = v
         end
 
+        def prefix
+          @@prefix ||= ''
+        end
+
+        def prefix=(v)
+          @@prefix = v
+        end
+
         def inherited(subclass)
           (subclass.properties << properties).flatten!
         end
@@ -50,15 +58,15 @@ module Api
 
         self.class.links.each do |link_name, link_value|
           link_actual_value = link_value[:value].dup
-          
+
           # retrieve stubs to replace looking for {{method_to_call}}
           stubs = link_actual_value.scan(/\{\{(\w+)\}\}/).flatten
-          
+
           # now we replace them
           stubs.each{ |stub| link_actual_value.gsub!(/\{\{#{stub}\}\}/, self.send(stub.to_sym).to_s) }
-          
+
           # and finish the url
-          links[link_name.to_s] = { "href" => "#{self.class.host}#{link_actual_value}" } if link_value[:condition].call(options)
+          links[link_name.to_s] = { "href" => "#{self.class.host}#{self.class.prefix}#{link_actual_value}" } if link_value[:condition].call(options)
         end
 
         links
@@ -67,7 +75,7 @@ module Api
       def self_link?(options = {})
         true
       end
-      
+
       def present
         Api::Presenter::Hypermedia.present self
       end

data/lib/api/presenter/version.rb

@@ -1,5 +1,5 @@
 module Api
   module Presenter
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/spec/hypertext_presenter_spec.rb

@@ -96,7 +96,7 @@ describe Api::Presenter::Hypermedia do
       "offset" => 0,
       "limit" => 15,
       "total" => 4,
-      
+
       "query" =>
       {
         "page" => 1,
@@ -154,7 +154,7 @@ describe Api::Presenter::Hypermedia do
         def floating_point_value
           10.3
         end
-        
+
         def to_resource
           MockSingleSpecificResource.new self
         end
@@ -169,17 +169,17 @@ describe Api::Presenter::Hypermedia do
 
       new_single_resource_standard = single_resource_standard
       new_single_resource_standard['floating_point_value'] = 10.3
-      
+
       mock_data = MockSpecificData.new(number: 1, string: 'This is a string', date: Date.today)
 
       mock_data.to_resource.present.must_equal new_single_resource_standard
     end
   end
-  
+
   describe "when using host" do
     it "must display a complete url" do
       Api::Presenter::Resource.host = "http://localhost:9292"
-      
+
       mock_data.to_resource.present.wont_equal single_resource_standard
 
       new_single_resource_standard = {
@@ -202,43 +202,76 @@ describe Api::Presenter::Hypermedia do
         "string" => 'This is a string',
         "date" => Date.today
       }
-      
+
       mock_data.to_resource.present.must_equal new_single_resource_standard
-      
+
       Api::Presenter::Resource.host = ''
-    end    
+    end
+  end
+
+  describe "when using prefix" do
+    it "must display a complete url" do
+      Api::Presenter::Resource.prefix = "/my_prefix"
+
+      mock_data.to_resource.present.wont_equal single_resource_standard
+
+      new_single_resource_standard = {
+        "links" =>
+        {
+          "self" =>
+          {
+            "href" => "/my_prefix/path/to/single_resource/1"
+          },
+          "custom" =>
+          {
+            "href" => "/my_prefix/path/to/custom_link"
+          },
+          "sibling" =>
+          {
+            "href" => "/my_prefix/path/to/single_resource/20"
+          }
+        },
+        "number" => 1,
+        "string" => 'This is a string',
+        "date" => Date.today
+      }
+
+      mock_data.to_resource.present.must_equal new_single_resource_standard
+
+      Api::Presenter::Resource.prefix = ''
+    end
   end
-  
+
   describe "when presenting a single resource" do
     let(:presented_single_resource) { mock_data.to_resource.present }
-    
+
     it "must respect the standard" do
       presented_single_resource.must_equal single_resource_standard
-    end    
+    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) { 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

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: api-presenter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.1.1
 platform: ruby
 authors:
 - Álvaro Lara
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-13 00:00:00.000000000 Z
+date: 2013-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -69,27 +64,26 @@ files:
 homepage: https://github.com/guiman/api-presenter
 licenses:
 - MIT
+metadata: {}
 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
+rubygems_version: 2.0.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A JSON resource presenter for a specific api media type
 test_files:
 - spec/hypertext_presenter_mocks.rb