staugaard-idn_actionmailer 0.2

data/History.txt

@@ -0,0 +1,6 @@
+=== 0.2 / 2008-05-27
+
+* 1 major enhancement
+
+  * Implemented the main feature
+

data/README.txt

@@ -0,0 +1,9 @@
+= IdnActionmailer
+
+idn_actionmailer is a gem that patches actionmailer to support recipients on domains with international characters.
+
+This is done by encoding these domain names.
+
+To use this gem in your rails project just install it and and " require 'idn_actionmailer' " to the bottom of your environment.rb.
+
+I KNOW NOTHING ABOUT HOW THE ENCODING WORKS. I just patched the actionmailer code.

data/Rakefile

@@ -0,0 +1,17 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/idn_actionmailer.rb'
+
+Hoe.new('IdnActionmailer', IdnActionmailer::VERSION) do |p|
+  p.author = 'Mick Staugaard'
+  p.email = 'mick@staugaard.com'
+  p.summary = 'monkey patch for ActionMailer to support international domain names'
+  p.description = 'monkey patch for ActionMailer to support international domain names'
+  p.url = 'http://github.com/staugaard/idn_actionmailer'
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  #p.extra_deps << ['mime-types']
+end
+
+# vim: syntax=Ruby

data/idn_actionmailer.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name = "idn_actionmailer"
+  s.version = "0.2"
+  s.date = "2008-05-27"
+  s.summary = "monkey patch for ActionMailer to support international domain names"
+  s.email = "mick@staugaard.com"
+  s.homepage = "http://github.com/staugaard/idn_actionmailer"
+  s.description = "monkey patch for ActionMailer to support international domain names"
+  s.has_rdoc = false
+  s.authors = ["Mick Staugaard"]
+  s.files = ["History.txt", "README.txt", "Rakefile", "idn_actionmailer.gemspec", "lib/idn_actionmailer.rb"]
+  s.test_files = ["test/test_encoding.rb", "test/test_idn_actionmailer.rb", "test/fixtures/test_mailer/signed_up_with_url.erb", "test/fixtures/test_mailer/signed_up_with_url.rhtml"]
+  s.rdoc_options = ["--main", "README.txt"]
+  s.extra_rdoc_files = ["History.txt", "README.txt"]
+  s.add_dependency("actionmailer", [">= 2.0.2"])
+  s.add_dependency("unicode", [">= 0.1"])
+  s.add_dependency("punycode4r", [">= 0.2.0"])
+end

data/lib/idn_actionmailer.rb

@@ -0,0 +1,69 @@
+require 'rubygems'
+require 'unicode'
+require 'punycode'
+require 'actionmailer'
+
+class IdnActionmailer
+  VERSION = '0.2'
+  
+  UTF8REGEX = /\A(?:                                                            
+                [\x09\x0A\x0D\x20-\x7E]            # ASCII
+              | [\xC2-\xDF][\x80-\xBF]             # non-overlong 2-byte
+              |  \xE0[\xA0-\xBF][\x80-\xBF]        # excluding overlongs
+              | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}  # straight 3-byte
+              |  \xED[\x80-\x9F][\x80-\xBF]        # excluding surrogates
+              |  \xF0[\x90-\xBF][\x80-\xBF]{2}     # planes 1-3
+              | [\xF1-\xF3][\x80-\xBF]{3}          # planes 4-15
+              |  \xF4[\x80-\x8F][\x80-\xBF]{2}     # plane 16
+              )*\z/mnx
+
+
+  UTF8_REGEX_MBYTE = /(?:                                 
+                   [\xC2-\xDF][\x80-\xBF]             # non-overlong 2-byte
+                 |  \xE0[\xA0-\xBF][\x80-\xBF]        # excluding overlongs
+                 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}  # straight 3-byte
+                 |  \xED[\x80-\x9F][\x80-\xBF]        # excluding surrogates
+                 |  \xF0[\x90-\xBF][\x80-\xBF]{2}     # planes 1-3
+                 | [\xF1-\xF3][\x80-\xBF]{3}          # planes 4-15
+                 |  \xF4[\x80-\x8F][\x80-\xBF]{2}     # plane 16
+                 )/mnx
+  
+  def self.encode(str)
+    if str =~ UTF8REGEX && str =~ UTF8_REGEX_MBYTE
+      
+      parts = Unicode::downcase(str).split('.')
+      parts.map! do |part|
+        if part =~ UTF8REGEX && part =~ UTF8_REGEX_MBYTE
+          "xn--" + Punycode.encode(Unicode::normalize_KC(part))
+        else
+          part
+        end
+      end
+      
+      parts.join('.') 
+     else
+      str 
+    end
+  end
+end
+
+module ActionMailer
+  module Quoting
+    alias_method :orig_quote_address_if_necessary, :quote_address_if_necessary
+    
+    def quote_address_if_necessary(address, charset)
+      if Array === address
+        orig_quote_address_if_necessary(address, charset)
+      else
+        if(address =~ /^(.*(<)?.*@)(.*)(>)?$/)
+          predomain = $1
+          domain = IdnActionmailer.encode($3)
+          postdomain = $4
+          orig_quote_address_if_necessary("#{predomain}#{domain}#{postdomain}", charset)
+        else
+          orig_quote_address_if_necessary(address, charset)
+        end
+      end
+    end
+  end
+end

data/test/fixtures/test_mailer/signed_up_with_url.erb

