hyperclient 0.0.6 → 0.0.7

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+examples/william.rb

data/Readme.md

@@ -121,6 +121,8 @@ posts.post({title: "I'm a blogger!", body: 'Wohoo!!'})
 
 * Resource permissions: Using the `Allow` header Hyperclient should be able to
   restrict the allowed method on a given `Resource`.
+* Curie syntax support for links (see http://tools.ietf.org/html/draft-kelly-json-hal-03#section-8.2)
+* Profile support for links
 
 
 ## Contributing

data/examples/cyberscore.rb

@@ -6,15 +6,15 @@ class Cyberscore
   entry_point 'http://cs-api.heroku.com/api/'
 
   def news
-    links.feeds.links.submissions.resources.news
+    links.feeds.links.submissions.embedded.news
   end
 
   def submissions
-    links.feeds.links.submissions.resources.submissions
+    links.feeds.links.submissions.embedded.submissions
   end
 
   def games
-    links.feeds.links.games.resources.games
+    links.feeds.links.games.embedded.games
   end
 
   def add_game(name)

data/examples/hal_shop.rb

@@ -35,11 +35,11 @@ print_resources(api.links)
 
 puts
 puts 'Resources at the entry point:'
-print_resources(api.resources)
+print_resources(api.embedded)
 
 puts
 puts "Let's see what stats we have:"
-print_attributes(api.resources.stats.attributes)
+print_attributes(api.embedded.stats.attributes)
 
 products = api.links["http://hal-shop.heroku.com/rels/products"].reload
 
@@ -49,7 +49,7 @@ puts products.attributes['inventory_size']
 
 puts 
 puts 'What resources does products have?'
-print_resources(products.resources.products)
+print_resources(products.embedded.products)
 
 puts
 puts 'And links?'
@@ -57,4 +57,4 @@ print_resources(products.links)
 
 puts
 puts 'Attributes of the first product?'
-print_attributes(products.resources.products.first.attributes)
+print_attributes(products.embedded.products.first.attributes)

data/lib/hyperclient/discoverer.rb

@@ -44,7 +44,7 @@ module Hyperclient
 
       @resources ||= @representation.inject({}) do |memo, (name, representation)|
         next memo if name == 'self'
-        memo.update(name => build_resource(representation, name))
+      memo.update(name => build_resource(representation, name))
       end
     end
 
@@ -55,19 +55,27 @@ module Hyperclient
     def build_resource(representation, name = nil)
       return representation.map(&method(:build_resource)) if representation.is_a?(Array)
 
-      url = extract_url(representation)
+      url = URLExtractor.new(representation).url
       ResourceFactory.resource(url, {representation: representation, name: name})
     end
 
-    # Internal: Returns a String with the resource URL
-    #
-    # representation - The JSON representation of the resource.
-    def extract_url(representation)
-      return representation['href'] if representation.include?('href')
+    # Internal: Extract the url from a HAL representation.
+    class URLExtractor
+      # Public: Initializes a URLExtractor.
+      #
+      # representation - A Hash with the representation of a Resource.
+      def initialize(representation)
+        @representation = representation
+      end
+
+      # Public: Returns a String with the resource URL
+      def url
+        return @representation.delete('href') if @representation.include?('href')
 
-      if representation && representation['_links'] && representation['_links']['self'] &&
-          (url = representation['_links']['self']['href'])
-        return url
+        if @representation && @representation['_links'] && @representation['_links']['self'] &&
+          (url = @representation['_links']['self']['href'])
+          return url
+        end
       end
     end
   end

data/lib/hyperclient/representation.rb

@@ -29,7 +29,7 @@ module Hyperclient
 
     # Public: Returns a Discoverer for the _embedded section of the representation.
     # It can be used later to use the resources from this section.
-    def resources
+    def embedded
       @embedded ||= Discoverer.new(@representation['_embedded'])
     end
 

data/lib/hyperclient/resource.rb

@@ -8,7 +8,7 @@ module Hyperclient
   class Resource
     extend Forwardable
     # Public: Delegate attributes and resources to the representation.
-    def_delegators :representation, :attributes, :resources, :links
+    def_delegators :representation, :attributes, :embedded, :links
 
     # Public: Delegate all HTTP methods (get, post, put, delete, options and
     # head) to Hyperclient::HTTP.

data/lib/hyperclient/version.rb

@@ -1,3 +1,3 @@
 module Hyperclient
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/test/hyperclient/discoverer_test.rb

@@ -72,5 +72,30 @@ module Hyperclient
         discoverer.filter.name.wont_be_empty
       end
     end
+
+    describe Discoverer::URLExtractor do
+      describe 'url' do
+        it 'extracts the url from embedded resources' do
+          hal = {'_links' => {'self' => {'href' => '/path/to/resource'}}}
+          extractor = Discoverer::URLExtractor.new(hal)
+
+          extractor.url.must_equal '/path/to/resource'
+        end
+
+        it 'extracts the url from linked resources' do
+          hal = {'href' => '/path/to/resource'}
+          extractor = Discoverer::URLExtractor.new(hal)
+
+          extractor.url.must_equal '/path/to/resource'
+        end
+
+        it 'deletes the url from linked resources to prevent empty representations' do
+          hal = {'href' => '/path/to/resource'}
+          Discoverer::URLExtractor.new(hal).url
+
+          hal.include?('href').must_equal false
+        end
+      end
+    end
   end
 end

data/test/hyperclient/representation_test.rb

@@ -41,11 +41,11 @@ module Hyperclient
       end
     end
 
-    describe 'resources' do
+    describe 'embedded' do
       it 'returns resources included in the _embedded section' do
-        representation.resources.author.must_be_kind_of Resource
-        representation.resources.episodes.first.must_be_kind_of Resource
-        representation.resources.episodes.last.must_be_kind_of Resource
+        representation.embedded.author.must_be_kind_of Resource
+        representation.embedded.episodes.first.must_be_kind_of Resource
+        representation.embedded.episodes.last.must_be_kind_of Resource
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hyperclient
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-30 00:00:00.000000000 Z
+date: 2012-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -126,7 +126,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2196933980159133374
+      hash: -1844692704935824375
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -135,10 +135,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2196933980159133374
+      hash: -1844692704935824375
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.19
 signing_key: 
 specification_version: 3
 summary: ''