europeana-api 0.5.2 → 1.0.0

data/lib/europeana/api/record/hierarchy.rb

@@ -1,48 +0,0 @@
-module Europeana
-  module API
-    class Record
-      ##
-      # Retrieve record hierarchies over the Europeana API
-      class Hierarchy
-        autoload :AncestorSelfSiblings, 'europeana/api/record/hierarchy/ancestor_self_siblings'
-        autoload :Base, 'europeana/api/record/hierarchy/base'
-        autoload :Children, 'europeana/api/record/hierarchy/children'
-        autoload :FollowingSiblings, 'europeana/api/record/hierarchy/following_siblings'
-        autoload :Parent, 'europeana/api/record/hierarchy/parent'
-        autoload :PrecedingSiblings, 'europeana/api/record/hierarchy/preceding_siblings'
-        autoload :Self, 'europeana/api/record/hierarchy/self'
-
-        def initialize(id)
-          @id = id
-        end
-
-        # bad idea having a method named self, but this is just a minimal
-        # helper class, so going with it for consistency with the API
-        def self(params = {})
-          Self.new(@id, params).execute_request
-        end
-
-        def parent(params = {})
-          Parent.new(@id, params).execute_request
-        end
-
-        def children(params = {})
-          Children.new(@id, params).execute_request
-        end
-
-        def preceding_siblings(params = {})
-          PrecedingSiblings.new(@id, params).execute_request
-        end
-        alias_method :preceeding_siblings, :preceding_siblings
-
-        def following_siblings(params = {})
-          FollowingSiblings.new(@id, params).execute_request
-        end
-
-        def ancestor_self_siblings(params = {})
-          AncestorSelfSiblings.new(@id, params).execute_request
-        end
-      end
-    end
-  end
-end

data/lib/europeana/api/record/hierarchy/ancestor_self_siblings.rb

@@ -1,12 +0,0 @@
-module Europeana
-  module API
-    class Record
-      class Hierarchy
-        ##
-        # Retrieve record full(ish) hierarchy data over the Europeana API
-        class AncestorSelfSiblings < Base
-        end
-      end
-    end
-  end
-end

data/lib/europeana/api/record/hierarchy/base.rb

@@ -1,30 +0,0 @@
-module Europeana
-  module API
-    class Record
-      class Hierarchy
-        ##
-        # Base class for common heirarchy API behaviour
-        class Base
-          include Requestable
-
-          def initialize(id, params = {})
-            @id = id
-            self.request_params = params
-          end
-
-          def parse_response(response, options = {})
-            super.slice(:self, :children, :parent, 'preceding-siblings', 'preceeding-siblings', 'following-siblings', 'ancestors')
-          end
-
-          def request_url(_options = {})
-            api_url + "/record#{@id}/#{api_method}.json"
-          end
-
-          def api_method
-            self.class.to_s.demodulize.underscore.dasherize
-          end
-        end
-      end
-    end
-  end
-end

data/lib/europeana/api/record/hierarchy/children.rb

@@ -1,12 +0,0 @@
-module Europeana
-  module API
-    class Record
-      class Hierarchy
-        ##
-        # Retrieve record children hierarchy data over the Europeana API
-        class Children < Base
-        end
-      end
-    end
-  end
-end

data/lib/europeana/api/record/hierarchy/following_siblings.rb

@@ -1,12 +0,0 @@
-module Europeana
-  module API
-    class Record
-      class Hierarchy
-        ##
-        # Retrieve record following siblings hierarchy data over the Europeana API
-        class FollowingSiblings < Base
-        end
-      end
-    end
-  end
-end

data/lib/europeana/api/record/hierarchy/parent.rb

@@ -1,12 +0,0 @@
-module Europeana
-  module API
-    class Record
-      class Hierarchy
-        ##
-        # Retrieve record parent hierarchy data over the Europeana API
-        class Parent < Base
-        end
-      end
-    end
-  end
-end

data/lib/europeana/api/record/hierarchy/preceding_siblings.rb

@@ -1,15 +0,0 @@
-module Europeana
-  module API
-    class Record
-      class Hierarchy
-        ##
-        # Retrieve record preceding siblings hierarchy data over the Europeana API
-        class PrecedingSiblings < Base
-          def api_method
-            'preceeding-siblings' # mis-spelt on the API
-          end
-        end
-      end
-    end
-  end
-end

