mrsool / zerobounce

Zerobounce Ruby client

Zerobounce

A ruby client for Zerobounce.net API.

Installation

Add this line to your application's Gemfile:

gem 'zerobounce'

And then execute:

$ bundle

Or install it yourself as:

$ gem install zerobounce

Usage

# Configure the client
Zerobounce.configure do |config|
  config.apikey = 'key'
  config.valid_statuses = [:valid, :catch_all, :unknown]
end

resp = Zerobounce.validate(email: '[email protected]')
resp.valid? # => true

# Change what is considered a valid status
Zerobounce.valid?('[email protected]') # => false
Zerobounce.config.valid_statuses = [:invalid]
Zerobounce.valid?('[email protected]') # => true

# Use a different API key for one request
Zerobounce.validate(email: '[email protected]', apikey: 'different-api-key')

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/afrase/zerobounce. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

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

Code of Conduct

Everyone interacting in the Zerobounce project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.