defra_ruby_area 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4136c639188f345ff7f134ae43493de19768027
-  data.tar.gz: 60e70fab3d624fc8078fa4229d46f4ef5afc03f9
+  metadata.gz: 3f427f04ac61c560c18dc91548c45c1843097f1a
+  data.tar.gz: 8f4a923e04b6861a168e867c302ed7ff583f1997
 SHA512:
-  metadata.gz: a36b69f5153fcdfc5fff4dc701b126fc137b3459876846e92a9a13232d882edd0f871ee7cf9d7490acaa6211d53bde8ea53b58295dcfe4b5a76bb0de80d4a5bf
-  data.tar.gz: d65828c98e10527719438daf61ed84dc6cd346aacf80ae5f36f16f271271f3b5eeea04186da7d8f5f2cf5d7255b354600291d796bcdb0c7a8122bcbcf6e7fde5
+  metadata.gz: 1def8fe471daa1dc45d2741e6509b3b4c84af6e49160e6635ba300f3b93c2e303c2e72513e94f91fbe475e4e1d18982ad9a2146469c0a49b7a2066ae13119825
+  data.tar.gz: b9c1eff78d8e407afff6ed9534fefa0287962cc414ba3155458f65e26aec5529c56f7db85b1844bdc998a28c94ecddfa337780eec0578d758037e9811b575879

data/README.md

