Class: CONTENTdmAPI::RequestBatch

Inherits:
Object
  • Object
show all
Defined in:
lib/contentdm_api/request_batch.rb

Overview

Make a batch of requests to the CONTENTdm API and combine them

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(base_url: '', service_configs: [], service: Service, requester: Request) ⇒ Void

“CdmServer.com:port/dmwebservices/index.php”

Parameters:

  • base_url (String) (defaults to: '') —

    URL to the CONTENTdm API “CdmServer.com:port/dmwebservices/index.php”

  • service_configs (Array) (defaults to: []) —

    An array of hash configurations for individual services

  • service (Object) (defaults to: Service) —

    A Service class to tell the Request class which function, params and format to request of the CONTENTdm API

  • requester (Object) (defaults to: Request) —

    A class to form requests to the ContentDM API



15
16
17
18
19
20
21
22
23
24
 
# File 'lib/contentdm_api/request_batch.rb', line 15

def initialize(base_url: '',
               service_configs: [],
               service: Service,
               requester: Request)

  @service   = service
  @configs   = service_configs
  @base_url  = base_url
  @requester = requester
end

Instance Attribute Details

#base_url ⇒ Object (readonly)

Returns the value of attribute base_url.



4
5
6
 
# File 'lib/contentdm_api/request_batch.rb', line 4

def base_url
  @base_url
end

#configs ⇒ Object (readonly)

Returns the value of attribute configs.



4
5
6
 
# File 'lib/contentdm_api/request_batch.rb', line 4

def configs
  @configs
end

#requester ⇒ Object (readonly)

Returns the value of attribute requester.



4
5
6
 
# File 'lib/contentdm_api/request_batch.rb', line 4

def requester
  @requester
end

#service ⇒ Object (readonly)

Returns the value of attribute service.



4
5
6
 
# File 'lib/contentdm_api/request_batch.rb', line 4

def service
  @service
end

Instance Method Details

#fetch ⇒ Array

Fetch data from the CONTENTdm API

Returns:

  • (Array) —

    an array of hashes containing Request response data



29
30
31
 
# File 'lib/contentdm_api/request_batch.rb', line 29

def fetch
  responses
end