Module: Rubydora::RestApiClient

Extended by:
ActiveSupport::Concern
Includes:
ActiveSupport::Benchmarkable, FedoraUrlHelpers
Included in:
Repository
Defined in:
lib/rubydora/rest_api_client.rb

Overview

Provide low-level access to the Fedora Commons REST API

Constant Summary collapse

VALID_CLIENT_OPTIONS = 
[:user, :password, :timeout, :open_timeout, :ssl_client_cert, :ssl_client_key]

Constants included from FedoraUrlHelpers

FedoraUrlHelpers::API_DOCUMENTATION

Instance Method Summary collapse

Methods included from FedoraUrlHelpers

#datastream_content_url, #datastream_history_url, #datastream_url, #dissemination_url, #export_object_url, #find_objects_url, #new_object_relationship_url, #next_pid_url, #object_relationship_url, #object_url, #object_versions_url, #object_xml_url, #url_for, #validate_object_url

Instance Method Details

#add_datastream(options = {}) ⇒ String

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :pid (String)
  • :dsid (String)

Returns:

  • (String) 


279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/rubydora/rest_api_client.rb', line 279

def add_datastream options = {}
  query_options = options.dup
  pid = query_options.delete(:pid)
  dsid = query_options.delete(:dsid)
  file = query_options.delete(:content)
  content_type = query_options.delete(:content_type) || query_options[:mimeType] || (MIME::Types.type_for(file.path).first if file.respond_to? :path) || 'application/octet-stream'
  run_hook :before_add_datastream, :pid => pid, :dsid => dsid, :file => file, :options => options
  str = file.respond_to?(:read) ? file.read : file
  file.rewind if file.respond_to?(:rewind)
  client[datastream_url(pid, dsid, query_options)].post(str, :content_type => content_type.to_s, :multipart => true)
rescue Exception => exception
    rescue_with_handler(exception) || raise
end

#add_relationship(options = {}) ⇒ String

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :pid (String)

Returns:

  • (String) 


353
354
355
356
357
358
359
360
 
# File 'lib/rubydora/rest_api_client.rb', line 353

def add_relationship options = {}
  query_options = options.dup
  pid = query_options.delete(:pid) || query_options[:subject]
  run_hook :before_add_relationship, :pid => pid, :options => options
  client[new_object_relationship_url(pid, query_options)].post nil
rescue Exception => exception
    rescue_with_handler(exception) || raise
end

#client(config = {}) ⇒ RestClient::Resource

Create an authorized HTTP client for the Fedora REST API TODO trap for these errors specifically: RestClient::Request::Unauthorized, Errno::ECONNREFUSED

Parameters:

  • config (Hash) (defaults to: {})

Options Hash (config):

  • :url (String)
  • :user (String)
  • :password (String)

Returns:

  • (RestClient::Resource) 


48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/rubydora/rest_api_client.rb', line 48

def client config = {}
  client_config = self.config.merge(config)
  client_config.symbolize_keys!
  if config.empty? or @config_hash.nil? or (client_config.hash == @config_hash)
    @config_hash = client_config.hash
    url = client_config[:url]
    client_config.delete_if { |k,v| not VALID_CLIENT_OPTIONS.include?(k) }
    client_config[:open_timeout] ||= client_config[:timeout]
    @client ||= RestClient::Resource.new(url, client_config)
  else
    raise ArgumentError, "Attemping to re-initialize #{self.class}#client with different configuration parameters"
  end
end

#datastream(options = {}) ⇒ String Also known as: datastreams

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :pid (String)
  • :dsid (String)
  • :asOfDateTime (String)
  • :validateChecksum (String)

Returns:

  • (String) 


191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/rubydora/rest_api_client.rb', line 191

def datastream options = {}
  query_options = options.dup
  pid = query_options.delete(:pid)
  dsid = query_options.delete(:dsid)
  query_options[:format] ||= 'xml'
  val = nil
  message = dsid.nil? ? "Loaded datastream list for #{pid}" : "Loaded datastream profile #{pid}/#{dsid}"
  benchmark message, :level=>:debug do
    val = client[datastream_url(pid, dsid, query_options)].get
  end

  val
rescue RestClient::Unauthorized => e
  logger.error "Unauthorized at #{client.url}/#{datastream_url(pid, dsid, query_options)}"
  raise e
rescue Exception => exception
    rescue_with_handler(exception) || raise
end

#datastream_dissemination(options = {}, &block_response) ⇒ String

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :pid (String)
  • :dsid (String)

Returns:

  • (String) 


253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/rubydora/rest_api_client.rb', line 253

def datastream_dissemination options = {}, &block_response
  query_options = options.dup
  pid = query_options.delete(:pid)
  dsid = query_options.delete(:dsid)
  method = query_options.delete(:method)
  method ||= :get
  raise self.class.name + "#datastream_dissemination requires a DSID" unless dsid
  if block_given?
    resource = safe_subresource(datastream_content_url(pid, dsid, query_options), :block_response => block_response)
  else
    resource = client[datastream_content_url(pid, dsid, query_options)]
  end
  val = nil
  benchmark "Loaded datastream content #{pid}/#{dsid}", :level=>:debug do
    val = resource.send(method)
  end
  val