@@ -0,0 +1 @@
+Hello there

data/test/test_encoding.rb

@@ -0,0 +1,24 @@
+require "test/unit"
+
+require "idn_actionmailer"
+
+class EncodingTest < Test::Unit::TestCase
+  def setup
+    @domains = [['مثال.إختبار', 'xn--mgbh0fb.xn--kgbechtv'],
+                ['例子.测试', 'xn--fsqu00a.xn--0zwm56d'],
+                ['例子.測試', 'xn--fsqu00a.xn--g6w251d'],
+                ['παράδειγμα.δοκιμή', 'xn--hxajbheg2az3al.xn--jxalpdlp'],
+                ['उदाहरण.परीक्षा', 'xn--p1b6ci4b4b3a.xn--11b5bs3a9aj6g'],
+                ['例え.テスト', 'xn--r8jz45g.xn--zckzah'],
+                ['실례.테스트', 'xn--9n2bp8q.xn--9t4b11yi5a'],
+                ['пример.испытание', 'xn--e1afmkfd.xn--80akhbyknj4f'],
+                ['உதாரணம்.பரிட்சை', 'xn--zkc6cc5bi7f6e.xn--hlcj6aya9esc7a'],
+                ['blåbærgrød.dk', 'xn--blbrgrd-fxak7p.dk']]
+  end
+  
+  def test_encoding
+    @domains.each do |pair|
+      assert_equal(pair[1], IdnActionmailer.encode(pair[0]))
+    end
+  end
+end

data/test/test_idn_actionmailer.rb

@@ -0,0 +1,83 @@
+require "test/unit"
+
+require "idn_actionmailer"
+
+ActionMailer::Base.template_root = "#{File.dirname(__FILE__)}/fixtures"
+
+class TestMailer < ActionMailer::Base
+  
+  default_url_options[:host] = 'www.basecamphq.com'
+  
+  def signed_up_with_url(recipient)
+    @recipients   = recipient
+    @subject      = "[Signed up] Welcome"
+    @from         = "bla <system@loudthinking.com>"
+    @sent_on      = Time.local(2004, 12, 12)
+
+    @body["recipient"]   = recipient
+  end
+
+  class <<self
+    attr_accessor :received_body
+  end
+
+  def receive(mail)
+    self.class.received_body = mail.body
+  end
+end
+
+class ActionMailerUrlTest < Test::Unit::TestCase
+  include ActionMailer::Quoting
+
+  def encode( text, charset="utf-8" )
+    quoted_printable( text, charset )
+  end
+
+  def new_mail( charset="utf-8" )
+    mail = TMail::Mail.new
+    mail.mime_version = "1.0"
+    if charset
+      mail.set_content_type "text", "plain", { "charset" => charset }
+    end
+    mail
+  end
+
+  def setup
+    ActionMailer::Base.delivery_method = :test
+    ActionMailer::Base.perform_deliveries = true
+    ActionMailer::Base.deliveries = []
+  end
+
+  def test_single_address
+
+    expected = new_mail
+    expected.to      = 'bla <mick@xn--brndendekrlighed-vobh.dk>'
+    expected.subject = "[Signed up] Welcome"
+    expected.body    = "Hello there"
+    expected.from    = "bla <system@loudthinking.com>"
+    expected.date    = Time.local(2004, 12, 12)
+
+    created = nil
+    assert_nothing_raised { created = TestMailer.create_signed_up_with_url('bla <mick@brændendekærlighed.dk>') }
+    assert_not_nil created
+    assert_equal expected.encoded, created.encoded
+
+    assert_nothing_raised { TestMailer.deliver_signed_up_with_url('bla <mick@brændendekærlighed.dk>') }
+    assert_not_nil ActionMailer::Base.deliveries.first
+    assert_equal expected.encoded, ActionMailer::Base.deliveries.first.encoded
+  end
+
+  def test_multi_addresses
+    expected = new_mail
+    expected.to      = ['bla <mick@xn--brndendekrlighed-vobh.dk>', 'mick@xn--brndendekrlighed-vobh.dk']
+    expected.subject = "[Signed up] Welcome"
+    expected.body    = "Hello there"
+    expected.from    = "bla <system@loudthinking.com>"
+    expected.date    = Time.local(2004, 12, 12)
+
+    created = nil
+    assert_nothing_raised { created = TestMailer.create_signed_up_with_url(['bla <mick@brændendekærlighed.dk>', 'mick@brændendekærlighed.dk']) }
+    assert_not_nil created
+    assert_equal expected.encoded, created.encoded
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: staugaard-idn_actionmailer
+version: !ruby/object:Gem::Version 
+  version: "0.2"
+platform: ruby
+authors: 
+- Mick Staugaard
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-27 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionmailer
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: unicode
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.1"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: punycode4r
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.0
+    version: 
+description: monkey patch for ActionMailer to support international domain names
+email: mick@staugaard.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- README.txt
+files: 
+- History.txt
+- README.txt
+- Rakefile
+- idn_actionmailer.gemspec
+- lib/idn_actionmailer.rb
+has_rdoc: false
+homepage: http://github.com/staugaard/idn_actionmailer
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: monkey patch for ActionMailer to support international domain names
+test_files: 
+- test/test_encoding.rb
+- test/test_idn_actionmailer.rb
+- test/fixtures/test_mailer/signed_up_with_url.erb
+- test/fixtures/test_mailer/signed_up_with_url.rhtml