data/lib/europeana/api/record/hierarchy/self.rb

@@ -1,12 +0,0 @@
-module Europeana
-  module API
-    class Record
-      class Hierarchy
-        ##
-        # Retrieve record self hierarchy data over the Europeana API
-        class Self < Base
-        end
-      end
-    end
-  end
-end

data/lib/europeana/api/requestable.rb

@@ -1,118 +0,0 @@
-module Europeana
-  module API
-    ##
-    # Mixin for classes that need to make Europeana API requests
-    #
-    # Class needs to implement {#request_url}
-    module Requestable
-      def extract_api_url(params)
-        @api_url = params.delete(:api_url)
-      end
-
-      def api_url
-        @api_url || Europeana::API.url
-      end
-
-      ##
-      # Request-specific params, to be overriden in including class
-      #
-      # @return [Hash]
-      def params
-        {}
-      end
-
-      def request_params=(params)
-        params = params.deep_dup
-        extract_api_url(params)
-        @params = HashWithIndifferentAccess.new(params)
-      end
-
-      ##
-      # Query params with API key added
-      #
-      # @return [Hash]
-      def params_with_authentication
-        return params if params.key?(:wskey) && params[:wskey].present?
-        unless Europeana::API.api_key.present?
-          fail Europeana::API::Errors::MissingAPIKeyError
-        end
-        params.merge(wskey: Europeana::API.api_key)
-      end
-
-      ##
-      # Execute the API request
-      #
-      # @param options [Hash] Options sent on to {#request_uri} and {#parse_response}
-      # @return (see #parse_response)
-      # @raise [Europeana::Errors::ResponseError] if API response could not be
-      #   parsed as JSON
-      def execute_request(options = {})
-        uri = request_uri(options)
-        cache_response_body(uri) do
-          response = Request.new(uri).execute
-          parse_response(response, options)
-        end
-      rescue JSON::ParserError
-        raise Errors::ResponseError
-      end
-
-      def cache_key(uri)
-        "Europeana/API/#{uri}"
-      end
-
-      def cache_response_body(uri)
-        Europeana::API.cache_store.fetch(cache_key(uri), expires_in: Europeana::API.cache_expires_in) do
-          yield
-        end
-      end
-
-      ##
-      # Parses a JSON response from the API
-      #
-      # @param response (see Net::HTTP#request)
-      # @param options [Hash] Options used by including class's implementation
-      #   of this method
-      # @return [HashWithIndifferentAccess] Parsed body of API response
-      def parse_response(response, _options = {})
-        JSON.parse(response.body).with_indifferent_access
-      end
-
-      ##
-      # URI query param string
-      #
-      # @return [String]
-      def request_uri_query
-        ''.tap do |uri_query|
-          params_with_authentication.each_pair do |name, value|
-            [value].flatten.each do |v|
-              uri_query << '&' unless uri_query.blank?
-              uri_query << CGI.escape(name.to_s) + '=' + CGI.escape(v.to_s)
-            end
-          end
-        end
-      end
-
-      ##
-      # Gets the URI for this request, with any query parameters
-      #
-      # @param [Hash{Symbol => Object}] options passed to {#request_url}
-      # @return [String]
-      def request_uri(options = {})
-        URI.parse(request_url(options)).tap do |uri|
-          uri.query = request_uri_query
-        end
-      end
-
-      ##
-      # URL for the request, without query params
-      #
-      # To be implemented by the including class
-      #
-      # @param options [Hash] Options used by implementation
-      # @return [String] Request URL
-      def request_url(_options = {})
-        fail NotImplementedError, "Requestable class #{self.class} does not implement #request_url"
-      end
-    end
-  end
-end

data/lib/europeana/api/search.rb

