hal-client 3.10.1 → 3.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd21eca3e5655cbafec1a435e8ab0db5dd1d7ed4
-  data.tar.gz: 23316a22b875539acb51f469217f64d110d91e7e
+  metadata.gz: 253c1dbaeef9a44aa3d64d9f6a440cdcd04567ad
+  data.tar.gz: 74898c74f70a37334b50b8ce1284759c0043e4be
 SHA512:
-  metadata.gz: 5c782a2300c1882a259268b2bd225c973197d62a62416385adacb18e96dc666015ccf5d76dc2470a4e04ec295afbb0542f163fc897cc686d7de258d273750ea6
-  data.tar.gz: bf553bc160d420a291a94628a9724ac7054faf9b119470405b2328eda199eee096cf55ee5b2765baf0420214ab186530d0904dba9c84e6f9f6acbcfd7ddb89d5
+  metadata.gz: 5b8bece5e9c60060a29711057b029d768c6661cdf654f3d3ff507f1894ceebfbd92111d7675bfa310d20037c0d9b4719191b445e058f5d08eb253d8752f1e9f4
+  data.tar.gz: f72e017752ebbcf1a3274cc798a68ae9b8724f5bd78c850abceb941632b3649d3c14bf48476d37153186a7df8c23ea5d7e57efa05dfc6585f7634d5d71233e74

data/README.md

@@ -14,11 +14,16 @@ The first step in using a HAL based API is getting a representation of one of it
     blog = HalClient.get("http://blog.me/")
     # => #<Representation: http://blog.me/>
 
-`HalClient::Representation`s expose a `#property` method to retrieve properties from the HAL document.
+`HalClient::Representation`s expose a `#property` method to retrieve a single property from the HAL document.
 
     blog.property('title')
     #=> "Some Person's Blog"
 
+They also expose a `#properties` method to retrieve all the properties from the document, as a `Hash`.
+
+    blog.properties
+    #=> {"title"=>"Some Person's Blog", "description"=>"Some description"}
+
 ### Link navigation
 
 Once we have a representation we will want to navigate its links. This can be accomplished using the `#related` method.
