hal-client 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a22811cd4e0f71ae8fe9767f40314c6c070a603b
+  data.tar.gz: de7b7a1b94bc47dd3a1da179d2241ce85e337eb0
+SHA512:
+  metadata.gz: 6d75d90c76548319814b03a18d7c8518609ef4911325d59c686a4ad63f5aba75933254fd70b850d05bb7b008504f5a8245a650841bc34046d99fb051aef048d8
+  data.tar.gz: 9cf40c295ddc43e1083a45e67c74a75fb901ebe793bfb0a097acbcd9f93fc5d4bfc74b50037e5a3750b890b3254780df2141776a27ec449a94c1798004889f04

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.#*
+*~
+.ruby-version
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hal-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Peter Williams
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,85 @@
+# HalClient
+
+An easy to use interface for REST APIs that use [HAL](http://stateless.co/hal_specification.html).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hal-client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hal-client
+
+## Usage
+
+The first step to using HalClient is to create a `HalClient` instance.
+
+    my_client = HalClient.new
+
+If the API uses one or more a custom mime types we can specify that they be included in the `Accept` header field of each request.
+
+    my_client = HalClient.new(accept: "application/vnd.myapp+hal+json")
+
+### `GET`ting an entry point
+
+In normal usage you will rarely use the `HalClient` instance directly. Normally, you will traverse links on a representation which uses the `HalClient` indirectly. Getting API entry points is main use for the HalClient instance.
+
+    blog = my_client.get("http://blog.me/")
+
+`HalClient::Representation`s expose a `#property` method to retrieve properties from the HAL document.
+
+    blog.property('title')
+    #=> "Some Person's Blog"
+
+### Link navigation
+
+Once we have a representation we are going to need to navigate its links. This can be accomplished by using the `#related` method.
+
+    articles = blog.related("item")
+    # => #<RepresentationSet:...>
+
+In the example above `item` is the link rel. The `#related` method looks up both embedded representations and links with the rel of `item`. Links are then dereferenced using the same `HalClient` instance used to retrieve the entry point. The dereferenced links and extracted embedded representations are converted into individual `HalClient::Representation`s and packaged into a `HalClient::RepresentationSet`. `HalClient` always returns `RepresentationSet`s when following links, even when there is only one result as doing so tends to result in simpler client code.
+
+`RepresentationSet`s are `Enumerable` so they expose all your favorite methods like `#each`, `#map`, `#any?`, etc. Additionally, `RepresentationSet`s expose a `#related` method which calls `#related` on each member of the set and then merges the results into a new representation set.
+
+    authors = blog.related("author").related("item")
+    authors.first.property("name")
+    # => "Bob Smith"
+
+### Templated links
+
+The `#related` methods takes a `Hash` as its second argument which is used to expand any templated links that are involved in the navigation.
+
+    old_articles = blog.related("index", before: "2013-02-03T12:30:00Z")
+    # => #<RepresentationSet:...>
+
+Assuming there is a templated link with a `before` variable this will result in a request being made to `http://blog.me/archive?before=2013-02-03T12:30:00Z`, the response parsed into a `HalClient::Representation` and that being wrapped in a representation set. Any options for which there is not a matching variable in the link's template will be ignored. Any links with that rel that are not templates will be dereferenced normally.
+
+### Identity
+
+All `HalClient::Representation`s exposed an `#href` attribute which is its identity. The value is extracted from the `self` link in the underlying HAL document.
+
+    blog.href # => "http://blog.me/"
+
+### Hash like interface
+
+`Representation`s expose a `Hash` like interface. Properties, and related representations can be retrieved using the `#[]` and `#fetch` method.
+
+    blog['title'] # => "Some Person's Blog"
+    blog['item']  # =>  #<RepresentationSet:...>
+    
+
+## Contributing
+
+1. Fork it ( http://github.com/pezra/hal-client/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+3. Update `lib/hal_client/version.rb` following [semantic versioning rules](http://semver.org/)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/hal-client.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hal_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hal-client"
+  spec.version       = HalClient::VERSION
+  spec.authors       = ["Peter Williams"]
+  spec.email         = ["pezra@barelyenough.org"]
+  spec.summary       = %q{Use HAL APIs easily}
+  spec.description   = %q{An easy to use interface for REST APIs that use HAL.}
+  spec.homepage      = "https://github.com/pezra/hal-client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rest-client", "~> 1.6", '>= 1.6.0'
+  spec.add_dependency "addressable", "~> 2.3", '>= 2.3.0'
+  spec.add_dependency "multi_json", "~> 1.8", '>= 1.8.0'
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 10.1", '>= 10.1.0'
+  spec.add_development_dependency "rspec", "~> 2.14", '>= 2.14.0'
+  spec.add_development_dependency "webmock", "~> 1.16", '>= 1.16.0'
+end

data/lib/hal-client.rb

@@ -0,0 +1 @@
+require 'hal_client'

data/lib/hal_client/representation.rb

@@ -0,0 +1,181 @@
+require 'forwardable'
+require 'addressable/template'
+
+require 'hal_client'
+require 'hal_client/representation_set'
+
+class HalClient
+
+  # HAL representation of a single resource. Provides access to
+  # properties, links and embedded representations.
+  class Representation
+    extend Forwardable
+
+    # Create a new Representation
+    #
+    # hal_client - The HalClient instance to use when navigating.
+    # parsed_json - A hash structure representing a single HAL
+    #   document.
+    def initialize(hal_client, parsed_json)
+      @hal_client = hal_client
+      @raw = parsed_json
+    end
+
+    # Returns The value of the specified property or the specified
+    #   default value.
+    #
+    # name - The name of property of interest
+    # default - an optional object that should be return if the
+    #   specified property does not exist
+    # default_proc - an option proc that will be called with `name`
+    #  to produce default value if the specified property does not
+    #  exist
+    #
+    # Raises KeyError if the specified property does not exist
+    #   and no default nor default_proc is provided.
+    def property(name, default=MISSING, &default_proc)
+      default_proc ||= ->(_){ default} if default != MISSING
+
+      raw.fetch(name.to_s, &default_proc)
+    end
+
+    # Returns the URL of the resource this representation represents.
+    def href
+      link_section.fetch("self").fetch("href")
+    end
+
+    # Returns the value of the specified property or representations
+    #   of resources related via the specified link rel or the
+    #   specified default value.
+    #
+    # name_or_rel - The name of property or link rel of interest
+    # default - an optional object that should be return if the
+    #   specified property or link does not exist
+    # default_proc - an option proc that will be called with `name`
+    #  to produce default value if the specified property or link does not
+    #  exist
+    #
+    # Raises KeyError if the specified property or link does not exist
+    #   and no default nor default_proc is provided.
+    def fetch(name_or_rel, default=MISSING, &default_proc)
+      item_key = name_or_rel
+      default_proc ||= ->(_){default} if default != MISSING
+
+      property(item_key) {
+        related(item_key, &default_proc)
+      }
+    end
+
+    # Returns the value of the specified property or representations
+    #   of resources related via the specified link rel or nil
+    #
+    # name_or_rel - The name of property or link rel of interest
+    def [](name_or_rel)
+      item_key = name_or_rel
+      fetch(item_key, nil)
+    end
+
+    # Returns representations of resources related via the specified
+    #   link rel or the specified default value.
+    #
+    # name_or_rel - The name of property or link rel of interest
+    # options - optional keys and values with which to expand any
+    #   templated links that are encountered
+    # default_proc - an option proc that will be called with `name`
+    #  to produce default value if the specified property or link does not
+    #  exist
+    #
+    # Raises KeyError if the specified link does not exist
+    #   and no default_proc is provided.
+    def related(link_rel, options = {}, &default_proc)
+      default_proc ||= ->(link_rel){
+        raise KeyError, "No resources are related via `#{link_rel}`"
+      }
+
+      embedded = embedded(link_rel) rescue nil
+      linked = linked(link_rel, options) rescue nil
+
+      if !embedded.nil? or !linked.nil?
+        RepresentationSet.new (Array(embedded) + Array(linked))
+      else
+        default_proc.call link_rel
+      end
+    end
+
+    # Returns urls of resources related via the specified
+    #   link rel or the specified default value.
+    #
+    # name_or_rel - The name of property or link rel of interest
+    # options - optional keys and values with which to expand any
+    #   templated links that are encountered
+    # default_proc - an option proc that will be called with `name`
+    #  to produce default value if the specified property or link does not
+    #  exist
+    #
+    # Raises KeyError if the specified link does not exist
+    #   and no default_proc is provided.
+    def related_hrefs(link_rel, options={}, &default_proc)
+      default_proc ||= ->(link_rel){
+        raise KeyError, "No resources are related via `#{link_rel}`"
+      }
+
+      embedded = boxed embedded_section.fetch(link_rel, nil)
+      linked = boxed link_section.fetch(link_rel, nil)
+
+      if !embedded.nil? or !linked.nil?
+        Array(embedded).map{|it| it.fetch("_links").fetch("self").fetch("href") rescue nil} +
+          Array(linked).map{|it| it.fetch("href", nil) }.
+          compact
+      else
+        default_proc.call link_rel
+      end
+    end
+
+    protected
+    attr_reader :raw, :hal_client
+
+    MISSING = Object.new
+
+    def link_section
+      @link_section ||= raw.fetch("_links", {})
+    end
+
+    def embedded_section
+      @embedded_section ||= raw.fetch("_embedded", {})
+    end
+
+    def embedded(link_rel)
+      relations = boxed embedded_section.fetch(link_rel)
+
+      relations.map{|it| Representation.new hal_client, it}
+    end
+
+    def linked(link_rel, options)
+      relations = boxed link_section.fetch(link_rel)
+
+      relations.
+        map {|link| href_from link, options }.
+        map {|href| hal_client.get href }
+    end
+
+
+    def boxed(list_hash_or_nil)
+      if Hash === list_hash_or_nil
+        [list_hash_or_nil]
+      else
+        list_hash_or_nil
+      end
+    end
+
+    def href_from(link, options)
+      raw_href = link.fetch('href')
+
+      if link.fetch('templated', false)
+        Addressable::Template.new(raw_href).expand(options).to_s
+      else
+        raw_href
+      end
+    end
+
+  end
+end

data/lib/hal_client/representation_set.rb

@@ -0,0 +1,34 @@
+class HalClient
+
+  # A collection HAL representations
+  class RepresentationSet
+    include Enumerable
+    extend Forwardable
+
+    def initialize(reprs)
+      @reprs = reprs
+    end
+
+    def_delegators :reprs, :each, :count, :empty?, :any?
+
+    # Returns representations of resources related via the specified
+    #   link rel or the specified default value.
+    #
+    # name_or_rel - The name of property or link rel of interest
+    # options - optional keys and values with which to expand any
+    #   templated links that are encountered
+    # default_proc - an option proc that will be called with `name`
+    #  to produce default value if the specified property or link does not
+    #  exist
+    #
+    # Raises KeyError if the specified link does not exist
+    #   and no default_proc is provided.
+    def related(link_rel, options={})
+      RepresentationSet.new flat_map{|it| it.related(link_rel, options){[]}.to_a }
+    end
+
+    protected
+
+    attr_reader :reprs
+  end
+end

data/lib/hal_client/version.rb

@@ -0,0 +1,3 @@
+class HalClient
+  VERSION = "1.1.0"
+end

data/lib/hal_client.rb

@@ -0,0 +1,34 @@
+require "hal_client/version"
+require 'rest-client'
+
+# Adapter used to access resources.
+class HalClient
+  autoload :Representation, 'hal_client/representation'
+  autoload :RepresentationSet, 'hal_client/representation_set'
+
+  # Initializes a new client instance
+  #
+  # options - hash of configuration options
+  #   :accept - one or more content types that should be 
+  #     prepended to the `Accept` header field of each request.
+  def initialize(options={})
+    @default_accept = options.fetch(:accept, 'application/hal+json')
+  end
+
+  # Returns a `Representation` of the resource identified by `url`.
+  #
+  # url - The URL of the resource of interest.
+  # options - set of options to pass to `RestClient#get`
+  def get(url, options={})
+    resp = RestClient.get url, rest_client_options(options)
+    Representation.new self, MultiJson.load(resp)
+  end
+
+  protected
+
+  attr_reader :default_accept
+
+  def rest_client_options(overrides)
+    {accept: default_accept}.merge overrides
+  end
+end

data/spec/hal_client/representation_set_spec.rb

@@ -0,0 +1,114 @@
+require_relative '../spec_helper'
+
+require 'hal_client'
+require 'hal_client/representation'
+require 'hal_client/representation_set'
+
+describe HalClient::RepresentationSet do
+  describe "#new" do
+    let!(:return_val) { described_class.new([foo_repr, bar_repr]) }
+    it { should be_kind_of described_class }
+    it { should have(2).items }
+  end
+
+  subject(:repr_set) { described_class.new([foo_repr, bar_repr]) }
+
+  describe "#each" do
+    it "iterates over each item in the set" do
+      seen = []
+      subject.each {|it| seen << it}
+      expect(seen).to match_array [foo_repr, bar_repr]
+    end
+  end
+
+  its(:count) { should eq 2 }
+  its(:empty?) { should be_false }
+
+  describe "#any?" do
+    it "returns true if there are any" do
+      expect(subject.any?{|it| it == foo_repr }).to be_true
+    end
+    it "returns false if there aren't any" do
+      expect(subject.any?{|it| false }).to be_false
+    end
+  end
+
+  describe "#related" do
+    context "single target in each member" do
+      subject(:returned_val) { repr_set.related("spouse") }
+      it { should include_representation_of "http://example.com/foo-spouse" }
+      it { should include_representation_of "http://example.com/bar-spouse" }
+      it { should have(2).items }
+    end
+    context "multiple targets" do
+      subject(:returned_val) { repr_set.related("sibling") }
+      it { should include_representation_of "http://example.com/foo-brother" }
+      it { should include_representation_of "http://example.com/foo-sister" }
+      it { should include_representation_of "http://example.com/bar-brother" }
+      it { should have(3).items }
+    end
+    context "templated" do
+      subject(:returned_val) { repr_set.related("cousin", distance: "first") }
+      it { should include_representation_of "http://example.com/foo-first-cousin" }
+      it { should include_representation_of "http://example.com/bar-paternal-first-cousin" }
+      it { should include_representation_of "http://example.com/bar-maternal-first-cousin" }
+      it { should have(3).items }
+    end
+  end
+
+  let(:a_client) { HalClient.new }
+
+  let(:foo_repr) { HalClient::Representation.new a_client, MultiJson.load(foo_hal)}
+  let(:foo_hal) { <<-HAL }
+{ "_links":{
+    "self": { "href":"http://example.com/foo" }
+    ,"cousin": { "href": "http://example.com/foo-{distance}-cousin"
+                 ,"templated": true }
+  }
+  ,"_embedded": {
+    "spouse": { "_links": { "self": { "href": "http://example.com/foo-spouse"}}}
+    ,"sibling": [{ "_links": { "self": { "href": "http://example.com/foo-brother"}}}
+                 ,{ "_links": { "self": { "href": "http://example.com/foo-sister"}}}]
+  }
+}
+  HAL
+
+  let(:bar_repr) { HalClient::Representation.new a_client, MultiJson.load(bar_hal) }
+  let(:bar_hal) { <<-HAL }
+{ "_links":{
+    "self": { "href":"http://example.com/bar" }
+    ,"cousin": [{ "href": "http://example.com/bar-maternal-{distance}-cousin"
+                  ,"templated": true }
+                ,{ "href": "http://example.com/bar-paternal-{distance}-cousin"
+                  ,"templated": true }]
+  }
+  ,"_embedded": {
+    "spouse": { "_links": { "self": { "href": "http://example.com/bar-spouse"}}}
+    ,"sibling": { "_links": { "self": { "href": "http://example.com/bar-brother"}}}
+  }
+}
+  HAL
+
+  let!(:foo_cousin_request) {
+    stub_identity_request "http://example.com/foo-first-cousin" }
+  let!(:bar_maternal_cousin_request) {
+    stub_identity_request "http://example.com/bar-maternal-first-cousin" }
+  let!(:bar_paternal_cousin_request) {
+    stub_identity_request "http://example.com/bar-paternal-first-cousin" }
+
+  def stub_identity_request(url)
+    stub_request(:get, url).
+      to_return body: %Q|{"_links":{"self":{"href":#{url.to_json}}}}|
+  end
+
+
+  RSpec::Matchers.define(:include_representation_of) do |url|
+    match { |repr_set|
+      repr_set.any?{|it| it.href == url}
+    }
+    failure_message_for_should { |repr_set|
+      "Expected representation of <#{url}> but found only #{repr_set.map(&:href)}"
+    }
+  end
+
+end

data/spec/hal_client/representation_spec.rb

@@ -0,0 +1,172 @@
+require_relative "../spec_helper"
+
+require "hal_client/representation"
+
+describe HalClient::Representation do
+  describe ".new" do
+    let!(:return_val) { described_class.new(a_client, MultiJson.load(raw_repr)) }
+    describe "return_val" do
+      subject { return_val }
+      it { should be_kind_of described_class }
+
+    end
+  end
+
+  let(:raw_repr) { <<-HAL }
+{ "prop1": 1
+  ,"_links": {
+    "self": { "href": "http://example.com/foo" }
+    ,"link1": { "href": "http://example.com/bar" }
+    ,"link2": { "href": "http://example.com/people{?name}"
+                ,"templated": true }
+    ,"link3": [{ "href": "http://example.com/link3-a" }
+               ,{ "href": "http://example.com/link3-b" }]
+  }
+  ,"_embedded": {
+    "embed1": {
+      "_links": { "self": { "href": "http://example.com/baz" }}
+    }
+  }
+}
+HAL
+  subject(:repr) { described_class.new(a_client, MultiJson.load(raw_repr)) }
+
+  describe "#property" do
+    context "existent" do
+      subject { repr.property "prop1" }
+      it { should eq 1 }
+    end
+    context "non-existent" do
+      it "raises exception" do
+        expect{repr.property 'wat'}.to raise_exception KeyError
+      end
+    end
+  end
+
+  its(:href) { should eq "http://example.com/foo" }
+
+  describe "#fetch" do
+    context "for existent property" do
+      subject { repr.fetch "prop1" }
+      it { should eq 1 }
+    end
+    context "for existent link" do
+      subject { repr.fetch "link1" }
+      it { should have(1).item }
+      it "includes related resource representation" do
+        expect(subject.first.href).to eq "http://example.com/bar"
+      end
+    end
+    context "for existent embedded" do
+      subject { repr.fetch "embed1" }
+      it { should have(1).item }
+      it "includes related resource representation" do
+        expect(subject.first.href).to eq "http://example.com/baz"
+      end
+    end
+    context "non-existent item w/o default" do
+      it "raises exception" do
+        expect{repr.fetch 'wat'}.to raise_exception KeyError
+      end
+    end
+    context "non-existent item w/ default value" do
+      subject { repr.fetch "wat", "whatevs" }
+      it { should eq "whatevs" }
+    end
+    context "non-existent item w/ default value generator" do
+      subject { repr.fetch("wat"){|key| key+"gen" } }
+      it { should eq "watgen" }
+    end
+  end
+
+  describe "#[]" do
+    context "for existent property" do
+      subject { repr["prop1"] }
+      it { should eq 1 }
+    end
+    context "for existent link" do
+      subject { repr["link1"] }
+      it { should have(1).item }
+      it { should include_representation_of "http://example.com/bar" }
+    end
+    context "for existent embedded" do
+      subject { repr["embed1"] }
+      it { should have(1).item }
+      it { should include_representation_of "http://example.com/baz" }
+    end
+    context "non-existent item w/o default" do
+      subject { repr["wat"] }
+      it { should be_nil }
+    end
+  end
+
+  describe "#related" do
+    context "for existent link" do
+      subject { repr.related "link1" }
+      it { should have(1).item }
+      it { should include_representation_of "http://example.com/bar" }
+    end
+    context "for existent compound link" do
+      subject { repr.related "link3" }
+      it { should have(2).item }
+      it { should include_representation_of "http://example.com/link3-a" }
+      it { should include_representation_of "http://example.com/link3-b" }
+    end
+    context "for existent templated link" do
+      subject { repr.related "link2", name: "bob" }
+      it { should have(1).item }
+      it { should include_representation_of "http://example.com/people?name=bob"  }
+    end
+    context "for existent embedded" do
+      subject { repr.related "embed1" }
+      it { should have(1).item }
+      it { should include_representation_of "http://example.com/baz" }
+    end
+    context "non-existent item w/o default" do
+      it "raises exception" do
+        expect{repr.related 'wat'}.to raise_exception KeyError
+      end
+    end
+  end
+
+  describe "#related_hrefs" do
+    context "for existent link" do
+      subject { repr.related_hrefs "link1" }
+      it { should have(1).item }
+      it { should include "http://example.com/bar" }
+    end
+    context "for existent embedded" do
+      subject { repr.related_hrefs "embed1" }
+      it { should have(1).item }
+      it { should include "http://example.com/baz" }
+    end
+    context "non-existent item w/o default" do
+      it "raises exception" do
+        expect{repr.related_hrefs 'wat'}.to raise_exception KeyError
+      end
+    end
+  end
+
+
+
+  let(:a_client) { HalClient.new }
+  let!(:bar_request) { stub_identity_request("http://example.com/bar") }
+  let!(:baz_request) { stub_identity_request "http://example.com/baz" }
+  let!(:people_request) { stub_identity_request "http://example.com/people?name=bob" }
+  let!(:link3_a_request) { stub_identity_request "http://example.com/link3-a" }
+  let!(:link3_b_request) { stub_identity_request "http://example.com/link3-b" }
+
+  def stub_identity_request(url)
+    stub_request(:get, url).
+      to_return body: %Q|{"_links":{"self":{"href":#{url.to_json}}}}|
+  end
+
+  RSpec::Matchers.define(:include_representation_of) do |url|
+    match { |repr_set|
+      repr_set.any?{|it| it.href == url}
+    }
+    failure_message_for_should { |repr_set|
+      "Expected representation of <#{url}> but found only #{repr_set.map(&:href)}"
+    }
+  end
+end

data/spec/hal_client_spec.rb

@@ -0,0 +1,44 @@
+require_relative "./spec_helper"
+require "hal_client"
+
+describe HalClient do
+  describe ".new()" do
+    subject { HalClient.new }
+    it { should be_kind_of HalClient }
+  end
+
+  describe '.new w/ custom accept' do
+    subject { HalClient.new(accept: "application/vnd.myspecialmediatype") }
+    it { should be_kind_of HalClient }
+  end
+
+  describe "#get(<url>)" do
+    subject(:client) { HalClient.new }
+    let!(:return_val) { client.get "http://example.com/foo" }
+
+    it "returns a HalClient::Representation" do
+      expect(return_val).to be_kind_of HalClient::Representation
+    end
+
+    describe "request" do
+      subject { request }
+      it("should have been made") { should have_been_made }
+
+      it "sends accept header" do
+        expect(request.with(headers: {'Accept' => 'application/hal+json'})).
+          to have_been_made
+      end
+    end
+
+    context "explicit accept" do
+      subject(:client) { HalClient.new accept: 'app/test' }
+      it "sends specified accept header" do
+        expect(request.with(headers: {'Accept' => 'app/test'})).
+          to have_been_made
+      end
+    end
+  end
+
+  let!(:request) { stub_request(:get, "http://example.com/foo").
+    to_return body: "{}" }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH << Pathname(__FILE__).dirname + "../lib"
+
+require 'rspec'
+require 'webmock/rspec'
+require 'multi_json'

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: hal-client
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Peter Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.0
+description: An easy to use interface for REST APIs that use HAL.
+email:
+- pezra@barelyenough.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hal-client.gemspec
+- lib/hal-client.rb
+- lib/hal_client.rb
+- lib/hal_client/representation.rb
+- lib/hal_client/representation_set.rb
+- lib/hal_client/version.rb
+- spec/hal_client/representation_set_spec.rb
+- spec/hal_client/representation_spec.rb
+- spec/hal_client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/pezra/hal-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Use HAL APIs easily
+test_files:
+- spec/hal_client/representation_set_spec.rb
+- spec/hal_client/representation_spec.rb
+- spec/hal_client_spec.rb
+- spec/spec_helper.rb