postcodes_io 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad9cc32017365faafe6c67cf7d18da5aa5010e1b
+  data.tar.gz: b04650165b7ec3830d90f1fc5eec3ce617273868
+SHA512:
+  metadata.gz: ec45114d531178260c93decbc083b0b4b7d6a02ae45aee0730c6658d18b3b79d0a1b776387099dd6685e6826e9573d51d019f3d1eedc56aaad4277e424408485
+  data.tar.gz: 890e6ca0d609aaf1204a6269c6b3426b71e8c2a67d3c06651b40b663cb186238ecacf48f1a1180786f08a1a1cddf168e229b4e076a5dc29fcb947bad7d7c5c8c

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in postcodes_io.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TODO: Write your name
+
+MIT License
+
+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,78 @@
+# PostcodesIo
+
+A simple wrapper around [postcodes.io](http://postcodes.io/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'postcodes_io'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install postcodes_io
+
+## Usage
+
+Require the gem
+
+```ruby
+require 'PostcodesIO'
+```
+
+Create new instance of the Postcode::IO
+
+```ruby
+pio = Postcodes::IO.new
+```
+
+Lookup a postcode
+```ruby
+postcode = pio.lookup('NN12 8TN')
+```
+
+Inspect the results!
+```ruby
+postcode.longitude # -1.02144562675883
+postcode.latitude # 52.0776806788868
+```
+
+##All available fields
+
+|name|description|
+|----|-----------|
+|postcode| pretty formatted postcode|
+|quality| 1-9 value of the quality of the grid reference |
+|eastings| OS grid reference |
+|northings | OS grid reference |
+|country | The code for the appropriate country|
+|nhs_ha | The health area code for the postcode |
+|admin_county | The county the postcode has been assigned |
+|admin_district| The current district/unitary authority to which the postcode has been assigned |
+|admin_ward| The current administrative/electoral area to which the postcode has been assigned |
+|longitude| The WGS84 longitude |
+|latitude| The WGS84 latitude |
+|parliamentary_constituency| he Westminster Parliamentary Constituency|
+|european_electoral_region| The European Electoral Region code|
+|primary_care_trust| The code for the Primary Care area |
+|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)|
+|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 )
+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`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+task :console do
+  exec "irb -r postcodes_io -I ./lib"
+end

data/lib/postcodes_io/lookup.rb

@@ -0,0 +1,17 @@
+require 'excon'
+require 'json'
+require 'postcodes_io/postcode'
+
+module Postcodes
+  module Lookup
+    def lookup(postcode)
+      postcode.gsub!(/\s+/, '') # remove any whitespace. m1 1ab => m11ab
+      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
+  end
+end

data/lib/postcodes_io/postcode.rb

@@ -0,0 +1,17 @@
+module Postcodes
+  class Postcode
+
+    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] if @info.key? name
+      @info.each { |k,v| return v if k.to_s.to_sym == name }
+      super.method_missing name
+    end
+  end
+end

data/lib/postcodes_io/version.rb

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

data/lib/postcodes_io.rb

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

data/postcodes_io.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'postcodes_io/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "postcodes_io"
+  spec.version       = Postcodes::VERSION
+  spec.authors       = ["James Ruston"]
+  spec.email         = ["jruston90@gmail.com"]
+  spec.summary       = %q{Lookup postcodes}
+  spec.description   = %q{Get rich data from postcode lookups. Wraps postcodes.io}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  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 "rspec"
+  spec.add_development_dependency "webmock"
+
+  spec.add_runtime_dependency "excon", "~> 0.39"
+end

data/spec/fixtures/lookup_response.json

@@ -0,0 +1,27 @@
+{
+    "status": 200,
+    "result": {
+        "postcode": "CM12 9TR",
+        "quality": 1,
+        "eastings": 567111,
+        "northings": 191249,
+        "country": "England",
+        "nhs_ha": "East of England",
+        "admin_county": "Essex",
+        "admin_district": "Basildon",
+        "admin_ward": "Burstead",
+        "longitude": 0.411227930206834,
+        "latitude": 51.5953004291798,
+        "parliamentary_constituency": "Basildon and Billericay",
+        "european_electoral_region": "Eastern",
+        "primary_care_trust": "South West Essex",
+        "region": "East of England",
+        "parish": "Little Burstead",
+        "lsoa": "Basildon 009A",
+        "msoa": "Basildon 009",
+        "nuts": "Burstead",
+        "incode": "9TR",
+        "outcode": "CM12",
+        "ccg": "NHS Basildon and Brentwood CCG"
+    }
+}

data/spec/postcode_io_spec.rb

@@ -0,0 +1,27 @@
+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
+
+  describe '#lookup' do
+    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
+end

data/spec/spec_helper.rb

@@ -0,0 +1,65 @@
+require 'webmock/rspec'
+require 'postcodes_io'
+
+RSpec.configure do |config|
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+=end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: postcodes_io
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Ruston
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-20 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
+email:
+- jruston90@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/postcodes_io.rb
+- lib/postcodes_io/lookup.rb
+- lib/postcodes_io/postcode.rb
+- lib/postcodes_io/version.rb
+- postcodes_io.gemspec
+- spec/fixtures/lookup_response.json
+- spec/postcode_io_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Lookup postcodes
+test_files:
+- spec/fixtures/lookup_response.json
+- spec/postcode_io_spec.rb
+- spec/spec_helper.rb