normailize 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Michael Henriksen
+
+MIT License
+
+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,104 @@
+# Normailize
+
+Normailize is a gem to normalize email addresses from something like `Jo.Hn+sneaky@gmail.com` to `john@gmail.com`. This can be used in applications to prevent
+spammers and other shady types from signing up multiple times with variations of the same email address by adding dots, mixing the case or adding a plus sign
+followed by an arbitrary string.
+
+Normailize currently supports normalizations for the following providers:
+
+ - gmail.com (including googlemail.com)
+ - live.com
+ - hotmail.com
+
+If an email is given that is not from any of the known providers, it will not do any normalization and only make a simple comparison between two addresses.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'normailize'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install normailize
+
+## Usage
+
+### Comparing two email addresses
+
+The core of the gem is the `Normailize::EmailAddress#same_as?` which can compare two email addresses and returns true if they normalize into the same address:
+
+    # Lets compare two Gmail addresses:
+    
+    address1 = Normailize::EmailAddress.new('Jo.Hn+sneaky@gmail.com')
+    address2 = Normailize::EmailAddress.new('j.o.h.n+again@googlemail.com')
+
+    address1.same_as?(address2) # => True, they both normalize to john and gmail.com and googlemail.com are domains for the same provider
+
+    # Now we compare two live.com addresses:
+
+    address1 = Normailize::EmailAddress.new('john@live.com')
+    address2 = Normailize::EmailAddress.new('john+sneaky@live.com')
+
+    address1.same_as?(address2) # => True, they both normalize to john@live.com
+
+    # These are not the same addresses:
+
+    address1 = Normailize::EmailAddress.new('john@somewhere.com')
+    address2 = Normailize::EmailAddress.new('john@somewhereelse.com')
+
+    address1.same_as?(address2) # => False, they are not the same addresses
+
+### Getting the normalized email address
+
+If you want to get the normalized email address, you can call the `Normailize::EmailAddress#normalized_address` method:
+
+    address = Normailize::EmailAddress.new('J.oh.N+sNeaky@gmail.com')
+    address.normalized_address # => john@gmail.com
+
+### Adding a new provider
+
+If you want to normalize addresses from providers that are not already covered, it's fairly easy to add a new one:
+
+#### Adding a new provider class
+
+The following is a basic provider for somewhere.com:
+
+    module Normailize
+      module Provider
+        class Somewhere
+          include Normailize::Provider
+
+          # Specify one or more domains for somewhere.com
+          set_domains 'somewhere.com'
+
+          # Specify modificiations to be done on the username part of the email.
+          # The following modificiations are currently supported:
+          #   - :lowercase          Lowercases the username
+          #   - :remove_dots        Removes all dots
+          #   - :remove_plus_part   Removes everything after the first occurrence of a plus sign
+          set_modifications :lowercase, :remove_plus_part
+        end
+      end
+    end
+
+Adapt the Somewhere provider to fit the new provider and save it in the `lib/normailize/providers` directory
+
+#### Registering the new provider
+
+Open `lib/normailize/provider.rb` and add a switch case in the `Normailize::Provider#factory` method
+
+This is not perfect and will probably change in the future.
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/normailize.rb

@@ -0,0 +1,11 @@
+require "normailize/version"
+require "normailize/email_address"
+require "normailize/provider"
+require "normailize/provider/generic"
+require "normailize/provider/gmail"
+require "normailize/provider/live"
+require "normailize/provider/hotmail"
+
+module Normailize
+  # Your code goes here...
+end

data/lib/normailize/email_address.rb