rescue Exception => exception
    rescue_with_handler(exception) || raise
end

#datastream_versions(options = {}) ⇒ String Also known as: datastream_history

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :pid (String)
  • :dsid (String)

Returns:

  • (String) 


232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/rubydora/rest_api_client.rb', line 232

def datastream_versions options = {}
  query_options = options.dup
  pid = query_options.delete(:pid)
  dsid = query_options.delete(:dsid)
  raise ArgumentError, "Must supply dsid" unless dsid
  query_options[:format] ||= 'xml'
  client[datastream_history_url(pid, dsid, query_options)].get
rescue RestClient::ResourceNotFound => e
  #404 Resource Not Found: No datastream history could be found. There is no datastream history for the digital object "changeme:1" with datastream ID of "descMetadata
  return nil
rescue Exception => exception
    rescue_with_handler(exception) || raise
end

#dissemination(options = {}, &block_response) ⇒ String

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :pid (String)
  • :sdef (String)
  • :method (String)

Returns:

  • (String) 


381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/rubydora/rest_api_client.rb', line 381

def dissemination options = {}, &block_response
  query_options = options.dup
  pid = query_options.delete(:pid)
  sdef = query_options.delete(:sdef)
  method = query_options.delete(:method)
  query_options[:format] ||= 'xml' unless pid and sdef and method
  if block_given?
    resource = safe_subresource(dissemination_url(pid,sdef,method,query_options), :block_response => block_response)
  else
    resource = client[dissemination_url(pid,sdef,method,query_options)]
  end
  resource.get

rescue Exception => exception
    rescue_with_handler(exception) || raise

end

#export(options = {}) ⇒ String

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :pid (String)

Returns:

  • (String) 


122
123
124
125
126
127
128
 
# File 'lib/rubydora/rest_api_client.rb', line 122

def export options = {}
  query_options = options.dup
  pid = query_options.delete(:pid)
  client[export_object_url(pid, query_options)].get
rescue Exception => exception
    rescue_with_handler(exception) || raise
end

#find_objects(options = {}, &block_response) ⇒ String

Parameters:

  • options (Hash) (defaults to: {})

Returns:

  • (String) 


76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/rubydora/rest_api_client.rb', line 76

def find_objects options = {}, &block_response
  query_options = options.dup
  raise ArgumentError,"Cannot have both :terms and :query parameters" if query_options[:terms] and query_options[:query]
  query_options[:resultFormat] ||= 'xml'

  resource = client[find_objects_url(query_options)]
  if block_given?
    resource.query_options[:block_response] = block_response
  end 
  return resource.get
rescue Exception => exception
  rescue_with_handler(exception) || raise
end

#ingest(options = {}) ⇒ String

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :pid (String)

Returns:

  • (String) 


107
108
109
110
111
112
113
114
115
116
 
# File 'lib/rubydora/rest_api_client.rb', line 107

def ingest options = {}
  query_options = options.dup
  pid = query_options.delete(:pid) || 'new'
  file = query_options.delete(:file)
  assigned_pid = client[object_url(pid, query_options)].post((file.dup if file), :content_type => 'text/xml')
  run_hook :after_ingest, :pid => assigned_pid, :file => file, :options => options
  assigned_pid
rescue Exception => exception
    rescue_with_handler(exception) || raise
end

#modify_datastream(options = {}) ⇒ String

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :pid (String)
  • :dsid (String)

Returns:

  • (String) 


298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/rubydora/rest_api_client.rb', line 298

def modify_datastream options = {}
  query_options = options.dup
  pid = query_options.delete(:pid)
  dsid = query_options.delete(:dsid)
  file = query_options.delete(:content)
  content_type = query_options.delete(:content_type) || query_options[:mimeType] || (MIME::Types.type_for(file.path).first if file.respond_to? :path) || 'application/octet-stream'

  rest_client_options = {}
  if file
    rest_client_options[:multipart] = true
    rest_client_options[:content_type] = content_type
  end

  run_hook :before_modify_datastream, :pid => pid, :dsid => dsid, :file => file, :content_type => content_type, :options => options
  str = file.respond_to?(:read) ? file.read : file
  file.rewind if file.respond_to?(:rewind)
  client[datastream_url(pid, dsid, query_options)].put(str, rest_client_options)

rescue Exception => exception
    rescue_with_handler(exception) || raise
end

#modify_object(options = {}) ⇒ String

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :pid (String)

Returns:

  • (String) 


134
135
136
137
138
139
140
141
 
# File 'lib/rubydora/rest_api_client.rb', line 134

def modify_object options = {}
  query_options = options.dup
  pid = query_options.delete(:pid)
  run_hook :before_modify_object, :pid => pid, :options => options
  client[object_url(pid, query_options)].put nil
rescue Exception => exception
    rescue_with_handler(exception) || raise
end

#next_pid(options = {}) ⇒ String

Parameters:

  • options (Hash) (defaults to: {})

