gmail-oauth 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.markdown
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Bob Potter
+
+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.markdown

@@ -0,0 +1,40 @@
+gmail-oauth
+===========
+
+Implements Gmail OAuth access methods for Net::IMAP and Net::SMTP
+
+Fully working examples (including fetching the access_token) for smtp and imap are in examples/
+
+IMAP Usage
+----------
+
+    require 'gmail-oauth'
+    imap = Net::IMAP.new('imap.gmail.com',993,true)
+
+    # For 3legged oauth provide an OAuth::AcessToken
+    imap.authenticate('XOAUTH', "example@gmail.com", :access_token => access_token)
+
+    # For 2legged oauth just provide the OAuth::Consumer
+    #imap.authenticate('XOAUTH', "example@gmail.com", :consumer => consumer)
+
+    imap.list("*","*").each do |folder|
+      puts folder.name
+    end
+
+SMTP Usage
+----------
+
+    require 'gmail-oauth'
+
+    raw_email = generate_email()  
+
+    smtp = Net::SMTP.new('smtp.gmail.com')
+    smtp.enable_starttls
+    smtp.start('gmail.com', "example@gmail.com", {:access_token => access_token}, :xoauth)
+    smtp.send_message raw_email, "example@gmail.com", "destination@gmail.com"
+    smtp.finish
+
+Copyright
+---------
+
+Copyright (c) 2010 Bob Potter. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "gmail-oauth"
+    gem.summary = %Q{Implements Gmail OAuth access methods for Net::IMAP and Net::SMTP}
+    gem.description = %Q{Implements Gmail OAuth access methods for Net::IMAP and Net::SMTP}
+    gem.email = "bobby.potter@gmail.com"
+    gem.homepage = "http://github.com/bpot/gmail-oauth"
+    gem.authors = ["Bob Potter"]
+    gem.add_development_dependency "rspec", ">= 2.0.0.beta.16"
+    gem.add_dependency "oauth"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |c|
+  c.ruby_opts = "-rubygems"
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "gmail-oauth #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/examples/three_legged_imap.rb

@@ -0,0 +1,26 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+require 'rubygems'
+require 'gmail-oauth'
+
+raise ArgumentError, "please provide email address (ruby examples/three_legged_imap.rb [email_address])" unless ARGV[0]
+
+gmail_address = ARGV[0]
+
+consumer = OAuth::Consumer.new("anonymous", "anonymous", 
+                               :site => "https://www.google.com", 
+                               :request_token_path => "/accounts/OAuthGetRequestToken",
+                               :authorize_path => "/accounts/OAuthAuthorizeToken",
+                               :access_token_path => "/accounts/OAuthGetAccessToken")
+
+rt = consumer.get_request_token({:oauth_callback => "oob"}, {:scope => "https://mail.google.com/"})
+print rt.authorize_url + "\n"
+print "Enter verification code: "
+code = $stdin.gets.chomp
+access_token = rt.get_access_token(:oauth_verifier => code)
+
+#Net::IMAP.debug = true
+imap = Net::IMAP.new('imap.gmail.com',993,true)
+imap.authenticate('XOAUTH', gmail_address, :access_token => access_token)
+imap.list("*","*").each do |folder|
+  puts folder.name
+end

data/examples/three_legged_smtp.rb