@@ -0,0 +1,99 @@
+module Normailize
+
+  # Public: Class to represent an email address.
+  #
+  # Normalizes email addresses according to the rules given by the provider.
+  #
+  # Examples
+  #
+  #   # Compare two Gmail accounts
+  #   address1 = Normailize::EmailAddress.new('Jo.Hn+sneaky@gmail.com')
+  #   address2 = Normailize::EmailAddress.new('j.o.h.n@googlemail.com')
+  #   address1.same_as?(address2) # => true
+  #
+  #   # Get normalized email address
+  #   address = Normailize::EmailAddress.new('Jo.Hn+sneaky@gmail.com')
+  #   address.normalized_address # => john@gmail.com
+  class EmailAddress
+    attr_reader :address, :username, :domain
+
+    # Private: Simple regex to validate format of an email address
+    #
+    # We're deliberately ignoring a whole range of special and restricted chars
+    # for the sake of simplicity. This should match 99.99% of all the email
+    # addresses out there. If you allow comments (parentheses enclosed) in the
+    # local or domain part of your email addresses, make sure to strip them for
+    # normalization purposes. For '@' in the local part to be allowed, split
+    # local and domain part at the _last_ occurrence of the @-symbol.
+    EMAIL_ADDRESS_REGEX = /\A([a-z0-9_\-][a-z0-9_\-\+\.]{,62})?[a-z0-9_\-]@(([a-z0-9]|[a-z0-9][a-z0-9\-]*[a-z0-9])\.)+[a-z]{2,}\z/i
+
+    # Public: Class initializer
+    #
+    # address - An email address
+    #
+    # Raises ArgumentError if email address does not have correct format
+    def initialize(address)
+      raise ArgumentError.new("Does not look like a valid email address") unless address =~ EMAIL_ADDRESS_REGEX
+      @address = address
+      @username, @domain = @address.split('@', 2)
+      normalize!
+    end
+
+    # Internal: Remove all dots from username parts
+    #
+    # Returns nothing
+    def remove_dots
+      @username.gsub!('.', '')
+    end
+
+    # Internal: Removes everything after the first occurrence of a plus sign in the username parts
+    #
+    # Returns nothing
+    def remove_plus_part
+      @username = @username.split('+', 2).first
+    end
+
+    # Internal: Lowercase characthers in username part
+    #
+    # Returns nothing
+    def lowercase
+      @username.downcase!
+    end
+
+    # Internal: Get provider instance for email address
+    #
+    # If provider is known, it returns a specific provider instance,
+    # otherwise a generic provider instance is returned
+    #
+    # Returns Normailize::Provider
+    def provider
+      Provider.factory(@domain)
+    end
+
+    # Public: Get normalized email address
+    #
+    # Returns normalized address according to the rules specified by the provider.
+    def normalized_address
+      "#{@username}@#{@domain}"
+    end
+
+    # Public: Determine if two email addresses are the same
+    #
+    # Performs a comparison of the normalized username and provider
+    #
+    # Returns true if same or false if not
+    def same_as?(address)
+      (@username == address.username) && self.provider.same_as?(address.provider)
+    end
+
+    private
+
+    # Internal: Normalize email address according to rules specified by the provider
+    #
+    # Returns nothing
+    def normalize!
+      @domain.downcase!
+      provider.modifications.each { |m| self.send(m) if self.respond_to?(m) }
+    end
+  end
+end

data/lib/normailize/provider.rb

@@ -0,0 +1,105 @@
+module Normailize
+
+  # Public: Module to give email provider classes default functionality
+  module Provider
+
+    # Internal: Create a provider instance from a domain
+    #
+    # domain - A domain for an email provider, like gmail.com
+    #
+    # Returns an instance of a provider that recognizes the domain or a
+    # generic provider
+    def self.factory(domain)
+      case domain
+      when *Gmail.domains   then Gmail.new(domain)
+      when *Live.domains    then Live.new(domain)
+      when *Hotmail.domains then Hotmail.new(domain)
+      else Generic.new(domain)
+      end
+    end
+
+    def self.included(base)
+      class << base; attr_accessor :domains, :modifications end
+      base.extend(ClassMethods)    
+    end
+
+    module ClassMethods
+
+      # Public: Set on or more domains for a provider
+      #
+      # *domains - one or more domains
+      #
+      # Returns nothing
+      def set_domains(*domains)
+        @domains = domains
+      end
+
+      # Public: Set one or more modifications to be performed on email address
+      # belonging to the provider
+      #
+      # *modifications - One or more modification symbols
+      #
+      # Currently, the following modifications are supported:
+      #
+      #   - :lowercase         Lowercase characthers in username part
+      #   - :remove_dots       Removes all dots in username part
+      #   - :remove_plus_part  Removes everything after the first occurrence of a plus sign
+      #
+      # Returns nothing
+      def set_modifications(*modifications)
+        self.modifications = modifications.map(&:to_sym)
+      end
+
+      # Internal: Get domains that are associated with the provider
+      #
+      # Returns an array of domains
+      def domains
+        @domains || []
+      end
+    end
+
+    # Public: Class initializer
+    #
+    # domain - A domain like gmail.com
+    #
+    # Returns nothing
+    def initialize(domain)
+      @domain = domain
+    end
+
+    # Internal: Get all modification rules for the provider
+    #
+    # Returns symbols that tell the email class how to normalize an address
+    # for the provider
+    def modifications
+      self.class.modifications || []
+    end
+
+    # Internal: Get the domain that the provider was instantiated with
+    #
+    # Returns domain
+    def domain
+      @domain
+    end
+
+    # Internal: Determine if a provider is generic or not
+    #
+    # Returns true if generic or false if not
+    def generic?
+      self.is_a?(Normailize::Provider::Generic)
+    end
+
+    # Internal: Determine if two providers are the same or not
+    #
+    # provider - An instance of another provider class
+    #
+    # Returns true if providers are the same or false if not
+    def same_as?(provider)
+      if self.generic? || provider.generic?
+        @domain == provider.domain
+      else
+        self.class == provider.class
+      end
+    end
+  end
+end