@@ -1,64 +0,0 @@
-module Europeana
-  module API
-    ##
-    # Interface to Europeana API's Search method
-    class Search
-      autoload :Fields, 'europeana/api/search/fields'
-
-      include Requestable
-
-      # Query params
-      attr_accessor :params
-
-      class << self
-        ##
-        # Escapes Lucene syntax special characters for use in query parameters
-        #
-        # @param [String] text Text to escape
-        # @return [String] Escaped text
-        def escape(text)
-          fail ArgumentError, "Expected String, got #{text.class}" unless text.is_a?(String)
-          specials = %w<\\ + - & | ! ( ) { } [ ] ^ " ~ * ? : / >
-          specials.each_with_object(text.dup) do |char, unescaped|
-            unescaped.gsub!(char, '\\\\' + char) # prepends *one* backslash
-          end
-        end
-      end
-
-      ##
-      # @param [Hash] params Europeana API request parameters for Search query
-      def initialize(params = {})
-        self.request_params = params
-      end
-
-      ##
-      # Base URL for a Search request
-      #
-      # @return [URI]
-      def request_url(_options = {})
-        api_url + '/search.json'
-      end
-
-      alias_method :execute, :execute_request
-
-      ##
-      # Examines the `success` and `error` fields of the response for failure
-      #
-      # @raise [Europeana::Errors::RequestError] if API response has
-      #   `success:false`
-      # @see Requestable#parse_response
-      def parse_response(response, _options = {})
-        super.tap do |body|
-          unless body[:success]
-            klass = if body.key?(:error) && body[:error] =~ /1000 search results/
-                      Errors::Request::PaginationError
-                    else
-                      Errors::RequestError
-                    end
-            fail klass, (body.key?(:error) ? body[:error] : response.code)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/europeana/api/search/fields.rb

