gmail_xoauth 0.3.0 → 0.3.2

data/LICENSE

@@ -1,5 +1,5 @@
 Author: Nicolas Fouché <nicolas@silentale.com>
-Copyright: (C) 2010 Silentale SAS
+Copyright: (C) 2011 Silentale SAS
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.markdown

@@ -1,10 +1,10 @@
-# gmail_xoauth
+# gmail_xoauth [![Dependency Status](https://gemnasium.com/nfo/gmail_xoauth.png)](https://gemnasium.com/nfo/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 supports 3-legged and 2-legged OAuth.
+The gem supports 3-legged OAuth, and 2-legged OAuth for Google Apps Business or Education account owners.
 
-Note: 2-legged OAuth support was coded by [Wojciech Kruszewski](https://github.com/wojciech). I could not test it as I don't have a Google Apps Business or Education account. Please [send me a message](https://github.com/inbox/new/nfo) if it works for you.
+Note: 2-legged OAuth support was added by [Wojciech Kruszewski](https://github.com/wojciech).
 
 ## Install
 
@@ -37,6 +37,16 @@ For your tests, Gmail allows to set 'anonymous' as the consumer key and secret.
 
 Note that the [Net::IMAP#login](http://www.ruby-doc.org/core/classes/Net/IMAP.html#M004191) method does not use support custom authenticators, so you have to use the [Net::IMAP#authenticate](http://www.ruby-doc.org/core/classes/Net/IMAP.html#M004190) method.
 
+If you use 2-legged OAuth:
+
+    require 'gmail_xoauth'
+    imap = Net::IMAP.new('imap.gmail.com', 993, usessl = true, certs = nil, verify = false)
+    imap.authenticate('XOAUTH', 'myemail@mydomain.com',
+      :two_legged => true,
+      :consumer_key => 'a',
+      :consumer_secret => 'b'
+    )
+
 ### SMTP
 
 For your tests, Gmail allows to set 'anonymous' as the consumer key and secret.
@@ -55,6 +65,20 @@ For your tests, Gmail allows to set 'anonymous' as the consumer key and secret.
 
 Note that +Net::SMTP#enable_starttls_auto+ is not defined in Ruby 1.8.6.
 
+If you use 2-legged OAuth:
+
+    require 'gmail_xoauth'
+    smtp = Net::SMTP.new('smtp.gmail.com', 587)
+    smtp.enable_starttls_auto
+    secret = {
+    	:two_legged => true,
+      :consumer_key => 'a',
+      :consumer_secret => 'b'
+    }
+    smtp.start('gmail.com', 'myemail@mydomain.com', secret, :xoauth)
+    smtp.finish
+
+
 ## Compatibility
 
 Tested on Ruby MRI 1.8.6, 1.8.7, 1.9.1 and 1.9.2. Feel free to send me a message if you tested this code with other implementations of Ruby.
@@ -63,7 +87,9 @@ The only external dependency is the [oauth gem](http://rubygems.org/gems/oauth).
 
 ## History
 
-* 0.3.0 Experimental 2-legged OAuth support. [Give some feedback](https://github.com/inbox/new/nfo) !
+* 0.3.2 New email for the maintainer
+* 0.3.1 2-legged OAuth support confirmed by [BobDohnal](https://github.com/BobDohnal)
+* 0.3.0 Experimental 2-legged OAuth support
 * 0.2.0 SMTP support
 * 0.1.0 Initial release with IMAP support and 3-legged OAuth
 
@@ -83,4 +109,4 @@ http://about.me/nfo
 
 ## Copyright
 
-Copyright (c) 2010 Silentale SAS. See LICENSE for details.
+Copyright (c) 2011 Silentale SAS. See LICENSE for details.

data/lib/gmail_xoauth/version.rb

@@ -1,3 +1,3 @@
 module GmailXoauth
-  VERSION = "0.3.0"
+  VERSION = "0.3.2"
 end

data/test/helper.rb

@@ -0,0 +1,44 @@
+require 'yaml'
+
+require 'rubygems'
+require 'test/unit'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'gmail_xoauth'
+
+# Wanna debug ? Activate the IMAP debug mode, it will show the client/server conversation
+# Net::IMAP.debug = true
+
+# SMTP debugging can only be enabled on Net::SMTP instances
+# Net::SMTP.class_eval do
+#   def initialize_with_debug(*args)
+#     initialize_without_debug(*args)
+#     @debug_output = STDERR
+#   end
+#   alias_method :initialize_without_debug, :initialize
+#   alias_method :initialize, :initialize_with_debug
+# end
+
+VALID_CREDENTIALS = begin
+  YAML.load_file(File.join(File.dirname(__FILE__), 'valid_credentials.yml'))
+rescue Errno::ENOENT
+  STDERR.puts %(
+Warning: some tests are disabled because they require valid credentials. To enable them, create a file \"test/valid_credentials.yml\".
+It should contain valid OAuth tokens. Valid tokens can be generated thanks to \"xoauth.py\":http://code.google.com/p/google-mail-xoauth-tools/.
+Of course, this file is .gitignored. Template:
+
+---
+:email: someuser@gmail.com
+:consumer_key: anonymous # "anonymous" is a valid value for testing
+:consumer_secret: anonymous # "anonymous" is a valid value for testing
+:token: 1/nE2xBCDOU0429bTeJySE11kRE95qzKQNlfTaaBcDeFg
+:token_secret: 123Z/bMsi9fFhN6qHFWOabcd
+
+)
+  false
+end
+
+class Test::Unit::TestCase
+end

data/test/test_imap_xoauth_authenticator.rb

@@ -0,0 +1,68 @@
+require 'helper'
+
+class TestImapXoauthAuthenticator < Test::Unit::TestCase
+  
+  def setup
+  end
+  
+  def test_xoauth_authenticator_is_enabled
+    authenticators = Net::IMAP.__send__('class_variable_get', '@@authenticators')
+    assert_not_nil authenticators['XOAUTH']
+    assert_equal authenticators['XOAUTH'], GmailXoauth::ImapXoauthAuthenticator
+  end
+  
+  def test_authenticate_with_invalid_credentials
+    imap = Net::IMAP.new('imap.gmail.com', 993, usessl = true, certs = nil, verify = false)
+    assert_raise(Net::IMAP::NoResponseError) do
+      imap.authenticate('XOAUTH', 'roger@moore.com',
+        :token => 'a',
+        :token_secret => 'b'
+      )
+    end
+  end
+  
+  def test_authenticate_with_valid_credentials
+    return unless VALID_CREDENTIALS
+    
+    imap = Net::IMAP.new('imap.gmail.com', 993, usessl = true, certs = nil, verify = false)
+    imap.authenticate('XOAUTH', VALID_CREDENTIALS[:email],
+      :consumer_key => VALID_CREDENTIALS[:consumer_key],
+      :consumer_secret => VALID_CREDENTIALS[:consumer_secret],
+      :token => VALID_CREDENTIALS[:token],
+      :token_secret => VALID_CREDENTIALS[:token_secret]
+    )
+    mailboxes = imap.list('', '*')
+    assert_instance_of Array, mailboxes
+    assert_instance_of Net::IMAP::MailboxList, mailboxes.first
+  ensure
+    imap.disconnect if imap
+  end
+
+  def test_2_legged_authenticate_with_invalid_credentials
+    imap = Net::IMAP.new('imap.gmail.com', 993, usessl = true, certs = nil, verify = false)
+    assert_raise(Net::IMAP::NoResponseError) do
+      imap.authenticate('XOAUTH', 'roger@moore.com',
+        :two_legged => true,
+        :consumer_key => 'a',
+        :consumer_secret => 'b'
+      )
+    end
+  end
+  
+  def test_2_legged_authenticate_with_valid_credentials
+    return unless VALID_CREDENTIALS
+    
+    imap = Net::IMAP.new('imap.gmail.com', 993, usessl = true, certs = nil, verify = false)
+    imap.authenticate('XOAUTH', VALID_CREDENTIALS[:email],
+      :two_legged => true,
+      :consumer_key => VALID_CREDENTIALS[:consumer_key],
+      :consumer_secret => VALID_CREDENTIALS[:consumer_secret]
+    )
+    mailboxes = imap.list('', '*')
+    assert_instance_of Array, mailboxes
+    assert_instance_of Net::IMAP::MailboxList, mailboxes.first
+  ensure
+    imap.disconnect if imap
+  end
+
+end

data/test/test_oauth_string.rb

@@ -0,0 +1,74 @@
+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_2_legged_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/?xoauth_requestor_id=user_name%40gmail.com";
+    oauth_params = {
+			:two_legged => true,
+      :consumer_key => 'c',
+      :consumer_secret => 'd',
+			:xoauth_requestor_id => 'user_name@gmail.com'
+    }
+    
+    oauth_string = C.new.__send__('build_oauth_string', request_url, oauth_params)
+    
+    assert_equal(
+			'oauth_consumer_key="c",oauth_nonce="abc",oauth_signature="eG6PG7Q%2BPbI%2FNeLLCZ9PvlB%2BUjg%3D",oauth_signature_method="HMAC-SHA1",oauth_timestamp="1274215474",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,66 @@
+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.started?
+  end
+
+  def test_2_legged_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', {:two_legged => true, :consumer_key => 'a', :consumer_secret => 'b'}, :xoauth)
+    end
+  end
+  
+  def test_2_legged_authenticate_with_valid_credentials
+    return unless VALID_CREDENTIALS
+    
+    smtp = Net::SMTP.new('smtp.gmail.com', 587)
+    smtp.enable_starttls_auto
+    
+    secret = {
+			:two_legged => true,
+      :consumer_key => VALID_CREDENTIALS[:consumer_key],
+      :consumer_secret => VALID_CREDENTIALS[:consumer_secret],
+    }
+    
+    assert_nothing_raised do
+      smtp.start('gmail.com', VALID_CREDENTIALS[:email], secret, :xoauth)
+    end
+  ensure
+    smtp.finish if smtp.started?
+  end
+end

metadata

@@ -1,100 +1,91 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: gmail_xoauth
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 3
-  - 0
-  version: 0.3.0
+version: !ruby/object:Gem::Version
+  version: 0.3.2
+  prerelease: 
 platform: ruby
-authors: 
-- "Nicolas Fouch\xC3\xA9"
+authors:
+- Nicolas Fouché
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-12-13 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: oauth
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 3
-        - 6
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.3.6
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: shoulda
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.6
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        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
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Get access to Gmail IMAP and STMP via OAuth, using the standard Ruby
+  Net libraries
+email:
+- nicolas.fouche@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/gmail_xoauth/imap_xoauth_authenticator.rb
 - lib/gmail_xoauth/oauth_string.rb
 - lib/gmail_xoauth/smtp_xoauth_authenticator.rb
 - lib/gmail_xoauth/version.rb
 - lib/gmail_xoauth.rb
+- test/helper.rb
+- test/test_imap_xoauth_authenticator.rb
+- test/test_oauth_string.rb
+- test/test_smtp_xoauth_authenticator.rb
 - LICENSE
 - README.markdown
-has_rdoc: true
-homepage: http://geeks.silentale.com/2010/05/26/gmail-and-oauth-ruby-gem
+homepage: https://github.com/nfo/gmail_xoauth
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 3
-      - 6
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
-summary: Get access to Gmail IMAP and STMP via OAuth, using the standard Ruby Net libraries
+summary: Get access to Gmail IMAP and STMP via OAuth, using the standard Ruby Net
+  libraries
 test_files: []
-