parliament-opensearch 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d49d1bbb5b87d8f73c34291fdfd5e3c90911a04e
-  data.tar.gz: 447fd872f92e50945605ee74a0cb258086a75b23
+  metadata.gz: 51c60a8ca7fca47e247c68f31f0bda226bc9d3e4
+  data.tar.gz: 640adba09ea47477410b8863ec803b264fd1fb2c
 SHA512:
-  metadata.gz: ebd0b3516e486030af48bf02f8fec009825ee295bb6e39768b079f2d64652f4dd4f8e2c5106e34b1fe4d479a32499e5ebdc231deb2e5844172085d9090baa7d6
-  data.tar.gz: 1e9b8ba24c639d2d682ff66bdbffce1698adbdd2c81920b1613ef7b516dc77d67504720ff62e7c4e21f34f0b614c3dd1bd1c46a106e05b3155c36405dafe269e
+  metadata.gz: 0d1fc9b1c473a8d0e24e1be7c76b36fb950a36d5d98d76deef044723a8e1c4bebebcb0c68e44d63977e986f42b393889e5281f62df11b50b9d80d5bc22c85aa5
+  data.tar.gz: df0940aff4ecdb2561df5881f94b390165bb9774fb608d88c3f727903186770032e3c760c56d58f752e9657c6b94449a3b0ec09495cb9a4d5b328a23e103c4b5

data/lib/parliament/builder/open_search_response_builder.rb

@@ -0,0 +1,21 @@
+require 'feedjira'
+
+module Parliament
+  module Builder
+    # OpenSearch response builder using Feedjira to parse the response.
+    #
+    # @since 0.1.0
+    class OpenSearchResponseBuilder < Parliament::Builder::BaseResponseBuilder
+      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
+        OPEN_SEARCH_ELEMENTS.each do |element|
+          Feedjira::Feed.add_common_feed_element(element)
+        end
+
+        Feedjira::Feed.parse(@response.body)
+      end
+    end
+  end
+end

data/lib/parliament/open_search/version.rb

@@ -1,5 +1,5 @@
 module Parliament
   module OpenSearch
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

data/lib/parliament/open_search.rb

@@ -1,8 +1,8 @@
 require 'parliament'
 
 require 'parliament/open_search/version'
-require 'parliament/open_search/builder'
-require 'parliament/open_search/request'
+require 'parliament/request/open_search_request'
+require 'parliament/builder/open_search_response_builder'
 
 # Namespace for classes and modules that handle connections to, and processing of data from OpenSearch APIs.
 # @since 0.1.0

data/lib/parliament/request/open_search_request.rb

