gmail_xoauth 0.1.0 → 0.2.0

data/.gitignore

@@ -17,6 +17,8 @@ tmtags
 coverage
 rdoc
 pkg
+*.gemspec
+*.gem
 
 ## PROJECT::SPECIFIC
 test/valid_credentials.yml

data/README.markdown

@@ -1,10 +1,12 @@
-# gmail-xoauth
+# gmail_xoauth
 
 Get access to [Gmail IMAP and STMP via OAuth](http://code.google.com/apis/gmail/oauth), using the standard Ruby Net libraries.
 
+The gem only supports 3-legged OAuth. If you need [2-legged OAuth feel](http://code.google.com/apis/accounts/docs/OAuth.html) free to fork!
+
 ## Install
 
-    $ gem install gmail-xoauth
+    $ gem install gmail_xoauth
 
 ## Usage
 
@@ -33,7 +35,21 @@ Note that the [Net::IMAP#login](http://www.ruby-doc.org/core/classes/Net/IMAP.ht
 
 ### SMTP
 
-[wip]
+For your tests, Gmail allows to set 'anonymous' as the consumer key and secret.
+
+    require 'gmail_xoauth'
+    smtp = Net::SMTP.new('smtp.gmail.com', 587)
+    smtp.enable_starttls_auto
+    secret = {
+      :consumer_key => 'anonymous',
+      :consumer_secret => 'anonymous',
+      :token => '4/nM2QAaunKUINb4RrXPC55F-mix_k',
+      :token_secret => '41r18IyXjIvuyabS/NDyW6+m'
+    }
+    smtp.start('gmail.com', 'myemail@gmail.com', secret, :xoauth)
+    smtp.finish
+
+Note that +Net::SMTP#enable_starttls_auto+ is not defined in Ruby 1.8.6.
 
 ## Compatibility
 

data/Rakefile

@@ -11,6 +11,7 @@ begin
     gem.homepage = "http://github.com/nfo/gmail_xoauth"
     gem.authors = ["Nicolas Fouch\303\251"]
     gem.add_dependency "oauth", ">= 0.3.6"
+    gem.add_development_dependency "shoulda", ">= 0"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/gmail_xoauth.rb

@@ -1 +1,3 @@
+require 'gmail_xoauth/oauth_string'
 require 'gmail_xoauth/imap_xoauth_authenticator'
+require 'gmail_xoauth/smtp_xoauth_authenticator'

data/lib/gmail_xoauth/imap_xoauth_authenticator.rb

@@ -3,58 +3,22 @@ require 'oauth'
 
 module GmailXoauth
   class ImapXoauthAuthenticator
-
+    
     def process(data)
-      'GET ' + @request_url + ' ' + @oauth_string
+      build_sasl_client_request(@request_url, @oauth_string)
     end
-
-    private
-
+    
+  private
+    
     # +user+ is an email address: roger@gmail.com
     # +password+ is a hash of oauth parameters, see +build_oauth_string+
     def initialize(user, password)
       @request_url = "https://mail.google.com/mail/b/#{user}/imap/"
       @oauth_string = build_oauth_string(@request_url, password)
     end
-
-    #
-    # Builds the "oauth protocol parameter string". See http://code.google.com/apis/gmail/oauth/protocol.html#sasl
-    # 
-    #   +request_url+ https://mail.google.com/mail/b/user_name@gmail.com/imap/
-    #   +oauth_params+ contains the following keys:
-    #     * :consumer_key (default 'anonymous')
-    #     * :consumer_secret (default 'anonymous')
-    #     * :token (mandatory)
-    #     * :token_secret (mandatory)
-    def build_oauth_string(request_url, oauth_params = {})
-      oauth_params[:consumer_key] ||= 'anonymous'
-      oauth_params[:consumer_secret] ||= 'anonymous'
-      
-      oauth_request_params = {
-        "oauth_consumer_key"     => oauth_params[:consumer_key],
-        'oauth_nonce'            => OAuth::Helper.generate_key,
-        "oauth_signature_method" => 'HMAC-SHA1',
-        'oauth_timestamp'        => OAuth::Helper.generate_timestamp,
-        "oauth_token"            => oauth_params[:token],
-        'oauth_version'          => '1.0'
-      }
-      
-      request = OAuth::RequestProxy.proxy(
-         'method'     => 'GET',
-         'uri'        => request_url,
-         'parameters' => oauth_request_params
-      )
-      
-      oauth_request_params['oauth_signature'] =
-        OAuth::Signature.sign(
-          request,
-          :consumer_secret => oauth_params[:consumer_secret],
-          :token_secret    => oauth_params[:token_secret]
-        )
-      
-      # Inspired from oauth_header OAuth::RequestProxy::Base#oauth_header
-      oauth_request_params.map { |k,v| "#{k}=\"#{OAuth::Helper.escape(v)}\"" }.sort.join(',')
-    end
+    
+    include OauthString
+    
   end
 end
 

data/lib/gmail_xoauth/oauth_string.rb

@@ -0,0 +1,51 @@
+module GmailXoauth
+  module OauthString
+  
+  private
+    
+    #
+    # Builds the "oauth protocol parameter string". See http://code.google.com/apis/gmail/oauth/protocol.html#sasl
+    # 
+    #   +request_url+ https://mail.google.com/mail/b/user_name@gmail.com/{imap|smtp}/
+    #   +oauth_params+ contains the following keys:
+    #     * :consumer_key (default 'anonymous')
+    #     * :consumer_secret (default 'anonymous')
+    #     * :token (mandatory)
+    #     * :token_secret (mandatory)
+    def build_oauth_string(request_url, oauth_params = {})
+      oauth_params[:consumer_key] ||= 'anonymous'
+      oauth_params[:consumer_secret] ||= 'anonymous'
+      
+      oauth_request_params = {
+        "oauth_consumer_key"     => oauth_params[:consumer_key],
+        'oauth_nonce'            => OAuth::Helper.generate_key,
+        "oauth_signature_method" => 'HMAC-SHA1',
+        'oauth_timestamp'        => OAuth::Helper.generate_timestamp,
+        "oauth_token"            => oauth_params[:token],
+        'oauth_version'          => '1.0'
+      }
+      
+      request = OAuth::RequestProxy.proxy(
+         'method'     => 'GET',
+         'uri'        => request_url,
+         'parameters' => oauth_request_params
+      )
+      
+      oauth_request_params['oauth_signature'] =
+        OAuth::Signature.sign(
+          request,
+          :consumer_secret => oauth_params[:consumer_secret],
+          :token_secret    => oauth_params[:token_secret]
+        )
+      
+      # Inspired from OAuth::RequestProxy::Base#oauth_header
+      oauth_request_params.map { |k,v| "#{k}=\"#{OAuth::Helper.escape(v)}\"" }.sort.join(',')
+    end
+    
+    # See http://code.google.com/apis/gmail/oauth/protocol.html#sasl
+    def build_sasl_client_request(request_url, oauth_string)
+      'GET ' + request_url + ' ' + oauth_string
+    end
+    
+  end
+end

data/lib/gmail_xoauth/smtp_xoauth_authenticator.rb

@@ -0,0 +1,28 @@
+require 'net/smtp'
+require 'oauth'
+
+module GmailXoauth
+  module SmtpXoauthAuthenticator
+    
+    def auth_xoauth(user, secret)
+      check_auth_args user, secret
+      
+      request_url  = "https://mail.google.com/mail/b/#{user}/smtp/"
+      oauth_string = build_oauth_string(request_url, secret)
+      sasl_client_request = build_sasl_client_request(request_url, oauth_string)
+      
+      res = critical {
+        get_response("AUTH XOAUTH #{base64_encode(sasl_client_request)}")
+      }
+      
+      check_auth_response res
+      res
+    end
+    
+    include OauthString
+    
+  end
+end
+
+# Not pretty, right ?
+Net::SMTP.__send__('include', GmailXoauth::SmtpXoauthAuthenticator)

data/test/helper.rb

@@ -2,7 +2,7 @@ require 'yaml'
 
 require 'rubygems'
 require 'test/unit'
-# require 'pony'
+require 'mocha'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))

data/test/test_oauth_string.rb

@@ -0,0 +1,54 @@
+require 'helper'
+
+class TestOauthString < Test::Unit::TestCase
+  
+  def setup
+  end
+  
+  def test_build_oauth_string_should_accept_custom_consumer
+    OAuth::Helper.stubs(:generate_key).returns('abc')
+    OAuth::Helper.stubs(:generate_timestamp).returns(1274215474)
+    
+    request_url = "https://mail.google.com/mail/b/user_name@gmail.com/imap/"
+    oauth_params = {
+      :consumer_key => 'c',
+      :consumer_secret => 'd',
+      :token => 'a',
+      :token_secret => 'b',
+    }
+    
+    oauth_string = C.new.__send__('build_oauth_string', request_url, oauth_params)
+    
+    assert_equal(
+      'oauth_consumer_key="c",oauth_nonce="abc",oauth_signature="eseW9YybDf3fPToiwyLdUwSlfUw%3D",oauth_signature_method="HMAC-SHA1",oauth_timestamp="1274215474",oauth_token="a",oauth_version="1.0"',
+      oauth_string
+    )
+  end
+  
+  def test_build_oauth_string_should_set_consumer_anonymous_by_default
+    OAuth::Helper.stubs(:generate_key).returns('abc')
+    OAuth::Helper.stubs(:generate_timestamp).returns(1274215474)
+    
+    request_url = "https://mail.google.com/mail/b/user_name@gmail.com/imap/"
+    oauth_params = {
+      :token => 'a',
+      :token_secret => 'b',
+    }
+    
+    oauth_string = C.new.__send__('build_oauth_string', request_url, oauth_params)
+    
+    assert_equal(
+      'oauth_consumer_key="anonymous",oauth_nonce="abc",oauth_signature="weu3Z%2Baqn6YUNnSLJmIvUwnCEmo%3D",oauth_signature_method="HMAC-SHA1",oauth_timestamp="1274215474",oauth_token="a",oauth_version="1.0"',
+      oauth_string
+    )
+  end
+  
+  def test_build_sasl_client_request
+    assert_equal 'GET 1 2', C.new.__send__('build_sasl_client_request', '1', '2')
+  end
+  
+end
+
+class C
+  include GmailXoauth::OauthString
+end

data/test/test_smtp_xoauth_authenticator.rb

@@ -0,0 +1,39 @@
+require 'helper'
+
+class TestSmtpXoauthAuthenticator < Test::Unit::TestCase
+  
+  def setup
+  end
+  
+  def test_smtp_authenticator_is_enabled
+    assert Net::SMTP.new(nil).respond_to?(:auth_xoauth), 'The Net::SMTP class should define the method :auth_xoauth'
+  end
+  
+  def test_authenticate_with_invalid_credentials
+    smtp = Net::SMTP.new('smtp.gmail.com', 587)
+    smtp.enable_starttls_auto
+    assert_raise(Net::SMTPAuthenticationError) do
+      smtp.start('gmail.com', 'roger@moore.com', {:token => 'a', :token_secret => 'b'}, :xoauth)
+    end
+  end
+  
+  def test_authenticate_with_valid_credentials
+    return unless VALID_CREDENTIALS
+    
+    smtp = Net::SMTP.new('smtp.gmail.com', 587)
+    smtp.enable_starttls_auto
+    
+    secret = {
+      :consumer_key => VALID_CREDENTIALS[:consumer_key],
+      :consumer_secret => VALID_CREDENTIALS[:consumer_secret],
+      :token => VALID_CREDENTIALS[:token],
+      :token_secret => VALID_CREDENTIALS[:token_secret],
+    }
+    
+    assert_nothing_raised do
+      smtp.start('gmail.com', VALID_CREDENTIALS[:email], secret, :xoauth)
+    end
+  ensure
+    smtp.finish if smtp
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - "Nicolas Fouch\xC3\xA9"
@@ -31,6 +31,18 @@ dependencies:
         version: 0.3.6
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
 description: Get access to Gmail IMAP and STMP via OAuth, using the standard Ruby Net libraries
 email: nicolas@silentale.com
 executables: []
@@ -48,8 +60,12 @@ files:
 - VERSION
 - lib/gmail_xoauth.rb
 - lib/gmail_xoauth/imap_xoauth_authenticator.rb
+- lib/gmail_xoauth/oauth_string.rb
+- lib/gmail_xoauth/smtp_xoauth_authenticator.rb
 - test/helper.rb
 - test/test_imap_xoauth_authenticator.rb
+- test/test_oauth_string.rb
+- test/test_smtp_xoauth_authenticator.rb
 has_rdoc: true
 homepage: http://github.com/nfo/gmail_xoauth
 licenses: []
@@ -83,3 +99,5 @@ summary: Get access to Gmail IMAP and STMP via OAuth, using the standard Ruby Ne
 test_files: 
 - test/helper.rb
 - test/test_imap_xoauth_authenticator.rb
+- test/test_oauth_string.rb
+- test/test_smtp_xoauth_authenticator.rb