Sha256: 9cf619f5edc31affeeb6bd8a58c7945588e440c5a3d55317cfb03016becadad4

Contents?: true

Size: 1.7 KB

Versions: 6

Compression:

Stored size: 1.7 KB

Contents

# frozen_string_literal: true

module Dor
  module Services
    class Client
      # API calls relating to files
      class Files < VersionedService
        # Get the contents from the workspace
        # @param [String] object the identifier for the object
        # @param [String] filename the name of the file to retrieve
        # @return [String] the file contents from the workspace
        def retrieve(object:, filename:)
          resp = connection.get do |req|
            req.url "#{api_version}/objects/#{object}/contents/#{filename}"
          end
          return unless resp.success?

          resp.body
        end

        # Get the preserved file contents
        # @param [String] object the identifier for the object
        # @param [String] filename the name of the file to retrieve
        # @param [Integer] version the version of the file to retrieve
        # @return [String] the file contents from the SDR
        def preserved_content(object:, filename:, version:)
          resp = connection.get do |req|
            req.url "#{api_version}/sdr/objects/#{object}/content/#{CGI.escape(filename)}?version=#{version}"
          end
          return unless resp.success?

          resp.body
        end

        # Get the list of files in the workspace
        # @param [String] object the identifier for the object
        # @return [Array<String>] the list of filenames in the workspace
        def list(object:)
          resp = connection.get do |req|
            req.url "#{api_version}/objects/#{object}/contents"
          end
          return [] unless resp.success?

          json = JSON.parse(resp.body)
          json['items'].map { |item| item['name'] }
        end
      end
    end
  end
end

Version data entries

6 entries across 6 versions & 1 rubygems

Version Path
dor-services-client-0.10.0 lib/dor/services/client/files.rb
dor-services-client-0.9.0 lib/dor/services/client/files.rb
dor-services-client-0.8.0 lib/dor/services/client/files.rb
dor-services-client-0.7.0 lib/dor/services/client/files.rb
dor-services-client-0.6.0 lib/dor/services/client/files.rb
dor-services-client-0.5.0 lib/dor/services/client/files.rb