mail-xoauth 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d2029f29f71b33164985ee6ca57e92a092e16bc4
+  data.tar.gz: 373dde7ebc4feb01c9e62f27f7556462a98a3b8c
+SHA512:
+  metadata.gz: b50b2074cd2b1a7fec11514c33530c3f8ab3adace21a64975ebc537e1eb725a18176aab1a89a101bfce2e9cfd060c88f7c9c85927992a155e101e490b8668c80
+  data.tar.gz: 8620c019ba076e378041301c1f055c2476058d81689e2e9431770ba2fc7ad2fd0bf1294d019476d12f647a024ea3e4cce5655e4920e4f3de4c401899aa51b48b

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 mail-xoauth.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 ahawkins
+
+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,60 @@
+# Mail::Xoauth
+
+Make the [Mail](https://github.com/mikel/mail) work with Gmail using
+[OAuth](https://developers.google.com/gmail/oauth_overview). This
+project is build on top of [gmail_xaouth](https://github.com/nfo/gmail_xoauth).
+`Mail::Xoauth` simply makes provides a nice connect to mail's rich
+delivery and retrevial interface.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mail-xoauth'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mail-xoauth
+
+## Usage
+
+This gem **does not retreive oauth access or refresh tokesn for you!**
+You must retrieve them yourself. `Mail::Xoauth` requires an access
+token. It's up to you to ensure a valid access token using a refresh
+token. If you do not know how to do that, then look at the tests.
+There is an example class to handle this. Given a valid oauth access
+token and email address you're ready to connect.
+
+### Getting Email
+
+```ruby
+gmail = Mail::XOauthIMAP.new address: 'example@gmail.com', access_token: 'foo'
+
+# Query using Mail's standard interface
+gmail.all
+```
+
+### Sending Mail
+
+```ruby
+email = Mail.new do
+  from 'example@gmail.com'
+  to 'example@example.com'
+  subject 'XOauth Test'
+end
+
+gmail = Mail::XOauthSMTP.new address: 'example@example.com', access_token: 'foo'
+gmail.deliver! email
+```
+
+## 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,18 @@
+require "bundler/gem_tasks"
+
+desc "Run tests"
+task :test do
+  # Do this is way to avoid forking another ruby process.
+  # See: http://ngauthier.com/2012/02/quick-tests-with-bash.html
+  root = File.dirname __FILE__
+  Dir["#{root}/test/**/*_test.rb"].each do |test_file|
+    begin
+      require test_file
+    rescue => ex
+      puts ex
+      puts ex.backtrace.join("\n")
+      exit!
+    end
+  end
+end
+task :default => :test

data/config.yml

@@ -0,0 +1,5 @@
+email: testing@radiumcrm.com
+oauth_key: 148490173223.apps.googleusercontent.com
+oauth_secret: IftxRkgtDISFDBbKBFm2Aw9K
+access_token: ya29.AHES6ZSb_Pqh9RW-F6ZruqOobQoT5iWEoDUsXYsSW1l0tPs
+refresh_token: 1/KU5bpLcckmUgBBgz6g66mgfCSyVrgvx6kdciswhBPEg

data/lib/mail-xoauth.rb

@@ -0,0 +1 @@
+require 'mail/xoauth'

data/lib/mail/network/delivery_methods/xoauth_smtp.rb

@@ -0,0 +1,27 @@
+module Mail
+  class XOauthSMTP < SMTP
+    class MissingAuthInfo < KeyError ; end
+
+    def initialize(values)
+      fail MissingAuthInfo unless values[:address]
+      fail MissingAuthInfo unless values[:access_token]
+      super values
+    end
+
+    def deliver!(mail)
+      smtp_from, smtp_to, message = check_delivery_params(mail)
+
+      smtp = Net::SMTP.new('smtp.gmail.com', 587)
+      smtp.enable_starttls_auto
+      smtp.start('gmail.com', settings.fetch(:address), settings.fetch(:access_token), :xoauth2) do |connection|
+        response = connection.sendmail(message, smtp_from, smtp_to)
+      end
+
+      if settings[:return_response]
+        response
+      else
+        self
+      end
+    end
+  end
+end

data/lib/mail/network/retreiver_methods/xoauth_imap.rb

@@ -0,0 +1,24 @@
+module Mail
+  class XOauthIMAP < IMAP
+    class MissingAuthInfo < KeyError ; end
+
+    def initialize(values)
+      fail MissingAuthInfo unless values[:address]
+      fail MissingAuthInfo unless values[:access_token]
+      super values
+    end
+
+    def start(config=Mail::Configuration.instance, &block)
+      raise ArgumentError.new("Mail::Retrievable#imap_start takes a block") unless block_given?
+
+      imap = Net::IMAP.new('imap.gmail.com', 993, usessl = true, certs = nil, verify = false)
+      imap.authenticate 'XOAUTH2', settings.fetch(:address), settings.fetch(:access_token)
+
+      yield imap
+    ensure
+      if defined?(imap) && imap && !imap.disconnected?
+        imap.disconnect
+      end
+    end
+  end
+end

data/lib/mail/xoauth.rb

@@ -0,0 +1,12 @@
+require "mail/xoauth/version"
+require "mail"
+require "gmail_xoauth"
+require "mail/network/retreiver_methods/xoauth_imap"
+require "mail/network/delivery_methods/xoauth_smtp"
+
+module Mail
+  module Xoauth
+    # Your code goes here...
+  end
+end
+

data/lib/mail/xoauth/version.rb

@@ -0,0 +1,5 @@
+module Mail
+  module Xoauth
+    VERSION = "0.1.0"
+  end
+end

data/mail-xoauth.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mail/xoauth/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mail-xoauth"
+  spec.version       = Mail::Xoauth::VERSION
+  spec.authors       = ["ahawkins"]
+  spec.email         = ["me@broadcastingadam.com"]
+  spec.description   = %q{Gmail OAuth IMAP & SMTP connections for the Mail gem}
+  spec.summary       = %q{}
+  spec.homepage      = "https://github.com/ahawkins/mail-xoauth"
+  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_dependency 'mail'
+  spec.add_dependency 'gmail_xoauth'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "faraday"
+  spec.add_development_dependency "faraday_middleware"
+end

data/test/email_test.rb

@@ -0,0 +1,60 @@
+require_relative "./test_helper"
+
+class GettingMailTest < MiniTest::Unit::TestCase
+  def test_connects_and_returns_messages
+    gmail = Mail::XOauthIMAP.new address: Config.email, access_token: access_token!
+    gmail.all
+  end
+
+  def test_round_trips_email
+    email = Mail.new do
+      from Config.email
+      to Config.email
+      subject 'XOauth Test'
+    end
+
+    gmail = Mail::XOauthSMTP.new address: Config.email, access_token: access_token!
+
+    gmail.deliver! email
+  end
+
+  def test_raises_an_error_when_missing_the_address_for_imap
+    assert_raises Mail::XOauthIMAP::MissingAuthInfo do
+      Mail::XOauthIMAP.new address: nil, access_token: 'foo'
+    end
+
+    assert_raises Mail::XOauthIMAP::MissingAuthInfo do
+      Mail::XOauthIMAP.new  access_token: 'foo'
+    end
+  end
+
+  def test_raises_an_error_when_missing_the_access_token_for_imap
+    assert_raises Mail::XOauthIMAP::MissingAuthInfo do
+      Mail::XOauthIMAP.new address: 'foo', access_token: nil
+    end
+
+    assert_raises Mail::XOauthIMAP::MissingAuthInfo do
+      Mail::XOauthIMAP.new address: 'foo'
+    end
+  end
+
+  def test_raises_an_error_when_missing_the_address_for_smtp
+    assert_raises Mail::XOauthSMTP::MissingAuthInfo do
+      Mail::XOauthSMTP.new address: nil, access_token: 'foo'
+    end
+
+    assert_raises Mail::XOauthSMTP::MissingAuthInfo do
+      Mail::XOauthSMTP.new  access_token: 'foo'
+    end
+  end
+
+  def test_raises_an_error_when_missing_the_access_token_for_smtp
+    assert_raises Mail::XOauthSMTP::MissingAuthInfo do
+      Mail::XOauthSMTP.new address: 'foo', access_token: nil
+    end
+
+    assert_raises Mail::XOauthSMTP::MissingAuthInfo do
+      Mail::XOauthSMTP.new address: 'foo'
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,109 @@
+require 'bundler/setup'
+require 'mail-xoauth'
+require 'minitest/autorun'
+require 'faraday'
+require 'faraday_middleware'
+
+config_klass = Class.new do
+  attr_accessor :email
+  attr_accessor :access_token, :refresh_token
+  attr_accessor :oauth_key, :oauth_secret
+
+  def initialize(hash = {})
+    hash.each_pair do |name, value|
+      send "#{name}=", value
+    end
+  end
+end
+
+root = File.expand_path "../../", __FILE__
+Config = config_klass.new YAML.load_file "#{root}/config.yml"
+
+class MiniTest::Unit::TestCase
+  def access_token!
+    auth.refresh_token! Config.refresh_token
+    auth.access_token
+  end
+
+  private
+  def auth
+    @auth ||= Oauth.new Config.oauth_key, Config.oauth_secret
+  end
+
+  # Handle Authentication for the Google Data API. For more information
+  # @see http://code.google.com/apis/gdata/docs/auth/overview.html
+  class Oauth
+    END_POINT = 'https://accounts.google.com/o/oauth2'.freeze
+
+    attr_reader :access_token, :refresh_token
+
+    def initialize(client_id, client_secret, redirect_uri = nil)
+      @auth_ok  = false
+      @client_id = client_id
+      @client_secret = client_secret
+      @redirect_uri = redirect_uri
+    end
+
+    def authorize_code!(code)
+      response = request :code => code,
+        :client_id => client_id, :client_secret => client_secret,
+        :redirect_uri => redirect_uri,
+        :grant_type => 'authorization_code'
+
+      @access_token   = response['access_token']
+      @refresh_token  = response['refresh_token']
+      @auth_ok = true
+    end
+
+    # This method is for subsequent initialization if a user has already granted access to
+    # the application. It will fetch a new access_token from a refresh_token.
+    def refresh_token!(refresh_token)
+      @refresh_token = refresh_token
+
+      response = request :refresh_token => refresh_token,
+        :client_id => client_id, :client_secret => client_secret,
+        :grant_type => 'refresh_token'
+
+      @access_token   = response['access_token']
+      @auth_ok = true
+    end
+
+    # Return the HTTP headers appropriate for this authentication type. This method
+    # is used in Google:HTTP.
+    # @return [Hash]
+    def http_headers
+      {'Authorization' => "Bearer #{@access_token}"}
+    end
+
+    private
+    def client_id
+      @client_id
+    end
+
+    def client_secret
+      @client_secret
+    end
+
+    def redirect_uri
+      @redirect_uri
+    end
+
+    # Send a request to the Token uri
+    # @param [String] body The body to POST
+    # @return [Net::HTTPResponse]
+    def request(params)
+      conn = Faraday.new do |builder|
+        builder.request :url_encoded
+
+        builder.use FaradayMiddleware::ParseJson
+        builder.response :raise_error
+
+        builder.adapter :net_http
+      end
+
+      response = conn.post "#{END_POINT}/token", params
+
+      response.body
+    end
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: mail-xoauth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ahawkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gmail_xoauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gmail OAuth IMAP & SMTP connections for the Mail gem
+email:
+- me@broadcastingadam.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- config.yml
+- lib/mail-xoauth.rb
+- lib/mail/network/delivery_methods/xoauth_smtp.rb
+- lib/mail/network/retreiver_methods/xoauth_imap.rb
+- lib/mail/xoauth.rb
+- lib/mail/xoauth/version.rb
+- mail-xoauth.gemspec
+- test/email_test.rb
+- test/test_helper.rb
+homepage: https://github.com/ahawkins/mail-xoauth
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- test/email_test.rb
+- test/test_helper.rb