mailchecker 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,11 @@
 # Mailchecker
 
-TODO: Write a gem description
+Simply validate your email in 3 steps using Mail-checker web service (http://www.mail-checker.com).
+- Validate the format of your email
+- Validate if the domain is responding 
+- Validate if the email is not a temporary mail (like yopmail or others...)
+
+This will be very helpful when you have to contact your users and you want to avoid errors causing lack of communication or want to block "spamboxes"
 
 ## Installation
 
@@ -18,7 +23,30 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Register your application in Mail-checker.com (http://www.mail-checker.com/apps/new).
+Generate the config file for the gem
+
+    $ rails generate mailchecker:install
+    
+Update the file (config/initializers/mailchecker.rb) with the values of your registered application (token and domain)
+
+Now you have two ways to do the validation:
+
+On the server side: 
+
+Add in your model the validation of your attribute for the email (hopefully email)
+    
+    class User < ActiveRecord::Base
+      mailchecker :email
+    end
+
+On the client side:
+
+Call the javascript lib on your email fields and do the stuff you need on the generated file
+
+    $ rails generate mailchecker:assets
+
+Of course you can do the validation on the both side if you want
 
 ## Contributing
 

data/lib/generators/mailchecker/assets_generator.rb

@@ -0,0 +1,13 @@
+module Mailchecker
+  module Generators
+    class AssetsGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Create the javascript file to make the validation in client side."
+
+      def copy_javascript
+        template "assets/mailchecker.js.coffee.erb", "app/assets/javascripts/mailchecker_client.js.coffee.erb"
+      end
+    end
+  end
+end

data/lib/generators/mailchecker/install_generator.rb

@@ -0,0 +1,18 @@
+module Mailchecker
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates a Mail-checker initializer and copy locale files to your application."
+
+      def copy_initializer
+        template "mailchecker.rb", "config/initializers/mailchecker.rb"
+      end
+
+      def copy_locales
+        copy_file "../../../locales/en.yml", "config/locales/mailchecker.en.yml"
+        copy_file "../../../locales/fr.yml", "config/locales/mailchecker.fr.yml"
+      end
+    end
+  end
+end

data/lib/generators/templates/assets/mailchecker.js.coffee.erb

@@ -0,0 +1,7 @@
+#= require mailchecker
+
+$("input[type=email]").mail_checker '<%= Mailchecker.token %>', 
+  success:        -> console.log "email #{$(this).val()} is valid"                # do what you whant when it's ok
+  invalid_format: -> console.error "format of #{$(this).val()} isn't valid"       # do what you whant when the format is not good
+  invalid_domain: -> console.error "domain of #{$(this).val()} is not responding" # do what you whant when the domain is not responding
+  temporary_mail: -> console.error "email #{$(this).val()} is a temporary mail"   # do what you whant when it's a temporary mail

data/lib/generators/templates/mailchecker.rb

@@ -0,0 +1,6 @@
+Mailchecker.setup do |config|
+  # Here you need to declare your token key and your application domain
+  # to have this, please register your application on http://www.mail-checker.com
+  config.token = "your_token_key"
+  config.domain = "your_app_domain"
+end

data/lib/mailchecker/version.rb

@@ -1,3 +1,3 @@
 module Mailchecker
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/locales/en.yml

@@ -0,0 +1,7 @@
+en:
+  mailchecker:
+    errors:
+      messages:
+        wrong_format: "the format is not valid (abc@example.com)"
+        wrong_gateway: "the domain is not responding"
+        temporary_email: "this kind of email is not valid (temporary email)"

data/locales/fr.yml

@@ -0,0 +1,7 @@
+fr:
+  mailchecker:
+    errors:
+      messages:
+        wrong_format: "le format n'est pas valide (abc@exemple.com)"
+        wrong_gateway: "le domaine ne répond pas"
+        temporary_email: "ce type d'email n'est pas valide (email temporaire)"

data/vendor/assets/javascripts/mailchecker.js.coffee.erb

@@ -0,0 +1,42 @@
+$.fn.mail_checker = (token, options) ->
+  if typeof token is 'object'
+    options = token
+    token = null
+  
+  defaults = 
+    token: null
+    trigger_on: "change"
+    success:        () ->
+    invalid_format: () ->
+    invalid_domain: () ->
+    temporary_mail: () ->
+    error:          (error) -> console.error(error)
+  
+  domain = document.domain.match /([^.]+)\.[^.]+.?$/
+
+  domain = domain[0] if domain and domain.length > 0
+  options = $.extend {}, defaults, options
+  
+  unless token
+    token = options.token
+    unless token
+      console.error "Missing token parameter"
+      return
+
+  $(this).bind options.trigger_on, ->
+    _this = this
+    data =
+      token: token
+      domain: domain
+      email: $(this).val()
+    $.ajax
+      url: "<%= Mailchecker.url %>"
+      data: data
+      dataType: "json"
+      complete: (jqXHR, textStatus) ->
+        options.success.apply(_this)         if jqXHR.status is 200
+        options.invalid_format.apply(_this)  if jqXHR.status is 422
+        options.invalid_domain.apply(_this)  if jqXHR.status is 502
+        options.temporary_mail.apply(_this)  if jqXHR.status is 406
+        options.error.apply(_this, [$.parseJSON(jqXHR.responseText).error]) if jqXHR.status is 400
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailchecker
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -25,9 +25,16 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/mailchecker/assets_generator.rb
+- lib/generators/mailchecker/install_generator.rb
+- lib/generators/templates/assets/mailchecker.js.coffee.erb
+- lib/generators/templates/mailchecker.rb
 - lib/mailchecker.rb
 - lib/mailchecker/version.rb
+- locales/en.yml
+- locales/fr.yml
 - mailchecker.gemspec
+- vendor/assets/javascripts/mailchecker.js.coffee.erb
 homepage: http://www.mail-checker.com/
 licenses: []
 post_install_message: