postcodes_io 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a025c5964930e2fdd31f1d4ac696d14ef8db7244
-  data.tar.gz: 3d5e0090a957e1a6af46f68d1204eb0c2ee9b5a9
+SHA256:
+  metadata.gz: 2c6a93dd223ae7a6cc8c04b1f7079f955eb4d93d0ebab8bd14f6cffa87f57b82
+  data.tar.gz: 28052e4ba75fa32901fc03b8997cbc67575df1e97c7902fbead915086b88f758
 SHA512:
-  metadata.gz: 5ca6179bdb36644e0d64dc65f3ff37efa574cbe9e0440200ef788514de7728c9c6d0fa95c87adaa258022f0d8aca834d4c0177c4ef8de817ab2610bc6e98727d
-  data.tar.gz: 1cc677ceaf30e1c0db12e0c44d604a77b35b44d05533a81440e545553806fca89f1f7222bfaa8b1fa321b9fd8f4b00a9cb78ae35b8b8048896e331349a7e3ea6
+  metadata.gz: 3cb7ab91ceba1f04d2aed32d96a5c4b1c9754c06fef797246311ed340aeaa78cd69157f05f59a9a47d04f6ba3c8d66a537108cd361f00940d30a3189e88b1342
+  data.tar.gz: e91286586e6dd99db43ae487df61d621df6e623877facc54117a132eab964a2f8d506c3c27fb8655d956a771bce39ec0859f3398b3375253b54b2766b678fe2f

data/.github/workflows/gem-push.yml

@@ -0,0 +1,43 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+ - 2.3

data/README.md

