gmail_xoauth 0.1.0

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,14 @@
+Author: Nicolas Fouché <nicolas@silentale.com>
+Copyright: (C) 2010 Silentale SAS
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.markdown

@@ -0,0 +1,56 @@
+# gmail-xoauth
+
+Get access to [Gmail IMAP and STMP via OAuth](http://code.google.com/apis/gmail/oauth), using the standard Ruby Net libraries.
+
+## Install
+
+    $ gem install gmail-xoauth
+
+## Usage
+
+### Get your OAuth tokens
+
+For testing, you can generate and validate your OAuth tokens thanks to the awesome [xoauth.py tool](http://code.google.com/p/google-mail-xoauth-tools/wiki/XoauthDotPyRunThrough).
+
+    $ python xoauth.py --generate_oauth_token --user=myemail@gmail.com
+
+### IMAP
+
+For your tests, Gmail allows to set 'anonymous' as the consumer key and secret.
+
+    require 'gmail_xoauth'
+    imap = Net::IMAP.new('imap.gmail.com', 993, usessl = true, certs = nil, verify = false)
+    imap.authenticate('XOAUTH', 'myemail@gmail.com',
+      :consumer_key => 'anonymous',
+      :consumer_secret => 'anonymous',
+      :token => '4/nM2QAaunKUINb4RrXPC55F-mix_k',
+      :token_secret => '41r18IyXjIvuyabS/NDyW6+m'
+    )
+    messages_count = imap.status('INBOX', ['MESSAGES'])['MESSAGES']
+    puts "Seeing #{messages_count} messages in INBOX"
+
+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.
+
+### SMTP
+
+[wip]
+
+## 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.
+
+The only external dependency is the [oauth gem](http://rubygems.org/gems/oauth).
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (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.
+
+## Copyright
+
+Copyright (c) 2010 Silentale SAS. See LICENSE for details.

data/Rakefile

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

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

data/lib/gmail_xoauth.rb

@@ -0,0 +1 @@
+require 'gmail_xoauth/imap_xoauth_authenticator'

data/lib/gmail_xoauth/imap_xoauth_authenticator.rb

@@ -0,0 +1,61 @@
+require 'net/imap'
+require 'oauth'
+
+module GmailXoauth
+  class ImapXoauthAuthenticator
+
+    def process(data)
+      'GET ' + @request_url + ' ' + @oauth_string
+    end
+
+    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
+  end
+end
+
+Net::IMAP.add_authenticator('XOAUTH', GmailXoauth::ImapXoauthAuthenticator)

data/test/helper.rb

@@ -0,0 +1,44 @@
+require 'yaml'
+
+require 'rubygems'
+require 'test/unit'
+# require 'pony'
+
+$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,40 @@
+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

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: gmail_xoauth
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Nicolas Fouch\xC3\xA9"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-18 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 6
+        version: 0.3.6
+  type: :runtime
+  version_requirements: *id001
+description: Get access to Gmail IMAP and STMP via OAuth, using the standard Ruby Net libraries
+email: nicolas@silentale.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/gmail_xoauth.rb
+- lib/gmail_xoauth/imap_xoauth_authenticator.rb
+- test/helper.rb
+- test/test_imap_xoauth_authenticator.rb
+has_rdoc: true
+homepage: http://github.com/nfo/gmail_xoauth
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+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