parliament-opensearch 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9cc1f42826fd6847a609290b7dcde216463f4a29
-  data.tar.gz: 9ca3acfff1f103c9f622b018d3e7be5fc6e1b217
+  metadata.gz: 112097c40a5e35ada1bb98ad15fdfc7c3fadbb5c
+  data.tar.gz: 4926ff9614056c0541fc9bb937576abe2e9966d2
 SHA512:
-  metadata.gz: abb4f499efbe83adaa61df55ed69178c40b0edb4f1b75980234da290ca2c8112628ede01a7f70b6b41e062af8b01c2df731c1f88433f0897a6ca5f2e9d055898
-  data.tar.gz: a2aa4643437795e51d03f095f739ea28c55cbdd6a4ce87081540d58af4972266413655aa7fb4d8ccfc729a32cc70b2a0927206042010927d2c14a415df43eb68
+  metadata.gz: c3dc002e7c6c966cd48f8901db83e6a2aec9b2f7b475c9043c77f07d1fa401ee51784d2e38c5a9698e915622fb3843dc0dfb087296b678c31a1bf030117edab9
+  data.tar.gz: bf2700d0847e84b52c24caa645b2bb2d30fd51c7f880de7e22b261123e1ab4e34a923e08c558d9955e62c1135969c5eddcddd301515751e4eff9f7fee3e405be

data/lib/parliament/builder/open_search_response_builder.rb

@@ -4,7 +4,7 @@ module Parliament
     #
     # @since 0.1.0
     class OpenSearchResponseBuilder < Parliament::Builder::BaseResponseBuilder
-      OPEN_SEARCH_ELEMENTS = %w(totalResults Query startIndex itemsPerPage).freeze
+      OPEN_SEARCH_ELEMENTS = %w[totalResults Query startIndex itemsPerPage].freeze
 
       # Builds a Feedjira::Feed response.  It adds the extra OpenSearch feed elements, then parses the HTTP Response.
       def build

data/lib/parliament/open_search.rb

@@ -60,6 +60,7 @@ module Parliament
       def register_opensearch
         require 'parliament/open_search/version'
         require 'parliament/open_search/description_error'
+        require 'parliament/open_search/description_cache'
       end
 
       def register_opensearch_request

data/lib/parliament/open_search/description_cache.rb

@@ -0,0 +1,98 @@
+module Parliament
+  module OpenSearch
+    # A module used to download, cache and serve description files for our OpenSearch requests.
+    # @since 0.1
+    module DescriptionCache
+      DESCRIPTION_CACHE_TIME = 600 # 10 minutes
+
+      class << self
+        # Given a description uri, either download the file or serve it from our cache
+        #
+        # @param [String] uri the uri of our description file
+        # @return [String] our description file
+        def fetch(uri)
+          store
+
+          if cache_valid?(store[uri])
+            templates = @store[uri][:templates]
+          else
+            templates = download_description_templates(uri)
+
+            @store[uri] = { timestamp: Time.now, templates: templates }
+          end
+
+          templates
+        end
+
+        # Given a uri, remove the description from our store.
+        #
+        # @param [String] uri the uri of our description
+        # @return [nil|Hash] returns nil if the description was not in the store,
+        #   or a Hash representing the deleted description's entry
+        def delete(uri)
+          store
+
+          @store.delete(uri)
+        end
+
+        # Returns a copy of our description store
+        #
+        # @return [Hash] returns our description store
+        def store
+          @store ||= {}
+        end
+
+        private
+
+        # Given a description entry from our store, tell us if the cache is still valid
+        #
+        # @param [Hash] description_entry the entry we are checking
+        # @return [Boolean] is the description cache valid?
+        def cache_valid?(description_entry)
+          return false if description_entry.nil?
+
+          (Time.now <= (description_entry[:timestamp] + DESCRIPTION_CACHE_TIME))
+        end
+
+        # Given a description uri, download it and return the certificate data
+        #
+        # @param [String] uri the uri of our certificates
+        # @return [String] certificate data
+        def download_description_templates(uri)
+          return if uri.nil?
+
+          begin
+            url = URI.parse(uri)
+          rescue URI::InvalidURIError => e
+            raise Parliament::OpenSearch::DescriptionError.new(uri), "Invalid description URI passed '#{uri}': #{e.message}"
+          end
+
+          headers = {
+              'Accept'                    => 'application/opensearchdescription+xml',
+              'Ocp-Apim-Subscription-Key' => ENV['OPENSEARCH_AUTH_TOKEN']
+          }
+          headers['Request-Id'] = "#{ENV['ApplicationInsights.request.id']}description-#{store.keys.length + 1}" if ENV['ApplicationInsights.request.id']
+          request = Parliament::Request::BaseRequest.new(base_url: uri,
+                                                         headers:  headers)
+          xml_response = request.get
+
+          begin
+            xml_root = REXML::Document.new(xml_response.response.body).root
+            templates = []
+            xml_root.elements.each('Url') do |url|
+              type = url.attributes['type']
+              template = url.attributes['template']
+              templates << { 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.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
+
+          templates
+        end
+      end
+    end
+  end
+end

data/lib/parliament/open_search/version.rb

@@ -1,5 +1,5 @@
 module Parliament
   module OpenSearch
-    VERSION = '0.4.1'.freeze
+    VERSION = '0.5.0'.freeze
   end
 end

data/lib/parliament/request/open_search_request.rb

@@ -5,7 +5,7 @@ module Parliament
     # @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
+      attr_reader :templates, :description_url
 
       OPEN_SEARCH_PARAMETERS = {
         count:           10,
@@ -27,11 +27,11 @@ module Parliament
       # @param [Hash] headers the headers being sent in the request.
       # @param [Parliament::OpenSearch::Builder] builder the builder required to create the response.
       def initialize(description_url: nil, headers: nil, builder: nil)
-        @description_url = description_url
+        @description_url = description_url ||= self.class.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.templates.nil?
 
-        @templates = Parliament::Request::OpenSearchRequest.get_description(@description_url) || self.class.templates
+        @templates = Parliament::OpenSearch::DescriptionCache.fetch(@description_url)
         @open_search_parameters = self.class.open_search_parameters
 
         super(base_url: nil, headers: headers, builder: builder)
@@ -49,8 +49,6 @@ module Parliament
         super(params: params)
       end
 
-      private
-
       # @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
@@ -58,56 +56,23 @@ module Parliament
 
         def description_url=(description_url)
           @description_url = description_url
-          @templates = Parliament::Request::OpenSearchRequest.get_description(@description_url)
+          @templates = Parliament::OpenSearch::DescriptionCache.fetch(@description_url)
         end
 
         def open_search_parameters
           OPEN_SEARCH_PARAMETERS.dup
         end
-
-        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',
-                                                          'Ocp-Apim-Subscription-Key' => ENV['OPENSEARCH_AUTH_TOKEN']
-                                                         })
-          xml_response = request.get
-
-          begin
-            xml_root = REXML::Document.new(xml_response.response.body).root
-            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
-
-          templates
-        end
       end
 
-      def query_url
-        @query_url
-      end
+      private
+
+      attr_reader :query_url
 
       def setup_query_url(search_params, type = nil)
         search_terms = search_params[:query]
         type ||= 'application/atom+xml'
 
-        url_hash = @templates[:url].select { |url| url[:type] == type }.first
+        url_hash = @templates.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?
 

data/parliament-opensearch.gemspec

@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'vcr', '~> 3.0'
   spec.add_development_dependency 'webmock', '~> 2.3'
   spec.add_development_dependency 'parliament-ruby', '~> 0.7.4'
+  spec.add_development_dependency 'timecop'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parliament-opensearch
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Rebecca Appleyard
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-14 00:00:00.000000000 Z
+date: 2018-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: feedjira
@@ -157,6 +157,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.4
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 'Parliamentary OpenSearch response builder '
 email:
 - rklappleyard@gmail.com
@@ -180,6 +194,7 @@ files:
 - gocd/web1live.yaml
 - lib/parliament/builder/open_search_response_builder.rb
 - lib/parliament/open_search.rb
+- lib/parliament/open_search/description_cache.rb
 - lib/parliament/open_search/description_error.rb
 - lib/parliament/open_search/version.rb
 - lib/parliament/request/open_search_request.rb