smtp_url 0.0.2

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+gem 'activesupport'
+
+group :test do
+  gem "rspec"
+end

data/Readme.md

@@ -0,0 +1,68 @@
+# SmtpURL setup
+
+This gem allows you to configure your smtp settings for mail and 
+action mailer using a url.  The intention is to keep those settings
+out of your code and allow easily setting them with an environment
+variable.
+
+## Installation
+
+Either in 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:
+
+    smtp://<user>:<password>@<hostname>:<port>/?<options>
+
+Options is a query string of key value pairs and is used for setting
+both the domain and authentication options. For example:
+
+    smtp://user:secret@mailserver:587/?domain=test.com&authentication=digest
+
+Only `hostname`, is required. Everything else is optional. It will
+default to port 25 if it is not specified.
+
+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:
+
+    config.action_mailer.delivery_method = :smtp
+    config.action_mailer.smtp_settings = SmtpURL.parse ENV["SMTP_URL"]
+
+## License
+
+SmtpURL is MIT Licensed
+
+Copyright (C) 2012 by Daniel Farrell
+
+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/lib/smtp_url.rb

@@ -0,0 +1,31 @@
+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

data/smtp_url.gemspec

@@ -0,0 +1,19 @@
+# encoding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
+require "smtp_url"
+
+Gem::Specification.new do |s|
+  s.name        = "smtp_url"
+  s.version     = SmtpURL::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Daniel Farrell"]
+  s.email       = ["danielfarrell76@gmail.com"]
+  s.homepage    = ""
+  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")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_dependency('activesupport')
+end

data/spec/smtp_url_spec.rb

@@ -0,0 +1,57 @@
+require 'smtp_url'
+
+describe SmtpURL, '#parse' do
+  it "should set port to 25 is not in url" do
+    url = "smtp://test.com"
+    settings = SmtpURL.parse url
+    settings[:port].should eq(25)
+  end
+
+  it "should allow setting port" do
+    url = "smtp://test.com:587"
+    settings = SmtpURL.parse url
+    settings[:port].should eq(587)
+  end
+
+  it "should handle urls without authentication" do
+    url = "smtp://test.com"
+    settings = SmtpURL.parse url
+    settings[:address].should eq('test.com')
+    settings[:user_name].should eq(nil)
+    settings[:passsword].should eq(nil)
+  end
+
+  it "should handle urls with authentication" do
+    url = "smtp://user:secret@test.com"
+    settings = SmtpURL.parse url
+    settings[:address].should eq('test.com')
+    settings[:user_name].should eq('user')
+    settings[:password].should eq('secret')
+  end
+
+  it "should parse domain from query params" do
+    url = "smtp://test.com/?domain=test2.com"
+    settings = SmtpURL.parse url
+    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[: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
+    url = "just a string of stuff"
+    settings = SmtpURL.parse url
+    settings.should eq({})
+  end
+
+  it "should return empty hash if url is not smtp" do
+    url = "http://test.com"
+    settings = SmtpURL.parse url
+    settings.should eq({})
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: smtp_url
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Daniel Farrell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-17 00:00:00.000000000 Z
+dependencies:
+- !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: Allows smtp settings to be defined as URL in environment variable, then
+  converted to hash for use in Mail/ActionMailer
+email:
+- danielfarrell76@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Readme.md
+- lib/smtp_url.rb
+- smtp_url.gemspec
+- spec/smtp_url_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Convert an smtp url into mail/action mailer friendly hashes
+test_files:
+- spec/smtp_url_spec.rb