hyperclient 0.0.8 → 0.1.0

data/test/test_helper.rb

@@ -1,7 +1,16 @@
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter '/test/'
+  end
+end
+
 gem 'minitest'
 
 require 'minitest/spec'
 require 'minitest/autorun'
+require 'mocha'
 require 'turn'
 require 'webmock/minitest'
-require 'json'
+require 'json'
+require 'pry'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hyperclient
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-24 00:00:00.000000000 Z
+date: 2012-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: uri_template
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +91,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: HyperClient is a Ruby Hypermedia API client.
 email:
 - oriol.gual@gmail.com
@@ -96,21 +128,26 @@ files:
 - examples/hal_shop.rb
 - hyperclient.gemspec
 - lib/hyperclient.rb
-- lib/hyperclient/discoverer.rb
+- lib/hyperclient/attributes.rb
+- lib/hyperclient/collection.rb
+- lib/hyperclient/entry_point.rb
 - lib/hyperclient/http.rb
-- lib/hyperclient/representation.rb
+- lib/hyperclient/link.rb
+- lib/hyperclient/link_collection.rb
 - lib/hyperclient/resource.rb
-- lib/hyperclient/resource_factory.rb
+- lib/hyperclient/resource_collection.rb
 - lib/hyperclient/version.rb
 - test/fixtures/collection.json
 - test/fixtures/element.json
 - test/fixtures/root.json
-- test/hyperclient/discoverer_test.rb
+- test/hyperclient/attributes_test.rb
+- test/hyperclient/collection_test.rb
+- test/hyperclient/entry_point_test.rb
 - test/hyperclient/http_test.rb
-- test/hyperclient/representation_test.rb
-- test/hyperclient/resource_factory_test.rb
+- test/hyperclient/link_collection_test.rb
+- test/hyperclient/link_test.rb
+- test/hyperclient/resource_collection_test.rb
 - test/hyperclient/resource_test.rb
-- test/hyperclient_test.rb
 - test/test_helper.rb
 homepage: http://codegram.github.com/hyperclient/
 licenses: []
@@ -126,7 +163,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3332679930856512053
+      hash: -1184667501328950554
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -135,10 +172,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3332679930856512053
+      hash: -1184667501328950554
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.19
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: ''
@@ -146,11 +183,13 @@ test_files:
 - test/fixtures/collection.json
 - test/fixtures/element.json
 - test/fixtures/root.json
-- test/hyperclient/discoverer_test.rb
+- test/hyperclient/attributes_test.rb
+- test/hyperclient/collection_test.rb
+- test/hyperclient/entry_point_test.rb
 - test/hyperclient/http_test.rb
-- test/hyperclient/representation_test.rb
-- test/hyperclient/resource_factory_test.rb
+- test/hyperclient/link_collection_test.rb
+- test/hyperclient/link_test.rb
+- test/hyperclient/resource_collection_test.rb
 - test/hyperclient/resource_test.rb
-- test/hyperclient_test.rb
 - test/test_helper.rb
 has_rdoc: 

data/lib/hyperclient/discoverer.rb

@@ -1,84 +0,0 @@
-module Hyperclient
-  # Public: Discovers resources from a Representation.
-  class Discoverer
-    # Include goodness of Enumerable.
-    include Enumerable
-
-    # Public: Initializes a Discoverer.
-    #
-    # representation - A Hash representing some resources.
-    def initialize(representation)
-      @representation = representation
-    end
-
-    # Public: Fetch a Resource with the given name. It is useful when
-    # resources don't have a friendly name and you can't call a method on the
-    # Discoverer.
-    #
-    # name - A String representing the resource name.
-    #
-    # Returns a Resource
-    def [](name)
-      resources[name.to_s]
-    end
-
-    # Public: Iterates over the discovered resources so one can navigate easily
-    # between them.
-    #
-    # block - A block to pass to each.
-    # 
-    # Returns an Enumerable.
-    def each(&block)
-      resources.values.each(&block)
-    end
-
-    # Public: Returns a Resource with the name of the method when exists.
-    def method_missing(method, *args, &block)
-      resources.fetch(method.to_s) { super }
-    end
-
-    private
-    # Internal: Returns a Hash with the resources of the representation.
-    def resources
-      return {} unless @representation.respond_to?(:inject)
-
-      @resources ||= @representation.inject({}) do |memo, (name, representation)|
-        next memo if name == 'self'
-      memo.update(name => build_resource(representation, name))
-      end
-    end
-
-    # Internal: Returns a Resource (or a collection of Resources).
-    #
-    # representation - A Hash representing the resource representation.
-    # name     - An optional String with the name of the resource.
-    def build_resource(representation, name = nil)
-      return representation.map(&method(:build_resource)) if representation.is_a?(Array)
-
-      url = URLExtractor.new(representation).url
-      ResourceFactory.resource(url, {representation: representation, name: name})
-    end
-
-    # 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
-        end
-      end
-    end
-  end
-end
-
-require 'hyperclient/resource_factory'

data/lib/hyperclient/representation.rb

@@ -1,43 +0,0 @@
-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 embedded
-      @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
-  end
-end
-
-require 'json'

data/lib/hyperclient/resource_factory.rb

@@ -1,53 +0,0 @@
-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.
-    #
-    # 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)
-        resource
-      end
-    end
-
-    private
-    # Internal: Returns a Hash that acts as identity map.
-    def self.identity_map
-      @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/test/hyperclient/discoverer_test.rb

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

@@ -1,52 +0,0 @@
-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 '{"title": "Hello world"}'
-
-        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.attributes.must_equal({})
-      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 'embedded' do
-      it 'returns resources included in the _embedded section' do
-        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
-end