mailgun_email_validator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c94647169b8b8b838a54f6500d51ec911dc1663b
+  data.tar.gz: 77cc1bd9cff8538baa022226e6b5d61af906e4a3
+SHA512:
+  metadata.gz: 31e8d500a4f3b12045fac399b1f88a3af613d3da561cc947306fd26e9d6596909963b1e5fa35e3b002588411bea7bf6b13f6203d0ecb1ebbe4efb1924e434387
+  data.tar.gz: 9a39cdab91bd17841504851620406ef202944ba85069bf0b3541eec2afbf45190802ed5b30558f9b797b58a07305feca9cdd4f8f4573a5a5833e65a5c20c623e

data/README.md

@@ -0,0 +1,39 @@
+# mailgun_email_validator
+
+This gem adds a ``validates_as_email_with_mailgun`` method to ActiveRecord. It first tries to verify an e-mail using the amazing Mailgun e-mail validation API and then falls back to using the [spectator_validates_email](https://github.com/spectator/validates_email) gem if it can't connect.
+
+## Usage
+
+Add the gem to your Rails project's Gemfile, then bundle install to get started.
+
+`gem 'mailgun_email_validator'`
+
+You'll need to add a ``MAILGUN_PUBLIC_KEY`` environmental variable to your system, for instance in your ``~/.bash_profile``:
+
+``export MAILGUN_PUBLIC_KEY='f23oifj3ojo2j3ofj32ijoj2iojf3iojoi2f32'``
+
+*Note: This is not a real Mailgun public key*
+
+
+To use mailgun_email_validator inside your models:
+
+`validates_as_email_with_mailgun :email`
+
+You can also specify many of the usual ActiveRecord validation options including ``:on``, ``:allow_nil``, ``:allow_blank``, and ``:message``.
+
+## Contributing to mailgun_email_validator
+
+Pull requests welcome.
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so we don't break it in a future version unintentionally.
+* Send in a pull request!
+
+
+## Credits
+
+* Zach Feldman [@zachfeldman](http://zfeldman.com)

data/lib/mailgun_email_validator/railtie.rb

@@ -0,0 +1,8 @@
+require "mailgun_email_validator/validator"
+module MailgunEmailValidator
+  class Railtie < Rails::Railtie
+    initializer "mailgun_email_validator.validator" do
+      ActiveRecord::Base.extend MailgunEmailValidator
+    end
+  end
+end

data/lib/mailgun_email_validator/validator.rb

@@ -0,0 +1,36 @@
+require 'rest_client'
+
+module MailgunEmailValidator
+  DEFAULT_VALIDATION_OPTIONS = {:on => :save, :allow_nil => false, :allow_blank => false, :message => nil}
+  
+  def validation_method(on)
+    case on
+      when :save   then :validate
+      when :create then :validate_on_create
+      when :update then :validate_on_update
+    end
+  end
+
+  def validates_as_email_with_mailgun(*attrs)
+    options = DEFAULT_VALIDATION_OPTIONS
+    options.update(attrs.extract_options!.symbolize_keys)
+
+    send(validation_method(options[:on]), options) do |record, attr, value|
+      if options[:allow_nil]
+        return if record.nil?
+      elsif options[:allow_blank]
+        return if record.blank?
+      else
+        begin
+          res = RestClient.get "https://api:#{ENV['MAILGUN_PUBLIC_KEY']}@api.mailgun.net/v2/address/validate", {params: {address: value}}
+          parsed = JSON.parse(res)
+          is_valid = !parsed["is_valid"].nil? ? parsed["is_valid"] : false
+          message = options[:message] ? options[:message] : "supplied email is invalid."
+          record.errors.add(attr, message) if !is_valid
+        rescue
+          validates record, email: true
+        end
+      end
+    end
+  end
+end

data/lib/mailgun_email_validator/version.rb

@@ -0,0 +1,3 @@
+module MailgunEmailValidator
+  VERSION = "0.0.1"
+end

data/lib/mailgun_email_validator.rb

@@ -0,0 +1 @@
+require 'mailgun_email_validator/railtie' if defined?(Rails)

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: mailgun_email_validator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Zach Feldman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: spectator-validates_email
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ability to validate e-mails using the Mailgun API with a REGEX fallback.
+email:
+- zachfeldman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mailgun_email_validator/railtie.rb
+- lib/mailgun_email_validator/validator.rb
+- lib/mailgun_email_validator/version.rb
+- lib/mailgun_email_validator.rb
+- README.md
+homepage: http://github.com/zachfeldman/mailgun_email_validator
+licenses:
+- GPL-3
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Ability to validate e-mails using the Mailgun API
+test_files: []