module Europeana

Constants

URL
VERSION

Attributes

api_key[RW]

The Europeana API key, required for authentication

max_retries[RW]

The maximum number of retries permitted

Retries occur when a network request to the API fails. The default is 5 retries before giving up.

@return [Integer]

retry_delay[RW]

The number of seconds to wait between retries

The default is 10 seconds.

@return [Integer]

Public Class Methods

defaults!() click to toggle source

Sets configuration values to their defaults

# File lib/europeana.rb, line 42
def defaults!
  self.max_retries = 5
  self.retry_delay = 10
end

deprecation_warning() click to toggle source

# File lib/europeana.rb, line 78
def deprecation_warning
  Deprecation.warn(Europeana, 'The europeana gem is deprecated. Please upgrade to the europeana-api gem.')
end

record(record_id, params = {}) click to toggle source

Sends a Record request to the Europeana API

Equivalent to:

search = Europeana::Record.new(record_id, params)
record.get

@param [String] Record ID @param [Hash] params Query parameters @return [Hash] search response @see Europeana::Record#get

# File lib/europeana.rb, line 74
def record(record_id, params = {})
  Record.new(record_id, params).get
end

search(params = {}) click to toggle source

Sends a Search request to the Europeana API

Equivalent to:

search = Europeana::Search.new(params)
search.execute

@param [Hash] params Query parameters @return [Hash] search response @see Europeana::Search#execute

# File lib/europeana.rb, line 58
def search(params = {})
  Search.new(params).execute
end