ea-area_lookup 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 548a57db3114a3cc09e50835c6aee5db409a7502
+  data.tar.gz: 65e4bf7c47eb3e67437bcf1561233a004358468d
+SHA512:
+  metadata.gz: 94d7677a81b2fc5528a460b07c110bf61a56acd7184fec2771a9e93b402ae66a0514491ed8c9da9f2788e607f05a250597151928325d4d74ef3947cdcd1d1ec2
+  data.tar.gz: 2b8ac1b2bb67326f6dff100ba092841add29a9582323ae77a816eaa3aaefb65ae70b34d2c0ab7eb568d2ce79a407c0b84d182d1ceddb3dbf41b1ab621c3a0043

data/.codeclimate.yml

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

data/.gitignore

@@ -0,0 +1,23 @@
+/.git-hooks/pre_commit/il8n_missing.rb
+/.git-hooks/pre_commit/il8n_unused.rb
+/.git-hooks/pre_commit/rspec_focus_check.rb
+/.overcommit.yml
+/.overcommit_gems.rb
+/.overcommit_gems.rb.lock
+/.rubocop.yml
+/rubocop/gds-ruby-styleguide.yml
+/rubocop/other-lint.yml
+/rubocop/other-rails.yml
+/rubocop/other-style.yml
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+.byebug_history
+.rspec-local

data/.rspec

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

data/.simplecov

@@ -0,0 +1,8 @@
+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/area_lookup/version.rb"
+end

data/.travis.yml