@@ -0,0 +1,38 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+require 'rubygems'
+require 'gmail-oauth'
+
+raise ArgumentError, "please provide email address (ruby examples/three_legged_smtp.rb [email_address])" unless ARGV[0]
+
+gmail_address = ARGV[0]
+
+consumer = OAuth::Consumer.new("anonymous", "anonymous", 
+                               :site => "https://www.google.com", 
+                               :request_token_path => "/accounts/OAuthGetRequestToken",
+                               :authorize_path => "/accounts/OAuthAuthorizeToken",
+                               :access_token_path => "/accounts/OAuthGetAccessToken")
+
+rt = consumer.get_request_token({:oauth_callback => "oob"}, {:scope => "https://mail.google.com/"})
+print rt.authorize_url + "\n"
+print "Enter verification code: "
+code = $stdin.gets.chomp
+access_token = rt.get_access_token(:oauth_verifier => code)
+
+
+ msgstr = <<END_OF_MESSAGE
+    From: Blah <#{gmail_address}>
+    To: Destination Address <#{gmail_address}>
+    Subject: test message
+    Date: Sat, 23 Jun 2001 16:26:43 +0900
+    Message-Id: <unique.message.id.string@example.com>
+
+    This is a test message.
+END_OF_MESSAGE
+
+smtp = Net::SMTP.new('smtp.gmail.com')
+smtp.enable_starttls
+smtp.debug_output = $stdout
+#smtp.enable_tls
+smtp.start('gmail.com', gmail_address, {:access_token => access_token}, :xoauth)
+smtp.send_message msgstr, gmail_address, gmail_address
+smtp.finish

data/lib/gmail-oauth.rb

@@ -0,0 +1,32 @@
+require 'gmail-oauth/request'
+require 'gmail-oauth/client'
+require 'net/imap'
+require 'net/smtp'
+require 'oauth'
+require 'cgi'
+
+class Net::IMAP
+  class XOAuthAuthenticator
+    def initialize(email_address, opts = {})
+      @email_address = email_address
+      @opts = opts
+    end
+
+    def process(s)
+      GmailOAuth::Client.new(@email_address, @opts).xoauth_string
+    end
+  end
+  add_authenticator 'XOAUTH', XOAuthAuthenticator
+end
+
+class Net::SMTP
+  def auth_xoauth(email_address, options)
+    auth_string = GmailOAuth::Client.new(email_address, options.merge(:service => :smtp)).xoauth_string
+    res = critical {
+      get_response('AUTH XOAUTH ' + base64_encode(auth_string))
+    }
+    check_auth_response res
+    res
+  end
+end
+

data/lib/gmail-oauth/client.rb

@@ -0,0 +1,38 @@
+module GmailOAuth
+  # Client.new("user@gmail.com", :access_token => @access_token)
+  # Client.new("user@mywork.com", :consumer => @consumer)
+  class Client
+    def initialize(email_address, options = {})
+      raise ArgumentError, "Must provide either an access token (3legged oauth) or a consumer (2legged oauth)" if options[:access_token].nil? && options[:consumer].nil?
+      
+      @email_address  = email_address
+      @access_token   = options[:access_token]
+      if @access_token
+        @consumer       = @access_token.consumer
+      else
+        @consumer       = options[:consumer]
+      end
+      @service        = options[:service] || :imap
+    end
+
+    def xoauth_string
+      params = request["parameters"].merge("oauth_signature" => signature)
+
+      prefix = "GET #{request["uri"]} "
+      prefix + params.keys.sort.select { |k| k != "xoauth_requestor_id" }.collect { |k| "#{k}=\"#{CGI.escape(params[k])}\"" }.join(",")
+    end
+
+    private
+    def signature
+      OAuth::Signature.sign(request, :scheme => 'header') { [access_token_secret, @consumer.secret] } 
+    end
+
+    def access_token_secret
+      @access_token ? @access_token.secret : nil
+    end
+
+    def request
+      @request ||= Request.new(@email_address, @access_token, @consumer, @service).request
+    end
+  end
+end

data/lib/gmail-oauth/request.rb

