postcodes_io 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad9cc32017365faafe6c67cf7d18da5aa5010e1b
-  data.tar.gz: b04650165b7ec3830d90f1fc5eec3ce617273868
+  metadata.gz: 196afbb36d87c52f7caeab5b4f071e38c374fb0d
+  data.tar.gz: 40c3c8ffd86ad103c4813d9b291b55c07537707b
 SHA512:
-  metadata.gz: ec45114d531178260c93decbc083b0b4b7d6a02ae45aee0730c6658d18b3b79d0a1b776387099dd6685e6826e9573d51d019f3d1eedc56aaad4277e424408485
-  data.tar.gz: 890e6ca0d609aaf1204a6269c6b3426b71e8c2a67d3c06651b40b663cb186238ecacf48f1a1180786f08a1a1cddf168e229b4e076a5dc29fcb947bad7d7c5c8c
+  metadata.gz: f54fc9694d50ac7e89e5976d0c8c07c6bda8daf4f47389ce8106d69f55acbb2744f691fe232c940d25220a6e64f32b3257da81c0dbe52cd9f7fae19540c35d66
+  data.tar.gz: b3ea796621c10a802e7e846f99f7bef95d2fbbf16663f1050199098a4977f02f43fb498b513a0f2643faa3f6aabe96473f4755626267e97765e298ad870352ff

data/README.md

@@ -26,7 +26,7 @@ Require the gem
 require 'PostcodesIO'
 ```
 
-Create new instance of the Postcode::IO
+Create new instance of the Postcodes::IO
 
 ```ruby
 pio = Postcodes::IO.new

data/lib/postcodes_io/lookup.rb

@@ -4,14 +4,56 @@ require 'postcodes_io/postcode'
 
 module Postcodes
   module Lookup
-    def lookup(postcode)
-      postcode.gsub!(/\s+/, '') # remove any whitespace. m1 1ab => m11ab
+
+
+    def lookup(*postcodes)
+      postcodes.flatten!
+      if postcodes.count > 1
+        lookup_multiple postcodes
+      else
+        lookup_postcode postcodes.first
+      end
+    end
+          
+
+    private
+
+    def lookup_postcode(postcode)
+      postcode = remove_whitespace postcode
       response = Excon.get("https://api.postcodes.io/postcodes/#{postcode}")
+
       unless response.status == 404
         parsed_response = JSON.parse(response.body)
         return Postcodes::Postcode.new(parsed_response['result'])
       end
       return nil
     end
+
+    def lookup_multiple(postcodes)
+      payload = {postcodes: postcodes.map {|p| remove_whitespace p}}
+      response = Excon.post(
+        "https://api.postcodes.io/postcodes",
+         body: payload.to_json,
+         headers: {'Content-Type' => 'application/json'}
+         )
+
+      process_response(response) do |r|
+        return r['result'].map do |result|
+          Postcodes::Postcode.new(result['result'])
+        end
+      end
+    end
+
+    def remove_whitespace(string)
+      string.gsub(/\s+/, '') # remove any whitespace. m1 1ab => m11ab
+    end
+
+    def process_response(response, &block)
+      unless response.status == 404
+        yield JSON.parse(response.body)
+      end
+      nil
+    end
+
   end
 end

data/lib/postcodes_io/postcode.rb

@@ -9,8 +9,8 @@ module Postcodes
 
     # allow accessing info values with dot notation
     def method_missing(name, *args, &block)
+      return @info[name.to_s] if @info.key? name.to_s
       return @info[name] if @info.key? name
-      @info.each { |k,v| return v if k.to_s.to_sym == name }
       super.method_missing name
     end
   end

data/lib/postcodes_io/version.rb

@@ -1,3 +1,3 @@
 module Postcodes
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/fixtures/lookup_multi_response.json

