PostcodeValidation

This gem provides basic postcode validation functionality which can be used in any application

It also comes with out of the box plugins for:

  • Solidus

Installation

Add this line to your application's Gemfile:

gem 'postcode_validation'

And then execute:

$ bundle

Or install it yourself as:

$ gem install postcode_validation

Usage

Using with Solidus

TODO

Bespoke application usage

use_case = PostcodeValidation::UseCase::ValidateAddress.new(
  address_match_gateway: PostcodeValidation::Gateway::PCAPotentialAddressMatch.new
)

valid = use_case.execute(postcode: 'SE10SW', country: 'GB')[:valid?]

Country must be a valid 2-letter ISO country code. Postcode is the postcode under test.

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/madetech/postcode_validation.

License

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

Credits

Developed and maintained by Made.

made

Key contributions: