hyperclient 0.0.5 → 0.0.6

data/Readme.md

@@ -19,7 +19,7 @@ class MyAPIClient
 
   entry_point 'http://myapp.com/api'
   auth :digest, 'user', 'password'
-  http_options {headers: {'accept-encoding' => 'deflate, gzip'}}
+  http_options headers: {'accept-encoding' => 'deflate, gzip'}, debug: true
 end
 ````
 

data/examples/hal_shop.rb

@@ -4,6 +4,7 @@ class HalShop
   include Hyperclient
 
   entry_point 'http://hal-shop.heroku.com'
+  http_options debug: true
 end
 
 def print_resources(resources)

data/lib/hyperclient.rb

@@ -59,7 +59,7 @@ module Hyperclient
     #
     # Example:
     #
-    #   http_options {headers: {'accept-encoding' => 'deflate, gzip'}}
+    #   http_options headers: {'accept-encoding' => 'deflate, gzip'}
     #
     # Returns a Hash.
     def http_options(options = {})

data/lib/hyperclient/discoverer.rb

@@ -55,7 +55,20 @@ module Hyperclient
     def build_resource(representation, name = nil)
       return representation.map(&method(:build_resource)) if representation.is_a?(Array)
 
-      ResourceFactory.resource(representation.delete('href'), {representation: representation, name: name})
+      url = extract_url(representation)
+      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')
+
+      if representation && representation['_links'] && representation['_links']['self'] &&
+          (url = representation['_links']['self']['href'])
+        return url
+      end
     end
   end
 end

data/lib/hyperclient/http.rb

@@ -26,6 +26,7 @@ module Hyperclient
       @resource = resource
       authenticate(options[:auth]) if options && options.include?(:auth)
       headers(options[:headers]) if options && options.include?(:headers)
+      enable_debug(options[:debug]) if options && options.include?(:debug)
     end
 
     # Public: Sends a GET request the the resource url.
@@ -99,5 +100,19 @@ module Hyperclient
     def headers(headers)
       self.class.send(:headers, headers)
     end
+
+    # Internal: Enables HTTP debugging.
+    #
+    # stream - An object to stream the HTTP out to or just a truthy value. If
+    #          it's truthy it will output to $stderr.
+    def enable_debug(stream)
+      return unless stream
+
+      if stream.respond_to?(:<<)
+        self.class.debug_output(stream)
+      else
+        self.class.debug_output
+      end
+    end
   end
 end

data/lib/hyperclient/representation.rb

@@ -37,15 +37,6 @@ module Hyperclient
     def attributes
       @attributes ||= @representation.dup.delete_if {|key, value| key =~ /^_/}
     end
-
-    # Public: Returns a String with the resource URL or nil of it does not have
-    # one.
-    def url
-      if @representation && @representation['_links'] && @representation['_links']['self'] &&
-          (url = @representation['_links']['self']['href'])
-        return url
-      end
-    end
   end
 end
 

data/lib/hyperclient/resource.rb

@@ -69,7 +69,6 @@ module Hyperclient
     def initialize_representation(raw_representation)
       if raw_representation && !raw_representation.empty?
         @representation = Representation.new(raw_representation)
-        @url = @representation.url if @representation.url
       end
     end
 

data/lib/hyperclient/resource_factory.rb

@@ -14,7 +14,12 @@ module Hyperclient
     #
     # url - A String to identify the Resource
     # args - An Array to pass other arguments to the Resource initialization.
+    #
+    # Raises MissingURLException if no url given.
+    # Returns a Resource.
     def self.resource(url, *args)
+      raise MissingURLException.new(args) unless url
+
       identity_map.fetch(url) do |url|
         resource = Resource.new(url, *args)
         identity_map.update(url => resource)
@@ -28,6 +33,21 @@ module Hyperclient
       @identity_map ||= {}
     end
   end
+
+  # Public: Exception that is raised when building a Resource without a URL.
+  class MissingURLException < StandardError
+    # Public: Initializes a MissingURLException
+    #
+    # args - An Array of the args the were to be used to build the Resource.
+    def initialize(args)
+      @args = args
+    end
+
+    # Public: Returns a String with the exception message.
+    def message
+      "Cannot build Resource without a URL, given args were: #{@args.inspect}"
+    end
+  end
 end
 
 require 'hyperclient/resource'

data/lib/hyperclient/version.rb

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

data/test/hyperclient/http_test.rb

@@ -35,6 +35,21 @@ module Hyperclient
       end
     end
 
+    describe 'debug' do
+      it 'enables debugging' do
+        http = HTTP.new(resource, {debug: true})
+
+        http.class.instance_variable_get(:@default_options)[:debug_output].must_equal $stderr
+      end
+
+      it 'uses a custom stream' do
+        stream = StringIO.new
+        http = HTTP.new(resource, {debug: stream})
+
+        http.class.instance_variable_get(:@default_options)[:debug_output].must_equal stream
+      end
+    end
+
     describe 'get' do
       it 'sends a GET request and returns the response body' do
         stub_request(:get, 'api.example.org/productions/1').

data/test/hyperclient/representation_test.rb

@@ -9,15 +9,15 @@ module Hyperclient
 
     describe 'intialize' do
       it 'handles non-hash representations' do
-        representation = Representation.new '{"_links": {"self": {"href": "/productions/1"}}}'
+        representation = Representation.new '{"title": "Hello world"}'
 
-        representation.url.must_equal '/productions/1'
+        representation.attributes['title'].must_equal 'Hello world'
       end
 
       it 'does not raise when non-JSON response is given' do
         representation = Representation.new 'This is not JSON'
 
-        representation.url.must_equal nil
+        representation.attributes.must_equal({})
       end
     end
 
@@ -48,17 +48,5 @@ module Hyperclient
         representation.resources.episodes.last.must_be_kind_of Resource
       end
     end
-
-    describe 'url' do
-      it 'returns the url of the resource grabbed from the representation' do
-        representation.url.must_equal '/productions/1'
-      end
-
-      it 'returns nil when the representation does not include the resource url' do
-        representation = Representation.new({_links: {media: {href: '/media/1'}}})
-
-        representation.url.must_equal nil
-      end
-    end
   end
 end

data/test/hyperclient/resource_factory_test.rb

@@ -23,6 +23,10 @@ module Hyperclient
 
         new_resource.object_id.must_equal resource.object_id
       end
+
+      it 'raises if the given url is nil' do
+        proc { ResourceFactory.resource(nil) }.must_raise MissingURLException
+      end
     end
   end
 end

data/test/hyperclient/resource_test.rb

@@ -38,18 +38,6 @@ module Hyperclient
         assert_not_requested(:get, 'http://api.example.org/')
       end
 
-      it 'updates the resource URL if the representation has one' do
-        resource = Resource.new('/', {representation: JSON.parse(representation)})
-
-        resource.url.must_include '/productions/1'
-      end
-
-      it 'does no update the resource URL if the representation does not have one' do
-        resource = Resource.new('/', {})
-
-        resource.url.wont_include '/productions/1'
-      end
-
       it 'sets the resource name' do
         resource = Resource.new('/', {name: 'posts'})
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hyperclient
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-23 00:00:00.000000000 Z
+date: 2012-06-30 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: -2046368484385540531
+      hash: -2196933980159133374
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -135,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2046368484385540531
+      hash: -2196933980159133374
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23