hal-client 1.5.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 035b9a77a60897b009604c5b84b767f6870e9da7
-  data.tar.gz: 453668c1af155925f62572cfb8988b79cf9f302c
+  metadata.gz: b0358df2e93e1a3ea4df131e23c87ff76871877f
+  data.tar.gz: 50eeadae4660c967681e88ba235b0c5b34af3e02
 SHA512:
-  metadata.gz: 39f9c20f48fdf12774fa26ed087dd6a725d3c555b0d3f6741c5e23f65237f98414fea058c0113309105d017065edc257e28cebf88542acc1706e764160ebff1e
-  data.tar.gz: 0a2b994966d7427b4167934ca553264ce1a008d4a63b7385cc23d0f50340a52e7b32a035a39aa082ba0c05a0cb27dc7405c0ee3c1f79ce0eedf2e0d639489d72
+  metadata.gz: 9f04ed673200ada3eeaf69da3efdff848f66b53364bf6091d0951ccf25ece8dfa4664d10d44eea60f16a318a61a5daa188142e374fc1d575fa2ec34c77675065
+  data.tar.gz: 062b8060773d2733ead788b829b93024d51bc397c3e5647bab0a80e401cd94964ca65fcaa9a4271496e4ac9c58d64dcaa1b604a56095cc108adf787805eee8b6

data/README.md

@@ -100,12 +100,16 @@ If the API uses one or more a custom mime types we can specify that they be incl
 
 HalClient can be used by servers of HAL APIs to interpret the bodies of requests. For example,
 