data/lib/normailize/provider/generic.rb

@@ -0,0 +1,9 @@
+module Normailize
+  module Provider
+
+    # Internal: A generic provider to represent an unknown provider
+    class Generic
+      include Normailize::Provider
+    end
+  end
+end

data/lib/normailize/provider/gmail.rb

@@ -0,0 +1,16 @@
+module Normailize
+  module Provider
+
+    # Internal: A provider to represent Gmail and Googlemail
+    class Gmail
+      include Normailize::Provider
+      
+      # Gmail addresses work on both gmail.com and googlemail.com
+      set_domains 'gmail.com', 'googlemail.com'
+
+      # A normalized Gmail address is lowercased, dots and everything after a 
+      # plus sign is removed from the username part
+      set_modifications :lowercase, :remove_dots, :remove_plus_part
+    end
+  end
+end

data/lib/normailize/provider/hotmail.rb

@@ -0,0 +1,15 @@
+module Normailize
+  module Provider
+
+    # Internal: A provider to represent Hotmail
+    class Hotmail
+      include Normailize::Provider
+
+      # A hotmail account only works on the hotmail.com domain
+      set_domains 'hotmail.com'
+
+      # A normalized hotmail address is lowercased and everything after a plus sign is removed
+      set_modifications :lowercase, :remove_plus_part
+    end
+  end
+end

data/lib/normailize/provider/live.rb

@@ -0,0 +1,15 @@
+module Normailize
+  module Provider
+
+    # Internal: A provider to represent Live
+    class Live
+      include Normailize::Provider
+      
+      # A Live account only works on the live.com domain
+      set_domains 'live.com'
+
+      # A mormalized Live address is lowercased and everything after a plus sign is removed 
+      set_modifications :lowercase, :remove_plus_part
+    end
+  end
+end

data/lib/normailize/version.rb

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

data/normailize.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'normailize/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "normailize"
+  spec.version       = Normailize::VERSION
+  spec.authors       = ["Michael Henriksen"]
+  spec.email         = ["michenriksen87@gmail.com"]
+  spec.description   = %q{Normalize emails like J.oh.n+sneaky@gmail.com into john@gmail.com}
+  spec.summary       = %q{Normalize emails like J.oh.n+sneaky@gmail.com into john@gmail.com}
+  spec.homepage      = "https://github.com/soundcloud/normailize"
+  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 "rspec"
+end

