uk_postcodes_io 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 78f23082bd2711c0813278e5c24016b05c3dadb0
+  data.tar.gz: 53c4eb412940649bc0c9f93912eee53cc57efde0
+SHA512:
+  metadata.gz: 1b443a042828178b7822cf40a086e83f7d4a1f1c8963d55635f2fd12fd1be8b4a44376a6b6aec668b30698ea0f2146ff835eeee1f832465d724c9fa7ce83cfeb
+  data.tar.gz: eca7cc68856deae04a57d79e35b71ce17818947f0afb264d2e62d4d8401d0a288b81b4cf9c33aa23cf3fc56adc99eefaa62fe7d6be5cfd4efbeaa1c259e66294

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in uk_postcodes_io.gemspec
+gemspec
+
+group :test do
+  gem 'minitest-rg'
+  gem 'webmock'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Rob Nichols & Marks and Spencer plc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,102 @@
+# UkPostcodesIo
+
+This gem uses data gathered from the API at http://postcodes.io
+
+It is an alternative to [James Ruston's postcodes_io](https://github.com/jamesruston/postcodes_io).
+_postcode_io_ works well on successful lookups, but does not provide information
+on why a lookup has failed. As I could not see an easy way of extending _postcode_io_
+to provide this information without breaking previous implementations, the best option
+seemed to be to write an alternative.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'uk_postcodes_io'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install uk_postcodes_io
+
+## Usage
+
+To look up a postcode:
+
+```ruby
+lookup = UkPostcodesIo.lookup 'SW1A 2AA'
+
+lookup.postcode == 'SW1A 2AA'
+lookup.success? == true # depending on success of lookup
+```
+
+The data returned from the _postcode.io_ API is presented as an object at `lookup.data`
+if the lookup is successful. For example, for the postcode of 10 Downing St ('SW1A 2AA'):
+
+```ruby
+lookup.data.longitude == -0.127695242183412
+lookup.data.latitude == 51.5035398826274
+```
+
+See the [_postcode.io_ documentation](http://postcodes.io/docs#Data) for a list of
+attributes available.
+
+### Multiple postcodes
+
+Postcodes can be passed to `UkPostcodesIo.multi_lookup` as a list or an array:
+
+```ruby
+lookup = UkPostcodesIo.multi_lookup 'SW1A 2AA', 'NW1 7JS'
+lookup = UkPostcodesIo.multi_lookup ['SW1A 2AA', 'NW1 7JS']
+```
+
+`UkPostcodesIo.multi_lookup`, returns the data in a hash where the keys are
+the postcodes passed in, and the values are the matching data object. So:
+
+```ruby
+lookup.data['SW1A 2AA'].longitude == -0.127695242183412
+lookup.data['SW1A 2AA'].latitude == 51.5035398826274
+```
+
+However, note that if a postcode is not found, the request will be successful,
+but the value matching the problem postcode will be `nil`. So:
+
+```ruby
+lookup.success? == true
+lookup['NW1 7JS'] == nil
+```
+
+### Failure
+
+If the lookup fails:
+
+```ruby
+lookup = UkPostcodesIo.lookup 'invalid'
+lookup.success? == false
+lookup.data == nil
+lookup.error == 'Invalid postcode'
+
+no_longer_valid_postcode = 'NW1 7JS'
+lookup = UkPostcodesIo.lookup no_longer_valid_postcode
+lookup.success? == false
+lookup.data == nil
+lookup.error == 'Postcode not found'
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/msventurelabs/uk_postcodes_io.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

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

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/lib/uk_postcodes_io.rb

@@ -0,0 +1,14 @@
+require "uk_postcodes_io/version"
+require "uk_postcodes_io/lookup"
+require "uk_postcodes_io/multi_lookup"
+
+module UkPostcodesIo
+  def self.lookup(postcode)
+    Lookup.new(postcode)
+  end
+
+  def self.multi_lookup(*postcodes)
+    postcodes.flatten!
+    MultiLookup.new(postcodes)
+  end
+end

data/lib/uk_postcodes_io/lookup.rb

@@ -0,0 +1,43 @@
+require 'uri'
+require 'net/http'
+require 'json'
+require 'ostruct'
+module UkPostcodesIo
+  class Lookup
+    API_URL = 'http://api.postcodes.io/postcodes'
+
+    attr_reader :postcode
+    def initialize(postcode)
+      @postcode = postcode
+    end
+
+    def data
+      @data ||= OpenStruct.new(body['result']) if body['result']
+    end
+
+    def status
+      body['status']
+    end
+
+    def error
+      body['error']
+    end
+
+    def success?
+      response.kind_of?(Net::HTTPSuccess) && status == 200
+    end
+
+    def body
+      @body ||= JSON.parse response.body
+    end
+
+    def response
+      @response ||= Net::HTTP.get_response(uri)
+    end
+
+    def uri
+      URI(File.join API_URL, URI.escape(postcode))
+    end
+
+  end
+end

data/lib/uk_postcodes_io/multi_lookup.rb

@@ -0,0 +1,40 @@
+module UkPostcodesIo
+  class MultiLookup < Lookup
+
+    attr_reader :postcodes
+    def initialize(postcodes)
+      @postcodes = postcodes
+    end
+
+    def data
+      @data ||= build_data_from_body_result
+    end
+
+    def build_data_from_body_result
+      return unless body['result']
+      body['result'].each_with_object({}) do |item, hash|
+        hash[item['query']] = item['result'] ? OpenStruct.new(item['result']) : nil
+      end
+    end
+
+    def response
+      @response ||= make_request
+    end
+
+    def request
+      @request ||= Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json')
+    end
+
+    def make_request
+      request.body = { postcodes: postcodes }.to_json
+      Net::HTTP.start(uri.hostname, uri.port) do |http|
+        http.request(request)
+      end
+    end
+
+    def uri
+      URI(API_URL)
+    end
+
+  end
+end

data/lib/uk_postcodes_io/version.rb

@@ -0,0 +1,3 @@
+module UkPostcodesIo
+  VERSION = "0.3.0"
+end

data/uk_postcodes_io.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'uk_postcodes_io/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "uk_postcodes_io"
+  spec.version       = UkPostcodesIo::VERSION
+  spec.authors       = ["Rob Nichols"]
+  spec.email         = ["rob@nicholshayes.co.uk"]
+
+  spec.summary       = %q{Look up UK postcodes data from http://postcodes.io/.}
+  spec.homepage      = "https://github.com/msventurelabs/uk_postcodes_io"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: uk_postcodes_io
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Rob Nichols
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- rob@nicholshayes.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/uk_postcodes_io.rb
+- lib/uk_postcodes_io/lookup.rb
+- lib/uk_postcodes_io/multi_lookup.rb
+- lib/uk_postcodes_io/version.rb
+- uk_postcodes_io.gemspec
+homepage: https://github.com/msventurelabs/uk_postcodes_io
+licenses:
+- MIT
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Look up UK postcodes data from http://postcodes.io/.
+test_files: []