defra_ruby_address 0.1.0 → 0.4.0

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: defra_ruby_address
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Defra
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-19 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -24,132 +23,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: defra_ruby_style
-  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: dotenv
-  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: github_changelog_generator
-  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: pry-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: rake
-  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: 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'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !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: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
 description: Provides a single source of functionality for querying Defra's various
   address lookup services.
 email:
@@ -167,42 +40,24 @@ files:
 - lib/defra_ruby/address.rb
 - lib/defra_ruby/address/configuration.rb
 - lib/defra_ruby/address/ea_address_facade_request.rb
+- lib/defra_ruby/address/helmert_transformation.rb
 - lib/defra_ruby/address/no_match_error.rb
 - lib/defra_ruby/address/response.rb
 - lib/defra_ruby/address/services/base_service.rb
 - lib/defra_ruby/address/services/ea_address_facade_v1_1_service.rb
 - lib/defra_ruby/address/services/ea_address_facade_v1_service.rb
+- lib/defra_ruby/address/services/easting_northing_to_lat_lon_service.rb
+- lib/defra_ruby/address/services/lat_lon_to_easting_northing_service.rb
+- lib/defra_ruby/address/services/os_api_address_lookup_v1_service.rb
 - lib/defra_ruby/address/services/os_places_address_lookup_service.rb
+- lib/defra_ruby/address/transverse_mercator_projection.rb
 - lib/defra_ruby/address/version.rb
-- spec/defra_ruby/address/configuration_spec.rb
-- spec/defra_ruby/address/response_spec.rb
-- spec/defra_ruby/address/services/ea_address_facade_v1_1_service_spec.rb
-- spec/defra_ruby/address/services/ea_address_facade_v1_service_spec.rb
-- spec/defra_ruby/address/services/os_places_address_lookup_service_spec.rb
-- spec/defra_ruby/address_spec.rb
-- spec/examples.txt
-- spec/fixtures/ea_address_facade_v1_1_blank.json
-- spec/fixtures/ea_address_facade_v1_1_not_found.json
-- spec/fixtures/ea_address_facade_v1_1_valid.json
-- spec/fixtures/ea_address_facade_v1_blank.json
-- spec/fixtures/ea_address_facade_v1_not_found.json
-- spec/fixtures/ea_address_facade_v1_valid.json
-- spec/fixtures/os_places_address_lookup_blank.json
-- spec/fixtures/os_places_address_lookup_not_found.json
-- spec/fixtures/os_places_address_lookup_valid.json
-- spec/spec_helper.rb
-- spec/support/defra_ruby_address.rb
-- spec/support/dotenv.rb
-- spec/support/pry.rb
-- spec/support/shared_examples/handle_request_errors.rb
-- spec/support/simplecov.rb
-- spec/support/webmock.rb
 homepage: https://github.com/DEFRA/defra-ruby-address
 licenses:
 - The Open Government Licence (OGL) Version 3
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -210,39 +65,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Defra ruby on rails address lookup gem
-test_files:
-- spec/spec_helper.rb
-- spec/defra_ruby/address/configuration_spec.rb
-- spec/defra_ruby/address/response_spec.rb
-- spec/defra_ruby/address/services/os_places_address_lookup_service_spec.rb
-- spec/defra_ruby/address/services/ea_address_facade_v1_service_spec.rb
-- spec/defra_ruby/address/services/ea_address_facade_v1_1_service_spec.rb
-- spec/defra_ruby/address_spec.rb
-- spec/examples.txt
-- spec/support/defra_ruby_address.rb
-- spec/support/simplecov.rb
-- spec/support/webmock.rb
-- spec/support/pry.rb
-- spec/support/dotenv.rb
-- spec/support/shared_examples/handle_request_errors.rb
-- spec/fixtures/ea_address_facade_v1_1_not_found.json
-- spec/fixtures/os_places_address_lookup_blank.json
-- spec/fixtures/ea_address_facade_v1_1_valid.json
-- spec/fixtures/ea_address_facade_v1_valid.json
-- spec/fixtures/ea_address_facade_v1_blank.json
-- spec/fixtures/ea_address_facade_v1_1_blank.json
-- spec/fixtures/os_places_address_lookup_valid.json
-- spec/fixtures/ea_address_facade_v1_not_found.json
-- spec/fixtures/os_places_address_lookup_not_found.json
+test_files: []

data/spec/defra_ruby/address/configuration_spec.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-module DefraRuby
-  module Address
-    RSpec.describe Configuration do
-      it "sets the appropriate default config settings" do
-        fresh_config = described_class.new
-
-        expect(fresh_config.timeout).to eq(3)
-        expect(fresh_config.host).to be_nil
-        expect(fresh_config.client_id).to eq(0)
-        expect(fresh_config.key).to eq("client1")
-      end
-    end
-  end
-end

