dor-services-client 4.13.1 → 4.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0765c7a68c51ff36c39235c7aef14030dbd79e41e6f9430100ac8f23d266bd8f
-  data.tar.gz: e6fa59e610a45e3b715e5a2d90a0c34ab8a671795fdafc7db87014e44d7ce61e
+  metadata.gz: 56c3ce6206a170292f44d10b8203748a498ae80450b15551136f3e7a2c804c67
+  data.tar.gz: 20cd69d1dffee9040fdd37fc2cd2c4b38e82a0f081d53367201789b2c2f0f6b1
 SHA512:
-  metadata.gz: f00270a84ed870ee9f722ab6a10eddabb8e0527d264c8ecaf605b7e2c1d88ec47ba48643cbce19f21b1422c8e2f1d85a2864c73dce949b4a9a2b992ff2cf92f6
-  data.tar.gz: f30b2e43b12928486f18a641005a51e0c9b37dbd7c6bcdd3cfb1ae44f0db1ec53d41f2c001e9fcfc113433905ae1e3e9d601f0b2fb6bdc646091871285b9d6eb
+  metadata.gz: eaff2fded30179d72a406fa087a2e4b8b43f1d8efe648215700df4244a599a3031b6b83aae50fb0414cff18f8ccf4b5618a5d27d2a3b3292ac4b0d11bd99e29a
+  data.tar.gz: e07b40ad72c26e76cd42325f264bea7af646c3593a09490a212e02947d4b69323b572523d9d2d6b97b11bc2018b6f781bf19dddda7bae450051552174d40436b

data/README.md

@@ -125,9 +125,12 @@ object_client.metadata.legacy_update(
 # Return the Cocina metadata
 object_client.find
 
-# Query for an objects collections
+# Query for an object's collections
 object_client.collections
 
+# Query for a collection's members
+object_client.members
+
 # View information about an object's files
 object_client.files.retrieve(filename: filename_string)
 object_client.files.list

data/lib/dor/services/client/members.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Dor
+  module Services
+    class Client
+      # API call that queries the members of a collection.
+      class Members < VersionedService
+        Member = Struct.new(:externalIdentifier, :type, keyword_init: true)
+
+        # @param object_identifier [String] the pid for the object
+        def initialize(connection:, version:, object_identifier:)
+          super(connection: connection, version: version)
+          @object_identifier = object_identifier
+        end
+
+        # Get a list of the members.
+        # @raise [UnexpectedResponse] if the request is unsuccessful.
+        # @return [Array<Member>]
+        def members
+          resp = connection.get do |req|
+            req.url members_path
+          end
+
+          return response_to_models(resp) if resp.success?
+
+          raise_exception_based_on_response!(resp, object_identifier)
+        end
+
+        private
+
+        def response_to_models(resp)
+          JSON.parse(resp.body)['members'].map { |result| Member.new(**result.symbolize_keys) }
+        end
+
+        def object_path
+          "#{api_version}/objects/#{object_identifier}"
+        end
+
+        def members_path
+          "#{object_path}/members"
+        end
+
+        attr_reader :object_identifier
+      end
+    end
+  end
+end

data/lib/dor/services/client/object.rb

@@ -64,6 +64,13 @@ module Dor
           Collections.new(parent_params).collections
         end
 
+        # Get a list of the members
+        # @raise [UnexpectedResponse] if the request is unsuccessful.
+        # @return [Array<Members::Member>]
+        def members
+          Members.new(parent_params).members
+        end
+
         # Publish an object (send to PURL)
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] when the response is not successful.

data/lib/dor/services/client/version.rb

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '4.13.1'
+      VERSION = '4.14.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 4.13.1
+  version: 4.14.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-14 00:00:00.000000000 Z
+date: 2020-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -215,6 +215,7 @@ files:
 - lib/dor/services/client/events.rb
 - lib/dor/services/client/files.rb
 - lib/dor/services/client/marcxml.rb
+- lib/dor/services/client/members.rb
 - lib/dor/services/client/metadata.rb
 - lib/dor/services/client/object.rb
 - lib/dor/services/client/object_version.rb
@@ -243,7 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A client for dor-services-app