Returns:

  • (String) 


65
66
67
68
69
70
71
 
# File 'lib/rubydora/rest_api_client.rb', line 65

def next_pid options = {}
  query_options = options.dup
  query_options[:format] ||= 'xml'
  client[next_pid_url(query_options)].post nil
rescue Exception => exception
  rescue_with_handler(exception) || raise
end

#object(options = {}) ⇒ String

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :pid (String)

Returns:

  • (String) 


94
95
96
97
98
99
100
101
 
# File 'lib/rubydora/rest_api_client.rb', line 94

def object options = {}
  query_options = options.dup
  pid = query_options.delete(:pid)
  query_options[:format] ||= 'xml'
  client[object_url(pid, query_options)].get
rescue Exception => exception
    rescue_with_handler(exception) || raise
end

#object_versions(options = {}) ⇒ String

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :pid (String)

Returns:

  • (String) 


160
161
162
163
164
165
166
167
168
 
# File 'lib/rubydora/rest_api_client.rb', line 160

def object_versions options = {}
  query_options = options.dup
  pid = query_options.delete(:pid)
  query_options[:format] ||= 'xml'
  raise ArgumentError, "Must have a pid" unless pid
  client[object_versions_url(pid, query_options)].get
rescue Exception => exception
    rescue_with_handler(exception) || raise
end

#object_xml(options = {}) ⇒ String

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :pid (String)

Returns:

  • (String) 


174
175
176
177
178
179
180
181
182
 
# File 'lib/rubydora/rest_api_client.rb', line 174

def object_xml options = {}
  query_options = options.dup
  pid = query_options.delete(:pid)
  raise ArgumentError, "Missing required parameter :pid" unless pid
  query_options[:format] ||= 'xml'
  client[object_xml_url(pid, query_options)].get
rescue Exception => exception
    rescue_with_handler(exception) || raise
end

#purge_datastream(options = {}) ⇒ String

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :pid (String)
  • :dsid (String)

Returns:

  • (String) 


325
326
327
328
329
330
331
332
333
 
# File 'lib/rubydora/rest_api_client.rb', line 325

def purge_datastream options = {}
  query_options = options.dup
  pid = query_options.delete(:pid)
  dsid = query_options.delete(:dsid)
  run_hook :before_purge_datastream, :pid => pid, :dsid => dsid
  client[datastream_url(pid, dsid, query_options)].delete
rescue Exception => exception
    rescue_with_handler(exception) || raise
end

#purge_object(options = {}) ⇒ String

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :pid (String)

Returns:

  • (String) 


147
148
149
150
151
152
153
154
 
# File 'lib/rubydora/rest_api_client.rb', line 147

def purge_object options = {}
  query_options = options.dup
  pid = query_options.delete(:pid)
  run_hook :before_purge_object, :pid => pid, :options => options
  client[object_url(pid, query_options)].delete
rescue Exception => exception
    rescue_with_handler(exception) || raise
end

#purge_relationship(options = {}) ⇒ String

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :pid (String)

Returns:

  • (String) 


366
367
368
369
370
371
372
373
 
# File 'lib/rubydora/rest_api_client.rb', line 366

def purge_relationship options = {}
  query_options = options.dup
  pid = query_options.delete(:pid) || query_options[:subject]
  run_hook :before_purge_relationship, :pid => pid, :options => options
  client[object_relationship_url(pid, query_options)].delete
rescue Exception => exception
    rescue_with_handler(exception) || raise
end

#relationships(options = {}) ⇒ String

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :pid (String)

Returns:

  • (String) 


339
340
341
342
343
344
345
346
347
 
# File 'lib/rubydora/rest_api_client.rb', line 339

def relationships options = {}
  query_options = options.dup
  pid = query_options.delete(:pid) || query_options[:subject]
  raise ArgumentError, "Missing required parameter :pid" unless pid
  query_options[:format] ||= 'xml'
  client[object_relationship_url(pid, query_options)].get
rescue Exception => exception
    rescue_with_handler(exception) || raise
end

#safe_subresource(subresource, options = Hash.new) ⇒ Object 



399
400
401
402
403
404
405
406
407
408
 
# File 'lib/rubydora/rest_api_client.rb', line 399

def safe_subresource(subresource, options=Hash.new)
  url = client.concat_urls(client.url, subresource)
  options = client.options.dup.merge! options
  block = client.block
  if block
    client.class.new(url, options, &block)
  else
    client.class.new(url, options)
  end
end

#set_datastream_options(options = {}) ⇒ String

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :pid (String)
  • :dsid (String)

Returns:

  • (String) 


217
218
219
220
221
222
223
224
225
 
# File 'lib/rubydora/rest_api_client.rb', line 217

def set_datastream_options options = {}
  query_options = options.dup
  pid = query_options.delete(:pid)
  dsid = query_options.delete(:dsid)
  run_hook :before_set_datastream_options, :pid => pid, :dsid => dsid, :options => options
  client[datastream_url(pid, dsid, query_options)].put nil
rescue Exception => exception
    rescue_with_handler(exception) || raise
end