hyperclient 0.0.2 → 0.0.3

data/Readme.md

@@ -1,10 +1,10 @@
 # Hyperclient [![Build Status](https://secure.travis-ci.org/codegram/hyperclient.png)](http://travis-ci.org/codegram/hyperclient) [![Dependency Status](https://gemnasium.com/codegram/hyperclient.png)](http://gemnasium.com/codegram/hyperclient)
 
-Hyperclient is a Ruby Hypermedia API client.
+Hyperclient is a Ruby Hypermedia API client written in Ruby.
 
 ## Documentation
 
-[Hyperclient on documentup][documentup]
+[Hyperclient on documentup][documentup] and [Hyperclient API documentation on rdoc.info][rdoc]
 
 ## Usage
 
@@ -142,4 +142,5 @@ MIT License. Copyright 2012 [Codegram Technologies][codegram]
 [documentup]: http://codegram.github.com/hyperclient
 [httparty]: http://github.com/jnunemaker/httparty
 [examples]: http://github.com/codegram/hyperclient/tree/master/examples
-[enumerable]: http://ruby-doc.org/core-1.9.3/Enumerable.html
+[enumerable]: http://ruby-doc.org/core-1.9.3/Enumerable.html
+[rdoc]: http://rubydoc.org/github/codegram/hyperclient/master/frames

data/lib/hyperclient/discoverer.rb

@@ -55,9 +55,9 @@ module Hyperclient
     def build_resource(response, name = nil)
       return response.map(&method(:build_resource)) if response.is_a?(Array)
 
-      Resource.new(response.delete('href'), {response: response, name: name})
+      ResourceFactory.resource(response.delete('href'), {response: response, name: name})
     end
   end
 end
 
-require 'hyperclient/resource'
+require 'hyperclient/resource_factory'

data/lib/hyperclient/resource_factory.rb

@@ -0,0 +1,33 @@
+module Hyperclient
+  # Public: This class acts as an interface to build Resources. It has a simple
+  # identity map so a user can save HTTP calls when interacting with the same
+  # resource.
+  #
+  # Examples
+  #
+  # ResourceFactory.resource('http://myapi.org/resource/1')
+  # => #<Hyperclient::Resource url: 'http://myapi.org/resource/1'>
+  #
+  class ResourceFactory
+    # Public: A factory method to build Resources. It will try to find a
+    # Resource in the identity map or build a new one if does not exist.
+    #
+    # url - A String to identify the Resource
+    # args - An Array to pass other arguments to the Resource initialization.
+    def self.resource(url, *args)
+      identity_map.fetch(url) do |url|
+        resource = Resource.new(url, *args)
+        identity_map.update(url => resource)
+        resource
+      end
+    end
+
+    private
+    # Internal: Returns a Hash that acts as identity map.
+    def self.identity_map
+      @identity_map ||= {}
+    end
+  end
+end
+
+require 'hyperclient/resource'

data/lib/hyperclient/version.rb

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

data/test/hyperclient/resource_factory_test.rb

@@ -0,0 +1,28 @@
+require_relative '../test_helper'
+require 'hyperclient/resource_factory'
+
+module Hyperclient
+  describe ResourceFactory do
+    let(:resource) do
+      ResourceFactory.resource('/path/to/resource')
+    end
+
+    before do
+      Hyperclient::Resource.entry_point = 'http://myapi.org'
+    end
+
+    describe 'resource' do
+      it 'creates a new resource when is not present in the identity map' do
+        resource = ResourceFactory.resource('/path/to/resource')
+
+        resource.url.must_include '/path/to/resource'
+      end
+
+      it 'returns the resource when is already present in the identity map' do
+        new_resource = ResourceFactory.resource('/path/to/resource')
+
+        new_resource.object_id.must_equal resource.object_id
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hyperclient
 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: 2012-05-29 00:00:00.000000000 Z
+date: 2012-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -98,6 +98,7 @@ files:
 - lib/hyperclient/discoverer.rb
 - lib/hyperclient/http.rb
 - lib/hyperclient/resource.rb
+- lib/hyperclient/resource_factory.rb
 - lib/hyperclient/response.rb
 - lib/hyperclient/version.rb
 - test/fixtures/collection.json
@@ -105,6 +106,7 @@ files:
 - test/fixtures/root.json
 - test/hyperclient/discoverer_test.rb
 - test/hyperclient/http_test.rb
+- test/hyperclient/resource_factory_test.rb
 - test/hyperclient/resource_test.rb
 - test/hyperclient/response_test.rb
 - test/hyperclient_test.rb
@@ -123,7 +125,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2437981689318086472
+      hash: 2448296263010756108
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -132,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2437981689318086472
+      hash: 2448296263010756108
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -145,6 +147,7 @@ test_files:
 - test/fixtures/root.json
 - test/hyperclient/discoverer_test.rb
 - test/hyperclient/http_test.rb
+- test/hyperclient/resource_factory_test.rb
 - test/hyperclient/resource_test.rb
 - test/hyperclient/response_test.rb
 - test/hyperclient_test.rb