europeana-api 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 894ad987b215b9e7dfd6002f1e2f7225fcab25ae
-  data.tar.gz: 87e594f04c09dc273d7b285975ae682b4fbf7675
+  metadata.gz: 900783456e54538f5ac9ddcff6fd9ad7b0a42336
+  data.tar.gz: b8fcd2aeab490cd197ecb7f6eb1985afeafc4c11
 SHA512:
-  metadata.gz: bcd7ad50a881202448ef74db5ab0165b5147448ab6a1e2df915741dd53d27cc76e723c5270a22de4778b06641d21dba5f634553d4e16f8457fe4e3c0afe08d8c
-  data.tar.gz: c490cbfa7b307dd0a25ba8cd84d4226b2bc49b8efb461bec3c975e38b6822cdfa337df5fc88fbe56543aea7d5cbf28c7408d6594b5c6c6f9bb4625fd96c0dd1c
+  metadata.gz: fb4f2822e5235c4eb46b7c975dc5271b7ec25d87d3be5f591143b92a4f398d34c5896343d7c4b184956e4dc3167eeb8f7aee0ffbd5c6b43211fcb903a4ef4d33
+  data.tar.gz: 12f747dcda20e90b737e1cb6193c9d373dd9b2d1eb82ba32342afba9a79dbb88681789862bc577caf05a7cd1dad3c2577d8114cd5be64516791ddb38d18a2b2f

data/README.md