@@ -0,0 +1,48 @@
+module GmailOAuth
+  class Request
+    def initialize(email_address, access_token, consumer, service = :imap)
+      @email_address  = email_address
+      @consumer       = consumer
+      @access_token   = access_token
+      @service        = service
+    end
+
+    def request
+      {
+        "uri"     => request_uri,
+        "parameters" => parameters,
+        "method" => "GET"
+      }
+    end
+
+    private
+    def two_legged?
+      !@access_token
+    end
+
+    def request_uri
+      uri = "https://mail.google.com/mail/b/#{@email_address}/#{@service}/"
+      if two_legged?
+        uri += "?xoauth_requestor_id=#{CGI.escape(@email_address)}"
+      end
+      uri
+    end
+
+    def parameters
+      params = {
+        "oauth_signature_method" => "HMAC-SHA1",
+        "oauth_version"          => "1.0", 
+        "oauth_nonce"            => OAuth::Helper.generate_nonce,
+        "oauth_timestamp"        => OAuth::Helper.generate_timestamp,
+        "oauth_consumer_key"     => @consumer.key
+      }
+
+      if two_legged?
+        params["xoauth_requestor_id"] = @email_address
+      else
+        params["oauth_token"]     = @access_token.token
+      end
+      params
+    end
+  end
+end

data/spec/gmail-oauth_request_spec.rb

@@ -0,0 +1,66 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe GmailOAuth::Request do
+
+  def consumer
+    OAuth::Consumer.new('consumer_key','secret')
+  end
+
+  def access_token
+    OAuth::AccessToken.new(consumer, 'access_token','secret')
+  end
+
+  context "2legged imap" do
+    before(:each) do
+      @request = GmailOAuth::Request.new("user@mywork.com", nil, consumer)
+    end
+
+    it "should have the correct request uri" do
+      @request.request["uri"].should == "https://mail.google.com/mail/b/user@mywork.com/imap/?xoauth_requestor_id=user%40mywork.com"
+    end
+
+    it "should have oauth_version of 1.0" do
+      @request.request["parameters"]["oauth_version"].should == "1.0"
+    end
+
+    it "should have oauth_signature_method of HMAC_SHA1" do
+      @request.request["parameters"]["oauth_signature_method"].should == "HMAC-SHA1"
+    end
+
+    it "should use access token's consumer's key" do
+      @request.request["parameters"]["oauth_consumer_key"].should == "consumer_key"
+    end
+
+    it "should have the email as the xoauth_requestor_id parameter" do
+      @request.request["parameters"]["xoauth_requestor_id"].should == "user@mywork.com"
+    end
+  end
+
+  context "3legged imap" do
+    before(:each) do
+      @request = GmailOAuth::Request.new("user@gmail.com", access_token, consumer)
+    end
+
+    it "should have the correct request uri" do
+      @request.request["uri"].should == "https://mail.google.com/mail/b/user@gmail.com/imap/"
+    end
+
+    it "should use access token's consumer's key" do
+      @request.request["parameters"]["oauth_consumer_key"].should == "consumer_key"
+    end
+
+    it "should have the access token as the oauth_token parameter" do
+      @request.request["parameters"]["oauth_token"].should == "access_token"
+    end
+  end
+
+  context "3legged smtp" do
+    before(:each) do
+      @request = GmailOAuth::Request.new("user@gmail.com", access_token, consumer, :smtp)
+    end
+
+    it "should have the correct request uri" do
+      @request.request["uri"].should == "https://mail.google.com/mail/b/user@gmail.com/smtp/"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'gmail-oauth'
+require 'rubygems'
+require 'rspec/core'
+
+RSpec.configure do |c|
+  
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification 
+name: gmail-oauth
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Bob Potter
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-08 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 62196419
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 16
+        version: 2.0.0.beta.16
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: Implements Gmail OAuth access methods for Net::IMAP and Net::SMTP
+email: bobby.potter@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- examples/three_legged_imap.rb
+- examples/three_legged_smtp.rb
+- lib/gmail-oauth.rb
+- lib/gmail-oauth/client.rb
+- lib/gmail-oauth/request.rb
+- spec/gmail-oauth_request_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/bpot/gmail-oauth
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Implements Gmail OAuth access methods for Net::IMAP and Net::SMTP
+test_files: 
+- spec/gmail-oauth_request_spec.rb
+- spec/spec_helper.rb
+- examples/three_legged_smtp.rb
+- examples/three_legged_imap.rb