data/spec/defra_ruby/address/response_spec.rb

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-module DefraRuby
-  module Address
-    RSpec.describe Response do
-      subject(:response) { described_class.new(response_exe) }
-
-      let(:successful) { -> { [{ "postcode" => "BS1 5AH" }] } }
-      let(:errored) { -> { raise "Boom!" } }
-
-      describe "#successful?" do
-        context "when the response throws an error" do
-          let(:response_exe) { errored }
-
-          it "returns false" do
-            expect(response).to_not be_successful
-          end
-        end
-
-        context "when the response doesn't throw an error" do
-          let(:response_exe) { successful }
-
-          it "returns true" do
-            expect(response).to be_successful
-          end
-        end
-      end
-
-      describe "#results" do
-        context "when the response throws an error" do
-          let(:response_exe) { errored }
-
-          it "returns an empty array" do
-            expect(response.results).to eq([])
-          end
-        end
-
-        context "when the response does not throw an error" do
-          let(:response_exe) { successful }
-
-          it "returns a JSON array" do
-            expect(response.results).to be_instance_of(Array)
-            expect(response.results[0]).to be_instance_of(Hash)
-            expect(response.results[0]["postcode"]).to eq("BS1 5AH")
-          end
-        end
-      end
-
-      describe "#error" do
-        context "when the response throws an error" do
-          let(:response_exe) { errored }
-
-          it "returns the error" do
-            expect(response.error).to be_a(StandardError)
-          end
-        end
-
-        context "when the response don't throw an error" do
-          let(:response_exe) { successful }
-
-          it "returns a nil object" do
-            expect(response.error).to be_nil
-          end
-        end
-      end
-    end
-  end
-end

data/spec/defra_ruby/address/services/ea_address_facade_v1_1_service_spec.rb

@@ -1,73 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-module DefraRuby
-  module Address
-    RSpec.describe EaAddressFacadeV11Service do
-      describe "#run" do
-        before do
-          DefraRuby::Address.configure { |c| c.host = "http://localhost:8005/" }
-          stub_request(:get, url).to_return(status: code, body: body)
-        end
-
-        let(:client_id) { DefraRuby::Address.configuration.client_id }
-        let(:key) { DefraRuby::Address.configuration.key }
-        let(:postcode) { "BS1 5AH" }
-        let(:url) { "http://localhost:8005/address-service/v1/addresses/postcode?client-id=#{client_id}&key=#{key}&query-string=#{postcode}" }
-        let(:code) { 200 }
-        let(:body) { File.read("spec/fixtures/ea_address_facade_v1_1_valid.json") }
-
-        include_examples "handle request errors"
-
-        context "when the postcode is valid" do
-
-          it "returns a successful response" do
-            response = described_class.run(postcode)
-
-            expect(a_request(:get, url)).to have_been_made.at_most_once
-
-            expect(response).to be_a(Response)
-            expect(response.successful?).to eq(true)
-            expect(response.results).not_to be_empty
-          end
-        end
-
-        context "when the postcode is invalid" do
-          context "because it is not found" do
-            let(:postcode) { "BS1 9XX" }
-            let(:body) { File.read("spec/fixtures/ea_address_facade_v1_1_not_found.json") }
-
-            it "returns a 'NoMatchError'" do
-              response = described_class.run(postcode)
-
-              expect(a_request(:get, url)).to have_been_made.at_most_once
-
-              expect(response).to be_a(Response)
-              expect(response).to_not be_successful
-              expect(response.results).to be_empty
-              expect(response.error).to be_an_instance_of(DefraRuby::Address::NoMatchError)
-            end
-          end
-
-          context "because it is blank" do
-            let(:postcode) { "" }
-            let(:code) { 400 }
-            let(:body) { File.read("spec/fixtures/ea_address_facade_v1_1_blank.json") }
-
-            it "returns a failed response" do
-              response = described_class.run(postcode)
-
-              expect(a_request(:get, url)).to have_been_made.at_most_once
-
-              expect(response).to be_a(Response)
-              expect(response).to_not be_successful
-              expect(response.results).to be_empty
-              expect(response.error).to be_an_instance_of(RestClient::BadRequest)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/spec/defra_ruby/address/services/ea_address_facade_v1_service_spec.rb

