ea-address_lookup 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b57bfc1eb09fcdd170481081f7c7c69cf9888564
+  data.tar.gz: e9805598175f36cc5d3454791932167ac6168579
+SHA512:
+  metadata.gz: 51a51be32e5af468c845fd839943324150ad69987d2d3d7a5f93f27d5ac89aa433f01afe7fd739c3536e550366e152f38059289fa2e018ea288974e599f1299c
+  data.tar.gz: ae2d01648bca7f2467b83a15634605741ba3b1febcfb33be823f6025059f6d765dd6d4bffa67f4325e4f601c0f6af8927db8266109dbf5e6e7db3b89f57a7bb8

data/.codeclimate.yml

@@ -0,0 +1,21 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+  brakeman:
+    enabled: false
+  rubymotion:
+    enabled: true
+ratings:
+  paths:
+  - "**.module"
+  - "**.rb"
+exclude_paths:
+- spec/

data/.gitignore

@@ -0,0 +1,39 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/fixtures/results/*
+/tmp/
+
+# Ignore ruby_mine folder
+/.idea
+
+*~
+.DS_Store
+.svn
+.*.swp
+___*
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all logfiles and tempfiles.
+/log/*
+!/log/.keep
+
+# Overcommit configuration files (added by before_commit)
+.overcommit*
+.git-hooks/
+.rubocop.yml
+.htmlhintrc
+
+# Ignore developer specific .rspec files
+.rspec-local
+
+./ea-address_lookup*.gem
+
+.byebug_history

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.simplecov

@@ -0,0 +1,9 @@
+SimpleCov.start "rails" do
+  # any custom configs like groups and filters can be here at a central place
+
+  # The enrollment builder controller is just used to create dummy records when
+  # working in development as a time saver. We are happy there is no test coverage
+  # for it.
+  add_filter "lib/ea/address_lookup/version.rb"
+  add_filter "lib/ea/address_lookup/adapters/locate_api.rb" # demo class
+end

data/.travis.yml

@@ -0,0 +1,47 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 2.3.1
+
+before_install:
+  - gem install bundler -v 1.11.2
+
+bundler_args: --binstubs=./bundler_stubs
+
+before_script:
+
+script:
+  - bundle exec rake --trace before_commit:run_without_checks
+  - git config --global user.email test@example.com # overcommit Author
+  - git config --global user.name "Test Example" # overcommit Author
+  - BUNDLE_GEMFILE=.overcommit_gems.rb bundle exec overcommit --run
+  - bundle exec rspec
+
+# Have this option to stop travis-ci building twice. Currently we have travis set to build both
+# PR's and pushes. However this means when we push to a PR we have to wait for Travis to finish
+# 2 builds. If we unticked 'pushes' when the PR was finally merged that would not be built. The
+# brute force approach would be to untick build PR's and just build all pushes. We instead have
+# gone with the approach outlined here http://stackoverflow.com/a/31882307
+branches:
+  only:
+    - master
+
+# This section was added as per https://docs.travis-ci.com/user/code-climate/
+# To protect our codeclimate stats rather than adding the Codeclimate API key for ea-area_lookup
+# in the open we used this guide https://docs.travis-ci.com/user/encryption-keys/ to encryt the
+# value. Essentially install travis gem, then run `travis encrypt <my_code_climate_api_key>`
+addons:
+  code_climate:
+    repo_token:
+      secure: "NHoT4H5wYUhdGoByjcnViaLzHFkxKgSgZPCNtWtaCdrWXUwX8VLYYl6NPqvANMII0z81Fq8P0+Nzo0o0YfWAvXsimsuhXd4hdzMSKW+xp6G5KRmCaU8FfIjqGhf0yYs3jmTD6Bz2rv1uhZ080k39OXBE/pGR3pkd229lVxrVR91zYYnERqNGD7p78NDGCTPlyoYYNB+wMLq76p6Hl2dSZgwMQtDS/Qi95vG+3Zq2y3z+iarlXSxm2xqfYMgUTcoO3w1eL2P/I+y/SqKgqKEpNKTzicFySUUg5NEvQy/GQit6iArkemU3q364fp4RqkUzauDenEsE64Q6MNY/n7Pj+ZVUKvT3mFKr2OAQojrJko2vtM7QuxBKmaRvkA89JRJvXDTREqbB1gY9pmnAbxBQbRW25KRSucKRPIGhK+gfwjM01eINveR86KECyTOLkrVcWFihrXzrIxLzv37UQUh9UVE/+aca0QVivYa6jJOebPKeLxS3sPLco8clv4A1H7HfvAkzg9lzWC6cz/cSOmQWWvAcDsd+riMaq188fCGuPhHcGywzwH4qt/75b8vnOoOSZSxqNAvQfsf0np0V+N2ahiGqpBhTgPKD3B+Mhff2KN0WY0eejzUMdPdi6zNcjJySyvLBZ9Jrmb+Vf/X1DhEqg05n/V2lQCWzoeJw4zSyRyU="
+
+deploy:
+  provider: rubygems
+  api_key:
+    secure: "HPERtzREWDTHbl0EKL9E6J5SKEdKhcbvhgAEgDJ7h0TERiPmmhzXEMN8wFUz3xFx4JVn+cNYdnqmRaJ6KJQKUsC7aNwKkwBM220/xIUYksBzbcqQ7YODSnkLknc7uDNXWlny+oqY/KWqdcfsHr+CJImbLg0XIZEm4EH28f6vQctfKyjov2IhML8JFcnzWvjP1NHw03MZf1CDlDdh84hl0gv+lPe6lWtvKZarRqJIaP7Tzq+x/PcO0vdZfe37gmKNxxswPDmLbjPmjJEts5qO+9QcidBi/lXrTxGuXBGzXxcOmqlsr7SZVyPWAHOs9Lc/eB/iNJBQ5X5JSS2FgSmNrvh8w9WcNNZN7Ng398zEsqJTDVmPjCmkYMxvcpoB/6XBiPjmhji3kWqHicP0u1FkWFlTlaZk0wCjoPAuDiAJI8V0fzEc/73S3t+sP8igiNgw8qq2JegvRaVAvYdbmovWASaMb8x64BLpEGv5VVIe+ML5w99Y33mWPO8bOz99ZBFNG5pDJerM6mHB+hrVh+YC7UAb0yS/yn90Id02fQlt6Uxn/rSKuuRX096ha1oexYUaIKzjOGD0ReuKs33JpoqzPPjz7mu0+ncQClZtQyEBPgFrS5AqIauSxMzC+UsRrZ5M8cz9dZ3QrxHuhWoDLjVtAIqJq0eE0LbJaknvwphvtSA="
+  gem: ea-address_lookup
+  on:
+    tags: true
+    repo: EnvironmentAgency/ea-address_lookup
+    all_branches: true

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+ruby "2.3.1"
+
+# Specify your gem's dependencies in *.gemspec
+gemspec
+
+# Required to enable codeclimate's test coverage functionality
+gem "codeclimate-test-reporter", group: :test, require: nil

data/LICENSE

@@ -0,0 +1,8 @@
+The Open Government Licence (OGL) Version 3
+
+Copyright (c) 2014 Environment Agency
+
+This source code is licensed under the Open Government Licence v3.0. To view this
+licence, visit www.nationalarchives.gov.uk/doc/open-government-licence/version/3
+or write to the Information Policy Team, The National Archives, Kew, Richmond,
+Surrey, TW9 4DU.

data/README.md

@@ -0,0 +1,93 @@
+# EA::AddressLookup
+
+[![Build Status](https://travis-ci.org/EnvironmentAgency/ea-address_lookup.svg?branch=master)](https://travis-ci.org/EnvironmentAgency/ea-address_lookup)
+[![Code Climate](https://codeclimate.com/github/EnvironmentAgency/ea-address_lookup/badges/gpa.svg)](https://codeclimate.com/github/EnvironmentAgency/ea-address_lookup)
+[![Test Coverage](https://codeclimate.com/github/EnvironmentAgency/ea-address_lookup/badges/coverage.svg)](https://codeclimate.com/github/EnvironmentAgency/ea-address_lookup/coverage)
+
+This ruby gem provides address lookup functionality by postcode.
+
+## Installation
+
+Add the gem to your Gemfile
+
+```ruby
+gem 'ea-address_lookup'
+```
+
+Then execute:
+
+```bash
+bundle install
+```
+
+## Usage
+
+### Rails
+
+Create an intializer eg `config/initializers/address_lookup.rb`
+
+```ruby
+EA::AddressLookup.configure do |config|
+  config.address_facade_server = <some_host_name>
+  config.address_facade_port = ""
+  config.address_facade_url = "/address-service/v1/addresses/""
+  config.address_facade_client_id = <client_id>
+  config.address_facade_key = <key>
+end
+```
+
+Now you can do the following:
+
+```ruby
+EA::AddressLookup.adapter = :address_facade # optional as its the default
+hash = EA::AddressLookup.find_by_postcode('BA1 5AH')
+hash = EA::AddressLookup.find_by_uprn('12345678')
+```
+
+## Testing with RSpec
+A test helper is included that provides methods that will stub calls to
+EA::AddressLookup methods in RSpec tests. To enable them add this to
+the rspec configuration (for example, within a `RSpec.configure do |config|`
+block in a Rails app's `spec/rails_helper.rb`):
+
+```ruby
+config.include EA::AddressLookup::TestHelper::RspecMocks
+```
+
+This will make the methods defined in `lib/ea/address_lookup/test_helper/rspec_mocks.rb`
+available within the host app's rspec tests. For example:
+
+```ruby
+describe "postcode lookup" do
+  before do
+    mock_ea_address_lookup_find_by_postcode
+  end
+
+  it "some tests that use data returned by a postcode lookup" do
+    ....
+  end
+end
+```
+
+
+## Contributing to this project
+
+If you have an idea you'd like to contribute please log an issue.
+
+All contributions should be submitted via a pull request.
+
+## License
+
+THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:
+
+http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3
+
+The following attribution statement MUST be cited in your products and applications when using this information.
+
+>Contains public sector information licensed under the Open Government license v3
+
+### About the license
+
+The Open Government Licence (OGL) was developed by the Controller of Her Majesty's Stationery Office (HMSO) to enable information providers in the public sector to license the use and re-use of their information under a common open licence.
+
+It is designed to encourage use and re-use of information freely and flexibly, with only a few conditions.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'before_commit'
+spec = Gem::Specification.find_by_name 'before_commit'
+load "#{spec.gem_dir}/lib/tasks/before_commit.rake"
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "whereabouts"
+
+# 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

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/ea-address_lookup.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ea/address_lookup/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ea-address_lookup"
+  spec.version       = EA::AddressLookup::VERSION
+  spec.authors       = ["Digital Services Team, EnvironmentAgency"]
+  spec.email         = ["dst@environment-agency.gov.uk"]
+
+  spec.summary       = "Address lookup by postcode"
+  spec.description   = "Address lookup by postcode. Wraps calls to osplaces an api."
+  spec.homepage      = "https://github.com/EnvironmentAgency"
+  spec.license       = "The Open Government Licence (OGL) Version 3"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 4.2"
+  spec.add_dependency "rest-client", "~> 2.0.0.rc2"
+  spec.add_dependency "nesty", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "vcr", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 1.24"
+  spec.add_development_dependency "shoulda-matchers", "~> 3.1"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "before_commit"
+end

data/lib/ea/address_lookup.rb

@@ -0,0 +1,15 @@
+require "active_support/core_ext/string"
+require "ea/address_lookup/version"
+require "ea/address_lookup/configuration"
+require "ea/address_lookup/logger"
+require "ea/address_lookup/errors"
+require "ea/address_lookup/adapters"
+require "ea/address_lookup/finders"
+require "ea/address_lookup/test_helper/rspec_mocks"
+
+module EA
+  module AddressLookup
+    extend Adapters
+    extend Finders
+  end
+end

data/lib/ea/address_lookup/adapters.rb

@@ -0,0 +1,32 @@
+# The specific wrapper class for the address lookup API
+# is wired up using the Adapter patter. This allows us to present a common
+# interface to potentially varying address api interfaces.
+require "ea/address_lookup/adapters/address_facade"
+
+module EA
+  module AddressLookup
+    module Adapters
+      def adapter
+        @adapter ||= create_adapter(EA::AddressLookup.config.default_adapter)
+      end
+
+      def adapter=(adapter_name)
+        @adapter = create_adapter(adapter_name)
+      end
+
+      private
+
+      # Given an adpater_nam of e.g. :address_facade, return an instance of
+      # EA::AddressLookup::AddressLookup::Adapters::AddressFacade
+      def create_adapter(adapter_name)
+        raise MissingAdapterError if adapter_name.blank?
+
+        adapter_klass = adapter_name.to_s.classify.to_s
+        Adapters.const_get(adapter_klass).new
+
+      rescue NameError
+        raise UnrecognisedAdapterError, adapter_name
+      end
+    end
+  end
+end

data/lib/ea/address_lookup/adapters/address_facade.rb

@@ -0,0 +1,132 @@
+# Adaptor for EA AddressFacade :
+#
+# Relies on the following configuration options:
+#
+#   :address_facade_server
+#   :address_facade_port
+#   :address_facade_url
+#   :address_facade_client_id
+#   :address_facade_key
+#
+# Testing The Service
+#
+# The service is a simple rest service and can be tested using any browser
+# or the curl command from a Unix command line:
+#
+# ## Match By String
+#
+# N.B '\ char is ruby string continue - not part of the URL
+
+# curl http://servername:port/address-service/v1/addresses/find?\
+# client-id=example%20team&201&key=client1&query-string=buckingham%20palace
+#
+# ## Search Post Code
+#
+# curl http://servername:port/address-service/v1/addresses/postcode?\
+# client-id=example%20team&201&key=key1&postcode=bs1%205ah
+#
+# It also comes with a swagger interface, which can also visit via your locally
+# running server @ http://localhost:9002/swagger
+#
+require "rest_client"
+require "benchmark"
+
+module EA
+  module AddressLookup
+    module Adapters
+      class AddressFacade
+        attr_reader :base_url
+
+        def reset
+          @base_url = nil
+        end
+
+        def base_url
+          @base_url ||= begin
+            server = config.address_facade_server
+            port = config.address_facade_port
+            url = config.address_facade_url
+            host = "http://#{server}:#{port}"
+            URI.join(host, url || "").to_s
+          end
+        end
+
+        def find_by_uprn(uprn)
+          with_logging(:find_by_uprn, uprn) do
+            result = http_get(uprn)
+            parse_json(result)
+          end
+        end
+
+        def find_by_postcode(post_code)
+          with_logging(:find_by_postcode, post_code) do
+            result = http_get("postcode", postcode: post_code)
+            parse_json(result)
+          end
+        end
+
+        private
+
+        def default_query_params
+          {
+            'client-id': config.address_facade_client_id,
+            'key': config.address_facade_key
+          }
+        end
+
+        def config
+          EA::AddressLookup.config
+        end
+
+        def logger
+          EA::AddressLookup.logger
+        end
+
+        # The AddressBaseFacade is internal within AWS, so we need to
+        # ensure that we DO NOT use a proxy in http calls.
+        def http_get(path, query_params = {})
+          http_address = URI.join(base_url, path).to_s
+          args = build_request_args(http_address, query_params)
+          RestClient::Request.execute(args)
+        rescue => ex
+          raise ex if ex.class.to_s =~ /^VCR/
+          raise EA::AddressLookup::AddressServiceUnavailableError,
+                "#{http_address} "\
+                "params:#{default_query_params.merge(query_params)} - "\
+                "#{ex.message}"
+        end
+
+        def build_request_args(http_address, query_params)
+          {
+            method: :get,
+            url: http_address,
+            proxy: false,
+            timeout: config.timeout_in_seconds,
+            headers: {
+              params: default_query_params.merge(query_params)
+            }
+          }
+        end
+
+        def parse_json(json)
+          JSON.parse(json)
+        rescue => e
+          logger.error("Failed to parse JSON results "\
+                                         "#{e.message} #{json}")
+          {}
+        end
+
+        def with_logging(scope, arg)
+          parsed_result = nil
+          time = Benchmark.realtime do
+            parsed_result = yield
+          end
+          logger.info "#{scope}(#{arg}) took "\
+                                         "#{sprintf('%05.2fms', time * 1000)}"
+          logger.debug "#{scope}(#{arg}) #{parsed_result}"
+          parsed_result
+        end
+      end
+    end
+  end
+end

data/lib/ea/address_lookup/adapters/locate_api.rb

@@ -0,0 +1,25 @@
+#
+# Example of how me might define an Adaptor for
+# https://github.com/alphagov/locate-api
+#
+module EA
+  module AddressLookup
+    module Adapters
+      module LocateApi
+        module_function
+
+        def url
+          Rails.configuration.dcs_locate_api_url
+        end
+
+        def find_by_postcode(post_code)
+          result = RestClient::Request.execute(method: :get,
+                                               url: url,
+                                               proxy: false,
+                                               params: { postcode: post_code })
+          JSON.parse(result)
+        end
+      end
+    end
+  end
+end

data/lib/ea/address_lookup/configuration.rb

@@ -0,0 +1,28 @@
+require "active_support/configurable"
+
+module EA
+  module AddressLookup
+    class Configuration
+      include ActiveSupport::Configurable
+      config_accessor(:address_facade_server)
+      config_accessor(:address_facade_port)
+      config_accessor(:address_facade_url)
+      config_accessor(:address_facade_client_id)
+      config_accessor(:address_facade_key)
+      config_accessor(:timeout_in_seconds) { 5 }
+      config_accessor(:default_adapter) { :address_facade }
+    end
+
+    def self.config
+      @config ||= Configuration.new
+    end
+
+    def self.configure
+      yield config
+    end
+
+    def self.reset
+      @config = Configuration.new
+    end
+  end
+end

data/lib/ea/address_lookup/errors.rb

@@ -0,0 +1,15 @@
+require "nesty"
+
+module EA
+  module AddressLookup
+    class MissingAdapterError < StandardError
+      include Nesty::NestedError
+    end
+    class UnrecognisedAdapterError < StandardError
+      include Nesty::NestedError
+    end
+    class AddressServiceUnavailableError < StandardError
+      include Nesty::NestedError
+    end
+  end
+end

data/lib/ea/address_lookup/finders.rb

@@ -0,0 +1,15 @@
+require "ea/address_lookup/adapters/address_facade"
+
+module EA
+  module AddressLookup
+    module Finders
+      def find_by_postcode(post_code)
+        adapter.find_by_postcode(post_code)
+      end
+
+      def find_by_uprn(uprn)
+        adapter.find_by_uprn(uprn)
+      end
+    end
+  end
+end

data/lib/ea/address_lookup/logger.rb

@@ -0,0 +1,20 @@
+# A consumer can hook into logging like so:
+#  EA::AddressLookup.logger = Rails.logger
+# or to silence logging unless there are errors for example:
+#  EA::AddressLookup.logger.level = Logger::ERROR
+require "logger"
+
+module EA
+  module AddressLookup
+    class << self
+      attr_writer :logger
+
+      def logger
+        @logger ||= Logger.new($stdout).tap do |log|
+          log.progname = name
+          log.level = Logger::DEBUG
+        end
+      end
+    end
+  end
+end

data/lib/ea/address_lookup/test_helper/address_lookup.yml

@@ -0,0 +1,64 @@
+---
+uprn_lookup:
+  totalMatches: 1
+  startMatch: 1
+  endMatch: 1
+  uri_to_supplier: https://api.ordnancesurvey.co.uk/places/v1/addresses/uprn?uprn=10010175140&lr=EN&dataset=DPA
+  uri_from_client: stub
+  results:
+    - uprn: 340116
+      address: ENVIRONMENT AGENCY, HORIZON HOUSE, DEANERY ROAD, BRISTOL, BS1 5AH
+      organisation: ENVIRONMENT AGENCY
+      premises: HORIZON HOUSE
+      street_address: DEANERY ROAD
+      locality: SOMEWHERE
+      city: BRISTOL
+      postcode: BS1 5AH
+      x: 358205.03
+      y: 172708.07
+      coordinate_system: ""
+      state_date: 12/10/2009
+      blpu_state_code: ""
+      postal_address_code: ""
+      logical_status_code: ""
+      source_data_type: dpa
+
+postcode_lookup:
+  totalMatches: 2
+  startMatch: 1
+  endMatch: 2
+  uri_to_supplier: "https://api.ordnancesurvey.co.uk/places/v1/addresses/postcode?lr=EN&postcode=BS1%205AH&maxresults=100&dataset=DPA"
+  uri_from_client: stub
+  results:
+    - uprn: 340116
+      address: ENVIRONMENT AGENCY, HORIZON HOUSE, DEANERY ROAD, BRISTOL, BS1 5AH
+      organisation: ENVIRONMENT AGENCY
+      premises: HORIZON HOUSE
+      street_address: DEANERY ROAD
+      locality: ""
+      city: BRISTOL
+      postcode: BS1 5AH
+      x: 358205.03
+      y: 172708.07
+      coordinate_system: ""
+      state_date: 12/10/2009
+      blpu_state_code: ""
+      postal_address_code: ""
+      logical_status_code: ""
+      source_data_type: dpa
+    - uprn: 10091760640
+      address: HARMSEN GROUP, TRIODOS BANK, DEANERY ROAD, BRISTOL, BS1 5AH
+      organisation: HARMSEN GROUP
+      premises: TRIODOS BANK
+      street_address: DEANERY ROAD
+      locality: ""
+      city: BRISTOL
+      postcode: BS1 5AH
+      x: 358130.1
+      y: 172687.87
+      coordinate_system: ""
+      state_date: ""
+      blpu_state_code: ""
+      postal_address_code: ""
+      logical_status_code: ""
+      source_data_type: dpa

data/lib/ea/address_lookup/test_helper/mock_data.rb

@@ -0,0 +1,32 @@
+module EA
+  module AddressLookup
+    module TestHelper
+      class MockData
+
+        def initialize(file_name)
+          @file_name = file_name.to_s.strip
+        end
+
+        def data_for(key)
+          yaml[key.to_s]
+        end
+
+        private
+
+        def file_name
+          return @file_name if @file_name =~ /\.yml$/
+          "#{@file_name}.yml"
+        end
+
+        def path
+          File.expand_path file_name, File.dirname(__FILE__)
+        end
+
+        def yaml
+          @yaml ||= YAML.load_file path
+        end
+
+      end
+    end
+  end
+end

data/lib/ea/address_lookup/test_helper/rspec_mocks.rb

@@ -0,0 +1,41 @@
+require_relative "mock_data"
+module EA
+  module AddressLookup
+    module TestHelper
+      # Uses data from address_lookup.yml to mock calls to EA::AddressLookup methods
+      module RspecMocks
+
+        def mock_ea_address_lookup_find_by_uprn
+          allow(EA::AddressLookup)
+            .to receive(:find_by_uprn)
+            .and_return(mock_data.data_for(:uprn_lookup))
+        end
+
+        def mock_failure_of_ea_address_lookup_find_by_uprn
+          allow(EA::AddressLookup)
+            .to receive(:find_by_uprn)
+            .and_raise(AddressServiceUnavailableError, "Whoops")
+        end
+
+        def mock_ea_address_lookup_find_by_postcode
+          allow(EA::AddressLookup)
+            .to receive(:find_by_postcode)
+            .and_return(mock_data.data_for(:postcode_lookup))
+        end
+
+        def mock_failure_of_ea_address_lookup_find_by_postcode
+          allow(EA::AddressLookup)
+            .to receive(:find_by_postcode)
+            .and_raise(AddressServiceUnavailableError, "Whoops")
+        end
+
+        private
+
+        def mock_data
+          @mock_data ||= MockData.new :address_lookup
+        end
+
+      end
+    end
+  end
+end

data/lib/ea/address_lookup/version.rb

@@ -0,0 +1,5 @@
+module EA
+  module AddressLookup
+    VERSION = "0.3.0".freeze
+  end
+end

metadata

@@ -0,0 +1,237 @@
+--- !ruby/object:Gem::Specification
+name: ea-address_lookup
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Digital Services Team, EnvironmentAgency
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0.rc2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0.rc2
+- !ruby/object:Gem::Dependency
+  name: nesty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: 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: '1.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: before_commit
+  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: Address lookup by postcode. Wraps calls to osplaces an api.
+email:
+- dst@environment-agency.gov.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".simplecov"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ea-address_lookup.gemspec
+- lib/ea/address_lookup.rb
+- lib/ea/address_lookup/adapters.rb
+- lib/ea/address_lookup/adapters/address_facade.rb
+- lib/ea/address_lookup/adapters/locate_api.rb
+- lib/ea/address_lookup/configuration.rb
+- lib/ea/address_lookup/errors.rb
+- lib/ea/address_lookup/finders.rb
+- lib/ea/address_lookup/logger.rb
+- lib/ea/address_lookup/test_helper/address_lookup.yml
+- lib/ea/address_lookup/test_helper/mock_data.rb
+- lib/ea/address_lookup/test_helper/rspec_mocks.rb
+- lib/ea/address_lookup/version.rb
+homepage: https://github.com/EnvironmentAgency
+licenses:
+- The Open Government Licence (OGL) Version 3
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Address lookup by postcode
+test_files: []