@@ -4,6 +4,7 @@
 [![Maintainability](https://api.codeclimate.com/v1/badges/7aeffed0588d86a5e553/maintainability)](https://codeclimate.com/github/DEFRA/defra-ruby-area/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/7aeffed0588d86a5e553/test_coverage)](https://codeclimate.com/github/DEFRA/defra-ruby-area/test_coverage)
 [![security](https://hakiri.io/github/DEFRA/defra-ruby-area/master.svg)](https://hakiri.io/github/DEFRA/defra-ruby-area/master)
+[![Gem Version](https://badge.fury.io/rb/defra_ruby_area.svg)](https://badge.fury.io/rb/defra_ruby_area)
 [![Licence](https://img.shields.io/badge/Licence-OGLv3-blue.svg)](http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3)
 
 This ruby gem provides a means of looking up an Environment Agency Administrative boundary from a GIS Web Feature Service (WFS). Provided with a valid [easting and northing](https://en.wikipedia.org/wiki/Easting_and_northing) it will query the WFS and return the long name for the area if a match is found.

data/lib/defra_ruby/area.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "area/configuration"
 require_relative "area/no_match_error"
 require_relative "area/response"
 
@@ -9,5 +10,17 @@ require_relative "area/services/water_management_area_service"
 
 module DefraRuby
   module Area
+    class << self
+      # attr_accessor :configuration
+
+      def configure
+        yield(configuration)
+      end
+
+      def configuration
+        @configuration ||= Configuration.new
+        @configuration
+      end
+    end
   end
 end

data/lib/defra_ruby/area/configuration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module DefraRuby
+  module Area
+    class Configuration
+      attr_accessor :timeout
+
+      def initialize
+        @timeout = 3
+      end
+    end
+  end
+end

data/lib/defra_ruby/area/services/base_area_service.rb

@@ -27,7 +27,11 @@ module DefraRuby
       def response_exe
         lambda do
           begin
-            response = RestClient::Request.execute(method: :get, url: url)
+            response = RestClient::Request.execute(
+              method: :get,
+              url: url,
+              timeout: DefraRuby::Area.configuration.timeout
+            )
             area = parse_xml(response)
             raise NoMatchError if area.nil? || area == ""
           rescue StandardError => e

data/lib/defra_ruby/area/version.rb

@@ -2,6 +2,6 @@
 
 module DefraRuby
   module Area
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/spec/cassettes/public_face_area_invalid_blank.yml

@@ -131,7 +131,7 @@ http_interactions:
       Server:
       - nginx
       Date:
-      - Sat, 03 Aug 2019 10:48:37 GMT
+      - Sun, 04 Aug 2019 10:30:09 GMT
       Content-Type:
       - application/xml
       Content-Length:
@@ -153,5 +153,5 @@ http_interactions:
           <ogc:ServiceException><![CDATA[Operator 'Intersects' can't parse geometry.]]></ogc:ServiceException>
         </ogc:ServiceExceptionReport>
     http_version: 
-  recorded_at: Sat, 03 Aug 2019 10:48:37 GMT
+  recorded_at: Sun, 04 Aug 2019 10:30:09 GMT
 recorded_with: VCR 4.0.0

data/spec/cassettes/public_face_area_valid.yml

@@ -128,7 +128,7 @@ http_interactions:
       Server:
       - nginx
       Date:
-      - Sat, 03 Aug 2019 10:48:43 GMT
+      - Sun, 04 Aug 2019 10:30:09 GMT
       Content-Type:
       - application/xml
       Content-Length:
@@ -161,5 +161,5 @@ http_interactions:
           </gml:featureMember>
         </wfs:FeatureCollection>
     http_version: 
-  recorded_at: Sat, 03 Aug 2019 10:48:44 GMT
+  recorded_at: Sun, 04 Aug 2019 10:30:09 GMT
 recorded_with: VCR 4.0.0

data/spec/defra_ruby/area/configuration_spec.rb

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

data/spec/defra_ruby/area/services/public_face_area_service_spec.rb

@@ -57,6 +57,8 @@ module DefraRuby
           end
 
         end
+
+        include_examples "handle request errors"
       end
     end
   end

data/spec/defra_ruby/area/services/water_management_area_service_spec.rb

@@ -57,6 +57,8 @@ module DefraRuby
           end
 
         end
+
+        include_examples "handle request errors"
       end
     end
   end

data/spec/defra_ruby/area_spec.rb

@@ -9,4 +9,22 @@ RSpec.describe DefraRuby::Area do
       expect(DefraRuby::Area::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::Area::Configuration instance" do
+        expect(described_class.configuration).to be_an_instance_of(DefraRuby::Area::Configuration)
+      end
+    end
+
+    context "when the host app has provided configuration" do
+      let(:timeout) { 10 }
+
+      it "returns an DefraRuby::Area::Configuration instance with a matching timeout" do
+        described_class.configure { |config| config.timeout = timeout }
+
+        expect(described_class.configuration.timeout).to eq(timeout)
+      end
+    end
+  end
 end

data/spec/examples.txt

@@ -1,15 +1,22 @@
 example_id                                                                       | status | run_time        |
 -------------------------------------------------------------------------------- | ------ | --------------- |
-./spec/defra_ruby/area/response_spec.rb[1:1:1:1]                                 | passed | 0.00012 seconds |
-./spec/defra_ruby/area/response_spec.rb[1:1:2:1]                                 | passed | 0.0001 seconds  |
-./spec/defra_ruby/area/response_spec.rb[1:2:1:1]                                 | passed | 0.00017 seconds |
-./spec/defra_ruby/area/response_spec.rb[1:2:2:1]                                 | passed | 0.00009 seconds |
-./spec/defra_ruby/area/response_spec.rb[1:3:1:1]                                 | passed | 0.00012 seconds |
-./spec/defra_ruby/area/response_spec.rb[1:3:2:1]                                 | passed | 0.0001 seconds  |
-./spec/defra_ruby/area/services/public_face_area_service_spec.rb[1:1:1:1]        | passed | 6.86 seconds    |
-./spec/defra_ruby/area/services/public_face_area_service_spec.rb[1:1:2:1:1]      | passed | 6.55 seconds    |
-./spec/defra_ruby/area/services/public_face_area_service_spec.rb[1:1:2:2:1]      | passed | 0.02233 seconds |
-./spec/defra_ruby/area/services/water_management_area_service_spec.rb[1:1:1:1]   | passed | 0.03547 seconds |
-./spec/defra_ruby/area/services/water_management_area_service_spec.rb[1:1:2:1:1] | passed | 0.022 seconds   |
-./spec/defra_ruby/area/services/water_management_area_service_spec.rb[1:1:2:2:1] | passed | 0.02539 seconds |
-./spec/defra_ruby/area_spec.rb[1:1:1]                                            | passed | 0.00171 seconds |
+./spec/defra_ruby/area/configuration_spec.rb[1:1]                                | passed | 0.0001 seconds  |
+./spec/defra_ruby/area/response_spec.rb[1:1:1:1]                                 | passed | 0.00017 seconds |
+./spec/defra_ruby/area/response_spec.rb[1:1:2:1]                                 | passed | 0.00013 seconds |
+./spec/defra_ruby/area/response_spec.rb[1:2:1:1]                                 | passed | 0.00013 seconds |
+./spec/defra_ruby/area/response_spec.rb[1:2:2:1]                                 | passed | 0.00013 seconds |
+./spec/defra_ruby/area/response_spec.rb[1:3:1:1]                                 | passed | 0.00011 seconds |
+./spec/defra_ruby/area/response_spec.rb[1:3:2:1]                                 | passed | 0.00012 seconds |
+./spec/defra_ruby/area/services/public_face_area_service_spec.rb[1:1:1:1]        | passed | 0.37074 seconds |
+./spec/defra_ruby/area/services/public_face_area_service_spec.rb[1:1:2:1:1]      | passed | 0.33628 seconds |
+./spec/defra_ruby/area/services/public_face_area_service_spec.rb[1:1:2:2:1]      | passed | 0.03231 seconds |
+./spec/defra_ruby/area/services/public_face_area_service_spec.rb[1:1:3:1:1]      | passed | 0.03391 seconds |
+./spec/defra_ruby/area/services/public_face_area_service_spec.rb[1:1:3:2:1]      | passed | 0.02614 seconds |
+./spec/defra_ruby/area/services/water_management_area_service_spec.rb[1:1:1:1]   | passed | 0.0305 seconds  |
+./spec/defra_ruby/area/services/water_management_area_service_spec.rb[1:1:2:1:1] | passed | 0.02802 seconds |
+./spec/defra_ruby/area/services/water_management_area_service_spec.rb[1:1:2:2:1] | passed | 0.02484 seconds |
+./spec/defra_ruby/area/services/water_management_area_service_spec.rb[1:1:3:1:1] | passed | 0.01976 seconds |
+./spec/defra_ruby/area/services/water_management_area_service_spec.rb[1:1:3:2:1] | passed | 0.02365 seconds |
+./spec/defra_ruby/area_spec.rb[1:1:1]                                            | passed | 0.00131 seconds |
+./spec/defra_ruby/area_spec.rb[1:2:1:1]                                          | passed | 0.00057 seconds |
+./spec/defra_ruby/area_spec.rb[1:2:2:1]                                          | passed | 0.0013 seconds  |

data/spec/support/shared_examples/handle_request_errors.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples "handle request errors" do
+  context "when there is a problem with the Web Feature Service" do
+    before(:each) { VCR.turn_off! }
+    after(:each) { VCR.turn_on! }
+
+    let(:host) { "https://environment.data.gov.uk/" }
+    let(:easting) { 408_602.61 }
+    let(:northing) { 257_535.31 }
+
+    context "and the request times out" do
+      before(:each) { stub_request(:any, /.*#{host}.*/).to_timeout }
+
+      it "returns a failed response" do
+        response = described_class.run(easting, northing)
+        expect(response).to be_a(DefraRuby::Area::Response)
+        expect(response).to_not be_successful
+        expect(response.area).to be_nil
+        expect(response.error).to_not be_nil
+      end
+    end
+
+    context "and the request returns an error" do
+      before(:each) { stub_request(:any, /.*#{host}.*/).to_raise(SocketError) }
+
+      it "returns a failed response" do
+        response = described_class.run(easting, northing)
+        expect(response).to be_a(DefraRuby::Area::Response)
+        expect(response).to_not be_successful
+        expect(response.area).to be_nil
+        expect(response.error).to_not be_nil
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: defra_ruby_area
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Defra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-03 00:00:00.000000000 Z
+date: 2019-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -193,6 +193,7 @@ files:
 - bin/setup
 - lib/defra_ruby.rb
 - lib/defra_ruby/area.rb
+- lib/defra_ruby/area/configuration.rb
 - lib/defra_ruby/area/no_match_error.rb
 - lib/defra_ruby/area/response.rb
 - lib/defra_ruby/area/services/base_area_service.rb
@@ -205,6 +206,7 @@ files:
 - spec/cassettes/water_management_area_invalid_blank.yml
 - spec/cassettes/water_management_area_invalid_coords.yml
 - spec/cassettes/water_management_area_valid.yml
+- spec/defra_ruby/area/configuration_spec.rb
 - spec/defra_ruby/area/response_spec.rb
 - spec/defra_ruby/area/services/public_face_area_service_spec.rb
 - spec/defra_ruby/area/services/water_management_area_service_spec.rb
@@ -214,6 +216,7 @@ files:
 - spec/support/defra_ruby_area.rb
 - spec/support/dotenv.rb
 - spec/support/pry.rb
+- spec/support/shared_examples/handle_request_errors.rb
 - spec/support/simplecov.rb
 - spec/support/vcr.rb
 homepage: https://github.com/DEFRA/defra-ruby-area
@@ -243,6 +246,7 @@ specification_version: 4
 summary: Defra ruby on rails EA administrative area lookup
 test_files:
 - spec/spec_helper.rb
+- spec/defra_ruby/area/configuration_spec.rb
 - spec/defra_ruby/area/response_spec.rb
 - spec/defra_ruby/area/services/water_management_area_service_spec.rb
 - spec/defra_ruby/area/services/public_face_area_service_spec.rb
@@ -259,3 +263,4 @@ test_files:
 - spec/support/vcr.rb
 - spec/support/pry.rb
 - spec/support/dotenv.rb
+- spec/support/shared_examples/handle_request_errors.rb