@@ -1,73 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-module DefraRuby
-  module Address
-    RSpec.describe EaAddressFacadeV1Service do
-      describe "#run" do
-        before do
-          DefraRuby::Address.configure { |c| c.host = "http://localhost:8005/" }
-          stub_request(:get, url).to_return(status: code, body: body)
-        end
-
-        let(:client_id) { DefraRuby::Address.configuration.client_id }
-        let(:key) { DefraRuby::Address.configuration.key }
-        let(:postcode) { "BS1 5AH" }
-        let(:url) { "http://localhost:8005/address-service/v1/addresses/postcode?client-id=#{client_id}&key=#{key}&postcode=#{postcode}" }
-        let(:code) { 200 }
-        let(:body) { File.read("spec/fixtures/ea_address_facade_v1_valid.json") }
-
-        include_examples "handle request errors"
-
-        context "when the postcode is valid" do
-
-          it "returns a successful response" do
-            response = described_class.run(postcode)
-
-            expect(a_request(:get, url)).to have_been_made.at_most_once
-
-            expect(response).to be_a(Response)
-            expect(response.successful?).to eq(true)
-            expect(response.results).not_to be_empty
-          end
-        end
-
-        context "when the postcode is invalid" do
-          context "because it is not found" do
-            let(:postcode) { "BS1 9XX" }
-            let(:body) { File.read("spec/fixtures/ea_address_facade_v1_not_found.json") }
-
-            it "returns a 'NoMatchError'" do
-              response = described_class.run(postcode)
-
-              expect(a_request(:get, url)).to have_been_made.at_most_once
-
-              expect(response).to be_a(Response)
-              expect(response).to_not be_successful
-              expect(response.results).to be_empty
-              expect(response.error).to be_an_instance_of(DefraRuby::Address::NoMatchError)
-            end
-          end
-
-          context "because it is blank" do
-            let(:postcode) { "" }
-            let(:code) { 400 }
-            let(:body) { File.read("spec/fixtures/ea_address_facade_v1_blank.json") }
-
-            it "returns a failed response" do
-              response = described_class.run(postcode)
-
-              expect(a_request(:get, url)).to have_been_made.at_most_once
-
-              expect(response).to be_a(Response)
-              expect(response).to_not be_successful
-              expect(response.results).to be_empty
-              expect(response.error).to be_an_instance_of(RestClient::BadRequest)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/spec/defra_ruby/address/services/os_places_address_lookup_service_spec.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-module DefraRuby
-  module Address
-    RSpec.describe OsPlacesAddressLookupService do
-      describe "#run" do
-        before do
-          DefraRuby::Address.configure { |c| c.host = "http://localhost:8005/" }
-          stub_request(:get, url).to_return(status: code, body: body)
-        end
-
-        let(:postcode) { "BS1 5AH" }
-        let(:url) { "http://localhost:8005/addresses?postcode=#{postcode}" }
-        let(:code) { 200 }
-        let(:body) { File.read("spec/fixtures/os_places_address_lookup_valid.json") }
-
-        include_examples "handle request errors"
-
-        context "when the postcode is valid" do
-
-          it "returns a successful response" do
-            response = described_class.run(postcode)
-
-            expect(a_request(:get, url)).to have_been_made.at_most_once
-
-            expect(response).to be_a(Response)
-            expect(response.successful?).to eq(true)
-            expect(response.results).not_to be_empty
-          end
-        end
-
-        context "when the postcode is invalid" do
-          let(:code) { 400 }
-
-          context "because it is not found" do
-            let(:postcode) { "BS1 9XX" }
-            let(:body) { File.read("spec/fixtures/os_places_address_lookup_not_found.json") }
-
-            it "returns a 'NoMatchError'" do
-              response = described_class.run(postcode)
-
-              expect(a_request(:get, url)).to have_been_made.at_most_once
-
-              expect(response).to be_a(Response)
-              expect(response).to_not be_successful
-              expect(response.results).to be_empty
-              expect(response.error).to be_an_instance_of(DefraRuby::Address::NoMatchError)
-            end
-          end
-
-          context "because it is blank" do
-            let(:postcode) { "" }
-            let(:body) { File.read("spec/fixtures/os_places_address_lookup_blank.json") }
-
-            it "returns a failed response" do
-              response = described_class.run(postcode)
-
-              expect(a_request(:get, url)).to have_been_made.at_most_once
-
-              expect(response).to be_a(Response)
-              expect(response).to_not be_successful
-              expect(response.results).to be_empty
-              expect(response.error).to be_an_instance_of(RestClient::BadRequest)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/spec/defra_ruby/address_spec.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-RSpec.describe DefraRuby::Address do
-  describe "VERSION" do
-    it "is a version string in the correct format" do
-      expect(DefraRuby::Address::VERSION).to be_a(String)
-      expect(DefraRuby::Address::VERSION).to match(/\d+\.\d+\.\d+/)
-    end
-  end
-
-  describe "#configuration" do
-    context "when the host app has not provided configuration" do
-      it "returns a DefraRuby::Address::Configuration instance" do
-        expect(described_class.configuration).to be_an_instance_of(DefraRuby::Address::Configuration)
-      end
-    end
-
-    context "when the host app has provided configuration" do
-      let(:host) { "http://localhost:9012" }
-
-      it "returns an DefraRuby::Address::Configuration instance with a matching host" do
-        described_class.configure { |config| config.host = host }
-
-        expect(described_class.configuration.host).to eq(host)
-      end
-    end
-  end
-end

