Contents

# frozen_string_literal: true

module Dor
  module Services
    class Client
      # API calls relating to files
      class Files < VersionedService
        # @param object_id [String] the pid for the object
        def initialize(connection:, version:, object_id:)
          super(connection: connection, version: version)
          @object_id = object_id
        end

        # Get the contents from the workspace
        # @param [String] filename the name of the file to retrieve
        # @return [String] the file contents from the workspace
        def retrieve(filename:)
          resp = connection.get do |req|
            req.url "#{api_version}/objects/#{object_id}/contents/#{filename}"
          end
          return unless resp.success?

          resp.body
        end

        # Get the preserved file contents
        # @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(filename:, version:)
          resp = connection.get do |req|
            req.url "#{api_version}/sdr/objects/#{object_id}/content/#{CGI.escape(filename)}?version=#{version}"
          end
          return unless resp.success?

          resp.body
        end

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

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

        private

        attr_reader :object_id
      end
    end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
dor-services-client-1.1.0	lib/dor/services/client/files.rb
dor-services-client-1.0.0	lib/dor/services/client/files.rb