hyperclient 0.0.3 → 0.0.4

data/Gemfile

@@ -3,6 +3,7 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rake'
+gem 'growl'
 gem 'guard'
 gem 'guard-minitest'
 gem 'pry'

data/examples/cs.rb

@@ -0,0 +1,44 @@
+require 'hyperclient'
+
+class HalShop
+  include Hyperclient
+
+  entry_point 'http://cs-api.heroku.com/api/'
+end
+
+def print_resources(resources)
+  resources.each do |resource|
+    if resource.is_a?(Array)
+      print_resources(resource)
+    else
+      puts %{Found "#{resource.name}" at "#{resource.url}" }
+    end
+  end
+end
+
+def print_games(games)
+  games.each do |game|
+    puts %{Found "#{game.attributes['name']}" at "#{game.url}" }
+  end
+end
+
+
+api = HalShop.new
+
+puts "Let's inspect the API:"
+puts "\n"
+
+puts 'Links from the entry point:'
+print_resources(api.links)
+puts "\n"
+
+puts 'How is the server feeling today?'
+puts api.attributes['motd']
+puts "\n"
+
+puts "Let's read the feeds:"
+print_resources(api.links.feeds.links)
+puts "\n"
+
+puts "I like games!"
+print_games(api.links.feeds.links.games.resources.games)

data/lib/hyperclient.rb

@@ -17,7 +17,7 @@ module Hyperclient
 
   # Public: Initializes the API with the entry point.
   def entry
-    @entry ||= Resource.new('/', resource_options)
+    @entry ||= Resource.new('', resource_options)
   end
 
   # Internal: Delegate the method to the API if it exists.

data/lib/hyperclient/discoverer.rb

@@ -1,14 +1,14 @@
 module Hyperclient
-  # Public: Discovers resources from an HTTP response.
+  # Public: Discovers resources from a Representation.
   class Discoverer
     # Include goodness of Enumerable.
     include Enumerable
 
     # Public: Initializes a Discoverer.
     #
-    # response - A Hash representing some resources.
-    def initialize(response)
-      @response = response
+    # representation - A Hash representing some resources.
+    def initialize(representation)
+      @representation = representation
     end
 
     # Public: Fetch a Resource with the given name. It is useful when
@@ -38,24 +38,24 @@ module Hyperclient
     end
 
     private
-    # Internal: Returns a Hash with the resources of the response.
+    # Internal: Returns a Hash with the resources of the representation.
     def resources
-      return {} unless @response.respond_to?(:inject)
+      return {} unless @representation.respond_to?(:inject)
 
-      @resources ||= @response.inject({}) do |memo, (name, response)|
+      @resources ||= @representation.inject({}) do |memo, (name, representation)|
         next memo if name == 'self'
-        memo.update(name => build_resource(response, name))
+        memo.update(name => build_resource(representation, name))
       end
     end
 
     # Internal: Returns a Resource (or a collection of Resources).
     #
-    # response - A Hash representing the resource response.
+    # representation - A Hash representing the resource representation.
     # name     - An optional String with the name of the resource.
-    def build_resource(response, name = nil)
-      return response.map(&method(:build_resource)) if response.is_a?(Array)
+    def build_resource(representation, name = nil)
+      return representation.map(&method(:build_resource)) if representation.is_a?(Array)
 
-      ResourceFactory.resource(response.delete('href'), {response: response, name: name})
+      ResourceFactory.resource(representation.delete('href'), {representation: representation, name: name})
     end
   end
 end

data/lib/hyperclient/http.rb

@@ -29,7 +29,7 @@ module Hyperclient
 
     # Public: Sends a GET request the the resource url.
     #
-    # Returns: The response parsed response.
+    # Returns: The parsed response.
     def get
       self.class.get(url).parsed_response
     end

data/lib/hyperclient/representation.rb

@@ -0,0 +1,52 @@
+require 'hyperclient/discoverer'
+
+module Hyperclient
+  # Public: This class is responsible for parsing a representation from the API
+  # and exposing some methods to access its values.
+  #
+  # It is mainly used by Hyperclient::Resource.
+  class Representation
+    # Public: Initializes a Representation.
+    #
+    # representation - A Hash containing a representation from the API. If the
+    # representation is not a Hash it will try to parse it as JSON.
+    def initialize(representation)
+      begin
+        representation = JSON.parse(representation) unless representation.is_a? Hash
+      rescue JSON::ParserError
+        warn 'WARNING Hyperclient::Representation: JSON representation was not valid:'
+        puts representation
+        representation = {}
+      end
+      @representation = representation
+    end
+
+    # Public: Returns a Discoverer for the _links section of the representation. It
+    # can be used later to use the resources from this section.
+    def links
+      @links ||= Discoverer.new(@representation['_links'])
+    end
+
+    # 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
+      @embedded ||= Discoverer.new(@representation['_embedded'])
+    end
+
+    # Public: Returns a Hash with the attributes of the resource.
+    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
+
+require 'json'

data/lib/hyperclient/resource.rb

@@ -1,4 +1,4 @@
-require 'hyperclient/response'
+require 'hyperclient/representation'
 require 'hyperclient/http'
 
 module Hyperclient
@@ -7,8 +7,8 @@ module Hyperclient
   # resource's attributes, links and embedded resources.
   class Resource
     extend Forwardable
-    # Public: Delegate attributes and resources to the response.
-    def_delegators :response, :attributes, :resources, :links
+    # Public: Delegate attributes and resources to the representation.
+    def_delegators :representation, :attributes, :resources, :links
 
     # Public: Delegate all HTTP methods (get, post, put, delete, options and
     # head) to Hyperclient::HTTP.
@@ -24,14 +24,14 @@ module Hyperclient
     #
     # options - An options Hash to initialize different values:
     #           :name     - The String name of the resource.
-    #           :response - An optional Hash representation of the resource's 
-    #           HTTP response.
+    #           :representation - An optional Hash representation of the resource's 
+    #           HTTP representation.
     #           :http     - An optional Hash to pass to the HTTP class.
     def initialize(url, options = {})
       @url = url
       @name = options[:name]
       @http = HTTP.new(self, options[:http])
-      initialize_response(options[:response])
+      initialize_representation(options[:representation])
     end
 
     # Public: Sets the entry point for all the resources in your API client.
@@ -52,31 +52,31 @@ module Hyperclient
       end
     end
 
-    # Public: Gets a fresh response from the resource representation.
+    # Public: Gets a fresh representation from the resource representation.
     #
     # Returns itself (this way you can chain method calls).
     def reload
-      initialize_response(get)
+      initialize_representation(get)
       self
     end
 
     private
-    # Internal: Initializes a Response
+    # Internal: Initializes a Representation
     #
-    # raw_response - A Hash representing the HTTP response for the resource.
+    # raw_representation - A Hash representing the HTTP representation for the resource.
     #
     # Return nothing.
-    def initialize_response(raw_response)
-      if raw_response && raw_response.is_a?(Hash) && !raw_response.empty?
-        @response = Response.new(raw_response)
-        @url = @response.url if @response.url
+    def initialize_representation(raw_representation)
+      if raw_representation && !raw_representation.empty?
+        @representation = Representation.new(raw_representation)
+        @url = @representation.url if @representation.url
       end
     end
 
-    # Internal: Returns the resource response.
-    def response
-      reload unless @response
-      @response
+    # Internal: Returns the resource representation.
+    def representation
+      reload unless @representation
+      @representation
     end
   end
 end

data/lib/hyperclient/version.rb

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

data/test/hyperclient/discoverer_test.rb

@@ -1,5 +1,5 @@
 require_relative '../test_helper'
-require 'hyperclient/response'
+require 'hyperclient/representation'
 
 module Hyperclient
   describe Discoverer do
@@ -7,13 +7,13 @@ module Hyperclient
       Resource.entry_point = 'http://api.myexample.org/'
     end
 
-    let (:response) do
+    let (:representation) do
       JSON.parse(File.read('test/fixtures/element.json'))
     end
 
     describe 'each' do
       it 'iterates between resources' do
-        discoverer = Discoverer.new(response['_links'])
+        discoverer = Discoverer.new(representation['_links'])
 
         discoverer.each do |resource|
           resource.must_be_kind_of Resource
@@ -23,7 +23,7 @@ module Hyperclient
 
     describe '[]' do
       it 'fetches a resource' do
-        discoverer = Discoverer.new(response['_links'])
+        discoverer = Discoverer.new(representation['_links'])
 
         discoverer['filter'].must_be_kind_of Resource
       end
@@ -31,43 +31,43 @@ module Hyperclient
 
     describe 'resources' do
       it 'does not include self as a resource' do
-        discoverer = Discoverer.new(response['_links'])
+        discoverer = Discoverer.new(representation['_links'])
 
         lambda { discoverer.self }.must_raise NoMethodError
       end
 
       it 'builds single resources' do