data/spec/lib/normailize/email_address_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+describe Normailize::EmailAddress do
+  let(:address) { Normailize::EmailAddress.new('sneaky.dude+lol@gmail.com') }
+
+  describe '#initialize' do
+    it 'accepts an email address as argument' do
+      expect do
+        Normailize::EmailAddress.new('john@doe.com')
+      end.to_not raise_error
+    end
+
+    context 'when email address is not valid' do
+      it 'raises an exception' do
+        expect do
+          Normailize::EmailAddress.new('not an @email address. sorry!')
+        end.to raise_error(ArgumentError)
+      end
+    end
+
+    context 'when email address is technically valid, but we do not accept it' do
+      it 'raises an exception' do
+        expect do
+          Normailize::EmailAddress.new('" fairly.@.unusual.example.com"(&a_comment_making_it_extralong!)@[IPv6:2001:db8:23:::42]')
+        end.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe '#normalized_address' do
+    it 'returns expected normalized address' do
+      emails = {
+        'rahenadibirfx+seicascoumsip@gmail.com'             => 'rahenadibirfx@gmail.com',
+        'ScrapeBoxAutoa.pp.r.ovelist+427727@googlemail.com' => 'scrapeboxautoapprovelist@googlemail.com',
+        'scrapeboxautoa.pp.r..ovelist+427727@gmail.com'     => 'scrapeboxautoapprovelist@gmail.com',
+        'o.b.r.a.c.h.t.p.r.d.z.y.n.s.k.i+22@gmail.com'      => 'obrachtprdzynski@gmail.com',
+        'z+o.e+j+ayl.e+em+a+r.t+i.n+d3u76n@gmail.com'       => 'z@gmail.com',
+        'sneakydude+lol@live.com'                           => 'sneakydude@live.com'
+      }
+
+      emails.each_pair do |sneaky, expected_normalization|
+        Normailize::EmailAddress.new(sneaky).normalized_address.should == expected_normalization
+      end
+    end
+  end
+
+  describe '#provider' do
+    context 'when address is a @gmail.com' do
+      it 'returns instance of Gmail provider' do
+        Normailize::EmailAddress.new('john@gmail.com').provider.should be_a(Normailize::Provider::Gmail)
+      end
+    end
+
+    context 'when address is a @googlemail.com' do
+      it 'returns instance of Gmail provider' do
+        Normailize::EmailAddress.new('john@googlemail.com').provider.should be_a(Normailize::Provider::Gmail)
+      end
+    end
+
+    context 'when address is a @live.com' do
+      it 'returns instance of Live provider' do
+        Normailize::EmailAddress.new('john@live.com').provider.should be_a(Normailize::Provider::Live)
+      end
+    end
+
+    context 'when address is a @hotmail.com' do
+      it 'returns instance of Hotmail provider' do
+        Normailize::EmailAddress.new('john@hotmail.com').provider.should be_a(Normailize::Provider::Hotmail)
+      end
+    end
+
+    context 'when address is an unknown provider' do
+      it 'returns instance of Generic provider' do
+        Normailize::EmailAddress.new('john@somewhere.com').provider.should be_a(Normailize::Provider::Generic)
+      end
+    end
+  end
+
+  describe '#same_as?' do
+    context 'when emails are the same' do 
+      it 'returns true' do
+        emails = {
+          'john@gmail.com'           => 'john@gmail.com',
+          'john+lol@gmail.com'       => 'john+wtf@gmail.com',
+          'JoHn@gmail.com'           => 'jOhN@gmail.com',
+          'jo.hn@gmail.com'          => 'j.oh.n@gmail.com',
+          'Jo.h.n+lol+wtf@gmail.com' => 'jO.h.n+lol@googlemail.com',
+          'john@live.com'            => 'john@live.com',
+          'JoHn@live.com'            => 'jOhN@live.com',
+          'john+lol@live.com'        => 'john+wtf@live.com',
+          'John+lol+wtf@live.com'    => 'jOhn+lol@live.com',
+          'john@hotmail.com'         => 'john@hotmail.com'
+        }
+
+        emails.each_pair do |e1, e2|
+          Normailize::EmailAddress.new(e1).same_as?(Normailize::EmailAddress.new(e2)).should be_true
+        end
+      end
+    end
+
+    context 'when emails are not the same' do
+      it 'returns false' do
+        emails = {
+          'john@gmail.com'      => 'john@live.com',
+          'johnny@gmail.com'    => 'john@gmail.com',
+          'john@googlemail.com' => 'john@hotmail.com',
+          'john+lol@gmail.com'  => 'john+lol@live.com',
+        }
+
+        emails.each_pair do |e1, e2|
+          Normailize::EmailAddress.new(e1).same_as?(Normailize::EmailAddress.new(e2)).should be_false
+        end
+      end
+    end
+  end
+end

