action-gmailer 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,24 @@
+source "http://rubygems.org"
+
+gem "activesupport"
+gem "actionmailer"
+gem "gmail_xoauth"
+
+group :test, :development do
+  gem "pry"
+  gem "pry-debugger"
+  gem "awesome_print"
+end
+
+group :test do
+  gem "mail"
+  gem "minitest", "~> 4.2.0"
+  gem "minitest-reporters", "~> 0.12.0"
+  gem "mocha", :require => false
+end
+
+group :development do
+  gem "jeweler", "~> 1.8.4"
+  gem "reek", "~> 1.2.8"
+end
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Joel Larsson
+
+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,64 @@
+# ActionMailer delivery method for oauth2/smtp
+
+Get access to [Gmail IMAP and STMP via OAuth2](https://developers.google.com/google-apps/gmail/xoauth2_protocol) using [ActionMailer](https://github.com/rails/rails/tree/master/actionmailer) or just a plain [Mail::Message](https://github.com/mikel/mail)
+
+It's using the [gmail_xauth gem](https://github.com/nfo/gmail_xoauth) so it can be extended to support a few other auth variants pretty simple.
+
+# Installation
+
+Add the following to your Gemfile:
+
+    gem 'action-gmailer'
+
+# Configuration
+
+You need to set oauth2_token and account to send mail with `ActionGmailer`. For more information, check [SASL XOAUTH2](https://developers.google.com/google-apps/gmail/xoauth2_protocol)
+
+## Using Rails and ActionMailer:
+
+    settings = {
+      smtp_host:    'FIXME', # default: 'smtp.gmail.com'
+      smtp_port:    'FIXME', # default: 587
+      helo_domain:  'FIXME', # default:'gmail.com'
+      auth_type:    'FIXME', # default: :xoauth2
+      oauth2_token: 'FIXME',
+      account:      'FIXME'
+    }
+
+    config.action_mailer.delivery_method = :action_gmailer
+    config.action_mailer.action_gmailer_settings = settings
+
+## Using a plain Mail::Message
+
+    mail = Mail.new {
+      from    "from@example.com"
+      to      "to@example.com
+      subject "test subject"
+      body    'test mail body'
+    }
+    mail.delivery_method ActionGmailer::DeliveryMethod, settings
+
+# Testing/Development
+
+Run all tests
+
+    rake
+
+Run all tests with sending a live email, uncomment the skips and set some secret env variables.
+
+    ACTION_GMAILER_ACCOUNT='joel@example.com' ACTION_MAILER_OAUTH2_TOKEN='FIXME' rake
+
+# Contributing to action_gmailer
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+# Copyright
+
+Copyright (c) 2013 Joel Larsson. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+require 'rubygems'
+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 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "action-gmailer"
+  gem.homepage = "http://github.com/popgiro/action-gmailer"
+  gem.license = "MIT"
+  gem.summary = %Q{ActionGmailer, oauth/gmail delivery method}
+  gem.description = %Q{ActionGmailer, oauth/gmail delivery method}
+  gem.email = "tilljoel@gmail.com"
+  gem.authors = ["Joel Larsson"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+

data/TODO.md

@@ -0,0 +1,4 @@
+### TODO/IMPROVEMENTS
+
+* Fix MockSMTP for tests
+* Add badge for version, deps, travis?

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/action-gmailer.gemspec

@@ -0,0 +1,72 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "action-gmailer"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Joel Larsson"]
+  s.date = "2013-02-23"
+  s.description = "ActionGmailer, oauth/gmail delivery method"
+  s.email = "tilljoel@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "TODO.md",
+    "VERSION",
+    "action-gmailer.gemspec",
+    "lib/action_gmailer.rb",
+    "lib/ext/check_delivery_params.rb",
+    "test/helper.rb",
+    "test/test_action_gmailer.rb"
+  ]
+  s.homepage = "http://github.com/popgiro/action-gmailer"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "ActionGmailer, oauth/gmail delivery method"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_runtime_dependency(%q<actionmailer>, [">= 0"])
+      s.add_runtime_dependency(%q<gmail_xoauth>, [">= 0"])
+      s.add_development_dependency(%q<pry>, [">= 0"])
+      s.add_development_dependency(%q<pry-debugger>, [">= 0"])
+      s.add_development_dependency(%q<awesome_print>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<reek>, ["~> 1.2.8"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<actionmailer>, [">= 0"])
+      s.add_dependency(%q<gmail_xoauth>, [">= 0"])
+      s.add_dependency(%q<pry>, [">= 0"])
+      s.add_dependency(%q<pry-debugger>, [">= 0"])
+      s.add_dependency(%q<awesome_print>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<reek>, ["~> 1.2.8"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<actionmailer>, [">= 0"])
+    s.add_dependency(%q<gmail_xoauth>, [">= 0"])
+    s.add_dependency(%q<pry>, [">= 0"])
+    s.add_dependency(%q<pry-debugger>, [">= 0"])
+    s.add_dependency(%q<awesome_print>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<reek>, ["~> 1.2.8"])
+  end
+end
+

data/lib/action_gmailer.rb

@@ -0,0 +1,75 @@
+# encoding: utf-8
+require 'action_mailer'
+require 'active_support'
+require 'gmail_xoauth'
+require_relative 'ext/check_delivery_params'
+
+module ActionGmailer
+
+  class DeliveryError < StandardError
+  end
+
+  class DeliveryMethod
+    include Mail::CheckDeliveryParams # for check_params(...)
+
+    attr_reader :settings
+
+    attr_accessor :smtp_host, :smtp_port
+    attr_accessor :helo_domain, :auth_type
+    attr_accessor :account, :oauth2_token
+
+    def initialize(settings)
+      self.settings = settings
+    end
+
+    def settings=(settings)
+      @settings = settings
+      set_accessors_from_settings!
+    end
+
+    def deliver!(mail)
+      envelope_from, destinations, message = check_params(mail)
+
+      smtp = Net::SMTP.new(smtp_host, smtp_port)
+      smtp.enable_starttls_auto
+      smtp.start(helo_domain, account, oauth2_token, auth_type) do
+        smtp.sendmail(message, envelope_from, destinations)
+      end
+    rescue StandardError => exp
+      raise DeliveryError, exp.message
+    end
+
+    private
+
+    def default_smtp_host
+      'smtp.gmail.com'
+    end
+
+    def default_smtp_port
+      587
+    end
+
+    def default_helo_domain
+      'gmail.com'
+    end
+
+    def default_auth_type
+      :xoauth2
+    end
+
+    def set_accessors_from_settings!
+      @smtp_host    = settings[:smtp_host]    || default_smtp_host
+      @smtp_port    = settings[:smtp_port]    || default_smtp_port
+      @helo_domain  = settings[:helo_domain]  || default_helo_domain
+      @auth_type    = settings[:auth_type]    || default_auth_type
+      @oauth2_token = settings.fetch(:oauth2_token)
+      @account      = settings.fetch(:account)
+    rescue KeyError
+      raise DeliveryError, 'Missing required setting'
+    end
+
+  end
+end
+
+ActionMailer::Base.add_delivery_method(:action_gmailer,
+                                       ActionGmailer::DeliveryMethod)

data/lib/ext/check_delivery_params.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+# Use until we use a newer mail gem
+# This is from '/mail/check_delivery_params.rb'
+module Mail
+
+  module CheckDeliveryParams
+
+    def self.included(klass)
+      klass.class_eval do
+
+        def check_params(mail)
+          envelope_from = mail.return_path ||
+                          mail.sender ||
+                          mail.from_addrs.first
+          if envelope_from.blank?
+            err = 'A sender (Return-Path, Sender or From) required'
+            raise ArgumentError.new(err)
+          end
+
+          destinations = mail.destinations if mail.respond_to?(:destinations)
+          if destinations.blank?
+            err = 'At least one recipient (To, Cc or Bcc) is required'
+            raise ArgumentError.new(err)
+          end
+
+          message ||= mail.encoded if mail.respond_to?(:encoded)
+          if message.blank?
+            err = 'A encoded content is required'
+            raise ArgumentError.new(err)
+          end
+
+          [envelope_from, destinations, message]
+        end
+
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+require 'rubygems'
+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 'minitest/unit'
+require 'minitest/mock'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'mocha/setup'
+
+MiniTest::Reporters.use! MiniTest::Reporters::SpecReporter.new
+#MiniTest::Reporters.use! MiniTest::Reporters::DefaultReporter.new
+
+#MiniTest::Unit.runner =  MiniTest::Unit.new
+#MiniTest::Unit.runner.reporters << MiniTest::Reporters::ProgressReporter.new
+#MiniTest::Unit.runner.reporters << MiniTest::Reporters::DefaultReporter.new
+#MiniTest::Unit.runner.reporters << MiniTest::Reporters::SpecReporter.new
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'action_gmailer'
+
+class MiniTest::Unit::TestCase
+end
+
+MiniTest::Unit.autorun

data/test/test_action_gmailer.rb

@@ -0,0 +1,105 @@
+# encoding: utf-8
+require 'helper'
+require_relative '../lib/action_gmailer.rb'
+
+describe ActionGmailer do
+
+  let(:account)      { ENV['ACTION_GMAILER_ACCOUNT'] || 'not-set@example.com' }
+  let(:oauth2_token) { ENV['ACTION_MAILER_OAUTH2_TOKEN'] || 'not-set' }
+  let(:settings)     { { account: account, oauth2_token: oauth2_token } }
+  subject            { ActionGmailer::DeliveryMethod.new(settings) }
+
+  describe '#deliver!' do
+
+    describe 'live mail' do
+      describe 'with valid mail' do
+        let(:mail) do
+          email = account
+          Mail.new do
+            from    "#{email}"
+            to      "#{email}"
+            subject "test subject from #{email} to: #{email}"
+            body    'test mail body'
+          end
+        end
+
+        it 'you must set ENV[ACTION_GMAILER_*]' do
+          skip
+          account.wont_equal 'not-set@example.com'
+          oauth2_token.wont_equal 'not-set'
+        end
+
+        it 'should deliver the mail' do
+          skip
+          subject.deliver!(mail)
+        end
+
+        it 'should deliver the mail, with delivery_method' do
+          skip
+          mail.delivery_method ActionGmailer::DeliveryMethod, settings
+          mail.deliver
+        end
+      end
+    end
+
+    describe 'with invalid mail' do
+      let(:mail) { Mail.new { body'test mail body' } }
+      it 'should raise DeliveryError' do
+        -> { subject.deliver!(mail) }.must_raise ActionGmailer::DeliveryError
+      end
+    end
+  end
+
+  describe '#initialize' do
+    describe 'with valid settings' do
+
+      specify { subject.account.must_equal account }
+      specify { subject.oauth2_token.must_equal oauth2_token }
+      specify { subject.smtp_host.must_equal 'smtp.gmail.com' }
+      specify { subject.smtp_port.must_equal 587 }
+      specify { subject.helo_domain.must_equal 'gmail.com' }
+      specify { subject.auth_type.must_equal :xoauth2 }
+
+      describe 'with no default accessors' do
+        let(:smtp_host)   { 'smtp.example.com' }
+        let(:smtp_port)   { 42 }
+        let(:helo_domain) { 'example.com' }
+        let(:auth_type)   { :example }
+        let(:settings) do
+          { account: account,
+            oauth2_token: oauth2_token,
+            smtp_port: smtp_port,
+            smtp_host: smtp_host,
+            helo_domain: helo_domain,
+            auth_type: auth_type
+          }
+        end
+
+        specify { subject.smtp_host.must_equal 'smtp.example.com' }
+        specify { subject.smtp_port.must_equal 42 }
+        specify { subject.helo_domain.must_equal 'example.com' }
+        specify { subject.auth_type.must_equal :example }
+      end
+    end
+
+    describe 'with invalid settings' do
+      describe 'with no account' do
+        let(:settings)     { { account: account } }
+        it 'raises DeliveryError' do
+          -> {
+            ActionGmailer::DeliveryMethod.new(settings)
+          }.must_raise ActionGmailer::DeliveryError
+        end
+      end
+
+      describe 'with no oauth2_token' do
+        let(:settings)     { { oauth2_token: oauth2_token } }
+        it 'raises DeliveryError' do
+          -> {
+            ActionGmailer::DeliveryMethod.new(settings)
+          }.must_raise ActionGmailer::DeliveryError
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: action-gmailer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Joel Larsson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-23 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'
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  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: gmail_xoauth
+  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: pry
+  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: pry-debugger
+  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: awesome_print
+  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: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+description: ActionGmailer, oauth/gmail delivery method
+email: tilljoel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO.md
+- VERSION
+- action-gmailer.gemspec
+- lib/action_gmailer.rb
+- lib/ext/check_delivery_params.rb
+- test/helper.rb
+- test/test_action_gmailer.rb
+homepage: http://github.com/popgiro/action-gmailer
+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: 1185003157797333558
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ActionGmailer, oauth/gmail delivery method
+test_files: []