@@ -1,3 +1,4 @@
+[![Build Status](https://travis-ci.org/jamesruston/postcodes_io.svg?branch=master)](https://travis-ci.org/jamesruston/postcodes_io) [![Gem Version](https://badge.fury.io/rb/postcodes_io.svg)](https://badge.fury.io/rb/postcodes_io)
 # PostcodesIo
 
 A simple wrapper around [postcodes.io](http://postcodes.io/)
@@ -32,7 +33,7 @@ Create new instance of the Postcodes::IO
 pio = Postcodes::IO.new
 ```
 
-####Lookup a postcode
+### Lookup a postcode
 ```ruby
 postcode = pio.lookup('NN12 8TN')
 ```
@@ -43,7 +44,7 @@ postcode.longitude # -1.02144562675883
 postcode.latitude # 52.0776806788868
 ```
 
-####Make a batch postcode lookup request
+### Make a batch postcode lookup request
 
 > max 100 postcodes per request
 
@@ -54,14 +55,33 @@ postcodes.each do |p|
 end
 ```
 
-####Autocomplete a postcode
+### Autocomplete a postcode
 
 ```ruby
 postcodes = pio.autocomplete('NN12')
 puts postcodes.list # ["NN12 6AA", "NN12 6AB", "NN12 6AD", "NN12 6AE", "NN12 6AF", "NN12 6AG", "NN12 6AH", "NN12 6AJ", "NN12 6AL", "NN12 6AN"]
 ```
 
-##All available fields
+
+### Perform a reverse geocode lookup
+
+```ruby
+postcodes = pio.reverse_geocode(longitude: 0.629834, latitude: 51.79232)
+puts postcodes.first.postcode # CM8 1EF
+```
+
+### Lookup a terminated postcode
+```ruby
+postcode = pio.lookup_terminated('SO23 7SP')
+```
+
+Inspect the results!
+```ruby
+postcode.longitude # -1.02144562675883
+postcode.latitude # 52.0776806788868
+```
+
+### All available fields
 
 |name|description|
 |----|-----------|
@@ -82,14 +102,14 @@ puts postcodes.list # ["NN12 6AA", "NN12 6AB", "NN12 6AD", "NN12 6AE", "NN12 6AF
 |region| [former GORs](http://www.ons.gov.uk/ons/guide-method/geography/beginner-s-guide/administrative/england/government-office-regions/index.html)|
 |parish| The smallest type of administrative area|
 |lsoa| [The 2011 Census lower layer SOA code](http://www.ons.gov.uk/ons/guide-method/geography/beginner-s-guide/census/super-output-areas--soas-/index.html)|
-|msoa| [The 2011 Census middle layer SOA (MSOA) code](The 2011 Census lower layer SOA code for England and Wales](http://www.ons.gov.uk/ons/guide-method/geography/beginner-s-guide/census/super-output-areas--soas-/index.html)|
+|msoa| [The 2011 Census middle layer SOA (MSOA) code](http://www.ons.gov.uk/ons/guide-method/geography/beginner-s-guide/census/super-output-areas--soas-/index.html)|
 |ccg| Clinical Commissioning Group |
 |nuts| [see here](http://en.wikipedia.org/wiki/Nomenclature_of_Territorial_Units_for_Statistics)|
 
 For more details see [the documentation on postcodes.io](http://postcodes.io/docs)
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/postcodes_io/fork )
+1. Fork it ( https://github.com/jamesruston/postcodes_io/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/Rakefile

@@ -1,5 +1,10 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) 
+
+task default: :spec
 
 task :console do
   exec "irb -r postcodes_io -I ./lib"
-end
+end

data/lib/postcodes_io/lookup_terminated.rb

@@ -0,0 +1,33 @@
+require 'excon'
+require 'json'
+require 'postcodes_io/postcode'
+
+module Postcodes
+  module LookupTerminated
+    def lookup_terminated(postcode)
+      lookup_terminated_postcode postcode
+    end
+
+    private
+
+    def lookup_terminated_postcode(postcode)
+      postcode = remove_whitespace postcode
+      response = Excon.get("https://api.postcodes.io/terminated_postcodes/#{postcode}")
+
+      unless response.status == 404
+        parsed_response = JSON.parse(response.body)
+        return Postcodes::Postcode.new(parsed_response['result'])
+      end
+      nil
+    end
+
+    def remove_whitespace(string)
+      string.gsub(/\s+/, '') # remove any whitespace. m1 1ab => m11ab
+    end
+
+    def process_response(response)
+      yield JSON.parse(response.body) unless response.status == 404
+      nil
+    end
+  end
+end

data/lib/postcodes_io/reverse_geocode.rb

@@ -0,0 +1,20 @@
+require 'excon'
+require 'json'
+require 'postcodes_io/postcode'
+
+module Postcodes
+  module ReverseGeocode
+    def reverse_geocode(longitude:, latitude:, limit: 10, radius: 100, wide_search: false)
+      response = Excon.get(
+        "https://api.postcodes.io/postcodes?lon=#{longitude}&lat=#{latitude}&limit=#{limit}&radius=#{radius}&wideSearch=#{wide_search}")
+      return unless response.status == 200
+
+      json = JSON.parse(response.body)
+      return unless json['result']
+
+      json['result'].map do |result|
+        Postcode.new(result)
+      end
+    end
+  end
+end

data/lib/postcodes_io/version.rb

@@ -1,3 +1,3 @@
 module Postcodes
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

data/lib/postcodes_io.rb

@@ -1,11 +1,15 @@
-require "postcodes_io/version"
-require "postcodes_io/lookup"
-require "postcodes_io/autocomplete"
-require "postcodes_io/postcode"
+require 'postcodes_io/version'
+require 'postcodes_io/lookup'
+require 'postcodes_io/autocomplete'
+require 'postcodes_io/postcode'
+require 'postcodes_io/reverse_geocode'
+require 'postcodes_io/lookup_terminated'
 
 module Postcodes
   class IO
     include Lookup
     include Autocomplete
+    include ReverseGeocode
+    include LookupTerminated
   end
 end

data/postcodes_io.gemspec

@@ -18,8 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "webmock"
 

data/spec/fixtures/lookup_terminated_response.json

@@ -0,0 +1,10 @@
+{
+    "status": 200,
+    "result": {
+      "postcode": "SO23 9DD",
+      "year_terminated": 2001,
+      "month_terminated": 8,
+      "longitude": -1.316261,
+      "latitude": 51.062297
+    }
+}

data/spec/fixtures/no_results_response.json

@@ -0,0 +1 @@
+{"status":200,"result":null}

data/spec/fixtures/reverse_geocode_response.json

@@ -0,0 +1 @@
+{"status":200,"result":[{"postcode":"PR7 4HF","quality":1,"eastings":360059,"northings":412765,"country":"England","nhs_ha":"North West","longitude":-2.60515477763266,"latitude":53.6099106263766,"european_electoral_region":"North West","primary_care_trust":"Central Lancashire","region":"North West","lsoa":"Chorley 014C","msoa":"Chorley 014","incode":"4HF","outcode":"PR7","distance":0,"parliamentary_constituency":"Chorley","admin_district":"Chorley","parish":"Adlington","admin_county":"Lancashire","admin_ward":"Adlington and Anderton","ccg":"NHS Chorley and South Ribble","nuts":"Chorley and West Lancashire","codes":{"admin_district":"E07000118","admin_county":"E10000017","admin_ward":"E05005165","parish":"E04005139","parliamentary_constituency":"E14000637","ccg":"E38000034","nuts":"UKD47"}},{"postcode":"PR7 4HR","quality":1,"eastings":360038,"northings":412741,"country":"England","nhs_ha":"North West","longitude":-2.60546907187036,"latitude":53.6096933152903,"european_electoral_region":"North West","primary_care_trust":"Central Lancashire","region":"North West","lsoa":"Chorley 014C","msoa":"Chorley 014","incode":"4HR","outcode":"PR7","distance":31.90158431,"parliamentary_constituency":"Chorley","admin_district":"Chorley","parish":"Adlington","admin_county":"Lancashire","admin_ward":"Adlington and Anderton","ccg":"NHS Chorley and South Ribble","nuts":"Chorley and West Lancashire","codes":{"admin_district":"E07000118","admin_county":"E10000017","admin_ward":"E05005165","parish":"E04005139","parliamentary_constituency":"E14000637","ccg":"E38000034","nuts":"UKD47"}},{"postcode":"PR7 4HJ","quality":1,"eastings":360076,"northings":412843,"country":"England","nhs_ha":"North West","longitude":-2.60490787349104,"latitude":53.6106129688375,"european_electoral_region":"North West","primary_care_trust":"Central Lancashire","region":"North West","lsoa":"Chorley 014C","msoa":"Chorley 014","incode":"4HJ","outcode":"PR7","distance":79.85903188,"parliamentary_constituency":"Chorley","admin_district":"Chorley","parish":"Adlington","admin_county":"Lancashire","admin_ward":"Adlington and Anderton","ccg":"NHS Chorley and South Ribble","nuts":"Chorley and West Lancashire","codes":{"admin_district":"E07000118","admin_county":"E10000017","admin_ward":"E05005165","parish":"E04005139","parliamentary_constituency":"E14000637","ccg":"E38000034","nuts":"UKD47"}}]}

data/spec/lookup_terminated_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Postcodes::IO do
+  let(:base_url) { 'https://api.postcodes.io' }
+  let(:stub_response) { File.read('spec/fixtures/lookup_terminated_response.json') }
+
+  describe '#lookup_terminated' do
+    before :each do
+      stub_request(:get, "#{base_url}/terminated_postcodes/CM129TR")
+        .to_return(status: 200, body: stub_response)
+    end
+
+    let(:input) { 'CM12 9TR' }
+    let(:output) { subject.lookup_terminated(input) }
+
+    it 'requests a terminated postcode' do
+      output
+      WebMock.should have_requested(:get, "#{base_url}/terminated_postcodes/CM129TR")
+    end
+
+    it 'returns the long and lat' do
+      output.longitude.should == -1.316261
+      output.latitude.should == 51.062297
+    end
+  end
+end

data/spec/reverse_geocode_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+RSpec.describe Postcodes::IO, '#reverse_geocode' do
+  let(:latitiude) { '53.6099106263766' }
+  let(:longitude) { '2.60515477763266' }
+  let(:base_url) { 'https://api.postcodes.io' }
+  let(:url) { "#{base_url}/postcodes?lon=#{longitude}&lat=#{latitiude}&limit=10&radius=100&wideSearch=false" }
+  let(:no_results_response) do
+    File.read('spec/fixtures/no_results_response.json')
+  end
+  let(:reverse_geocode_response) do
+    File.read('spec/fixtures/reverse_geocode_response.json')
+  end
+
+  subject(:reverse_geocode) do
+    described_class.new.reverse_geocode(
+      longitude: longitude, latitude: latitiude)
+  end
+
+  context 'when a 400 is returned' do
+    before do
+      stub_request(:get, url).to_return(status: 400)
+    end
+
+    it { is_expected.to be_nil }
+  end
+
+  context 'when there are no results returned' do
+    before do
+      stub_request(:get, url).to_return(status: 200, body: no_results_response)
+    end
+
+    it { is_expected.to be_nil }
+  end
+
+  context 'when results are returned' do
+    before do
+      stub_request(:get, url)
+        .to_return(status: 200, body: reverse_geocode_response)
+    end
+
+    it 'returns the correct number of postcodes' do
+      expect(reverse_geocode.count).to eq(3)
+    end
+
+    it 'instantiates an object for each returned postcode' do
+      reverse_geocode.each do |result|
+        expect(result).to be_a(Postcodes::Postcode)
+      end
+    end
+  end
+end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: postcodes_io
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - James Ruston
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-17 00:00:00.000000000 Z
+date: 2021-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -87,8 +87,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/gem-push.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -98,15 +101,22 @@ files:
 - lib/postcodes_io/autocomplete_list.rb
 - lib/postcodes_io/base.rb
 - lib/postcodes_io/lookup.rb
+- lib/postcodes_io/lookup_terminated.rb
 - lib/postcodes_io/postcode.rb
+- lib/postcodes_io/reverse_geocode.rb
 - lib/postcodes_io/version.rb
 - postcodes_io.gemspec
 - spec/autocomplete_spec.rb
 - spec/fixtures/autocomplete_response.json
 - spec/fixtures/lookup_multi_response.json
 - spec/fixtures/lookup_response.json
+- spec/fixtures/lookup_terminated_response.json
+- spec/fixtures/no_results_response.json
+- spec/fixtures/reverse_geocode_response.json
 - spec/lookup_spec.rb
+- spec/lookup_terminated_spec.rb
 - spec/postcode_io_spec.rb
+- spec/reverse_geocode_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -127,8 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Lookup postcodes
@@ -137,6 +146,11 @@ test_files:
 - spec/fixtures/autocomplete_response.json
 - spec/fixtures/lookup_multi_response.json
 - spec/fixtures/lookup_response.json
+- spec/fixtures/lookup_terminated_response.json
+- spec/fixtures/no_results_response.json
+- spec/fixtures/reverse_geocode_response.json
 - spec/lookup_spec.rb
+- spec/lookup_terminated_spec.rb
 - spec/postcode_io_spec.rb
+- spec/reverse_geocode_spec.rb
 - spec/spec_helper.rb