mailcheckjs-rails 1.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f16068e538661a2bd3d0c07972632d065744f899
+  data.tar.gz: b5f79c6481ec9546dcb2ac41d80bdb6308d66383
+SHA512:
+  metadata.gz: d1b3ce74c9c4723eed2396bc72eb5c47a1cded2b63a0863c486c1b9e44e8c38fab781bb604f4178863610fce81be60f27633f98a923e0386fd86080ae7cbd3ac
+  data.tar.gz: cb3ac571669a08b9a60096582ddce7ea79f811d9e78c9f313523bb94aa82bd82aca4f43b05c0b32c7e4436a579c20f67ee99b5edef46e9ff9ed86be7e69f8bf3

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,51 @@
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc
+.ruby-gemset
+.ruby-version

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mailcheckjs-rails.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,88 @@
+PATH
+  remote: .
+  specs:
+    mailcheckjs-rails (1.0.5)
+      railties (>= 3.2, < 4.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (4.0.2)
+      activesupport (= 4.0.2)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activesupport (4.0.2)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.5)
+    atomic (1.1.14)
+    builder (3.1.4)
+    erubis (2.7.0)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.20)
+    httpauth (0.2.0)
+    i18n (0.6.9)
+    jeweler (1.8.8)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    minitest (4.7.5)
+    multi_json (1.8.2)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    railties (4.0.2)
+      actionpack (= 4.0.2)
+      activesupport (= 4.0.2)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.38)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  jeweler (~> 1.8.7)
+  mailcheckjs-rails!
+  rake
+  rdoc (~> 3.12)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Michael J. Cohen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,44 @@
+= mailcheckjs-rails
+
+{<img src="https://codeclimate.com/github/mjc/mailcheckjs-rails.png" />}[https://codeclimate.com/github/mjc/mailcheckjs-rails]
+
+mailcheckjs-rails wraps the {Mailcheck}[https://github.com/Kicksend/mailcheck] library in a rails engine for simple
+use with the asset pipeline provided by rails 4.  This gem incldues the development source, because the asset
+pipeline will minify in production.
+
+Mailcheck is "The Javascript library and jQuery plugin that suggests a right domain when your users misspell it in
+an email address."  Please see the {Mailcheck README}[https://github.com/Kicksend/mailcheck] for details.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mailcheckjs-rails'
+
+Add the following directive to your Javascript manifest file (application.js):
+
+    //= require mailcheck
+
+== Versioning
+
+mailcheckjs-rails 1.0.2 == Mailcheck 1.0.2
+
+Every attempt is made to mirror the currently shipping Mailcheck version number wherever possible.
+The major, minor, and patch version numbers will always represent the Mailcheck version. Should a gem
+bug be discovered, a 4th version identifier will be added and incremented.
+
+== Contributing to mailcheckjs-rails
+ 
+* 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 I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2013 Michael J. Cohen. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "mailcheckjs-rails"
+  gem.homepage = "http://github.com/mjc/mailcheckjs-rails"
+  gem.license = "MIT"
+  gem.summary = %Q{TODO: one-line summary of your gem}
+  gem.description = %Q{TODO: longer description of your gem}
+  gem.email = "mjc@kernel.org"
+  gem.authors = ["Michael J. Cohen"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mailcheckjs-rails #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/app/assets/javascripts/mailcheck.js

@@ -0,0 +1,209 @@
+/*
+ * Mailcheck https://github.com/Kicksend/mailcheck
+ * Author
+ * Derrick Ko (@derrickko)
+ *
+ * License
+ * Copyright (c) 2012 Receivd, Inc.
+ *
+ * Licensed under the MIT License.
+ *
+ * v 1.1
+ */
+
+var Kicksend = {
+  mailcheck : {
+    threshold: 3,
+
+    defaultDomains: ["yahoo.com", "google.com", "hotmail.com", "gmail.com", "me.com", "aol.com", "mac.com",
+      "live.com", "comcast.net", "googlemail.com", "msn.com", "hotmail.co.uk", "yahoo.co.uk",
+      "facebook.com", "verizon.net", "sbcglobal.net", "att.net", "gmx.com", "mail.com", "outlook.com", "icloud.com"],
+
+    defaultTopLevelDomains: ["co.jp", "co.uk", "com", "net", "org", "info", "edu", "gov", "mil", "ca"],
+
+    run: function(opts) {
+      opts.domains = opts.domains || Kicksend.mailcheck.defaultDomains;
+      opts.topLevelDomains = opts.topLevelDomains || Kicksend.mailcheck.defaultTopLevelDomains;
+      opts.distanceFunction = opts.distanceFunction || Kicksend.sift3Distance;
+
+      var defaultCallback = function(result){ return result }
+      var suggestedCallback = opts.suggested || defaultCallback
+      var emptyCallback = opts.empty || defaultCallback
+
+      var result = Kicksend.mailcheck.suggest(encodeURI(opts.email), opts.domains, opts.topLevelDomains, opts.distanceFunction);
+
+      return result ? suggestedCallback(result) : emptyCallback()
+    },
+
+    suggest: function(email, domains, topLevelDomains, distanceFunction) {
+      email = email.toLowerCase();
+
+      var emailParts = this.splitEmail(email);
+
+      var closestDomain = this.findClosestDomain(emailParts.domain, domains, distanceFunction);
+
+      if (closestDomain) {
+        if (closestDomain != emailParts.domain) {
+          // The email address closely matches one of the supplied domains; return a suggestion
+          return { address: emailParts.address, domain: closestDomain, full: emailParts.address + "@" + closestDomain };
+        }
+      } else {
+        // The email address does not closely match one of the supplied domains
+        var closestTopLevelDomain = this.findClosestDomain(emailParts.topLevelDomain, topLevelDomains);
+        if (emailParts.domain && closestTopLevelDomain && closestTopLevelDomain != emailParts.topLevelDomain) {
+          // The email address may have a mispelled top-level domain; return a suggestion
+          var domain = emailParts.domain;
+          closestDomain = domain.substring(0, domain.lastIndexOf(emailParts.topLevelDomain)) + closestTopLevelDomain;
+          return { address: emailParts.address, domain: closestDomain, full: emailParts.address + "@" + closestDomain };
+        }
+      }
+      /* The email address exactly matches one of the supplied domains, does not closely
+       * match any domain and does not appear to simply have a mispelled top-level domain,
+       * or is an invalid email address; do not return a suggestion.
+       */
+      return false;
+    },
+
+    findClosestDomain: function(domain, domains, distanceFunction) {
+      var dist;
+      var minDist = 99;
+      var closestDomain = null;
+
+      if (!domain || !domains) {
+        return false;
+      }
+      if(!distanceFunction) {
+        distanceFunction = this.sift3Distance;
+      }
+
+      for (var i = 0; i < domains.length; i++) {
+        if (domain === domains[i]) {
+          return domain;
+        }
+        dist = distanceFunction(domain, domains[i]);
+        if (dist < minDist) {
+          minDist = dist;
+          closestDomain = domains[i];
+        }
+      }
+
+      if (minDist <= this.threshold && closestDomain !== null) {
+        return closestDomain;
+      } else {
+        return false;
+      }
+    },
+
+    sift3Distance: function(s1, s2) {
+      // sift3: http://siderite.blogspot.com/2007/04/super-fast-and-accurate-string-distance.html
+      if (s1 == null || s1.length === 0) {
+        if (s2 == null || s2.length === 0) {
+          return 0;
+        } else {
+          return s2.length;
+        }
+      }
+
+      if (s2 == null || s2.length === 0) {
+        return s1.length;
+      }
+
+      var c = 0;
+      var offset1 = 0;
+      var offset2 = 0;
+      var lcs = 0;
+      var maxOffset = 5;
+
+      while ((c + offset1 < s1.length) && (c + offset2 < s2.length)) {
+        if (s1.charAt(c + offset1) == s2.charAt(c + offset2)) {
+          lcs++;
+        } else {
+          offset1 = 0;
+          offset2 = 0;
+          for (var i = 0; i < maxOffset; i++) {
+            if ((c + i < s1.length) && (s1.charAt(c + i) == s2.charAt(c))) {
+              offset1 = i;
+              break;
+            }
+            if ((c + i < s2.length) && (s1.charAt(c) == s2.charAt(c + i))) {
+              offset2 = i;
+              break;
+            }
+          }
+        }
+        c++;
+      }
+      return (s1.length + s2.length) /2 - lcs;
+    },
+
+    splitEmail: function(email) {
+      var parts = email.split('@');
+
+      if (parts.length < 2) {
+        return false;
+      }
+
+      for (var i = 0; i < parts.length; i++) {
+        if (parts[i] === '') {
+          return false;
+        }
+      }
+
+      var domain = parts.pop();
+      var domainParts = domain.split('.');
+      var tld = '';
+
+      if (domainParts.length == 0) {
+        // The address does not have a top-level domain
+        return false;
+      } else if (domainParts.length == 1) {
+        // The address has only a top-level domain (valid under RFC)
+        tld = domainParts[0];
+      } else {
+        // The address has a domain and a top-level domain
+        for (var i = 1; i < domainParts.length; i++) {
+          tld += domainParts[i] + '.';
+        }
+        if (domainParts.length >= 2) {
+          tld = tld.substring(0, tld.length - 1);
+        }
+      }
+
+      return {
+        topLevelDomain: tld,
+        domain: domain,
+        address: parts.join('@')
+      }
+    }
+  }
+};
+
+// Export the mailcheck object if we're in a CommonJS env (e.g. Node).
+// Modeled off of Underscore.js.
+if (typeof module !== 'undefined' && module.exports) {
+    module.exports = Kicksend.mailcheck;
+}
+
+if (typeof window !== 'undefined' && window.jQuery) {
+  (function($){
+    $.fn.mailcheck = function(opts) {
+      var self = this;
+      if (opts.suggested) {
+        var oldSuggested = opts.suggested;
+        opts.suggested = function(result) {
+          oldSuggested(self, result);
+        };
+      }
+
+      if (opts.empty) {
+        var oldEmpty = opts.empty;
+        opts.empty = function() {
+          oldEmpty.call(null, self);
+        };
+      }
+
+      opts.email = this.val();
+      Kicksend.mailcheck.run(opts);
+    }
+  })(jQuery);
+}

data/lib/mailcheckjs-rails.rb

@@ -0,0 +1,8 @@
+require "mailcheckjs-rails/version"
+
+module Mailcheckjs
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/mailcheckjs-rails/version.rb

@@ -0,0 +1,5 @@
+module Mailcheckjs
+  module Rails
+    VERSION = '1.0.5'
+  end
+end

data/mailcheckjs-rails.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mailcheckjs-rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mailcheckjs-rails"
+  spec.version       = Mailcheckjs::Rails::VERSION
+  spec.authors       = ["Michael J. Cohen"]
+  spec.email         = ["mjc@kernel.org"]
+  spec.description   = %q{Mailcheck.js for Rails'}
+  spec.summary       = %q{Mailcheck.js is a Javascript library and jQuery plugin that suggests a right domain when your users misspell it in an email address.}
+  spec.homepage      = "https://github.com/mjc/mailcheckjs-rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rdoc", "~> 3.12"
+  spec.add_development_dependency "jeweler", "~> 1.8.7"
+
+  spec.add_dependency 'railties', ">= 3.2", "< 4.3"
+end

data/test/helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'mailcheckjs-rails'
+
+class Test::Unit::TestCase
+end

data/test/test_mailcheckjs-rails.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestMailcheckjsRails < Test::Unit::TestCase
+  def test_something_for_real
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: mailcheckjs-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.5
+platform: ruby
+authors:
+- Michael J. Cohen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+description: Mailcheck.js for Rails'
+email:
+- mjc@kernel.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".document"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- app/assets/javascripts/mailcheck.js
+- lib/mailcheckjs-rails.rb
+- lib/mailcheckjs-rails/version.rb
+- mailcheckjs-rails.gemspec
+- test/helper.rb
+- test/test_mailcheckjs-rails.rb
+homepage: https://github.com/mjc/mailcheckjs-rails
+licenses:
+- MIT
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Mailcheck.js is a Javascript library and jQuery plugin that suggests a right
+  domain when your users misspell it in an email address.
+test_files:
+- test/helper.rb
+- test/test_mailcheckjs-rails.rb