hal-client 3.8.1 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3aa1556d1a5044c04bc66ad6b1e49105fbc124b7
-  data.tar.gz: a266b7c77869e4f5b1429a4360ad3fa29d0de134
+  metadata.gz: 85cc05b22fd50911b4e49b91d2b8ee8512ee2fd3
+  data.tar.gz: cf83685b05bc87f970d868eedd93a035873768e9
 SHA512:
-  metadata.gz: cd05cd62bdc95763d81d78e85c19042a8818ccafde1d4449d7ada687b1bde79d1f839a327c6162c42ced12a89fad171f0426d40f4fbe4206f8ae4f63cfe37a0f
-  data.tar.gz: 755b04edb28982ba19f242355a69d9d2e7d7481744e80678641cbf37717ec2677a6cf690237926ed21a7d4e0cd7b88364016b5868092ba888755fc632f9faf00
+  metadata.gz: 2943114d371646828b0ec861ff157320791c55cc684941ebd1df90d3da6b1e68426c57cda34315a0b235f95930a7f5cc2a778513238703853570d4ef9a83691b
+  data.tar.gz: e8ca34954374194acdd19a952163a92aafc462719bda737be1b5a10019fb55b0db5cefb810615812c3fbe0568686c81699519610d44da4180398627ad5aa51b8

data/.travis.yml

@@ -2,9 +2,8 @@ sudo: false
 cache: bundler
 language: ruby
 rvm:
-  - "1.9.3"
   - "2.0.0"
   - "2.1.0"
   - "2.2.0"
-  - jruby-19mode
-  - jruby-21mode
+  - rbx-2.5.2
+  

data/README.md

@@ -128,7 +128,7 @@ doc.put(improved_doc)                                                   # save c
 
 ```
 
-This removes "John Plagerist" from the documents list of authors and then performs an HTTP PUT request with the updated document.
+This removes the obsolete link to "John Doe" from the documents list of authors and replaces it with the correct link then performs an HTTP PUT request with the updated document.
 
 ### Custom media types
 

data/lib/hal_client/representation_editor.rb

@@ -43,9 +43,14 @@ class HalClient
     # blk - When given only linked and embedded resource for whom
     #   the block returns true will be rejected.
     #
+    # Options
+    #
+    #   ignore - one or more categories of things to ignore. Valid
+    #     values are: :broken_links. Default: []
+    #
     # Yields Representation of the target for each link/embedded.
-    def reject_related(rel, &blk)
-      reject_links(rel, &blk).reject_embedded(rel, &blk)
+    def reject_related(rel, ignore: [], &blk)
+      reject_links(rel, ignore: ignore, &blk).reject_embedded(rel, ignore: ignore, &blk)
     end
 
     # Returns a RepresentationEditor for a representation like the
@@ -55,13 +60,18 @@ class HalClient
     # blk - When given only links to resources for whom
     #   the block returns true will be rejected.
     #
+    # Options
+    #
+    #   ignore - one or more categories of things to ignore. Valid
+    #     values are: :broken_links. Default: []
+    #
     # Yields Representation of the target for each link.
-    def reject_links(rel, &blk)
+    def reject_links(rel, ignore: [], &blk)
       reject_from_section("_links",
                           rel,
                           ->(l) {Representation.new(href: l["href"],
                                                     hal_client: hal_client)},
-                          blk)
+                          ignoring(ignore, blk))
     end
 
     # Returns a RepresentationEditor for a representation like the
@@ -71,13 +81,18 @@ class HalClient
     # blk - When given only embedded resources for whom
     #   the block returns true will be rejected.
     #
+    # Options
+    #
+    #   ignore - one or more categories of things to ignore. Valid
+    #     values are: :broken_links. Default: []
+    #
     # Yields Representation of the target for each embedded.
-    def reject_embedded(rel, &blk)
+    def reject_embedded(rel, ignore: [], &blk)
       reject_from_section("_embedded",
                           rel,
                           ->(e) {Representation.new(parsed_json: e,
                                                     hal_client: hal_client)},
-                          blk)
+                          ignoring(ignore, blk))
     end
 
     # Returns a RepresentationEditor exactly like this one except that
@@ -143,5 +158,21 @@ class HalClient
 
       self.class.new(orig_repr, raw.merge(name => new_sec))
     end
+
+    def ignoring(criteria, filter)
+      Array(criteria)
+        .reduce(filter) {|f, c|
+          case c
+          when :broken_links
+            ->(*args) { begin
+                          f.call(*args)
+                        rescue HalClient::HttpClientError
+                          false
+                        end }
+          else
+            fail ArgumentError, "Unsupported ignore criteria: #{c}"
+          end
+        }
+    end
   end
 end

data/lib/hal_client/version.rb

@@ -1,3 +1,3 @@
 class HalClient
-  VERSION = "3.8.1"
+  VERSION = "3.9.0"
 end

data/spec/hal_client/representation_editor_spec.rb

@@ -26,6 +26,12 @@ RSpec.describe HalClient::RepresentationEditor do
     specify { expect(subject.reject_links("absent-rel")).to be_equivalent_json_to raw_hal }
     specify { expect(subject.reject_links("about") {|repr| %r|/another$| === repr.href })
               .not_to have_link "about" }
+
+    specify { expect{subject.reject_links("broken-link") {|repr| repr[:t] }}
+                .to raise_error HalClient::HttpClientError }
+    specify { expect{subject.reject_links("broken-link", ignore: :broken_links) { |repr|
+                       repr[:t] }}
+                .not_to raise_error }
   end
 
   describe "#reject_embedded" do
@@ -74,12 +80,16 @@ RSpec.describe HalClient::RepresentationEditor do
 
       expect(altered).to have_link("replies", hash_including("value" => "-1"))
                           .or(have_embedded("replies", hash_including("value" => "-1")))
-
     end
 
     specify { expect(subject.reject_related("absent-rel"))
               .to be_equivalent_json_to raw_hal }
 
+    specify { expect{subject.reject_related("broken-link") {|repr| repr[:t] }}
+              .to raise_error HalClient::HttpClientError }
+    specify { expect{subject.reject_related("broken-link", ignore: :broken_links) { |repr|
+                       repr[:t] }}
+              .not_to raise_error }
   end
 
   describe "#set_property" do
@@ -116,8 +126,10 @@ RSpec.describe HalClient::RepresentationEditor do
 
   # Background
 
+  let(:hal_client) { HalClient.new }
   let(:a_repr) { HalClient::Representation
-                 .new(parsed_json: MultiJson.load(raw_hal)) }
+                 .new(parsed_json: MultiJson.load(raw_hal),
+                      hal_client: hal_client) }
 
   let(:raw_hal) { <<-HAL }
     { "age": 10
@@ -126,6 +138,7 @@ RSpec.describe HalClient::RepresentationEditor do
         ,"up"   : [{ "href": "http://example.com/c1" },
                   { "href": "http://example.com/c2" }]
         ,"about": { "href": "http://example.com/another" }
+        ,"broken-link": { "href": "http://example.com/missing" }
       }
       ,"_embedded": {
         "replies": [
@@ -136,6 +149,9 @@ RSpec.describe HalClient::RepresentationEditor do
     }
   HAL
 
+  let!(:missing_resource_req) { stub_request(:get, "http://example.com/missing")
+                                .to_return(status: 404) }
+
   ANYTHING = ->(_) { true }
 
   matcher :be_templated do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hal-client
 version: !ruby/object:Gem::Version
-  version: 3.8.1
+  version: 3.9.0
 platform: ruby
 authors:
 - Peter Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-22 00:00:00.000000000 Z
+date: 2015-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http