CraftyClicks

A simple wrapper around the CraftyClicks APIs 🌍

ClickToAddress | RapidAddress

Installation

Add this line to your application's Gemfile:

gem 'craftyclicks-ruby'

And then execute:

$ bundle

Or install it yourself as:

$ gem install craftyclicks-ruby

Usage

Set your API key

require 'crafty_clicks'

CraftyClicks.configure do |c|
  c.api_key = 'API_KEY'
end

Address lookup:

CraftyClicks::AddressLookup.find(query: 'Buckingham Palace', country: 'GB')
CraftyClicks::AddressLookup.retrieve(id: '26086283', country: 'GB')

Postcode lookup

CraftyClicks::PostcodeLookup.full_address(postcode: 'AA11AA')
CraftyClicks::PostcodeLookup.basic_address(postcode: 'AA11AA')
CraftyClicks::PostcodeLookup.geocode(postcodes: ['AA11AA', 'AA11AB'])

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also 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, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/JoeSouthan/craftyclicks-ruby.

License

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