Postcode.io Ruby Client

Wrapper for Postcode.io API.

Requirements

Ruby > 1.9.x

Installation

Add this line to your application's Gemfile:

gem "postcodesio"

And then execute:

$ bundle

Or install it yourself as:

$ gem install postcodesio

Configuration

Postcodesio.configure do |config|
  config.base_url = "https://api.postcodes.io/"
  config.verbose = true
  config.logger = Rails.logger
end

Some configuration can be set by environment variables:

POSTCODESIO_BASE_URL="https://api.postcodes.io/"
POSTCODESIO_TIMEOUT=60000
POSTCODESIO_VERBOSE=true

base_url sets the Postcodes.io API url https://api.postcodes.io/
timeout sets the Postcodes.io API request timeout 3600
verbose should all output be printed to STDOUT false
logger Logger object. Logger

Usage

Reverse Geolocate

result = Postcodesio.locate(lat: 50.827152, lon: -3.591682)
result.as_hash # => { ... }

# Methods are dynamically defined based on headers. For example:
result.methods.sort # => [..., :postcode, :country]
result.postcode # => "EX17 4AZ"

PAW File

Download for PAW

Testing

# Includes Rubocop
$ bin/test

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Fork it ( https://github.com/chuckjhardy/Postcodesio/fork )
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create a new Pull Request

License

The gem is available as open source under the terms of the MIT License.

ChuckJHardy / Postcodesio