@@ -1,112 +0,0 @@
-module Europeana
-  module API
-    class Search
-      ##
-      # API field information and validation in search context
-      #
-      # @see http://labs.europeana.eu/api/data-fields/
-      module Fields
-        EDM_PROVIDED_CHO = %w(edm_europeana_proxy proxy_dc_contributor
-          proxy_dc_coverage proxy_dc_creator proxy_dc_date proxy_dc_description
-          proxy_dc_format proxy_dc_identifier proxy_dc_language
-          proxy_dc_publisher proxy_dc_relation proxy_dc_rights proxy_dc_source
-          proxy_dc_subject proxy_dc_title proxy_dc_type
-          proxy_dcterms_alternative proxy_dcterms_conformsTo
-          proxy_dcterms_created proxy_dcterms_extent proxy_dcterms_hasFormat
-          proxy_dcterms_hasPart proxy_dcterms_hasVersion
-          proxy_dcterms_isFormatOf proxy_dcterms_isPartOf
-          proxy_dcterms_isReferencedBy proxy_dcterms_isReplacedBy
-          proxy_dcterms_isRequiredBy proxy_dcterms_issued
-          proxy_dcterms_isVersionOf proxy_dcterms_medium
-          proxy_dcterms_provenance proxy_dcterms_references
-          proxy_dcterms_replaces proxy_dcterms_requires proxy_dcterms_spatial
-          proxy_dcterms_tableOfContents proxy_dcterms_temporal
-          proxy_edm_currentLocation proxy_edm_currentLocation_lat
-          proxy_edm_currentLocation_lon proxy_edm_hasMet proxy_edm_hasType
-          proxy_edm_incorporates proxy_edm_isDerivativeOf
-          proxy_edm_isNextInSequence proxy_edm_isRelatedTo
-          proxy_edm_isRepresentationOf proxy_edm_isSimilarTo
-          proxy_edm_isSuccessorOf proxy_edm_realizes proxy_edm_type
-          proxy_edm_unstored proxy_edm_wasPresentAt proxy_owl_sameAs
-          proxy_edm_rights proxy_edm_userTags proxy_edm_year proxy_ore_proxy
-          proxy_ore_proxyFor proxy_ore_proxyIn)
-
-        ORE_AGGREGATION = %w(provider_aggregation_ore_aggregation
-          provider_aggregation_ore_aggregates
-          provider_aggregation_edm_aggregatedCHO
-          provider_aggregation_edm_dataProvider
-          provider_aggregation_edm_hasView provider_aggregation_edm_isShownAt
-          provider_aggregation_edm_isShownBy provider_aggregation_edm_object
-          provider_aggregation_edm_provider provider_aggregation_dc_rights
-          provider_aggregation_edm_rights edm_UGC
-          provider_aggregation_edm_unstored edm_previewNoDistribute)
-
-        EDM_EUROPEANA_AGGREGATION = %w(edm_europeana_aggregation
-          europeana_aggregation_dc_creator europeana_aggregation_edm_country
-          europeana_aggregation_edm_hasView europeana_aggregation_edm_isShownBy
-          europeana_aggregation_edm_landingPage
-          europeana_aggregation_edm_language europeana_aggregation_edm_rights
-          europeana_aggregation_ore_aggregatedCHO
-          europeana_aggregation_ore_aggregates)
-
-        EDM_WEB_RESOURCE = %w(edm_webResource wr_dc_description wr_dc_format
-          wr_dc_rights wr_dc_source wr_dcterms_conformsTo wr_dcterms_created
-          wr_dcterms_extent wr_dcterms_hasPart wr_dcterms_isFormatOf
-          wr_dcterms_issued wr_edm_isNextInSequence wr_edm_rights)
-
-        EDM_AGENT = %w(edm_agent ag_skos_prefLabel ag_skos_altLabel
-          ag_skos_hiddenLabel ag_skos_note ag_dc_date ag_dc_identifier
-          ag_edm_begin ag_edm_end ag_edm_hasMet ag_edm_isRelatedTo
-          ag_edm_wasPresentAt ag_foaf_name ag_rdagr2_biographicalInformation
-          ag_rdagr2_dateOfBirth ag_rdagr2_dateOfDeath
-          ag_rdagr2_dateOfEstablishment ag_rdagr2_dateOfTermination
-          ag_rdagr2_gender ag_rdagr2_professionOrOccupation ag_owl_sameAs)
-
-        SKOS_CONCEPT = %w(skos_concept cc_skos_prefLabel cc_skos_altLabel
-          cc_skos_hiddenLabel cc_skos_broader cc_skos_broaderLabel
-          cc_skos_narrower cc_skos_related cc_skos_broadMatch
-          cc_skos_narrowMatch cc_skos_relatedMatch cc_skos_exactMatch
-          cc_skos_closeMatch cc_skos_note cc_skos_notation cc_skos_inScheme)
-
-        EDM_PLACE = %w(edm_place pl_wgs84_pos_lat pl_wgs84_pos_long
-          pl_wgs84_pos_alt pl_wgs84_pos_lat_long pl_skos_prefLabel
-          pl_skos_altLabel pl_skos_hiddenLabel pl_skos_note pl_dcterms_hasPart
-          pl_dcterms_isPartOf pl_owl_sameAs pl_dcterms_isPartOf_label)
-
-        EDM_TIME_SPAN = %w(edm_timespan ts_skos_prefLabel ts_skos_altLabel
-          ts_skos_hiddenLabel ts_skos_note ts_dcterms_hasPart
-          ts_dcterms_isPartOf ts_edm_begin ts_edm_end ts_owl_sameAs
-          ts_dcterms_isPartOf_label)
-
-        NON_EDM = %w(europeana_completeness europeana_previewNoDistribute
-          timestamp europeana_id identifier europeana_collectionName)
-
-        AGGREGATED = %w(country date description format language location
-          publisher relation rights source subject text title what when where
-          who)
-
-        FACETS = %w(COMPLETENESS CONTRIBUTOR COUNTRY DATA_PROVIDER LANGUAGE
-          LOCATION PROVIDER RIGHTS SUBJECT TYPE UGC USERTAGS YEAR)
-
-        AGGREGATED_FACETS = %w(DEFAULT)
-
-        MEDIA = %w(COLOURPALETTE IMAGE_ASPECTRATIO IMAGE_COLOR IMAGE_COLOUR
-                   IMAGE_GRAYSCALE IMAGE_GREYSCALE IMAGE_SIZE MEDIA MIME_TYPE
-                   SOUND_DURATION SOUND_HQ TEXT_FULLTEXT VIDEO_DURATION VIDEO_HD)
-
-        ##
-        # Tests whether the given field name is valid in the API search context
-        #
-        # @param name [String] field name
-        # @return [Boolean]
-        def self.include?(name)
-          constants.any? do |scope|
-            const_get(scope).any? do |field|
-              field == name
-            end
-          end
-        end
-      end
-    end
-  end
-end