moneyadviceservice / postcode_anywhere-email_validation

Verify the existence of an email address.

PostcodeAnywhere::EmailValidation

[] build-status [] code-climate-feed [] coverage-status

Verifies the existence of an email address using the [Email Validation web services] email-validation from PostcodeAnywhere.

Installation

Add this line to your application's Gemfile:

gem 'postcode_anywhere-email_validation'

And then execute:

$ bundle

Or install it yourself as:

$ gem install postcode_anywhere-email_validation

Usage

PostcodeAnywhere::EmailValidation.key = 'AA11-AA11-AA11-AA11'
PostcodeAnywhere::EmailValidation.valid?('[e-mail]') #=> true

Or use the provided ActiveModel validator:

class ValidatedClass
  include ActiveModel::Validations

  attr_accessor :email

  validates_with PostcodeAnywhere::EmailValidation::Validator, attributes: %w{ email }
end

Usage with RSpec

With default attribute: :email

  it { should validate_email_with_postcode_anywhere }

With custom attribute.

  it { should validate_email_with_postcode_anywhere.on_attribute(:email) }

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request