@@ -0,0 +1,86 @@
+{
+    "status": 200,
+    "result": [
+        {
+            "query": "OX49 5NU",
+            "result": {
+                "postcode": "OX49 5NU",
+                "quality": 1,
+                "eastings": 464435,
+                "northings": 195686,
+                "country": "England",
+                "nhs_ha": "South Central",
+                "admin_county": "Oxfordshire",
+                "admin_district": "South Oxfordshire",
+                "admin_ward": "Benson",
+                "longitude": -1.06993881320412,
+                "latitude": 51.6562791294687,
+                "parliamentary_constituency": "Henley",
+                "european_electoral_region": "South East",
+                "primary_care_trust": "Oxfordshire",
+                "region": "South East",
+                "parish": "Brightwell Baldwin",
+                "lsoa": "South Oxfordshire 011B",
+                "msoa": "South Oxfordshire 011",
+                "nuts": "Benson",
+                "incode": "5NU",
+                "outcode": "OX49",
+                "ccg": "NHS Oxfordshire CCG"
+            }
+        },
+        {
+            "query": "M32 0JG",
+            "result": {
+                "postcode": "M32 0JG",
+                "quality": 1,
+                "eastings": 379988,
+                "northings": 395476,
+                "country": "England",
+                "nhs_ha": "North West",
+                "admin_county": null,
+                "admin_district": "Trafford",
+                "admin_ward": "Gorse Hill",
+                "longitude": -2.30283674284007,
+                "latitude": 53.4556572899372,
+                "parliamentary_constituency": "Stretford and Urmston",
+                "european_electoral_region": "North West",
+                "primary_care_trust": "Trafford",
+                "region": "North West",
+                "parish": null,
+                "lsoa": "Trafford 003C",
+                "msoa": "Trafford 003",
+                "nuts": "Gorse Hill",
+                "incode": "0JG",
+                "outcode": "M32",
+                "ccg": "NHS Trafford CCG"
+            }
+        },
+        {
+            "query": "NE30 1DP",
+            "result": {
+                "postcode": "NE30 1DP",
+                "quality": 1,
+                "eastings": 435982,
+                "northings": 568683,
+                "country": "England",
+                "nhs_ha": "North East",
+                "admin_county": null,
+                "admin_district": "North Tyneside",
+                "admin_ward": "Tynemouth",
+                "longitude": -1.43889223951028,
+                "latitude": 55.0114112900573,
+                "parliamentary_constituency": "Tynemouth",
+                "european_electoral_region": "North East",
+                "primary_care_trust": "North Tyneside",
+                "region": "North East",
+                "parish": null,
+                "lsoa": "North Tyneside 016C",
+                "msoa": "North Tyneside 016",
+                "nuts": "Tynemouth",
+                "incode": "1DP",
+                "outcode": "NE30",
+                "ccg": "NHS North Tyneside CCG"
+            }
+        }
+    ]
+}

data/spec/postcode_io_spec.rb

@@ -3,14 +3,16 @@ require 'spec_helper'
 describe Postcodes::IO do
 
   let(:base_url) {'https://api.postcodes.io'}
-  let(:stub_response) { File.read('spec/fixtures/lookup_response.json') }
-
-  before :each do
-    stub_request(:get, "#{base_url}/postcodes/CM129TR")
-    .to_return(status: 200, body: stub_response)
-  end
+  let(:stub_single_response) { File.read('spec/fixtures/lookup_response.json') }
+  let(:stub_multi_response) { File.read('spec/fixtures/lookup_multi_response.json') }
 
   describe '#lookup' do
+
+    before :each do
+      stub_request(:get, "#{base_url}/postcodes/CM129TR")
+        .to_return(status: 200, body: stub_single_response)
+    end
+
     let(:input) { 'CM12 9TR' }
     let(:output) { subject.lookup(input) }
 
@@ -22,6 +24,39 @@ describe Postcodes::IO do
     it 'returns the long and lat' do
       output.longitude.should == 0.411227930206834
     end
+  end
+
+  describe '#lookup with multiple postcodes' do
+    before :each do
+      stub_request(:post, "#{base_url}/postcodes")
+        .with(body: postcode_payload, headers: {'Content-Type' => 'application/json'})
+        .to_return(status: 200, body: stub_multi_response)
+    end
 
+    let(:input) { ['OX495NU', 'M320JG', 'NE301DP'] }
+    let(:output) { subject.lookup(input) }
+    let(:postcode_payload) { {postcodes: input}.to_json }
+    
+    it 'makes a request with mutliple postcodes' do
+      output
+      WebMock.should have_requested(:post, "#{base_url}/postcodes")
+    end
+
+    it 'returns a postcode object for each result' do
+      output.count.should == 3
+      output.each do |o|
+        o.class.should == Postcodes::Postcode
+      end
+    end
+
+    describe 'as splat' do
+      let(:output) { subject.lookup('OX495NU', 'M320JG', 'NE301DP') }
+      
+      it 'allows passing postcodes as multiple arguments' do
+        output
+        WebMock.should have_requested(:post, "#{base_url}/postcodes")
+      end
+
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postcodes_io
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - James Ruston
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-20 00:00:00.000000000 Z
+date: 2014-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,6 +98,7 @@ files:
 - lib/postcodes_io/postcode.rb
 - lib/postcodes_io/version.rb
 - postcodes_io.gemspec
+- spec/fixtures/lookup_multi_response.json
 - spec/fixtures/lookup_response.json
 - spec/postcode_io_spec.rb
 - spec/spec_helper.rb
@@ -126,6 +127,7 @@ signing_key:
 specification_version: 4
 summary: Lookup postcodes
 test_files:
+- spec/fixtures/lookup_multi_response.json
 - spec/fixtures/lookup_response.json
 - spec/postcode_io_spec.rb
 - spec/spec_helper.rb