smtp_url 0.0.2 → 0.1.0

data/Gemfile.lock

@@ -0,0 +1,24 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    diff-lcs (1.1.3)
+    i18n (0.6.0)
+    multi_json (1.3.5)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.0)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  rspec

data/Readme.md

@@ -7,18 +7,10 @@ variable.
 
 ## Installation
 
-Either in your `Gemfile`:
+Add to your `Gemfile`:
 
     gem "smtp_url"
 
-Or install it directly onto your system with rubygems:
-
-    gem install smtp_url
-
-Then require in your app:
-
-    require "smtp_url"
-
 ## Usage
 
 Use a URL like so:
@@ -37,10 +29,13 @@ Set the URL in an enviroment variable in your server setup:
 
     export SMTP_URL=smtp://user:secret@mailserver:587/?domain=test.com
 
-And then wherever you setup your smtp settings(often config/application.rb) add:
+## Development
+
+Can be very useful in development when paired with something like
+[Mailcatcher](http://mailcatcher.me/):
+
+    export SMTP_URL=smtp://127.0.0.1:1025
 
-    config.action_mailer.delivery_method = :smtp
-    config.action_mailer.smtp_settings = SmtpURL.parse ENV["SMTP_URL"]
 
 ## License
 

data/lib/smtp_url/invalid_url_exception.rb

@@ -0,0 +1,3 @@
+module SmtpURL
+  class InvalidUrlException < Exception; end
+end

data/lib/smtp_url/parser.rb

@@ -0,0 +1,46 @@
+require 'uri'
+require 'active_support/core_ext/object/try'
+require 'active_support/core_ext/hash/keys'
+
+module SmtpURL
+  class Parser
+
+    def initialize(url)
+      @url = url
+    end
+
+    def parse
+      config = parse_url
+      query = split_query_params(config.query)
+      settings = build_hash(config, query)
+      settings.reject!{ |key,value| value.nil? }
+      settings
+    end
+
+    private
+
+    def parse_url
+      parsed_url = URI.parse(@url)
+      raise InvalidUrlException, "Improper format of SMTP_URL env var, must be smtp://" unless parsed_url.scheme == 'smtp'
+      parsed_url
+    rescue URI::InvalidURIError => e
+      raise InvalidUrlException, "Could not parse SMTP_URL env var"
+    end
+
+    def build_hash(config, query)
+      {
+        :address        => config.host,
+        :port           => config.port || 25,
+        :domain         => query[:domain],
+        :user_name      => config.user,
+        :password       => config.password,
+        :authentication => query[:authentication].try(:to_sym)
+      }
+    end
+
+    def split_query_params(query = nil)
+      return {} unless query
+      Hash[query.split("&").map{ |pair| pair.split("=") }].symbolize_keys
+    end
+  end
+end

data/lib/smtp_url/railtie.rb

@@ -0,0 +1,6 @@
+module SmtpURL
+  class Railtie < Rails::Railtie
+    config.action_mailer.delivery_method = :smtp
+    config.action_mailer.smtp_settings = SmtpURL::Parser.new(ENV["SMTP_URL"]).parse
+  end
+end

data/lib/smtp_url/version.rb

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

data/lib/smtp_url.rb

@@ -1,31 +1,4 @@
-require 'uri'
-require 'active_support/core_ext/object/try'
-require 'active_support/core_ext/hash/keys'
-
-module SmtpURL
-  VERSION = '0.0.2'
-
-  def self.parse(uri)
-    config = URI.parse(uri)
-    return {} if config.scheme != 'smtp'
-    query_params = split_query_params(config.query)
-    settings = { :address        => config.host,
-                 :port           => config.port || 25,
-                 :domain         => query_params[:domain],
-                 :user_name      => config.user,
-                 :password       => config.password,
-                 :authentication => query_params[:authentication].try(:to_sym)
-               }
-    settings.reject!{ |key,value| value.nil? }
-    settings
-  rescue URI::InvalidURIError
-    return {}
-  end
-
-  private
-  def self.split_query_params(query = nil)
-    return {} unless query
-    Hash[query.split("&").map{ |pair| pair.split("=") }].symbolize_keys
-  end
-
-end
+require 'smtp_url/version'
+require 'smtp_url/invalid_url_exception'
+require 'smtp_url/parser'
+require 'smtp_url/railtie' if defined?(Rails)

data/smtp_url.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Daniel Farrell"]
   s.email       = ["danielfarrell76@gmail.com"]
-  s.homepage    = ""
+  s.homepage    = "https://github.com/danielfarrell/smtp_url"
   s.summary     = %q{Convert an smtp url into mail/action mailer friendly hashes}
   s.description = %q{Allows smtp settings to be defined as URL in environment variable, then converted to hash for use in Mail/ActionMailer}
   s.files         = `git ls-files`.split("\n")

data/spec/{smtp_url_spec.rb → smtp_url/parser_spec.rb}

@@ -1,21 +1,22 @@
-require 'smtp_url'
+require 'smtp_url/invalid_url_exception'
+require 'smtp_url/parser'
 
-describe SmtpURL, '#parse' do
+describe SmtpURL::Parser, '#parse' do
   it "should set port to 25 is not in url" do
     url = "smtp://test.com"
-    settings = SmtpURL.parse url
+    settings = SmtpURL::Parser.new(url).parse
     settings[:port].should eq(25)
   end
 
   it "should allow setting port" do
     url = "smtp://test.com:587"
-    settings = SmtpURL.parse url
+    settings = SmtpURL::Parser.new(url).parse
     settings[:port].should eq(587)
   end
 
   it "should handle urls without authentication" do
     url = "smtp://test.com"
-    settings = SmtpURL.parse url
+    settings = SmtpURL::Parser.new(url).parse
     settings[:address].should eq('test.com')
     settings[:user_name].should eq(nil)
     settings[:passsword].should eq(nil)
@@ -23,7 +24,7 @@ describe SmtpURL, '#parse' do
 
   it "should handle urls with authentication" do
     url = "smtp://user:secret@test.com"
-    settings = SmtpURL.parse url
+    settings = SmtpURL::Parser.new(url).parse
     settings[:address].should eq('test.com')
     settings[:user_name].should eq('user')
     settings[:password].should eq('secret')
@@ -31,27 +32,25 @@ describe SmtpURL, '#parse' do
 
   it "should parse domain from query params" do
     url = "smtp://test.com/?domain=test2.com"
-    settings = SmtpURL.parse url
+    settings = SmtpURL::Parser.new(url).parse
     settings[:domain].should eq('test2.com')
   end
 
   it "should parse authentication from query params" do
     url = "smtp://user:secret@test.com/?authentication=digest"
-    settings = SmtpURL.parse url
+    settings = SmtpURL::Parser.new(url).parse
     settings[:user_name].should eq('user')
     settings[:password].should eq('secret')
     settings[:authentication].should eq(:digest)
   end
 
-  it "should return empty hash for invalid url" do
+  it "should raise InvalidUriException for invalid url" do
     url = "just a string of stuff"
-    settings = SmtpURL.parse url
-    settings.should eq({})
+    lambda {SmtpURL::Parser.new(url).parse}.should raise_error(SmtpURL::InvalidUrlException, "Could not parse SMTP_URL env var")
   end
 
-  it "should return empty hash if url is not smtp" do
+  it "should raise InvalidUriException if url is not smtp" do
     url = "http://test.com"
-    settings = SmtpURL.parse url
-    settings.should eq({})
+    lambda {SmtpURL::Parser.new(url).parse}.should raise_error(SmtpURL::InvalidUrlException, "Improper format of SMTP_URL env var, must be smtp://")
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smtp_url
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-17 00:00:00.000000000 Z
+date: 2012-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -36,11 +36,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- Gemfile.lock
 - Readme.md
 - lib/smtp_url.rb
+- lib/smtp_url/invalid_url_exception.rb
+- lib/smtp_url/parser.rb
+- lib/smtp_url/railtie.rb
+- lib/smtp_url/version.rb
 - smtp_url.gemspec
-- spec/smtp_url_spec.rb
-homepage: ''
+- spec/smtp_url/parser_spec.rb
+homepage: https://github.com/danielfarrell/smtp_url
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -65,4 +70,4 @@ signing_key:
 specification_version: 3
 summary: Convert an smtp url into mail/action mailer friendly hashes
 test_files:
-- spec/smtp_url_spec.rb
+- spec/smtp_url/parser_spec.rb