data/spec/lib/normailize/provider/generic_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Normailize::Provider::Generic do
+  subject { Normailize::Provider::Generic.new('somewhere.com') }
+
+  it 'includes the Provider module' do
+    subject.should be_a(Normailize::Provider)
+  end
+
+  it 'is a generic provider' do
+    subject.should be_generic
+  end
+
+  describe '.domains' do
+    subject { Normailize::Provider::Generic.domains }
+
+    it 'does not include any domains' do
+      subject.should be_nil
+    end
+  end
+
+  describe '#modifications' do
+    subject { Normailize::Provider::Generic.new('somewhere.com').modifications }
+
+    it 'does not contain any modifications' do
+      subject.should be_empty
+    end
+  end
+
+  describe '#same_as?' do
+    context 'when comparing a provider of the same type' do
+      it 'returns true' do
+        subject.same_as?(Normailize::Provider::Generic.new('somewhere.com')).should be_true
+      end
+    end
+
+    context 'when comparing a generic provider with a different domain' do
+      it 'returns false' do
+        subject.same_as?(Normailize::Provider::Generic.new('somewhereelse.com')).should be_false
+      end
+    end
+
+    context 'when comparing a Gmail provider' do
+      it 'returns false' do
+        subject.same_as?(Normailize::Provider::Gmail.new('gmail.com')).should be_false
+      end
+    end
+  end
+end

data/spec/lib/normailize/provider/gmail_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Normailize::Provider::Gmail do
+  subject { Normailize::Provider::Gmail.new('gmail.com') }
+
+  it 'includes the Provider module' do
+    subject.should be_a(Normailize::Provider)
+  end
+
+  it 'is not a generic provider' do
+    subject.should_not be_generic
+  end
+
+  describe '.domains' do
+    subject { Normailize::Provider::Gmail.domains }
+
+    it 'includes gmail.com' do
+      subject.should include('gmail.com')
+    end
+
+    it 'includes googlemail.com' do
+      subject.should include('googlemail.com')
+    end
+  end
+
+  describe '#modifications' do
+    subject { Normailize::Provider::Gmail.new('gmail.com').modifications }
+
+    it 'lowercases emails' do
+      subject.should include(:lowercase)
+    end
+
+    it 'removes dots' do
+      subject.should include(:remove_dots)
+    end
+
+    it 'removes plus parts' do
+      subject.should include(:remove_plus_part)
+    end
+  end
+
+  describe '#same_as?' do
+    context 'when comparing a provider of the same type' do
+      it 'returns true' do
+        subject.same_as?(Normailize::Provider::Gmail.new('gmail.com')).should be_true
+      end
+    end
+
+    context 'when comparing a generic provider' do
+      it 'returns false' do
+        subject.same_as?(Normailize::Provider::Generic.new('somewhere.com')).should be_false
+      end
+    end
+
+    context 'when comparing a Hotmail provider' do
+      it 'returns false' do
+        subject.same_as?(Normailize::Provider::Hotmail.new('hotmail.com')).should be_false
+      end
+    end
+  end
+end

data/spec/lib/normailize/provider/hotmail_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Normailize::Provider::Hotmail do
+  subject { Normailize::Provider::Hotmail.new('hotmail.com') }
+
+  it 'includes the Provider module' do
+    subject.should be_a(Normailize::Provider)
+  end
+
+  it 'is not a generic provider' do
+    subject.should_not be_generic
+  end
+
+  describe '.domains' do
+    subject { Normailize::Provider::Hotmail.domains }
+
+    it 'includes hotmail.com' do
+      subject.should include('hotmail.com')
+    end
+  end
+
+  describe '#modifications' do
+    subject { Normailize::Provider::Hotmail.new('hotmail.com').modifications }
+
+    it 'lowercases emails' do
+      subject.should include(:lowercase)
+    end
+
+    it 'does not remove dots' do
+      subject.should_not include(:remove_dots)
+    end
+
+    it 'removes plus parts' do
+      subject.should include(:remove_plus_part)
+    end
+  end
+
+  describe '#same_as?' do
+    context 'when comparing a provider of the same type' do
+      it 'returns true' do
+        subject.same_as?(Normailize::Provider::Hotmail.new('hotmail.com')).should be_true
+      end
+    end
+
+    context 'when comparing a generic provider' do
+      it 'returns false' do
+        subject.same_as?(Normailize::Provider::Generic.new('somewhere.com')).should be_false
+      end
+    end
+
+    context 'when comparing a Gmail provider' do
+      it 'returns false' do
+        subject.same_as?(Normailize::Provider::Gmail.new('gmail.com')).should be_false
+      end
+    end
+  end
+end