-    new_post_repr = HalClient::Representation.new(JSON.load(request.raw_post))
+    new_post_repr = HalClient::Representation.new(parsed_json: JSON.load(request.raw_post))
     author = Author.by_href(new_post_repr.related('author').first.href)
     new_post = Post.new title: new_post_repr['title'], author: author, #...
 
 Created this way the representation will not dereference any links (because it doesn't have a HalClient) but it will provide `HalClient::Representation`s of both embedded and linked resources.
 
+## Upgrading from 1.x to 2.x
+
+The signature of `HalClient::Representation#new` changed such that keyword arguments are required. Any direct uses of that method must be changed. This is the only breaking change.
+
 ## Contributing
 
 1. Fork it ( http://github.com/pezra/hal-client/fork )

data/lib/hal_client/errors.rb

@@ -0,0 +1,4 @@
+puts "ERRORS"
+class HalClient
+  InvalidRepresentationError = Class.new(StandardError)
+end

data/lib/hal_client/representation.rb

@@ -17,44 +17,16 @@ class HalClient
     #   document.
     # href - The href of this representation.
     # hal_client - The HalClient instance to use when navigating.
-    #
-    # Signature
-    #
-    #     initialize(hal_client, parsed_json)
-    #     initialize(parsed_json, hal_client)
-    #
-    # Initialize this representation with a parsed json document and a
-    # hal_client with which to make requests.
-    #
-    #     initialize(href, hal_client)
-    #
-    # Initialize this representation with an href and a hal_client
-    # with which to make requests. Any attempt to retrieve properties
-    # or related representations will result in the href being
-    # dereferenced.
-    #
-    #     initialize(href)
-    #
-    # Initialize this representation with an href. The representation
-    # will not be able to make requests to dereference itself but this
-    # can still be useful in test situations to maintain a uniform
-    # interface.
-    #
-    #     initialize(parse_json)
-    #
-    # Initializes representation that cannot request related
-    # representations.
-    #
-    def initialize(*args)
-      (raise ArgumentError, "wrong number of arguments (#{args.size} for 1 or 2)") if
-        args.size > 2
+    def initialize(parsed_json: nil, hal_client: nil, href: nil)
+      @raw = parsed_json
+      @hal_client = hal_client
+      @href = href
 
-      @raw = args.find {|it| (it.respond_to? :has_key?) &&  (it.respond_to? :fetch) }
-      @hal_client = args.find {|it| HalClient === it }
+      (fail ArgumentError, "Either parsed_json or href must be provided") if
+        @raw.nil? && href.nil?
 
-      if @raw.nil?
-        @href = args.find {|it| it.respond_to? :downcase }
-      end
+      (fail InvalidRepresentationError, "Invalid HAL representation: #{raw.inspect}") if
+        raw && ! hashish?(raw)
     end
 
     # Returns The value of the specified property or the specified
@@ -118,6 +90,7 @@ class HalClient
     def has_related?(link_rel)
       _ = related link_rel
       true
+
     rescue KeyError
       false
     end
@@ -178,7 +151,11 @@ class HalClient
     MISSING = Object.new
 
     def raw
-      @raw ||= hal_client.get(href)
+      if @raw.nil? && @href && hal_client
+        @raw ||= hal_client.get(@href).raw
+      end
+
+      @raw
     end
 
     def link_section
@@ -192,8 +169,11 @@ class HalClient
     def embedded(link_rel)
       relations = boxed embedded_section.fetch(link_rel)
 
-      relations.map{|it| Representation.new hal_client, it}
-    end
+      relations.map{|it| Representation.new hal_client: hal_client, parsed_json: it}
+
+    rescue InvalidRepresentationError => err
+      fail InvalidRepresentationError, "/_embedded/#{jpointer_esc(link_rel)} is not a valid representation"
+end
 
     def embedded_or_nil(link_rel)
       embedded link_rel
@@ -207,7 +187,14 @@ class HalClient
 
       relations.
         map {|link| href_from link, options }.
-        map {|href| Representation.new href, hal_client }
+        map {|href| Representation.new href: href, hal_client: hal_client }
+
+    rescue InvalidRepresentationError => err
+      fail InvalidRepresentationError, "/_links/#{jpointer_esc(link_rel)} is not a valid link"
+    end
+
+    def jpointer_esc(str)
+      str.gsub "/", "~1"
     end
 
     def linked_or_nil(link_rel, options)
@@ -219,10 +206,15 @@ class HalClient
 
 
     def boxed(list_hash_or_nil)
-      if Hash === list_hash_or_nil
+      if hashish? list_hash_or_nil
         [list_hash_or_nil]
-      else
+      elsif list_hash_or_nil.respond_to? :map
         list_hash_or_nil
+      else
+        # The only valid values for a link/embedded set are hashes or
+        # array-ish things.
+
+        fail InvalidRepresentationError
       end
     end
 
@@ -246,7 +238,9 @@ class HalClient
       @namespaces ||= CurieResolver.new raw.fetch("_links", {}).fetch("curies", [])
     end
 
-
+    def hashish?(thing)
+      thing.respond_to?(:fetch) && thing.respond_to?(:key?)
+    end
 
   end
 end

data/lib/hal_client/version.rb

@@ -1,3 +1,3 @@
 class HalClient
-  VERSION = "1.5.0"
+  VERSION = "2.0.0"
 end

data/lib/hal_client.rb

@@ -6,6 +6,7 @@ class HalClient
   autoload :Representation, 'hal_client/representation'
   autoload :RepresentationSet, 'hal_client/representation_set'
   autoload :CurieResolver, 'hal_client/curie_resolver'
+  autoload :InvalidRepresentationError, 'hal_client/errors'
 
   # Initializes a new client instance
   #
@@ -22,7 +23,7 @@ class HalClient
   # 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)
+    Representation.new hal_client: self, parsed_json: MultiJson.load(resp)
   end
 
   protected

data/spec/hal_client/representation_set_spec.rb

@@ -58,7 +58,7 @@ describe HalClient::RepresentationSet do
 
   let(:a_client) { HalClient.new }
 
-  let(:foo_repr) { HalClient::Representation.new a_client, MultiJson.load(foo_hal)}
+  let(:foo_repr) { HalClient::Representation.new hal_client: a_client, parsed_json: MultiJson.load(foo_hal)}
   let(:foo_hal) { <<-HAL }
 { "_links":{
     "self": { "href":"http://example.com/foo" }
@@ -73,7 +73,7 @@ describe HalClient::RepresentationSet do
 }
   HAL
 
-  let(:bar_repr) { HalClient::Representation.new a_client, MultiJson.load(bar_hal) }
+  let(:bar_repr) { HalClient::Representation.new hal_client: a_client, parsed_json: MultiJson.load(bar_hal) }
   let(:bar_hal) { <<-HAL }
 { "_links":{
     "self": { "href":"http://example.com/bar" }

data/spec/hal_client/representation_spec.rb

@@ -3,14 +3,6 @@ require_relative "../spec_helper"
 require "hal_client/representation"
 
 describe HalClient::Representation do
-  describe ".new(a_hal_client, a_parsed_json_doc)" 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": {
@@ -28,7 +20,8 @@ describe HalClient::Representation do
   }
 }
 HAL
-  subject(:repr) { described_class.new(a_client, MultiJson.load(raw_repr)) }
+  subject(:repr) { described_class.new(hal_client: a_client,
+                                       parsed_json: MultiJson.load(raw_repr)) }
 
   describe "#to_s" do
     subject(:return_val) { repr.to_s }
@@ -212,8 +205,28 @@ HAL
     end
   end
 
+  context "invalid link/embedded" do
+    let(:raw_repr) { <<-HAL }
+{ "_links": {
+    "self": { "href": "http://example.com/foo" }
+    ,"bare_url": "http://example.com/bar"
+  }
+  ,"_embedded": {
+    "atom": "hello"
+    ,"array-of-atoms": [1,2,3]
+  }
+}
+HAL
 
+    specify { expect{repr.related("bare_url")}
+        .to raise_error HalClient::InvalidRepresentationError, %r(/_links/bare_url) }
+    specify { expect{repr.related("atom")}
+        .to raise_error HalClient::InvalidRepresentationError, %r(/_embedded/atom) }
+    specify { expect{repr.related("array-of-atoms")}
+        .to raise_error HalClient::InvalidRepresentationError, %r(/_embedded/array-of-atoms) }
 
+  end
+  # Background
 
   let(:a_client) { HalClient.new }
   let!(:bar_request) { stub_identity_request("http://example.com/bar") }
@@ -227,7 +240,7 @@ HAL
       to_return body: %Q|{"_links":{"self":{"href":#{url.to_json}}}}|
   end
 
-  RSpec::Matchers.define(:include_representation_of) do |url|
+  matcher :include_representation_of do |url|
     match { |repr_set|
       repr_set.any?{|it| it.href == url}
     }
@@ -238,7 +251,7 @@ HAL
 end
 
 describe HalClient::Representation, "w/o hal_client" do
-  subject(:repr) { described_class.new(MultiJson.load(raw_repr)) }
+  subject(:repr) { described_class.new(parsed_json: MultiJson.load(raw_repr)) }
 
   specify { expect(subject.href).to eq "http://example.com/foo" }
   specify { expect(subject.related_hrefs "link1").to include "http://example.com/bar" }
@@ -259,4 +272,4 @@ describe HalClient::Representation, "w/o hal_client" do
   }
 }
   HAL
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hal-client
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Peter Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-10 00:00:00.000000000 Z
+date: 2014-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -161,6 +161,7 @@ files:
 - lib/hal-client.rb
 - lib/hal_client.rb
 - lib/hal_client/curie_resolver.rb
+- lib/hal_client/errors.rb
 - lib/hal_client/representation.rb
 - lib/hal_client/representation_set.rb
 - lib/hal_client/version.rb