@@ -7,7 +7,9 @@ REST API](http://labs.europeana.eu/api/introduction/).
 
 Add this line to your application's Gemfile:
 
-    gem 'europeana-api'
+```ruby
+gem 'europeana-api'
+```
 
 And then execute:
 
@@ -29,21 +31,28 @@ Sign up for an API key at: http://labs.europeana.eu/api/registration/
 
 Configure your application with the API key:
 
-    Europeana::API.api_key = "xyz"
+```ruby
+require 'europeana/api'
+Europeana::API.api_key = 'xyz'
+```
 
 ### Search
 
-    search = Europeana::API.search(:query => '"first world war"') # => { "success" => true, "items" => [ ... ], "totalResults" => 1234, ... }
-    search["items"] # => [ item1, item2, ... ]
-    search["totalResults"] # => 1234
-    
+```ruby
+search = Europeana::API.search(query: '"first world war"') # => { "success" => true, "items" => [ ... ], "totalResults" => 1234, ... }
+search['items'] # => [ item1, item2, ... ]
+search['totalResults'] # => 1234
+```
+
 See http://labs.europeana.eu/api/search/ for details of the data returned in
 the search response.
 
 ### Record
 
-    record = Europeana::API.record("abc/1234") # => { "success" => true, "object" => { ... }, ... }
-    record["object"] # => { "title" => "...", "proxies" => [ ... ], "aggregations" => [ ... ]
+```ruby
+record = Europeana::API.record('abc/1234') # => { "success" => true, "object" => { ... }, ... }
+record['object'] # => { "title" => "...", "proxies" => [ ... ], "aggregations" => [ ... ]
+```
 
 See http://labs.europeana.eu/api/record/ for details of the data returned in
 the record response.

data/europeana-api.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 1.9.2'
+
   spec.add_dependency 'activesupport', '>= 3.0'
   spec.add_dependency 'multi_json', '~> 1.0'
 

data/lib/europeana/api.rb

@@ -1,12 +1,12 @@
-require 'europeana/api/version'
-require 'uri'
-require 'logger'
 require 'active_support/core_ext/object'
 require 'active_support/hash_with_indifferent_access'
+require 'europeana/api/version'
+require 'logger'
+require 'uri'
 
-##
-# Europeana REST API client
 module Europeana
+  ##
+  # Europeana REST API client
   module API
     API_VERSION = 'v2'
     URL = "http://www.europeana.eu/api/#{API_VERSION}"
@@ -27,7 +27,6 @@ module Europeana
       # retries before giving up.
       #
       # @return [Integer]
-      #
       attr_accessor :max_retries
 
       ##
@@ -36,12 +35,10 @@ module Europeana
       # The default is 10 seconds.
       #
       # @return [Integer]
-      #
       attr_accessor :retry_delay
 
       ##
       # Sets configuration values to their defaults
-      #
       def defaults!
         self.max_retries = 5
         self.retry_delay = 10
@@ -51,13 +48,12 @@ module Europeana
       # Sends a Search request to the Europeana API
       #
       # Equivalent to:
-      #   search = Europeana::Search.new(params)
+      #   search = Europeana::API::Search.new(params)
       #   search.execute
       #
       # @param [Hash] params Query parameters
       # @return [Hash] search response
-      # @see Europeana::Search#execute
-      #
+      # @see Europeana::API::Search#execute
       def search(params = {})
         Search.new(params).execute
       end
@@ -66,27 +62,29 @@ module Europeana
       # Sends a Record request to the Europeana API
       #
       # Equivalent to:
-      #   search = Europeana::Record.new(record_id, params)
-      #   record.get
+      #   record = Europeana::API::Record.new(record_id, params)
+      #   record.get(options)
       #
       # @param [String] Record ID
       # @param [Hash] params Query parameters
+      # @param [Hash] options (see Europeana::API::Record#get)
       # @return [Hash] search response
-      # @see Europeana::Record#get
-      #
-      def record(record_id, params = {})
-        Record.new(record_id, params).get
+      # @see Europeana::API::Record#get
+      def record(record_id, params = {}, options = {})
+        Record.new(record_id, params).get(options)
       end
 
       def logger
-        unless @logger
-          if defined?(Rails) && Rails.logger
-            @logger = Rails.logger
-          else
-            @logger = Logger.new(STDOUT)
+        return @logger unless @logger.nil?
+
+        @logger = case
+        when defined?(Rails) && Rails.logger
+           Rails.logger
+        else
+          Logger.new(STDOUT).tap do |logger|
+            logger.progname = 'Europeana::API'
           end
         end
-        @logger
       end
     end
 

data/lib/europeana/api/record.rb

@@ -62,9 +62,14 @@ module Europeana
       ##
       # Gets the URI for this Record request with parameters
       #
+      # @param [Hash{Symbol => Object}] options
+      # @option options [Boolean] :ld (false)
+      #   Request JSON-LD
       # @return [URI]
-      def request_uri
-        uri = URI.parse(Europeana::API::URL + "/record#{@id}.json")
+      def request_uri(options = {})
+        url = Europeana::API::URL + "/record#{@id}.json"
+        url << 'ld' if options[:ld]
+        uri = URI.parse(url)
         uri.query = params_with_authentication.to_query
         uri
       end
@@ -72,19 +77,24 @@ module Europeana
       ##
       # Sends a request for this record to the API
       #
-      # @return [HashWithIndifferentAccess]
+      # @param [Hash{Symbol => Object}] options
+      # @option options [Boolean] :ld (false)
+      #   Request JSON-LD
+      # @return [Hash]
       # @raise [Europeana::Errors::ResponseError] if API response could not be
       #   parsed as JSON
       # @raise [Europeana::Errors::RequestError] if API response has
       #   `success:false`
       # @raise [Europeana::Errors::RequestError] if API response has 404 status
       #   code
-      def get
-        request = Request.new(request_uri)
+      def get(options = {})
+        request = Request.new(request_uri(options))
         response = request.execute
         body = JSON.parse(response.body)
-        fail Errors::RequestError, body['error'] unless body['success']
-        HashWithIndifferentAccess.new(body)
+        if (options[:ld] && !(200..299).include?(response.code.to_i)) || (!options[:ld] && !body['success'])
+          fail Errors::RequestError, response.code
+        end
+        body
       rescue JSON::ParserError
         if response.code.to_i == 404
           # Handle HTML 404 responses on malformed record ID, emulating API's

data/lib/europeana/api/request.rb

@@ -21,9 +21,9 @@ module Europeana
 
       # @return (see Net::HTTP#request)
       def execute
-        logger.debug("#{self.class} API URL: #{uri}")
+        logger.info("Request URL: #{uri}")
 
-        benchmark("#{self.class} API query", level: :debug) do
+        benchmark("Request query", level: :info) do
           http = Net::HTTP.new(uri.host, uri.port)
           request = Net::HTTP::Get.new(uri.request_uri)
           retries = Europeana::API.max_retries

data/lib/europeana/api/version.rb

@@ -2,6 +2,6 @@ module Europeana
   ##
   # Sets the *gem* version (not the *API* version)
   module API
-    VERSION = '0.3.0'
+    VERSION = '0.3.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: europeana-api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Richard Doe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-18 00:00:00.000000000 Z
+date: 2015-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -133,7 +133,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="