data/spec/lib/normailize/provider/live_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Normailize::Provider::Live do
+  subject { Normailize::Provider::Live.new('live.com') }
+
+  it 'includes the Provider module' do
+    subject.should be_a(Normailize::Provider)
+  end
+
+  it 'is not a generic provider' do
+    subject.should_not be_generic
+  end
+
+  describe '.domains' do
+    subject { Normailize::Provider::Live.domains }
+
+    it 'includes live.com' do
+      subject.should include('live.com')
+    end
+  end
+
+  describe '#modifications' do
+    subject { Normailize::Provider::Live.new('live.com').modifications }
+
+    it 'lowercases emails' do
+      subject.should include(:lowercase)
+    end
+
+    it 'does not remove dots' do
+      subject.should_not include(:remove_dots)
+    end
+
+    it 'removes plus parts' do
+      subject.should include(:remove_plus_part)
+    end
+  end
+
+  describe '#same_as?' do
+    context 'when comparing a provider of the same type' do
+      it 'returns true' do
+        subject.same_as?(Normailize::Provider::Live.new('live.com')).should be_true
+      end
+    end
+
+    context 'when comparing a generic provider' do
+      it 'returns false' do
+        subject.same_as?(Normailize::Provider::Generic.new('somewhere.com')).should be_false
+      end
+    end
+
+    context 'when comparing a Hotmail provider' do
+      it 'returns false' do
+        subject.same_as?(Normailize::Provider::Hotmail.new('hotmail.com')).should be_false
+      end
+    end
+  end
+end

data/spec/lib/normailize/provider_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Normailize::Provider do
+  describe '.factory' do
+    context 'when given gmail.com as domain' do
+      it 'returns the Gmail provider' do
+        Normailize::Provider.factory('gmail.com').should be_a(Normailize::Provider::Gmail)
+      end
+    end
+
+    context 'when given googlemail.com as domain' do
+      it 'returns the Gmail provider' do
+        Normailize::Provider.factory('googlemail.com').should be_a(Normailize::Provider::Gmail)
+      end
+    end
+
+    context 'when given live.com as domain' do
+      it 'returns the Live provider' do
+        Normailize::Provider.factory('live.com').should be_a(Normailize::Provider::Live)
+      end
+    end
+
+    context 'when given hotmail.com as domain' do
+      it 'returns the Hotmail provider' do
+        Normailize::Provider.factory('hotmail.com').should be_a(Normailize::Provider::Hotmail)
+      end
+    end
+
+    context 'when given an unknown domain' do
+      it 'returns instance of Generic provider' do
+        Normailize::Provider.factory('somewhere.com').should be_a(Normailize::Provider::Generic)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+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 'normailize'
+
+RSpec.configure do |config|
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: normailize
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Michael Henriksen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Normalize emails like J.oh.n+sneaky@gmail.com into john@gmail.com
+email:
+- michenriksen87@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/normailize.rb
+- lib/normailize/email_address.rb
+- lib/normailize/provider.rb
+- lib/normailize/provider/generic.rb
+- lib/normailize/provider/gmail.rb
+- lib/normailize/provider/hotmail.rb
+- lib/normailize/provider/live.rb
+- lib/normailize/version.rb
+- normailize.gemspec
+- spec/lib/normailize/email_address_spec.rb
+- spec/lib/normailize/provider/generic_spec.rb
+- spec/lib/normailize/provider/gmail_spec.rb
+- spec/lib/normailize/provider/hotmail_spec.rb
+- spec/lib/normailize/provider/live_spec.rb
+- spec/lib/normailize/provider_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/soundcloud/normailize
+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: -3381404140353405978
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3381404140353405978
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Normalize emails like J.oh.n+sneaky@gmail.com into john@gmail.com
+test_files:
+- spec/lib/normailize/email_address_spec.rb
+- spec/lib/normailize/provider/generic_spec.rb
+- spec/lib/normailize/provider/gmail_spec.rb
+- spec/lib/normailize/provider/hotmail_spec.rb
+- spec/lib/normailize/provider/live_spec.rb
+- spec/lib/normailize/provider_spec.rb
+- spec/spec_helper.rb