defra_ruby_area 0.1.0

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module DefraRuby
+  module Area
+    RSpec.describe WaterManagementAreaService do
+      describe "#run" do
+
+        context "when the coordinates are valid and in England" do
+          before(:each) { VCR.insert_cassette("water_management_area_valid") }
+          after(:each) { VCR.eject_cassette }
+
+          let(:easting) { 408_602.61 }
+          let(:northing) { 257_535.31 }
+
+          it "returns a successful response" do
+            response = described_class.run(easting, northing)
+            expect(response).to be_a(Response)
+            expect(response.successful?).to eq(true)
+            expect(response.area).to eq("Staffordshire Warwickshire and West Midlands")
+          end
+
+        end
+
+        context "when the coordinates are invalid" do
+          context "because they are blank" do
+            before(:each) { VCR.insert_cassette("water_management_area_invalid_blank") }
+            after(:each) { VCR.eject_cassette }
+
+            let(:easting) { nil }
+            let(:northing) { nil }
+
+            it "returns a failed response" do
+              response = described_class.run(easting, northing)
+              expect(response).to be_a(Response)
+              expect(response).to_not be_successful
+              expect(response.area).to be_nil
+              expect(response.error).to_not be_nil
+            end
+          end
+
+          context "because they are not in an area" do
+            before(:each) { VCR.insert_cassette("water_management_area_invalid_coords") }
+            after(:each) { VCR.eject_cassette }
+
+            let(:easting) { 301_233.0 }
+            let(:northing) { 221_592.0 }
+
+            it "returns a failed response" do
+              response = described_class.run(easting, northing)
+              expect(response).to be_a(Response)
+              expect(response).to_not be_successful
+              expect(response.area).to be_nil
+              expect(response.error).to_not be_nil
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/spec/defra_ruby/area_spec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe DefraRuby::Area do
+  describe "VERSION" do
+    it "is a version string in the correct format" do
+      expect(DefraRuby::Area::VERSION).to be_a(String)
+      expect(DefraRuby::Area::VERSION).to match(/\d+\.\d+\.\d+/)
+    end
+  end
+end

data/spec/examples.txt

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

data/spec/spec_helper.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+
+# Require and run our simplecov initializer as the very first thing we do.
+# This is as per its docs https://github.com/colszowka/simplecov#getting-started
+require "./spec/support/simplecov"
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# We make an exception for simplecov because that will already have been
+# required and run at the very top of spec_helper.rb
+support_files = Dir["./spec/support/**/*.rb"].reject { |file| file == "./spec/support/simplecov.rb" }
+support_files.each { |f| require f }
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

data/spec/support/defra_ruby_area.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+# Need to require our actual code files.
+require "defra_ruby/area"

data/spec/support/dotenv.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+# Load env vars from a text file
+require "dotenv/load"

data/spec/support/pry.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Support debugging in the tests. Add `binding.pry` wherever you want execution
+# to stop and the debugger to kick in.
+# Details on the debugging commands can be found here
+# https://github.com/deivid-rodriguez/pry-byebug#commands
+require "pry-byebug"

data/spec/support/simplecov.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "simplecov"
+
+# We start it with the rails param to ensure it includes coverage for all code
+# started by the rails app, and not just the files touched by our unit tests.
+# This gives us the most accurate assessment of our unit test coverage
+# https://github.com/colszowka/simplecov#getting-started
+SimpleCov.start do
+  # We filter the spec folder, mainly to ensure that any dummy apps don't get
+  # included in the coverage report. However our intent is that nothing in the
+  # spec folder should be included
+  add_filter "/spec/"
+  # The version file is simply just that, so we do not feel the need to ensure
+  # we have a test for it
+  add_filter "lib/defra_ruby/validators/version"
+end

data/spec/support/vcr.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Stubbing HTTP requests
+require "webmock/rspec"
+# Auto generate fake responses for web-requests
+require "vcr"
+
+VCR.configure do |c|
+  c.cassette_library_dir = "spec/cassettes"
+  c.hook_into :webmock
+
+  c.ignore_hosts "127.0.0.1", "codeclimate.com"
+
+  SECONDS_IN_DAY = 24 * 60 * 60
+
+  c.default_cassette_options = { re_record_interval: (14 * SECONDS_IN_DAY) }
+end

metadata

@@ -0,0 +1,261 @@
+--- !ruby/object:Gem::Specification
+name: defra_ruby_area
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Defra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.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: Use to query the EA's administrative boundary Web Feature Services for
+  area names.
+email:
+- alan.cruikshanks@environment-agency.gov.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/defra_ruby.rb
+- lib/defra_ruby/area.rb
+- lib/defra_ruby/area/no_match_error.rb
+- lib/defra_ruby/area/response.rb
+- lib/defra_ruby/area/services/base_area_service.rb
+- lib/defra_ruby/area/services/public_face_area_service.rb
+- lib/defra_ruby/area/services/water_management_area_service.rb
+- lib/defra_ruby/area/version.rb
+- spec/cassettes/public_face_area_invalid_blank.yml
+- spec/cassettes/public_face_area_invalid_coords.yml
+- spec/cassettes/public_face_area_valid.yml
+- 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/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
+- spec/defra_ruby/area_spec.rb
+- spec/examples.txt
+- spec/spec_helper.rb
+- spec/support/defra_ruby_area.rb
+- spec/support/dotenv.rb
+- spec/support/pry.rb
+- spec/support/simplecov.rb
+- spec/support/vcr.rb
+homepage: https://github.com/DEFRA/defra-ruby-area
+licenses:
+- The Open Government Licence (OGL) Version 3
+metadata:
+  allowed_push_host: https://rubygems.org
+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.13
+signing_key: 
+specification_version: 4
+summary: Defra ruby on rails EA administrative area lookup
+test_files:
+- spec/spec_helper.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
+- spec/defra_ruby/area_spec.rb
+- spec/examples.txt
+- spec/cassettes/water_management_area_invalid_coords.yml
+- spec/cassettes/public_face_area_invalid_coords.yml
+- spec/cassettes/water_management_area_invalid_blank.yml
+- spec/cassettes/public_face_area_valid.yml
+- spec/cassettes/water_management_area_valid.yml
+- spec/cassettes/public_face_area_invalid_blank.yml
+- spec/support/defra_ruby_area.rb
+- spec/support/simplecov.rb
+- spec/support/vcr.rb
+- spec/support/pry.rb
+- spec/support/dotenv.rb