canonical-emails 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+pkg

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.1.0 (6/22/2013)
+
+* Initial public release, written on a plane from NYC to SF - [@dblock](https://github.com/dblock).

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem "rspec"
+gem "rake"

data/LICENSE.md

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2013 Daniel Doubrovkine.
+
+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.md

@@ -0,0 +1,100 @@
+CanonicalEmails
+==============
+
+[![Build Status](https://travis-ci.org/dblock/canonical-emails.png)](https://travis-ci.org/dblock/canonical-emails)
+
+Combine email validation and transformations to produce canonical email addresses. For example, parse and transform `Donald Duck <donald.duck@gmail.com>` into `donaldduck@gmail.com`, for `@gmail.com` addresses only. Patches instances of `Mail::Address`.
+
+### Install
+
+Add `canonical-emails` to your Gemfile.
+
+```
+gem 'canonical-emails'
+```
+
+### Use
+
+``` ruby
+class User
+  include CanonicalEmails::Extensions
+
+  attr_accessor :email
+  canonical_email :email, CanonicalEmails::GMail
+end
+
+user = User.new
+user.email = "Donald Duck <Donald.Duck@gmail.com>"
+user.canonical_email.class # Mail::Address
+user.canonical_email.to_s # "Donald Duck <donaldduck@gmail.com>"
+user.canonical_email.address # "donaldduck@gmail.com"
+``` 
+
+### Transform
+
+#### CanonicalEmails::Downcase
+
+Replaces the address and domain portion of the email by its lowercase equivalent.
+
+``` ruby
+email = CanonicalEmails::Downcase.transform("Donald Duck <DoNaLD.DuCK@eXaMPLe.CoM>")
+email.to_s # "Donald Duck <donald.duck@example.com>"
+email.address # "donald.duck@example.com"
+```
+
+#### CanonicalEmails::GMail
+
+Gmail.com e-mail addresses ignore periods and aren't case-sensitive. The canonical version removes them and changes the address portion to lowercase.
+
+``` ruby
+email = CanonicalEmails::GMail.transform("Donald Duck <donald.duck@gmail.com>")
+email.to_s # "Donald Duck <donaldduck@gmail.com>"
+email.local # "donaldduck"
+email.address # "donaldduck@gmail.com"
+```
+
+### Multiple Transformations
+
+Combine multiple transformations, executed from left to right.
+
+```
+canonical_email :email, CanonicalEmails::GMail, CanonicalEmails::...
+```
+
+### Custom Transformations
+
+A transformation is a module that has a single `transform` method that returns a `Mail::Address` instance. This library patches internal methods of the `Mail::Address` class.
+
+``` ruby
+module CanonicalEmails
+  module ReverseName
+    def self.transform(value)
+      Mail::Address.new(value).tap do |email|
+        email.instance_eval do
+          def name
+            super.reverse
+          end
+        end
+      end
+    end
+  end
+end
+
+email = CanonicalEmails::ReverseName.transform("Donald Duck <donald@example.org>")
+email.name # "kcuD dlanoD"
+```
+
+### Contribute
+
+You're encouraged to contribute to this gem.
+
+* Fork this project.
+* Make changes, write tests.
+* Updated CHANGELOG.
+* Make a pull request, bonus points for topic branches.
+
+### Copyright and License
+
+Copyright Daniel Doubrovkine and Contributors, Artsy Inc., 2013
+
+[MIT License](LICENSE.md)

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler/gem_tasks'
+
+Bundler.setup :default, :development
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList["spec/**/*_spec.rb"]
+end
+
+task :default => :spec

data/canonical-emails.gemspec

@@ -0,0 +1,18 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'canonical-emails/version'
+
+Gem::Specification.new do |s|
+  s.name = "canonical-emails"
+  s.version = CanonicalEmails::VERSION
+  s.authors = [ "Daniel Doubrovkine" ]
+  s.email = "dblock@dblock.org"
+  s.platform = Gem::Platform::RUBY
+  s.required_rubygems_version = '>= 1.3.6'
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = [ "lib" ]
+  s.homepage = "http://github.com/dblock/canonical-emails"
+  s.licenses = [ "MIT" ]
+  s.summary = "Combine email validation and transformations to produce canonical email addresses."
+  s.add_dependency "mail"
+  s.add_dependency "activesupport"
+end

data/lib/canonical-emails.rb

@@ -0,0 +1,7 @@
+require 'mail'
+require 'active_support'
+
+require 'canonical-emails/version'
+require 'canonical-emails/downcase'
+require 'canonical-emails/gmail'
+require 'canonical-emails/extensions'

data/lib/canonical-emails/downcase.rb

@@ -0,0 +1,20 @@
+module CanonicalEmails
+  module Downcase
+
+    def self.transform(value)
+      Mail::Address.new(value).tap do |email|
+        email.instance_eval do
+          def get_local
+            value = super
+            value.downcase if value
+          end
+          def domain
+            value = super
+            value.downcase if value
+          end
+        end
+      end if value
+    end
+
+  end
+end

data/lib/canonical-emails/extensions.rb

@@ -0,0 +1,17 @@
+module CanonicalEmails
+  module Extensions
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def canonical_email(field, *parsers)
+        define_method "canonical_#{field}" do
+          value = send(field)
+          Array(parsers).each do |parser|
+            value = parser.transform(value.to_s)
+          end
+          value
+        end
+      end
+    end
+  end
+end

data/lib/canonical-emails/gmail.rb

@@ -0,0 +1,22 @@
+module CanonicalEmails
+  module GMail
+
+    def self.transform(value)
+      Mail::Address.new(value).tap do |email|
+        if email.domain && [ "gmail.com" ].include?(email.domain.downcase)
+          email.instance_eval do
+            def get_local
+              value = super
+              value.gsub(".", "").downcase if value
+            end
+            def domain
+              value = super
+              value.downcase if value
+            end
+          end
+        end if value
+      end
+    end
+
+  end
+end

data/lib/canonical-emails/version.rb

@@ -0,0 +1,3 @@
+module CanonicalEmails
+  VERSION = '0.1.0'
+end

data/lib/canonical_emails.rb

@@ -0,0 +1 @@
+require 'canonical-emails'

data/spec/canonical-emails/downcase_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe CanonicalEmails::Downcase do
+  it_behaves_like 'transform fixture_examples'
+end

data/spec/canonical-emails/extensions_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe CanonicalEmails::Extensions do
+  it_behaves_like 'extension fixture_examples'
+end

data/spec/canonical-emails/fixtures/downcase.yml

@@ -0,0 +1,30 @@
+-
+  source: Donald <donald@example.org>
+  name: Donald
+  local: donald
+  domain: example.org
+-
+  source: Donald   <   donald@example.org     >
+  name: Donald
+  local: donald
+  domain: example.org
+-
+  source: donald@example.org
+  local: donald
+  domain: example.org
+-
+  source: ! ' donald@example.org'
+  local: donald
+  domain: example.org
+-
+  source: donald@eXaMPLe.org
+  local: donald
+  domain: example.org
+-
+  source: DONALD@eXaMPLe.org
+  local: donald
+  domain: example.org
+-
+  source: DoNaLD@example.org
+  local: donald
+  domain: example.org

data/spec/canonical-emails/fixtures/extensions.yml

@@ -0,0 +1,16 @@
+-
+  email: Donald Duck <DoNaLD.DuCK@GMaiL.CoM>
+  transforms:
+    - CanonicalEmails::Downcase
+  canonical_email: Donald Duck <donald.duck@gmail.com>
+-
+  email: Donald Duck <DoNaLD.DuCK@GMaiL.CoM>
+  transforms:
+    - CanonicalEmails::GMail
+  canonical_email: Donald Duck <donaldduck@gmail.com>
+-
+  email: Donald Duck <DoNaLD.DuCK@GMaiL.CoM>
+  transforms:
+    - CanonicalEmails::GMail
+    - CanonicalEmails::Reverse
+  canonical_email: Donald Duck <kcuddlanod@moc.liamg>

data/spec/canonical-emails/fixtures/gmail.yml

@@ -0,0 +1,29 @@
+-
+  source: Donald Duck <example@example.org>
+  name: Donald Duck
+  local: example
+  domain: example.org
+-
+  source: donald@example.org
+  local: donald
+  domain: example.org
+-
+  source: donald@eXaMPLe.org
+  local: donald
+  domain: eXaMPLe.org
+-
+  source: donald.duck@gmail.com
+  local: donaldduck
+  domain: gmail.com
+-
+  source: donaldduck@gmail.com
+  local: donaldduck
+  domain: gmail.com
+-
+  source: donald.duck@gMaiL.com
+  local: donaldduck
+  domain: gmail.com
+-
+  source: donald.duck@google.com
+  local: donald.duck
+  domain: google.com

data/spec/canonical-emails/gmail_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe CanonicalEmails::GMail do
+  it_behaves_like 'transform fixture_examples'
+end

data/spec/canonical-emails/version_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe CanonicalEmails do
+  it "has a version" do
+    CanonicalEmails::VERSION.should_not be_nil
+  end
+end

data/spec/shared/extension_examples.rb

@@ -0,0 +1,14 @@
+shared_examples 'extension fixture_examples' do
+  yml_examples.each do |example|
+    it "#{example['transforms'].join(', ')}" do
+      klass = Class.new do
+        include CanonicalEmails::Extensions
+        attr_accessor :email
+        canonical_email :email, * example['transforms'].map(&:constantize)
+      end
+      user = klass.new
+      user.email = example['email']
+      user.canonical_email.to_s.should == example['canonical_email']
+    end
+  end
+end

data/spec/shared/transform_examples.rb

@@ -0,0 +1,11 @@
+shared_examples 'transform fixture_examples' do
+  yml_examples.each do |example|
+    it "transforms '#{example['source']}'" do
+      subject.transform(example['source']).tap do |email|
+        email.local.should == example['local']
+        email.domain.should == example['domain']
+        email.name.should == example['name']
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'rspec'
+require 'canonical-emails'
+require 'yaml'
+
+[ "support", "shared" ].each do |path|
+  Dir["#{File.dirname(__FILE__)}/#{path}/**/*.rb"].each do |f|
+    require f
+  end
+end

data/spec/support/reverse.rb

@@ -0,0 +1,18 @@
+module CanonicalEmails
+  module Reverse
+
+    def self.transform(value)
+      Mail::Address.new(value).tap do |email|
+        email.instance_eval do
+          def get_local
+            super.reverse
+          end
+          def domain
+            super.reverse
+          end
+        end
+      end
+    end
+
+  end
+end

data/spec/support/yml_examples.rb

@@ -0,0 +1,10 @@
+def yml_examples
+  caller.each do |c|
+    c =~ /(.*):(\d+)/
+    dir_name = File.dirname($1)
+    file_name = File.basename($1)
+    next unless file_name.end_with?("_spec.rb")
+    fixture_file = "#{file_name.split('_spec').first}.yml"
+    return YAML::load(File.open([ dir_name, 'fixtures', fixture_file ].join('/')))
+  end  
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: canonical-emails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Daniel Doubrovkine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: dblock@dblock.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- canonical-emails.gemspec
+- lib/canonical-emails.rb
+- lib/canonical-emails/downcase.rb
+- lib/canonical-emails/extensions.rb
+- lib/canonical-emails/gmail.rb
+- lib/canonical-emails/version.rb
+- lib/canonical_emails.rb
+- spec/canonical-emails/downcase_spec.rb
+- spec/canonical-emails/extensions_spec.rb
+- spec/canonical-emails/fixtures/downcase.yml
+- spec/canonical-emails/fixtures/extensions.yml
+- spec/canonical-emails/fixtures/gmail.yml
+- spec/canonical-emails/gmail_spec.rb
+- spec/canonical-emails/version_spec.rb
+- spec/shared/extension_examples.rb
+- spec/shared/transform_examples.rb
+- spec/spec_helper.rb
+- spec/support/reverse.rb
+- spec/support/yml_examples.rb
+homepage: http://github.com/dblock/canonical-emails
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 247467439
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Combine email validation and transformations to produce canonical email addresses.
+test_files: []