@@ -0,0 +1,93 @@
+module Parliament
+  module Request
+    # API request object, allowing the user to build a request to an OpenSearch API and build a response.
+    #
+    # @since 0.1.0
+    class OpenSearchRequest < Parliament::Request::BaseRequest
+      OPEN_SEARCH_PARAMETERS = {
+          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.
+      #
+      # 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.
+      #
+      # @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 [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 || ENV['OPENSEARCH_DESCRIPTION_URL']
+        @open_search_parameters = self.class.open_search_parameters
+
+        super(base_url: @base_url, 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 [Hash] params any extra parameters.
+      def get(search_params, params: nil)
+        setup_query_url(search_params)
+
+        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 [Hash] open_search_parameters the possible parameters to use in the query url.
+      class << self
+        attr_reader :base_url, :open_search_parameters
+
+        def base_url=(base_url)
+          @base_url = get_description(base_url)
+        end
+
+        def open_search_parameters
+          OPEN_SEARCH_PARAMETERS.dup
+        end
+
+        def get_description(url)
+          return if url.nil?
+
+          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']
+        end
+      end
+
+      def query_url
+        @query_url
+      end
+
+      def setup_query_url(search_params)
+        search_terms = search_params[:query]
+        query_url = @base_url.dup
+        query_url.gsub!('{searchTerms}', search_terms)
+
+        @open_search_parameters.each do |key, value|
+          camel_case_key = ActiveSupport::Inflector.camelize(key.to_s, false)
+          if search_params.keys.include?(key)
+            query_url.gsub!("{#{camel_case_key}?}", search_params[key].to_s)
+          else
+            query_url.gsub!("{#{camel_case_key}?}", value.to_s)
+          end
+        end
+
+        @query_url = query_url
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parliament-opensearch
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Rebecca Appleyard
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-07 00:00:00.000000000 Z
+date: 2017-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: feedjira
@@ -161,12 +161,10 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/parliament/builder/open_search_response_builder.rb
 - lib/parliament/open_search.rb
-- lib/parliament/open_search/builder.rb
-- lib/parliament/open_search/builder/open_search_response_builder.rb
-- lib/parliament/open_search/request.rb
-- lib/parliament/open_search/request/open_search_request.rb
 - lib/parliament/open_search/version.rb
+- lib/parliament/request/open_search_request.rb
 - parliament-opensearch.gemspec
 homepage: http://github.com/ukparliament/parliament_opensearch
 licenses: []
@@ -187,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Parliamentary OpenSearch response builder

data/lib/parliament/open_search/builder/open_search_response_builder.rb

@@ -1,23 +0,0 @@
-require 'feedjira'
-
-module Parliament
-  module OpenSearch
-    module Builder
-      # OpenSearch response builder using Feedjira to parse the response.
-      #
-      # @since 0.1.0
-      class OpenSearchResponseBuilder < Parliament::Builder::BaseResponseBuilder
-        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
-          OPEN_SEARCH_ELEMENTS.each do |element|
-            Feedjira::Feed.add_common_feed_element(element)
-          end
-
-          Feedjira::Feed.parse(@response.body)
-        end
-      end
-    end
-  end
-end

data/lib/parliament/open_search/builder.rb

@@ -1,11 +0,0 @@
-require 'parliament/open_search/builder/open_search_response_builder'
-
-# Namespace for classes and modules that processes data from OpenSearch APIs.
-# @since 0.1.0
-module Parliament
-  module OpenSearch
-    module Builder
-      # Currently just a namespace definition
-    end
-  end
-end

data/lib/parliament/open_search/request/open_search_request.rb

@@ -1,95 +0,0 @@
-module Parliament
-  module OpenSearch
-    module Request
-      # API request object, allowing the user to build a request to an OpenSearch API and build a response.
-      #
-      # @since 0.1.0
-      class OpenSearchRequest < Parliament::Request::BaseRequest
-        OPEN_SEARCH_PARAMETERS = {
-            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.
-        #
-        # 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.
-        #
-        # @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 [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 || ENV['OPENSEARCH_DESCRIPTION_URL']
-          @open_search_parameters = self.class.open_search_parameters
-
-          super(base_url: @base_url, 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 [Hash] params any extra parameters.
-        def get(search_params, params: nil)
-          setup_query_url(search_params)
-
-          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 [Hash] open_search_parameters the possible parameters to use in the query url.
-        class << self
-          attr_reader :base_url, :open_search_parameters
-
-          def base_url=(base_url)
-            @base_url = get_description(base_url)
-          end
-
-          def open_search_parameters
-            OPEN_SEARCH_PARAMETERS.dup
-          end
-
-          def get_description(url)
-            return if url.nil?
-
-            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']
-          end
-        end
-
-        def query_url
-          @query_url
-        end
-
-        def setup_query_url(search_params)
-          search_terms = search_params[:query]
-          query_url = @base_url.dup
-          query_url.gsub!('{searchTerms}', search_terms)
-
-          @open_search_parameters.each do |key, value|
-            camel_case_key = ActiveSupport::Inflector.camelize(key.to_s, false)
-            if search_params.keys.include?(key)
-              query_url.gsub!("{#{camel_case_key}?}", search_params[key].to_s)
-            else
-              query_url.gsub!("{#{camel_case_key}?}", value.to_s)
-            end
-          end
-
-          @query_url = query_url
-        end
-      end
-    end
-  end
-end

data/lib/parliament/open_search/request.rb

@@ -1,11 +0,0 @@
-require 'parliament/open_search/request/open_search_request'
-
-# Namespace for classes and modules that handle connections to OpenSearch APIs.
-# @since 0.1.0
-module Parliament
-  module OpenSearch
-    module Request
-      # Currently just a namespace definition
-    end
-  end
-end