Class: Dor::Services::Client
- Inherits:
-
Object
- Object
- Dor::Services::Client
- Includes:
- Singleton
- Defined in:
- lib/dor/services/client.rb,
lib/dor/services/client/sdr.rb,
lib/dor/services/client/files.rb,
lib/dor/services/client/object.rb,
lib/dor/services/client/objects.rb,
lib/dor/services/client/version.rb,
lib/dor/services/client/workflow.rb,
lib/dor/services/client/workflows.rb,
lib/dor/services/client/workspace.rb,
lib/dor/services/client/release_tags.rb,
lib/dor/services/client/versioned_service.rb
Defined Under Namespace
Classes: Error, Files, MalformedResponse, NotFoundResponse, Object, Objects, ReleaseTags, SDR, UnexpectedResponse, VersionedService, Workflow, Workflows, Workspace
Constant Summary collapse
- DEFAULT_VERSION =
'v1'
- VERSION =
'1.5.1'
Instance Attribute Summary collapse
-
#connection ⇒ Object
writeonly
Sets the attribute connection.
-
#password ⇒ Object
writeonly
Sets the attribute password.
-
#url ⇒ Object
writeonly
Sets the attribute url.
-
#username ⇒ Object
writeonly
Sets the attribute username.
Class Method Summary collapse
Instance Method Summary collapse
-
#object(object_identifier) ⇒ Dor::Services::Client::Object
An instance of the ‘Client::Object` class.
-
#objects ⇒ Dor::Services::Client::Objects
An instance of the ‘Client::Objects` class.
- #workflows ⇒ Object
Instance Attribute Details
#connection=(value) ⇒ Object
Sets the attribute connection
69 70 71 |
# File 'lib/dor/services/client.rb', line 69 def connection=(value) @connection = value end |
#password=(value) ⇒ Object
Sets the attribute password
69 70 71 |
# File 'lib/dor/services/client.rb', line 69 def password=(value) @password = value end |
#url=(value) ⇒ Object
Sets the attribute url
69 70 71 |
# File 'lib/dor/services/client.rb', line 69 def url=(value) @url = value end |
#username=(value) ⇒ Object
Sets the attribute username
69 70 71 |
# File 'lib/dor/services/client.rb', line 69 def username=(value) @username = value end |
Class Method Details
.configure(url:, username: nil, password: nil) ⇒ Object
56 57 58 59 60 61 62 63 64 |
# File 'lib/dor/services/client.rb', line 56 def configure(url:, username: nil, password: nil) instance.url = url instance.username = username instance.password = password # Force connection to be re-established when `.configure` is called instance.connection = nil self end |
Instance Method Details
#object(object_identifier) ⇒ Dor::Services::Client::Object
Returns an instance of the ‘Client::Object` class.
35 36 37 38 39 40 41 42 43 44 |
# File 'lib/dor/services/client.rb', line 35 def object(object_identifier) raise ArgumentError, '`object_identifier` argument cannot be `nil` in call to `#object(object_identifier)' if object_identifier.nil? # Return memoized object instance if object identifier value is the same # This allows us to test the client more easily in downstream codebases, # opening up stubbing without requiring `any_instance_of` return @object if @object&.object_identifier == object_identifier @object = Object.new(connection: connection, version: DEFAULT_VERSION, object_identifier: object_identifier) end |
#objects ⇒ Dor::Services::Client::Objects
Returns an instance of the ‘Client::Objects` class.
47 48 49 |
# File 'lib/dor/services/client.rb', line 47 def objects @objects ||= Objects.new(connection: connection, version: DEFAULT_VERSION) end |
#workflows ⇒ Object
51 52 53 |
# File 'lib/dor/services/client.rb', line 51 def workflows @workflows ||= Workflows.new(connection: connection, version: DEFAULT_VERSION) end |