postcodes_io 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 196afbb36d87c52f7caeab5b4f071e38c374fb0d
-  data.tar.gz: 40c3c8ffd86ad103c4813d9b291b55c07537707b
+  metadata.gz: a025c5964930e2fdd31f1d4ac696d14ef8db7244
+  data.tar.gz: 3d5e0090a957e1a6af46f68d1204eb0c2ee9b5a9
 SHA512:
-  metadata.gz: f54fc9694d50ac7e89e5976d0c8c07c6bda8daf4f47389ce8106d69f55acbb2744f691fe232c940d25220a6e64f32b3257da81c0dbe52cd9f7fae19540c35d66
-  data.tar.gz: b3ea796621c10a802e7e846f99f7bef95d2fbbf16663f1050199098a4977f02f43fb498b513a0f2643faa3f6aabe96473f4755626267e97765e298ad870352ff
+  metadata.gz: 5ca6179bdb36644e0d64dc65f3ff37efa574cbe9e0440200ef788514de7728c9c6d0fa95c87adaa258022f0d8aca834d4c0177c4ef8de817ab2610bc6e98727d
+  data.tar.gz: 1cc677ceaf30e1c0db12e0c44d604a77b35b44d05533a81440e545553806fca89f1f7222bfaa8b1fa321b9fd8f4b00a9cb78ae35b8b8048896e331349a7e3ea6

data/.gitignore

@@ -12,3 +12,4 @@
 *.o
 *.a
 mkmf.log
+.idea/

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 TODO: Write your name
+Copyright (c) 2015 James Ruston
 
 MIT License
 

data/README.md

@@ -23,7 +23,7 @@ Or install it yourself as:
 Require the gem
 
 ```ruby
-require 'PostcodesIO'
+require 'postcodes_io'
 ```
 
 Create new instance of the Postcodes::IO
