README¶ ↑

<img src=“https://badge.fury.io/rb/postcode_software.svg” alt=“Gem Version” />

<img src=“https://travis-ci.org/ianfleeton/postcode_software.svg” />

Unofficial Ruby wrapper for using the web SDK provided by postcodesoftware.net.

Installation¶ ↑

gem install postcode_software

Usage¶ ↑

require 'postcode_software'
PostcodeSoftware.account  = 'myaccount'
PostcodeSoftware.password = 'mypassword'
response = PostcodeSoftware.look_up('LS18 4AB')
response.address_1 # => "North Broadgate Lane"
response.address_2 # => "Horsforth"
response.town      # => "Leeds"
response.postcode  # => "LS18 4AB"
response.premises[0]
# => {:organisation=>nil, :building_details=>"Broadgate House", :number=>nil}