parliament-opensearch 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 624c7a0bb16dc5fbc8da124f2625425f5a7a9934
-  data.tar.gz: 7eb3e957efe50ea05bd723dd8f275eac526e9e4c
+  metadata.gz: d3ed8751eb8608de936ab34091f78c00647c9bde
+  data.tar.gz: 8987fa2c6ae21159f9288fbcdfd0779484d319d0
 SHA512:
-  metadata.gz: b579f51e21cc50a84bd9832170d68630068f97ec241a3db299510d5cc69acd407b8567078a15ae14d581bdcd13a969f8625c3d552887a73b08cd86c5ccb47296
-  data.tar.gz: 63240287a3b8746dadd1d9767fb80d013dd64240085640611703b3ae7f82f200868c0e4261cdc045fa1dff352bd6d37611876b215d342713928b3d51c3bae6bf
+  metadata.gz: 2f85f5127b033c6b23583c679858582d534b5ffe7a966bb38194d991fe04aa696bdb723b5c445db15b7210347208c5753723a115ea20c06117495e72c6ac3233
+  data.tar.gz: 7f05a0dc8c3f3d35115d15ac7e679e6853f7a9c221724e56204edf285168afc3232e70f8b8664056ab6d0139f6041a9f9be0380b529138c350a6c1346323da4d

data/Rakefile

@@ -3,4 +3,4 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "parliament/open_search"
+require 'bundler/setup'
+require 'parliament/open_search'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "parliament/open_search"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/parliament/open_search.rb

@@ -1,6 +1,6 @@
-# Namespace for classes and modules that handle connections to, and processing of data from OpenSearch APIs.
-# @since 0.1.0
 module Parliament
+  # Namespace for classes and modules that handle connections to, and processing of data from OpenSearch APIs.
+  # @since 0.1.0
   module OpenSearch
     # Currently just a namespace definition
     class << self

data/lib/parliament/open_search/version.rb

@@ -1,5 +1,5 @@
 module Parliament
   module OpenSearch
-    VERSION = '0.2.5'.freeze
+    VERSION = '0.2.6'.freeze
   end
 end

data/lib/parliament/request/open_search_request.rb

@@ -3,14 +3,17 @@ module Parliament
     # API request object, allowing the user to build a request to an OpenSearch API and build a response.
     #
     # @since 0.1.0
+    # attr [Hash] templates the different types and template urls set from the OpenSearch API description document.
     class OpenSearchRequest < Parliament::Request::BaseRequest
+      attr_reader :templates
+
       OPEN_SEARCH_PARAMETERS = {
-          count: 10,
-          start_index: 1,
-          start_page: 1,
-          language: '*',
-          output_encoding: 'UTF-8',
-          input_encoding: 'UTF-8'
+        count:           10,
+        start_index:     1,
+        start_page:      1,
+        language:        '*',
+        output_encoding: 'UTF-8',
+        input_encoding:  'UTF-8'
       }.freeze
 
       # Creates a new instance of Parliament::OpenSearch::Request.
@@ -26,35 +29,36 @@ module Parliament
       def initialize(description_url: nil, headers: nil, builder: nil)
         @description_url = description_url
 
-        raise Parliament::OpenSearch::DescriptionError.new(@description_url), 'No description URL passed to Parliament::OpenSearchRequest#new and, no Parliament::OpenSearchRequest#base_url value set. Without a description URL, we are unable to make any search requests.' if @description_url.nil? && self.class.base_url.nil?
+        raise Parliament::OpenSearch::DescriptionError.new(@description_url), 'No description URL passed to Parliament::OpenSearchRequest#new and, no Parliament::OpenSearchRequest#base_url value set. Without a description URL, we are unable to make any search requests.' if @description_url.nil? && self.class.templates.nil?
 
-        @base_url = Parliament::Request::OpenSearchRequest.get_description(@description_url) || self.class.base_url
+        @templates = Parliament::Request::OpenSearchRequest.get_description(@description_url) || self.class.templates
         @open_search_parameters = self.class.open_search_parameters
 
-        super(base_url: @base_url, headers: headers, builder: builder)
+        super(base_url: nil, headers: headers, builder: builder)
       end
 
       # Sets up the query url using the base_url and parameters, then make an HTTP GET request and process results.
       #
       # @see Parliament::BaseRequest#get
       # @params [Hash] search_params the search parameters to be passed to the OpenSearch API.  This is the search term and/or any of the keys from OPEN_SEARCH_PARAMETERS, depending on the parameters allowed in the API.
+      # @params [String] type the type of data requested, eg. 'application/atom+xml'.
       # @params [Hash] params any extra parameters.
-      def get(search_params, params: nil)
-        setup_query_url(search_params)
+      def get(search_params, type: nil, params: nil)
+        setup_query_url(search_params, type)
 
         super(params: params)
       end
 
       private
 
-      # @attr [String] base_url the base url for the OpenSearch API description. (expected: http://example.com - without the trailing slash).
+      # @attr [String] templates the different types and template urls set from the OpenSearch API description document.
       # @attr [Hash] open_search_parameters the possible parameters to use in the query url.
       class << self
-        attr_reader :description_url, :base_url
+        attr_reader :description_url, :templates
 
         def description_url=(description_url)
           @description_url = description_url
-          @base_url = Parliament::Request::OpenSearchRequest.get_description(@description_url)
+          @templates = Parliament::Request::OpenSearchRequest.get_description(@description_url)
         end
 
         def open_search_parameters
@@ -71,21 +75,27 @@ module Parliament
           end
 
           request = Parliament::Request::BaseRequest.new(base_url: url,
-                                                         headers: { 'Accept' => 'application/opensearchdescription+xml',
-                                                                    'Ocp-Apim-Subscription-Key' => ENV['OPENSEARCH_AUTH_TOKEN']
+                                                         headers:  {
+                                                          'Accept' => 'application/opensearchdescription+xml',
+                                                          'Ocp-Apim-Subscription-Key' => ENV['OPENSEARCH_AUTH_TOKEN']
                                                          })
           xml_response = request.get
 
           begin
             xml_root = REXML::Document.new(xml_response.response.body).root
-            template = xml_root.elements['Url'].attributes['template']
-
-            raise Parliament::OpenSearch::DescriptionError.new(url), "The document found does not contain a require node. Attempted to get a 'Url' element with the attribute 'template'. Please check the description document at '#{url}' and try again." if template.nil?
+            templates = { url: [] }
+            xml_root.elements.each('Url') do |url|
+              type = url.attributes['type']
+              template = url.attributes['template']
+              templates[:url] << { type: type, template: template }
+            end
+
+            raise Parliament::OpenSearch::DescriptionError.new(url), "The document found does not contain the required node. Attempted to get a 'Url' element with the attribute 'template'. Please check the description document at '#{url}' and try again." if templates[:url].empty?
           rescue NoMethodError
             raise Parliament::OpenSearch::DescriptionError.new(url), "The document found does not appear to be XML. Please check the description document at '#{url}' and try again."
           end
 
-          template
+          templates
         end
       end
 
@@ -93,9 +103,16 @@ module Parliament
         @query_url
       end
 
-      def setup_query_url(search_params)
+      def setup_query_url(search_params, type = nil)
         search_terms = search_params[:query]
-        query_url = @base_url.dup
+        type ||= 'application/atom+xml'
+
+        url_hash = @templates[:url].select { |url| url[:type] == type }.first
+
+        raise Parliament::OpenSearch::DescriptionError.new(type), "There is no url for the requested type '#{type}'." if url_hash.nil?
+
+        query_url = url_hash[:template].dup
+
         query_url.gsub!('{searchTerms}', search_terms)
 
         @open_search_parameters.each do |key, value|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parliament-opensearch
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Rebecca Appleyard
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-04 00:00:00.000000000 Z
+date: 2017-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: feedjira