gmail_xoauth 0.2.0 → 0.3.0

data/README.markdown

@@ -2,7 +2,9 @@
 
 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!
+The gem supports 3-legged and 2-legged OAuth.
+
+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.
 
 ## Install
 
@@ -16,6 +18,8 @@ For testing, you can generate and validate your OAuth tokens thanks to the aweso
 
     $ python xoauth.py --generate_oauth_token --user=myemail@gmail.com
 
+Or if you want some webapp code, check the [gmail-oauth-sinatra](https://github.com/nfo/gmail-oauth-sinatra) project.
+
 ### IMAP
 
 For your tests, Gmail allows to set 'anonymous' as the consumer key and secret.
@@ -53,10 +57,16 @@ Note that +Net::SMTP#enable_starttls_auto+ is not defined in Ruby 1.8.6.
 
 ## Compatibility
 
-Tested on Ruby MRI 1.8.6, 1.8.7 and 1.9.1. Feel free to send me a message if you tested this code with other implementations of Ruby.
+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.
 
 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.2.0 SMTP support
+* 0.1.0 Initial release with IMAP support and 3-legged OAuth
+
 ## Note on Patches/Pull Requests
  
 * Fork the project.
@@ -67,6 +77,10 @@ The only external dependency is the [oauth gem](http://rubygems.org/gems/oauth).
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
+## Contact me
+
+http://about.me/nfo
+
 ## Copyright
 
 Copyright (c) 2010 Silentale SAS. See LICENSE for details.

data/lib/gmail_xoauth/imap_xoauth_authenticator.rb

@@ -13,7 +13,13 @@ module GmailXoauth
     # +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/"
+      @request_url = "https://mail.google.com/mail/b/#{user}/imap/";
+
+      if password[:two_legged]
+        password = password.merge({:xoauth_requestor_id => user})
+        @request_url += "?xoauth_requestor_id=#{CGI.escape(user)}";
+      end
+
       @oauth_string = build_oauth_string(@request_url, password)
     end
     
@@ -22,4 +28,4 @@ module GmailXoauth
   end
 end
 
-Net::IMAP.add_authenticator('XOAUTH', GmailXoauth::ImapXoauthAuthenticator)
+Net::IMAP.add_authenticator('XOAUTH', GmailXoauth::ImapXoauthAuthenticator)

data/lib/gmail_xoauth/oauth_string.rb

@@ -21,14 +21,17 @@ module GmailXoauth
         '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'
       }
+      oauth_request_params["oauth_token"] = oauth_params[:token] unless oauth_params[:two_legged]
       
+      oauth_request_params_for_signing = oauth_request_params.dup
+      oauth_request_params_for_signing["xoauth_requestor_id"] = oauth_params[:xoauth_requestor_id] if oauth_params[:two_legged]
+
       request = OAuth::RequestProxy.proxy(
          'method'     => 'GET',
          'uri'        => request_url,
-         'parameters' => oauth_request_params
+         'parameters' => oauth_request_params_for_signing
       )
       
       oauth_request_params['oauth_signature'] =
@@ -41,11 +44,11 @@ module GmailXoauth
       # 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
+end

data/lib/gmail_xoauth/smtp_xoauth_authenticator.rb

@@ -8,7 +8,14 @@ module GmailXoauth
       check_auth_args user, secret
       
       request_url  = "https://mail.google.com/mail/b/#{user}/smtp/"
+
+      if secret[:two_legged]
+        request_url += "?xoauth_requestor_id=#{CGI.escape(user)}";
+				secret = secret.merge({:xoauth_requestor_id => user})
+      end
+
       oauth_string = build_oauth_string(request_url, secret)
+
       sasl_client_request = build_sasl_client_request(request_url, oauth_string)
       
       res = critical {
@@ -25,4 +32,4 @@ module GmailXoauth
 end
 
 # Not pretty, right ?
-Net::SMTP.__send__('include', GmailXoauth::SmtpXoauthAuthenticator)
+Net::SMTP.__send__('include', GmailXoauth::SmtpXoauthAuthenticator)

data/lib/gmail_xoauth/version.rb

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

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - "Nicolas Fouch\xC3\xA9"
@@ -14,13 +14,14 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-18 00:00:00 +02:00
+date: 2010-12-13 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: oauth
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -35,6 +36,7 @@ dependencies:
   name: shoulda
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -44,30 +46,24 @@ dependencies:
   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
+email: 
+- nicolas@silentale.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE
-- README.markdown
+extra_rdoc_files: []
+
 files: 
-- .gitignore
-- LICENSE
-- README.markdown
-- Rakefile
-- 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
+- lib/gmail_xoauth/version.rb
+- lib/gmail_xoauth.rb
+- LICENSE
+- README.markdown
 has_rdoc: true
-homepage: http://github.com/nfo/gmail_xoauth
+homepage: http://geeks.silentale.com/2010/05/26/gmail-and-oauth-ruby-gem
 licenses: []
 
 post_install_message: 
@@ -76,6 +72,7 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -83,21 +80,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Get access to Gmail IMAP and STMP via OAuth, using the standard Ruby Net libraries
-test_files: 
-- test/helper.rb
-- test/test_imap_xoauth_authenticator.rb
-- test/test_oauth_string.rb
-- test/test_smtp_xoauth_authenticator.rb
+test_files: []
+

data/.gitignore

@@ -1,24 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-*.gemspec
-*.gem
-
-## PROJECT::SPECIFIC
-test/valid_credentials.yml

data/Rakefile

@@ -1,53 +0,0 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "gmail_xoauth"
-    gem.summary = %Q{Get access to Gmail IMAP and STMP via OAuth, using the standard Ruby Net libraries}
-    gem.description = %Q{Get access to Gmail IMAP and STMP via OAuth, using the standard Ruby Net libraries}
-    gem.email = "nicolas@silentale.com"
-    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
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
-
-task :test => :check_dependencies
-
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "gmail_xoauth #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/VERSION

@@ -1 +0,0 @@
-0.2.0

data/test/helper.rb

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

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

data/test/test_oauth_string.rb

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

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