@@ -0,0 +1,25 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 2.2.3
+
+before_install: gem install bundler -v 1.11.2
+
+# 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: "DsWI1kzx5RIfB/QQysErQTW94FF6v512q3vqFChSXaAViJA6LgU9coBRiLtZ3RyE0YcvPzu0B1q/fqR4sDq4xG1L6VMY2PlF4ZI57AaPa1WFmzT9mCAhYCbpYKXuMySCoS4YvoHrHgwd30M0RYmiRtZY75Olmbd1PsbbZGfnIGwcEchujHb6oQ6WKgEAqq6zvHHf5QM18oSm4ZCFSYijGU7BvxMsLTToFuPnndGomWHCfMDSyBkC2wt5pmfdsjbirrsPPnFbYxCOCxGk77WWw9G+swUZclgUiUn1q2tSFgri27zufbFuGknDWf9HMiMqzgfCO8kut/78CqRjt5BtUm2otJLEhlpmL4t9rqDUKl/hmc+asxfoj04qP1cNRmjZf0QYbT4rFlsFlcNgYNcZcLf66ry9c8WXcpV6qvKukaT9Xyj1/KAVXDqO1EUd1oEBIoKnILW7H4Zhbjhu6lq2ga47Wux0IrMdtHE2RwjdtCxwfhkuUcblfnPpjW8tXeDND0nE/Se45rXZ/YwojZSeqyZCvZbcXMOvggzRQeAgi02sruw33oZU6W/f8VOjC5VrB1KEHm4j0n21dI6ENu0D+tbjBIW0TvI47hAuV/R1v7kHJVbSIcAedtxWt87mSdyQkOukCVSYHMOKJHY6T1EtZlK5V9RHDrHD8KIMeJV/Dx0="

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+ruby "2.2.3"
+
+# 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,73 @@
+# EA::AreaLookup
+
+[![Build Status](https://travis-ci.org/EnvironmentAgency/ea-area_lookup.svg?branch=master)](https://travis-ci.org/EnvironmentAgency/ea-area_lookup)
+[![Code Climate](https://codeclimate.com/github/EnvironmentAgency/ea-area_lookup/badges/gpa.svg)](https://codeclimate.com/github/EnvironmentAgency/ea-area_lookup)
+[![Test Coverage](https://codeclimate.com/github/EnvironmentAgency/ea-area_lookup/badges/coverage.svg)](https://codeclimate.com/github/EnvironmentAgency/ea-area_lookup/coverage)
+
+This ruby gem provides a means of looking up the Environment Agency Administrative Area (e.g. 'Wessex')
+for a given easting and northing. It wraps an API designed for this purpose.
+
+## Installation
+
+Add this line to your application's Gemfile
+
+```ruby
+gem 'ea-area_lookup'
+```
+
+And then update your dependencies by calling
+
+```bash
+bundle install
+```
+
+## Usage
+
+### Rails
+
+Create an intializer e.g. `config/initializers/area_lookup.rb`
+
+```ruby
+EA::AreaLookup.configure do |config|
+  config.administrative_area_api_url = "http://admin-area-api-base-url"
+end
+```
+
+Now you can do the following
+
+```ruby
+coords = EA::AreaLookup::Coordinates.new(easting: 123, northing: 456)
+(or EA::AreaLookup::Coordinates.new(x: 123, y: 456))
+result = EA::AreaLookup.find_by_coordinates(coords)
+p result
+=> {:area_id=>"XX", :code=>"WESSEX", :area_name=>"Wessex", :short_name=>"Wessex", :long_name=>"Wessex"}
+```
+
+Note that the `Coordinates` class accepts x and y synonymously with easting and northing.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## 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,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 "ea/area_lookup"
+
+# 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-area_lookup.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ea/area_lookup/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ea-area_lookup"
+  spec.version       = EA::AreaLookup::VERSION
+  spec.authors       = ["Digital Services Team, EnvironmentAgency"]
+  spec.email         = ["dst@environment-agency.gov.uk"]
+
+  spec.summary       = "Provides a means of looking-up Environment Agency administrative areas."
+  spec.description   = "Provides a means of looking-up an Environment Agency administrative area "\
+                       "using the co-ordinates of any point in England."
+  spec.homepage      = "https://github.com/EnvironmentAgency"
+  spec.license       = "The Open Government Licence (OGL) Version 3"
+
+  spec.required_ruby_version = '>= 2.2'
+  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 "nokogiri", "~> 1.3"
+
+  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 "byebug"
+  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"
+end

data/lib/ea/area_lookup.rb

@@ -0,0 +1,12 @@
+require "ea/area_lookup/version"
+require "ea/area_lookup/configuration"
+require "ea/area_lookup/errors"
+require "ea/area_lookup/logger"
+require "ea/area_lookup/coordinates"
+require "ea/area_lookup/finders"
+
+module EA
+  module AreaLookup
+    extend Finders
+  end
+end

data/lib/ea/area_lookup/configuration.rb

@@ -0,0 +1,19 @@
+module EA
+  module AreaLookup
+    class Configuration
+      attr_accessor :administrative_area_api_url
+    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/area_lookup/coordinates.rb

@@ -0,0 +1,18 @@
+module EA
+  module AreaLookup
+    class Coordinates
+      attr_accessor :easting, :northing
+      alias x easting
+      alias y northing
+
+      def initialize(easting:, northing:)
+        @easting = easting
+        @northing = northing
+      end
+
+      def valid?
+        easting && northing
+      end
+    end
+  end
+end

data/lib/ea/area_lookup/errors.rb

@@ -0,0 +1,7 @@
+module EA
+  module AreaLookup
+    class ApiConnectionError < StandardError; end
+    class ApiInvalidRequestError < StandardError; end
+    class InvalidConfigError < StandardError; end
+  end
+end

data/lib/ea/area_lookup/finders.rb

@@ -0,0 +1,71 @@
+require "nokogiri"
+require "open-uri"
+
+module EA
+  module AreaLookup
+    module Finders
+      def find_by_coordinates(coords)
+        validate_config!
+        return nil unless coords && coords.valid?
+        xml = fetch_admin_area_from_api(coords)
+        parse_xml(xml)
+      end
+
+      private
+
+      DEFAULT_API_PARAMS = {
+        SERVICE: "WFS",
+        INTERFACE: "ENVIRONMENTWFS",
+        VERSION: "1.1.0",
+        REQUEST: "GetFeature",
+        MSVER: 6,
+        SRS: "EPSG:27700",
+        TYPENAME: "ea-wfs-area_public_face_inspire",
+        propertyName: "long_name,short_name,code,area_id,area_name",
+        Filter: ""
+      }.freeze
+
+      def api_url
+        EA::AreaLookup.config.administrative_area_api_url
+      end
+
+      def validate_config!
+        return if api_url
+        raise EA::AreaLookup::InvalidConfigError, "Missing administrative_area_api_url"
+      end
+
+      def fetch_admin_area_from_api(coords)
+        params = DEFAULT_API_PARAMS.merge(Filter: "(#{filter_xml(coords)})")
+        full_url = %(#{api_url}?#{params.map { |k, v| "#{k}=#{v}" }.join('&')})
+        open full_url, proxy: ENV["http_proxy"]
+      rescue => e
+        raise EA::AreaLookup::ApiConnectionError,
+              "Failed with error #{e.inspect} trying to GET #{full_url}"
+      end
+
+      def filter_xml(coords)
+        "<Filter><Intersects>" \
+        "<PropertyName>Geometry</PropertyName>" \
+        "<gml:Point><gml:coordinates>#{coords.easting},#{coords.northing}</gml:coordinates></gml:Point>" \
+        "</Intersects></Filter>"
+      end
+
+      def parse_xml(response)
+        xml = Nokogiri::XML response
+        validate_xml(xml)
+
+        result = %i(area_id code area_name short_name long_name).each_with_object({}) do |path, hash|
+          hash[path] = xml.xpath("//gml:featureMember/ms:ea-wfs-area_public_face_inspire/ms:#{path}").text
+        end
+        result.tap { |h| EA::AreaLookup.logger.debug(h) }
+      end
+
+      def validate_xml(xml)
+        if xml.namespaces["xmlns:ows"] && xml.xpath("//ows:Exception").count > 0
+          raise EA::AreaLookup::ApiInvalidRequestError,
+                "API returned an exception: #{xml.text && xml.text.strip}"
+        end
+      end
+    end
+  end
+end

data/lib/ea/area_lookup/logger.rb

@@ -0,0 +1,21 @@
+# A consumer can hook into logging like so:
+#   EA::AreaLookup.logger = Rails.logger
+# or to silence logging unless there are errors for example:
+#  EA::AreaLookup.logger.level = Logger::ERROR
+#
+require "logger"
+
+module EA
+  module AreaLookup
+    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/area_lookup/version.rb

@@ -0,0 +1,5 @@
+module EA
+  module AreaLookup
+    VERSION = "0.1.0".freeze
+  end
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: ea-area_lookup
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Digital Services Team, EnvironmentAgency
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: 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: 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'
+description: Provides a means of looking-up an Environment Agency administrative area
+  using the co-ordinates of any point in England.
+email:
+- dst@environment-agency.gov.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".simplecov"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ea-area_lookup.gemspec
+- lib/ea/area_lookup.rb
+- lib/ea/area_lookup/configuration.rb
+- lib/ea/area_lookup/coordinates.rb
+- lib/ea/area_lookup/errors.rb
+- lib/ea/area_lookup/finders.rb
+- lib/ea/area_lookup/logger.rb
+- lib/ea/area_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: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Provides a means of looking-up Environment Agency administrative areas.
+test_files: []