parliament-opensearch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d49d1bbb5b87d8f73c34291fdfd5e3c90911a04e
+  data.tar.gz: 447fd872f92e50945605ee74a0cb258086a75b23
+SHA512:
+  metadata.gz: ebd0b3516e486030af48bf02f8fec009825ee295bb6e39768b079f2d64652f4dd4f8e2c5106e34b1fe4d479a32499e5ebdc231deb2e5844172085d9090baa7d6
+  data.tar.gz: 1e9b8ba24c639d2d682ff66bdbffce1698adbdd2c81920b1613ef7b516dc77d67504720ff62e7c4e21f34f0b614c3dd1bd1c46a106e05b3155c36405dafe269e

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+
+.idea
+
+# rspec failure tracking
+.rspec_status

data/.hound.yml

@@ -0,0 +1,4 @@
+ruby:
+  config_file: .rubocop.yml
+
+fail_on_violations: true

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,55 @@
+Metrics/LineLength:
+  Description: 'Limit lines to 120 characters.'
+  Max: 120
+  IgnoredPatterns: ['\A#', '\A([ ]{2}|[ ]{4})#']
+
+Style/SpaceBeforeFirstArg:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/AlignHash:
+  Severity: fatal
+  Enabled: true
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/CollectionMethods:
+  PreferredMethods:
+    collect: 'map'
+    collect!: 'map!'
+    inject: 'reduce'
+    detect: 'find'
+    find_all: 'select'
+
+Style/DotPosition:
+  EnforcedStyle: leading
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/SpaceAroundOperators:
+  # When true, allows most uses of extra spacing if the intent is to align
+  # with an operator on the previous or next line, not counting empty lines
+  # or comment lines.
+  AllowForAlignment: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+AllCops:
+  Exclude:
+    - '*.gemspec'
+    - 'vendor/**/*'
+    - 'spec/**/*'
+    - 'tmp/**/*'

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.3.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mattrayner1@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in parliament-open_search.gemspec
+gemspec
+
+# Include coveralls for CI coverage reports
+gem 'coveralls', require: false

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2016-2017 United Kingdom Parliament
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# Parliament::Opensearch
+[parliament-opensearch](http://github.com/ukparliament/opensearch) is a gem created by the [Parliamentary Digital Service](https://www.parliament.uk/mps-lords-and-offices/offices/bicameral/parliamentary-digital-service/) to allow connections to and the processing of data from OpenSearch APIs.
+
+> **NOTE:** This gem is in active development and is likely to change at short notice. It is not recommended that you use this in any production environment.
+
+## Requirements
+[parliament-opensearch](http://github.com/ukparliament/opensearch) requires the following:
+* [Ruby](https://www.ruby-lang.org/en/)
+* [Bundler](http://http://bundler.io/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+This gem is currently not available on RubyGems. To use it in an application, install it directly from GitHub via your Gemfile
+```bash
+gem 'parliament-opensearch', git: 'https://github.com/ukparliament/parliament-open-search.git', branch: 'master'
+```
+
+## Usage
+
+This gem's main function is fetching data from an OpenSearch API and parsing it.
+
+> **Note:** Comprehensive class documentation can be found on [rubydocs](http://www.rubydoc.info/github/ukparliament/parliament-opensearch/master/file/README.md).
+
+
+## Getting Started with Development
+To clone the repository and set up the dependencies, run the following:
+```bash
+git clone https://github.com/ukparliament/parliament-opensearch.git
+cd parliament-opensearch
+bundle install
+```
+
+### Running the tests
+We use [RSpec](http://rspec.info/) as our testing framework and tests can be run using:
+```bash
+bundle exec rake
+```
+
+## Contributing
+If you wish to submit a bug fix or feature, you can create a pull request and it will be merged pending a code review.
+
+1. Fork the repository
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin my-new-feature`)
+1. Ensure your changes are tested using [Rspec](http://rspec.info/)
+1. Create a new Pull Request
+
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

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

@@ -0,0 +1,23 @@
+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

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,95 @@
+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

@@ -0,0 +1,11 @@
+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

data/lib/parliament/open_search/version.rb

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

data/lib/parliament/open_search.rb

@@ -0,0 +1,13 @@
+require 'parliament'
+
+require 'parliament/open_search/version'
+require 'parliament/open_search/builder'
+require 'parliament/open_search/request'
+
+# Namespace for classes and modules that handle connections to, and processing of data from OpenSearch APIs.
+# @since 0.1.0
+module Parliament
+  module OpenSearch
+    # Currently just a namespace definition
+  end
+end

data/parliament-opensearch.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'parliament/open_search/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'parliament-opensearch'
+  spec.version       = Parliament::OpenSearch::VERSION
+  spec.authors       = ['Rebecca Appleyard']
+  spec.email         = ['rklappleyard@gmail.com']
+
+  spec.summary       = %q{Parliamentary OpenSearch response builder }
+  spec.description   = %q{Parliamentary OpenSearch response builder }
+  spec.homepage      = 'http://github.com/ukparliament/parliament_opensearch'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'feedjira', '~> 2.1', '>= 2.1.2'
+  spec.add_dependency 'parliament-ruby', '~> 0.7.2.pre'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.47'
+  spec.add_development_dependency 'simplecov', '~> 0.12'
+  spec.add_development_dependency 'vcr', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 2.3'
+end

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: parliament-opensearch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rebecca Appleyard
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: feedjira
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+- !ruby/object:Gem::Dependency
+  name: parliament-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2.pre
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2.pre
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: 'Parliamentary OpenSearch response builder '
+email:
+- rklappleyard@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- 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
+- parliament-opensearch.gemspec
+homepage: http://github.com/ukparliament/parliament_opensearch
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: Parliamentary OpenSearch response builder
+test_files: []