@@ -32,7 +32,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,6 +43,24 @@ postcode.longitude # -1.02144562675883
 postcode.latitude # 52.0776806788868
 ```
 
+####Make a batch postcode lookup request
+
+> max 100 postcodes per request
+
+```ruby
+postcodes = pio.lookup('NN12 8TN', 'DA3 8NG') # or pio.lookup(['NN12 8TN', 'DA3 8NG'])
+postcodes.each do |p|
+  puts p.nuts
+end
+```
+
+####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
 
 |name|description|

data/lib/postcodes_io.rb

@@ -1,9 +1,11 @@
 require "postcodes_io/version"
 require "postcodes_io/lookup"
+require "postcodes_io/autocomplete"
 require "postcodes_io/postcode"
 
 module Postcodes
   class IO
     include Lookup
+    include Autocomplete
   end
 end

data/lib/postcodes_io/autocomplete.rb

@@ -0,0 +1,37 @@
+require 'excon'
+require 'json'
+require 'postcodes_io/autocomplete_list'
+
+module Postcodes
+  module Autocomplete
+
+    def autocomplete(postcode)
+      autocomplete_postcode postcode
+    end
+
+    private
+
+    def autocomplete_postcode(postcode)
+      postcode = remove_whitespace postcode
+      response = Excon.get("https://api.postcodes.io/postcodes/#{postcode}/autocomplete")
+
+      unless response.status == 404
+        parsed_response = JSON.parse(response.body)
+        return Postcodes::AutocompleteList.new(parsed_response['result'])
+      end
+      return nil
+    end
+
+    def remove_whitespace(string)
+      string.gsub(/\s+/, '')
+    end
+
+    def process_response(response, &block)
+      unless response.status == 404
+        yield JSON.parse(response.body)
+      end
+      nil
+    end
+
+  end
+end

data/lib/postcodes_io/autocomplete_list.rb

@@ -0,0 +1,12 @@
+require "postcodes_io/base"
+
+module Postcodes
+  class AutocompleteList < Base
+
+    attr_reader :list
+
+    def initialize(list)
+      @list = list
+    end
+  end
+end

data/lib/postcodes_io/base.rb

@@ -0,0 +1,10 @@
+module Postcodes
+  class Base
+    # 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
+      super.method_missing name
+    end
+  end
+end

data/lib/postcodes_io/postcode.rb

@@ -1,17 +1,12 @@
+require "postcodes_io/base"
+
 module Postcodes
-  class Postcode
+  class Postcode < Base
 
     attr_reader :info
 
     def initialize(info)
       @info = info
     end
-
-    # 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
-      super.method_missing name
-    end
   end
 end

data/lib/postcodes_io/version.rb

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

data/spec/autocomplete_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Postcodes::IO do
+
+  let(:base_url) {'https://api.postcodes.io'}
+  let(:stub_autocomplete) { File.read('spec/fixtures/autocomplete_response.json') }
+
+  describe '#autocomplete' do
+
+    before :each do
+      stub_request(:get, "#{base_url}/postcodes/NN10/autocomplete")
+          .to_return(status: 200, body: stub_autocomplete)
+    end
+
+    let(:input) { 'NN10' }
+    let(:output) { subject.autocomplete(input) }
+
+    it 'requests a postcode' do
+      output
+      WebMock.should have_requested(:get, "#{base_url}/postcodes/NN10/autocomplete")
+    end
+
+    it 'returns autocompleted array' do
+      expect(output.list).to eq(["NN10 0AA",
+                                 "NN10 0AD",
+                                 "NN10 0AE",
+                                 "NN10 0AF",
+                                 "NN10 0AG",
+                                 "NN10 0AH",
+                                 "NN10 0AJ",
+                                 "NN10 0AL",
+                                 "NN10 0AN",
+                                 "NN10 0AP"])
+    end
+  end
+end

data/spec/fixtures/autocomplete_response.json

@@ -0,0 +1,14 @@
+{
+  "result": [
+    "NN10 0AA",
+    "NN10 0AD",
+    "NN10 0AE",
+    "NN10 0AF",
+    "NN10 0AG",
+    "NN10 0AH",
+    "NN10 0AJ",
+    "NN10 0AL",
+    "NN10 0AN",
+    "NN10 0AP"
+  ]
+}

data/spec/lookup_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe Postcodes::IO do
+
+  let(:base_url) {'https://api.postcodes.io'}
+  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) }
+
+    it 'requests a postcode' do
+      output
+      WebMock.should have_requested(:get, "#{base_url}/postcodes/CM129TR")
+    end
+
+    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

data/spec/postcode_io_spec.rb

@@ -2,61 +2,4 @@ require 'spec_helper'
 
 describe Postcodes::IO do
 
-  let(:base_url) {'https://api.postcodes.io'}
-  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) }
-
-    it 'requests a postcode' do
-      output
-      WebMock.should have_requested(:get, "#{base_url}/postcodes/CM129TR")
-    end
-
-    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,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: postcodes_io
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - James Ruston
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-21 00:00:00.000000000 Z
+date: 2017-02-17 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'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !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: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   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: excon
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.39'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.39'
 description: Get rich data from postcode lookups. Wraps postcodes.io
@@ -87,19 +87,25 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/postcodes_io.rb
+- lib/postcodes_io/autocomplete.rb
+- lib/postcodes_io/autocomplete_list.rb
+- lib/postcodes_io/base.rb
 - lib/postcodes_io/lookup.rb
 - lib/postcodes_io/postcode.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/lookup_spec.rb
 - spec/postcode_io_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -112,22 +118,25 @@ 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.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Lookup postcodes
 test_files:
+- spec/autocomplete_spec.rb
+- spec/fixtures/autocomplete_response.json
 - spec/fixtures/lookup_multi_response.json
 - spec/fixtures/lookup_response.json
+- spec/lookup_spec.rb
 - spec/postcode_io_spec.rb
 - spec/spec_helper.rb