@@ -79,12 +84,12 @@ All `HalClient::Representation`s exposed an `#href` attribute which is its ident
 
 HalClient provides a high level abstraction for paged collections encoded using [standard `item`, `next` and `prev` link relations](http://tools.ietf.org/html/rfc6573).
 
-    articles = blog.as_enum
+    articles = blog.to_enum
     articles.each do |an_article|
       # do something with each article representation
     end
 
-If the collection is paged this will navigate to the next page after yielding all the items on the current page. `HalClient::Collection` is `Enumerable` so all your favorite collection methods are available.
+If the collection is paged this will navigate to the next page after yielding all the items on the current page. The return is an `Enumerable` so all your favorite collection methods are available.
 
 ### PUT/POST/PATCH requests
 

data/lib/hal_client/collection.rb

@@ -52,7 +52,7 @@ class HalClient
       end
     end
 
-    # Returns one or more randomly selected item from the first page
+    # Returns one or more randomly selected items from the first page
     # of the collection.
     #
     # count - number of items to return. If specified return type will

data/lib/hal_client/representation.rb

@@ -11,6 +11,10 @@ class HalClient
   class Representation
     extend Forwardable
 
+    # Collection of reserved properties
+    # https://tools.ietf.org/html/draft-kelly-json-hal-07#section-4.1
+    RESERVED_PROPERTIES = ['_links', '_embedded'].freeze
+
     # Create a new Representation
     #
     # options - name parameters
@@ -90,6 +94,13 @@ class HalClient
       raw.fetch(name.to_s, &default_proc)
     end
 
+    # Returns a Hash including the key-value pairs of all the properties
+    #   in the resource. It does not include HAL's reserved
+    #   properties (`_links` and `_embedded`).
+    def properties
+      raw.reject { |k, _| RESERVED_PROPERTIES.include? k }
+    end
+
     # Returns the URL of the resource this representation represents.
     def href
       @href ||= if has_related? "self"
@@ -219,6 +230,15 @@ class HalClient
       Collection.new(self)
     end
 
+    # Returns an Enumerator of the items in the collection resource
+    # if this is an rfc 6573 collection.
+    #
+    # Raises HalClient::NotACollectionError if this is not a
+    # collection resource.
+    def to_enum(method=:each, *args, &blk)
+      as_enum.to_enum(method, *args, &blk)
+    end
+
     # Resets this representation such that it will be requested from
     # the upstream on it's next use.
     def reset

data/lib/hal_client/representation_set.rb

@@ -11,7 +11,7 @@ class HalClient
       @reprs = reprs
     end
 
-    def_delegators :reprs, :each, :count, :empty?, :any?
+    def_delegators :reprs, :each, :count, :empty?, :any?, :sample
 
     # Returns representations of resources related via the specified
     #   link rel or the specified default value.

data/lib/hal_client/version.rb

@@ -1,3 +1,3 @@
 class HalClient
-  VERSION = "3.10.1"
+  VERSION = "3.11.1"
 end

data/spec/hal_client/collection_spec.rb

@@ -3,6 +3,34 @@ require_relative "../spec_helper"
 require 'hal_client/collection'
 
 describe HalClient::Collection do
+  # BACKGROUND
+
+  shared_context "multi-item, multi-page" do
+    subject(:collection) { described_class.new(first_page) }
+    let!(:second_page_req) { stub_request(:get, second_page.href)
+                             .to_return body: second_page.to_json  }
+
+    let(:first_page_href) { "http://example.com/p1" }
+    let(:first_page) { collection_page(next_href: second_page_href,
+                                       self_href: first_page_href,
+                                       items: ["foo", "bar"]) }
+
+    let(:second_page_href) { "http://example.com/p2" }
+    let(:second_page) { collection_page(items: ["baz"],
+                                        self_href: second_page_href,
+                                        prev_href: first_page_href) }
+
+  end
+
+  shared_context "multi-item, single page" do
+    subject(:collection) { described_class.new(only_page) }
+
+    let(:only_page) { collection_page(self_href: "http://example.com/p1",
+                                       items: ["foo", "bar"]) }
+  end
+
+  # END OF BACKGROUND
+
   describe "creation" do
     subject { described_class }
 
@@ -25,45 +53,47 @@ describe HalClient::Collection do
     let(:non_first_page) { collection_page(prev_href: "http://example.com/p1") }
   end
 
-  describe "multi-item, multi-page" do
-    subject(:collection) { described_class.new(first_page) }
-    let!(:second_page_req) { stub_request(:get, second_page.href)
-        .to_return body: second_page.to_json  }
+  describe "#each" do
+    context do
+      include_context "multi-item, multi-page"
 
-    it "fetches all the pages when iterating" do
-      collection.each do |it| end
+      it "fetches all the pages when iterating" do
+        collection.each do |it| end
 
-      expect(a_request(:get, second_page.href)).to have_been_made
-    end
+        expect(a_request(:get, second_page.href)).to have_been_made
+      end
+
+      it "yields all the items" do
+        yielded = collection.map { |it| it.href }
+        expect(yielded).to eq ["foo", "bar", "baz"]
+      end
 
-    it "iteration yields all the items" do
-      yielded = collection.map { |it| it.href }
-      expect(yielded).to eq ["foo", "bar", "baz"]
     end
+  end
 
-    specify { expect { collection.count }.to raise_exception }
+  describe "#count" do
+    context do
+      include_context "multi-item, single page"
 
+      specify { expect(collection.count).to eq 2 }
+    end
 
-    let(:first_page_href) { "http://example.com/p1" }
-    let(:first_page) { collection_page(next_href: second_page_href,
-                                       self_href: first_page_href,
-                                       items: ["foo", "bar"]) }
+    context do
+      include_context "multi-item, multi-page"
 
-    let(:second_page_href) { "http://example.com/p2" }
-    let(:second_page) { collection_page(items: ["baz"],
-                                        self_href: second_page_href,
-                                        prev_href: first_page_href) }
+      specify { expect { collection.count }.to raise_exception }
+    end
   end
 
-  describe "multi-item, single page" do
-    subject(:collection) { described_class.new(only_page) }
-
-    specify { expect(collection.count).to eq 2 }
+  describe "#sample" do
+    include_context "multi-item, multi-page"
 
-    let(:only_page) { collection_page(self_href: "http://example.com/p1",
-                                       items: ["foo", "bar"]) }
+    specify { expect( collection.sample ).to be }
+    specify { expect( collection.sample ).to be_kind_of HalClient::Representation }
   end
 
+  # BACKGROUND
+
   let(:hal_client) { HalClient.new }
 
   def collection_page(opts={})

data/spec/hal_client/representation_spec.rb

@@ -5,6 +5,7 @@ require "hal_client/representation"
 describe HalClient::Representation do
   let(:raw_repr) { <<-HAL }
 { "prop1": 1
+  ,"prop2": 2
   ,"_links": {
     "self": { "href": "http://example.com/foo" }
     ,"link1": { "href": "http://example.com/bar" }
@@ -161,6 +162,9 @@ HAL
   specify { expect(repr.property? "nonexistent-prop").to be false }
   specify { expect(repr.has_property? "nonexistent-prop").to be false }
 
+  specify { expect(repr.properties).to include("prop1" => 1, "prop2" => 2) }
+  specify { expect(repr.properties).to_not include("_links" => 1,
+                                                   "_embedded" => 2) }
 
   specify { expect(subject.href).to eq "http://example.com/foo" }
 
@@ -361,6 +365,7 @@ HAL
   end
 
   specify { expect(repr).to respond_to :as_enum }
+  specify { expect(repr).to respond_to :to_enum }
 
   context "collection" do
     let(:raw_repr) { <<-HAL }
@@ -378,10 +383,15 @@ HAL
 
     specify { expect(repr.as_enum).to a_kind_of Enumerable }
     specify { expect(repr.as_enum).to have(2).items }
+
+    specify { expect( repr.to_enum ).to be_kind_of Enumerator }
+    specify { expect( repr.to_enum(:each) ).to be_kind_of Enumerator }
+    specify { expect( repr.to_enum ).to have(2).items }
   end
 
   context "non-collection" do
     specify { expect{repr.as_enum}.to raise_error }
+    specify { expect{repr.to_enum}.to raise_error }
   end
 
   # Background

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hal-client
 version: !ruby/object:Gem::Version
-  version: 3.10.1
+  version: 3.11.1
 platform: ruby
 authors:
 - Peter Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-04 00:00:00.000000000 Z
+date: 2015-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -181,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: Use HAL APIs easily
@@ -195,4 +195,3 @@ test_files:
 - spec/hal_client_spec.rb
 - spec/spec_helper.rb
 - spec/support/custom_matchers.rb
-has_rdoc: