parliament-opensearch 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b23156551353cbfe6be82648b354761bbbce30fb
-  data.tar.gz: f236613bf33beee7deb6f2fecff00f6659e547f8
+  metadata.gz: 89764f0e23de18af2c597be14a52198dc7011e16
+  data.tar.gz: 95f44a316c601778ad1fd466757b2b9b5deec1ce
 SHA512:
-  metadata.gz: 9ab2fea386df769c812c429a1157e7ff8522277f41a2ee3508b0986795d24eead0ba7db7e2c39ff809e032259d148dad10ae0b916499f840d9703d20a0b2886f
-  data.tar.gz: 53f36a86528539c02a9ca4be4b2141ebf1d8965f3c22474ecaab708c257ab0f99b9d5b8545965c9bae5d8d56a65ad60f1ad4e199e587dce31e61f67a359a0b4d
+  metadata.gz: d9d48aa35039abcee3cef6731d79af106f020b306098f11e01bca5bec6e49f16aecf7415d65613ce680dfa944b2f8a467a4236fe788aac86a51f67ace2d2c1df
+  data.tar.gz: acb15d5c8218eb7fd4d817f9dfe01683c734b3fff359b6c7cea1a59723d08e219bd3e617152d9ce69252c8f7b96ac67ca4b3ec94641d8f29c682b8f14f8dadc4

data/lib/parliament/open_search.rb

@@ -3,6 +3,7 @@ require 'rexml/document'
 require 'parliament'
 
 require 'parliament/open_search/version'
+require 'parliament/open_search/description_error'
 require 'parliament/request/open_search_request'
 require 'parliament/builder/open_search_response_builder'
 

data/lib/parliament/open_search/description_error.rb

@@ -0,0 +1,18 @@
+module Parliament
+  module OpenSearch
+    # An error raised when there is an issue processing an OpenSearch description file.
+    # This could be raised when the URL provided is invalid, or when we are unable to find a URL template for future requests.
+    #
+    # @attr_reader url the description url that caused the Parliament::OpenSearchDescriptionError.
+    #
+    # @since 0.2.3
+    class DescriptionError < StandardError
+      attr_reader :url
+
+      # @param [String] description_url the description url that caused the Parliament::OpenSearchDescriptionError.
+      def initialize(description_url)
+        @url = description_url
+      end
+    end
+  end
+end

data/lib/parliament/open_search/version.rb

@@ -1,5 +1,5 @@
 module Parliament
   module OpenSearch
-    VERSION = '0.2.2'.freeze
+    VERSION = '0.2.3'.freeze
   end
 end

data/lib/parliament/request/open_search_request.rb

@@ -15,16 +15,20 @@ module Parliament
 
       # Creates a new instance of Parliament::OpenSearch::Request.
       #
-      # An interesting note for #initialize is that setting base_url on the class, or using the environment variable
-      # OPENSEARCH_DESCRIPTION_URL means you don't need to pass in a base_url. You can pass one anyway to override the
-      # environment variable or class parameter.  Similarly, headers can be set by either settings the headers on the class, or passing headers in.
+      # An interesting note for #initialize is that setting description_url on the class means you don't need to pass in a description_url.
+      # You can pass one anyway to override the class parameter.  Similarly, headers can be set by either settings the headers on the class,
+      # or passing headers in.
       #
       # @see Parliament::BaseRequest#initialize
-      # @param [String] base_url the base url for the OpenSearch API description. (expected: http://example.com - without the trailing slash).
+      # @param [String] description_url the url for the OpenSearch API description file. (expected: http://example.com/description.xml - without the trailing slash).
       # @param [Hash] headers the headers being sent in the request.
       # @param [Parliament::OpenSearch::Builder] builder the builder required to create the response.
-      def initialize(base_url: nil, headers: nil, builder: nil)
-        @base_url = Parliament::Request::OpenSearchRequest.get_description(base_url) || self.class.base_url
+      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?
+
+        @base_url = Parliament::Request::OpenSearchRequest.get_description(@description_url) || self.class.base_url
         @open_search_parameters = self.class.open_search_parameters
 
         super(base_url: @base_url, headers: headers, builder: builder)
@@ -46,10 +50,11 @@ module Parliament
       # @attr [String] base_url the base url for the OpenSearch API description. (expected: http://example.com - without the trailing slash).
       # @attr [Hash] open_search_parameters the possible parameters to use in the query url.
       class << self
-        attr_reader :base_url, :open_search_parameters
+        attr_reader :description_url, :base_url
 
-        def base_url=(base_url)
-          @base_url = get_description(base_url)
+        def description_url=(description_url)
+          @description_url = description_url
+          @base_url = Parliament::Request::OpenSearchRequest.get_description(@description_url)
         end
 
         def open_search_parameters
@@ -59,12 +64,26 @@ module Parliament
         def get_description(url)
           return if url.nil?
 
+          begin
+            URI.parse(url)
+          rescue URI::InvalidURIError => e
+            raise Parliament::OpenSearch::DescriptionError.new(url), "Invalid description URI passed '#{url}': #{e.message}"
+          end
+
           request = Parliament::Request::BaseRequest.new(base_url: url,
                                                          headers: {'Accept' => 'application/opensearchdescription+xml'})
           xml_response = request.get
 
-          xml_root = REXML::Document.new(xml_response.body).root
-          xml_root.elements['Url'].attributes['template']
+          begin
+            xml_root = REXML::Document.new(xml_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?
+          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
         end
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parliament-opensearch
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Rebecca Appleyard
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-11 00:00:00.000000000 Z
+date: 2017-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: feedjira
@@ -165,6 +165,7 @@ files:
 - bin/setup
 - lib/parliament/builder/open_search_response_builder.rb
 - lib/parliament/open_search.rb
+- lib/parliament/open_search/description_error.rb
 - lib/parliament/open_search/version.rb
 - lib/parliament/request/open_search_request.rb
 - parliament-opensearch.gemspec