https://github.com/madetech/postcode_validation
https://github.com/madetech/postcode_validation
postcode solidus spree validation
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/madetech/postcode_validation
- Owner: madetech
- License: mit
- Created: 2016-12-06T13:53:56.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-09-29T13:16:25.000Z (over 8 years ago)
- Last Synced: 2025-01-25T14:11:51.244Z (12 months ago)
- Topics: postcode, solidus, spree, validation
- Language: Ruby
- Size: 87.9 KB
- Stars: 2
- Watchers: 41
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# PostcodeValidation [](https://travis-ci.org/madetech/postcode_validation)
This gem provides basic postcode validation functionality which can be used in any application
The specific validation that we perform goes beyond simple regex matching, to determine if the postcode actually exists.
To do this it uses PCAPredict.com's Capture+ API.
By leveraging this service we are able to provide validation against country's postcode that they support.
It also comes with out of the box plugins for:
- Solidus
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'postcode_validation'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install postcode_validation
## Usage
This gem relies on ```ENV['POSTCODE_ANYWHERE_KEY']``` being set to a valid PCAPredict service key for Capture+.
One of the easiest ways to do this is to use the ```dotenv``` gem for this in your host application.
### Using with Solidus
```ruby
require 'postcode_validation'
require 'postcode_validation/plugins/solidus'
Spree::Order.include(PostcodeValidation::SpreeOrderPostcodeValid)
````
NB: Error reporting currently only works with a Tagged Logger
### Bespoke application usage
```ruby
require 'postcode_validation'
use_case = PostcodeValidation::UseCase::ValidateAddress.new(
address_match_gateway: PostcodeValidation::Gateway::PCAPotentialAddressMatch.new
)
valid = use_case.execute(postcode: 'SE10SW', country: 'GB')[:valid?]
```
```
> valid
true
```
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](https://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](http://opensource.org/licenses/MIT).
## Credits
Developed and maintained by [Made](http://www.madetech.co.uk?ref=github&repo=postcode_validation).
[](http://www.madetech.co.uk?ref=github&repo=postcode_validation)
Key contributions:
* [Craig J. Bass](https://github.com/craigjbass)
* [Seb Ashton](https://github.com/sebashton)
* [Chris Blackburn](https://github.com/chrisblackburn)