-        discoverer = Discoverer.new(response['_links'])
+        discoverer = Discoverer.new(representation['_links'])
 
         discoverer.filter.must_be_kind_of Resource
       end
 
       it 'builds collection resources' do
-        discoverer = Discoverer.new(response['_embedded'])
+        discoverer = Discoverer.new(representation['_embedded'])
 
         discoverer.episodes.must_be_kind_of Array
       end
 
       it 'also builds elements in collection resources' do
-        discoverer = Discoverer.new(response['_embedded'])
+        discoverer = Discoverer.new(representation['_embedded'])
 
         discoverer.episodes.first.must_be_kind_of Resource
       end
 
       it 'initializes resources with its URL' do
-        discoverer = Discoverer.new(response['_links'])
+        discoverer = Discoverer.new(representation['_links'])
 
         discoverer.filter.url.wont_be_empty
       end
 
-      it 'initializes resources with the response' do
-        discoverer = Discoverer.new(response['_embedded'])
+      it 'initializes resources with the representation' do
+        discoverer = Discoverer.new(representation['_embedded'])
 
         discoverer.author.attributes.wont_be_empty
       end
 
       it 'initializes resources with its name' do
-        discoverer = Discoverer.new(response['_links'])
+        discoverer = Discoverer.new(representation['_links'])
 
         discoverer.filter.name.wont_be_empty
       end

data/test/hyperclient/representation_test.rb

@@ -0,0 +1,64 @@
+require_relative '../test_helper'
+require 'hyperclient/representation'
+
+module Hyperclient
+  describe Representation do
+    let (:representation) do
+      Representation.new JSON.parse(File.read('test/fixtures/element.json'))
+    end
+
+    describe 'intialize' do
+      it 'handles non-hash representations' do
+        representation = Representation.new '{"_links": {"self": {"href": "/productions/1"}}}'
+
+        representation.url.must_equal '/productions/1'
+      end
+
+      it 'does not raise when non-JSON response is given' do
+        representation = Representation.new 'This is not JSON'
+
+        representation.url.must_equal nil
+      end
+    end
+
+    describe 'attributes' do
+      it 'returns the resource attributes' do
+        representation.attributes['title'].must_equal 'Real World ASP.NET MVC3'
+      end
+
+      it 'does not include _links as attributes' do
+        representation.attributes.wont_include '_links'
+      end
+
+      it 'does not include _embedded as attributes' do
+        representation.attributes.wont_include '_embedded'
+      end
+    end
+
+    describe 'links' do
+      it 'returns resources included in the _links section' do
+        representation.links.filter.must_be_kind_of Resource
+      end
+    end
+
+    describe 'resources' 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
+      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_test.rb

@@ -3,12 +3,12 @@ require 'hyperclient/resource'
 
 module Hyperclient
   describe Resource do
-    let(:response) do
+    let(:representation) do
       File.read('test/fixtures/element.json')
     end
 
-    let(:parsed_response) do
-      JSON.parse(response)
+    let(:parsed_representation) do
+      JSON.parse(representation)
     end
 
     before do
@@ -32,19 +32,19 @@ module Hyperclient
         stub_request(:get, 'http://api.example.org')
       end
 
-      it 'initializes the response when one is given' do
-        resource = Resource.new('/', {response: JSON.parse(response)})
+      it 'initializes the representation when one is given' do
+        resource = Resource.new('/', {representation: JSON.parse(representation)})
 
         assert_not_requested(:get, 'http://api.example.org/')
       end
 
-      it 'updates the resource URL if the response has one' do
-        resource = Resource.new('/', {response: JSON.parse(response)})
+      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 response does not have one' do
+      it 'does no update the resource URL if the representation does not have one' do
         resource = Resource.new('/', {})
 
         resource.url.wont_include '/productions/1'
@@ -60,7 +60,7 @@ module Hyperclient
     describe 'reload' do
       before do
         stub_request(:get, "http://api.example.org/productions/1").
-          to_return(:status => 200, :body => response, headers: {content_type: 'application/json'})
+          to_return(:status => 200, :body => representation, headers: {content_type: 'application/json'})
       end
 
       it 'retrives itself from the API' do

data/test/hyperclient_test.rb

@@ -22,7 +22,12 @@ describe Hyperclient do
     end
 
     it 'initializes a Resource at the entry point' do
-      api.new.entry.url.must_equal 'http://my.api.org/'
+      api.new.entry.url.must_equal 'http://my.api.org'
+    end
+
+    it 'also works with entry points that are not in the root' do
+      api.entry_point 'http://my.api.org/api'
+      api.new.entry.url.must_equal 'http://my.api.org/api'
     end
 
     it 'sets the Resource name' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hyperclient
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-31 00:00:00.000000000 Z
+date: 2012-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -92,23 +92,24 @@ files:
 - MIT-LICENSE
 - Rakefile
 - Readme.md
+- examples/cs.rb
 - examples/hal_shop.rb
 - hyperclient.gemspec
 - lib/hyperclient.rb
 - lib/hyperclient/discoverer.rb
 - lib/hyperclient/http.rb
+- lib/hyperclient/representation.rb
 - lib/hyperclient/resource.rb
 - lib/hyperclient/resource_factory.rb
-- lib/hyperclient/response.rb
 - lib/hyperclient/version.rb
 - test/fixtures/collection.json
 - test/fixtures/element.json
 - test/fixtures/root.json
 - test/hyperclient/discoverer_test.rb
 - test/hyperclient/http_test.rb
+- test/hyperclient/representation_test.rb
 - test/hyperclient/resource_factory_test.rb
 - test/hyperclient/resource_test.rb
-- test/hyperclient/response_test.rb
 - test/hyperclient_test.rb
 - test/test_helper.rb
 homepage: http://codegram.github.com/hyperclient/
@@ -125,7 +126,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2448296263010756108
+      hash: 12208377733581260
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -134,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2448296263010756108
+      hash: 12208377733581260
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -147,9 +148,9 @@ test_files:
 - test/fixtures/root.json
 - test/hyperclient/discoverer_test.rb
 - test/hyperclient/http_test.rb
+- test/hyperclient/representation_test.rb
 - test/hyperclient/resource_factory_test.rb
 - test/hyperclient/resource_test.rb
-- test/hyperclient/response_test.rb
 - test/hyperclient_test.rb
 - test/test_helper.rb
 has_rdoc: 

data/lib/hyperclient/response.rb

@@ -1,42 +0,0 @@
-require 'hyperclient/discoverer'
-
-module Hyperclient
-  # Public: This class is responsible for parsing a response from the API
-  # and exposing some methods to access its values.
-  #
-  # It is mainly used by Hyperclient::Resource.
-  class Response
-    # Public: Initializes a Response.
-    #
-    # response - A Hash representing the response from the API.
-    def initialize(response)
-      @response = response
-    end
-
-    # Public: Returns a Discoverer for the _links section of the response. It
-    # can be used later to use the resources from this section.
-    def links
-      @links ||= Discoverer.new(@response['_links'])
-    end
-
-    # Public: Returns a Discoverer for the _embedded section of the response.
-    # It can be used later to use the resources from this section.
-    def resources
-      @embedded ||= Discoverer.new(@response['_embedded'])
-    end
-
-    # Public: Returns a Hash with the attributes of the resource.
-    def attributes
-      @attributes ||= @response.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 @response && @response['_links'] && @response['_links']['self'] &&
-          (url = @response['_links']['self']['href'])
-        return url
-      end
-    end
-  end
-end

data/test/hyperclient/response_test.rb

@@ -1,50 +0,0 @@
-require_relative '../test_helper'
-require 'hyperclient/response'
-
-module Hyperclient
-  describe Response do
-    let (:response) do
-      Response.new JSON.parse(File.read('test/fixtures/element.json'))
-    end
-
-    describe 'attributes' do
-      it 'returns the resource attributes' do
-        response.attributes['title'].must_equal 'Real World ASP.NET MVC3'
-      end
-
-      it 'does not include _links as attributes' do
-        response.attributes.wont_include '_links'
-      end
-
-      it 'does not include _embedded as attributes' do
-        response.attributes.wont_include '_embedded'
-      end
-    end
-
-    describe 'links' do
-      it 'returns resources included in the _links section' do
-        response.links.filter.must_be_kind_of Resource
-      end
-    end
-
-    describe 'resources' do
-      it 'returns resources included in the _embedded section' do
-        response.resources.author.must_be_kind_of Resource
-        response.resources.episodes.first.must_be_kind_of Resource
-        response.resources.episodes.last.must_be_kind_of Resource
-      end
-    end
-
-    describe 'url' do
-      it 'returns the url of the resource grabbed from the response' do
-        response.url.must_equal '/productions/1'
-      end
-
-      it 'returns nil when the response does not include the resource url' do
-        response = Response.new({_links: {media: {href: '/media/1'}}})
-
-        response.url.must_equal nil
-      end
-    end
-  end
-end