data/spec/examples.txt

@@ -1,27 +0,0 @@
-example_id                                                                             | status | run_time        |
--------------------------------------------------------------------------------------- | ------ | --------------- |
-./spec/defra_ruby/address/configuration_spec.rb[1:1]                                   | passed | 0.00888 seconds |
-./spec/defra_ruby/address/response_spec.rb[1:1:1:1]                                    | passed | 0.00013 seconds |
-./spec/defra_ruby/address/response_spec.rb[1:1:2:1]                                    | passed | 0.0003 seconds  |
-./spec/defra_ruby/address/response_spec.rb[1:2:1:1]                                    | passed | 0.0001 seconds  |
-./spec/defra_ruby/address/response_spec.rb[1:2:2:1]                                    | passed | 0.00014 seconds |
-./spec/defra_ruby/address/response_spec.rb[1:3:1:1]                                    | passed | 0.00011 seconds |
-./spec/defra_ruby/address/response_spec.rb[1:3:2:1]                                    | passed | 0.0001 seconds  |
-./spec/defra_ruby/address/services/ea_address_facade_v1_1_service_spec.rb[1:1:1:1:1]   | passed | 0.00301 seconds |
-./spec/defra_ruby/address/services/ea_address_facade_v1_1_service_spec.rb[1:1:1:2:1]   | passed | 0.00311 seconds |
-./spec/defra_ruby/address/services/ea_address_facade_v1_1_service_spec.rb[1:1:2:1]     | passed | 0.01005 seconds |
-./spec/defra_ruby/address/services/ea_address_facade_v1_1_service_spec.rb[1:1:3:1:1]   | passed | 0.01183 seconds |
-./spec/defra_ruby/address/services/ea_address_facade_v1_1_service_spec.rb[1:1:3:2:1]   | passed | 0.00571 seconds |
-./spec/defra_ruby/address/services/ea_address_facade_v1_service_spec.rb[1:1:1:1:1]     | passed | 0.00323 seconds |
-./spec/defra_ruby/address/services/ea_address_facade_v1_service_spec.rb[1:1:1:2:1]     | passed | 0.00337 seconds |
-./spec/defra_ruby/address/services/ea_address_facade_v1_service_spec.rb[1:1:2:1]       | passed | 0.02025 seconds |
-./spec/defra_ruby/address/services/ea_address_facade_v1_service_spec.rb[1:1:3:1:1]     | passed | 0.0075 seconds  |
-./spec/defra_ruby/address/services/ea_address_facade_v1_service_spec.rb[1:1:3:2:1]     | passed | 0.00576 seconds |
-./spec/defra_ruby/address/services/os_places_address_lookup_service_spec.rb[1:1:1:1:1] | passed | 0.0035 seconds  |
-./spec/defra_ruby/address/services/os_places_address_lookup_service_spec.rb[1:1:1:2:1] | passed | 0.00558 seconds |
-./spec/defra_ruby/address/services/os_places_address_lookup_service_spec.rb[1:1:2:1]   | passed | 0.0041 seconds  |
-./spec/defra_ruby/address/services/os_places_address_lookup_service_spec.rb[1:1:3:1:1] | passed | 0.00572 seconds |
-./spec/defra_ruby/address/services/os_places_address_lookup_service_spec.rb[1:1:3:2:1] | passed | 0.00559 seconds |
-./spec/defra_ruby/address_spec.rb[1:1:1]                                               | passed | 0.00494 seconds |
-./spec/defra_ruby/address_spec.rb[1:2:1:1]                                             | passed | 0.00262 seconds |
-./spec/defra_ruby/address_spec.rb[1:2:2:1]                                             | passed | 0.00014 seconds |

data/spec/fixtures/ea_address_facade_v1_1_blank.json

@@ -1,8 +0,0 @@
-{
-  "facade_status_code": 400,
-  "facade_error_message": "bad request to facade service, no request made to supplier service. required paramater missing.",
-  "facade_error_code": "address_service_error_13",
-  "supplier_was_called": false,
-  "supplier_status_code": null,
-  "supplier_response": null
-}

data/spec/fixtures/ea_address_facade_v1_1_not_found.json

@@ -1,14 +0,0 @@
-{
-  "header": {
-    "totalMatches": 0,
-    "startMatch": null,
-    "endMatch": null,
-    "query": "postcode=BS1 9XX",
-    "language": "EN",
-    "dataset": "DPA",
-    "epoch": "70",
-    "uriToSupplier": "https://api.ordnancesurvey.co.uk/places/v1/addresses/postcode?lr=EN&postcode=BS1%209XX&fq=logical_status_code%3A1&dataset=DPA",
-    "uriFromClient": ""
-  },
-  "results": []
-}