gmail_xoauth 0.4.1 → 0.4.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a128d4dd6159a1ceaeb6415c6cf0956e358e5752cca94617896f851ecdd71587
+  data.tar.gz: 2d89b9a0d67b700fdfafb5bec9d2af4f16404bd07a606b221afd508d072dc258
+SHA512:
+  metadata.gz: 7f20d1e04affcc7e5c4f239bc44d7534aa20d6b5752b0751367a5087566b61b882c169c6e10342f5d01f04eb67fbc0c695ad781ca9c814783483d54fa5112b10
+  data.tar.gz: 43c1ce7b6de2095bb826c4815fa44758534b404762cf83ac99690da24c7566da508378921caaf6544babc4712c9a3cca6cfb4d9b1708ad3f802e5a08f8422c7d

data/LICENSE

@@ -1,14 +1,24 @@
-Author: Nicolas Fouché <nicolas.fouche@gmail.com>
-Copyright: (C) 2011 Silentale SAS
+This is free and unencumbered software released into the public domain.
 
-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
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
 
-http://www.apache.org/licenses/LICENSE-2.0
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
 
-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.
+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 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.
+
+For more information, please refer to <https://unlicense.org>

data/README.markdown

@@ -1,6 +1,6 @@
-# gmail_xoauth [![Dependency Status](https://gemnasium.com/nfo/gmail_xoauth.png)](https://gemnasium.com/nfo/gmail_xoauth)
+# gmail_xoauth [![Gem Version](https://badge.fury.io/rb/gmail_xoauth.png)](http://badge.fury.io/rb/gmail_xoauth)
 
-Get access to [Gmail IMAP and STMP via OAuth2](https://developers.google.com/google-apps/gmail/xoauth2_protocol) and [OAuth 1.0a](https://developers.google.com/google-apps/gmail/oauth_protocol), using the standard Ruby Net libraries.
+Get access to [Gmail IMAP and SMTP via OAuth2](https://developers.google.com/google-apps/gmail/xoauth2_protocol) and [OAuth 1.0a](https://developers.google.com/google-apps/gmail/oauth_protocol), using the standard Ruby Net libraries.
 
 The gem supports 3-legged OAuth, and 2-legged OAuth for Google Apps Business or Education account owners.
 
@@ -14,9 +14,11 @@ The gem supports 3-legged OAuth, and 2-legged OAuth for Google Apps Business or
 
 You can generate and validate your OAuth 2.0 tokens thanks to the [oauth2.py tool](http://code.google.com/p/google-mail-oauth2-tools/wiki/OAuth2DotPyRunThrough).
 
-Create your API project in the [Google APIs console](https://code.google.com/apis/console/), from the "API Access" tab.
+Create your API project in the [Google APIs console](https://code.google.com/apis/console/), from the menu "APIs and auth > Credentials". Click on "Create new Client ID", choose "Installed Application" and "Other".
 
-    $ python oauth2.py --generate_oauth2_token --client_id=364545978226.apps.googleusercontent.com --client_secret=zNrNsBzOOnQy8_O-8LkofeTR
+Then go to the menu "APIs and auth > Consent screen" and enter an email address and product name.
+
+    $ python oauth2.py --generate_oauth2_token --client_id=423906513574-o9v6kqt89lefrbfv1f3394u9rebfgv6n.apps.googleusercontent.com --client_secret=5SfdvZsYagblukE5VAhERjxZ
 
 ### IMAP OAuth 2.0
 
@@ -118,14 +120,15 @@ smtp.finish
 
 ## Compatibility
 
-Tested on Ruby MRI 1.8.6, 1.8.7, 1.9.1, 1.9.2 and 1.9.3. 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.x and 2.1.x. 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.4.1 Changed to way to give the OAuth 2.0 token, see https://github.com/nfo/gmail_xoauth/commit/b7b936cfb094c2fc9b8e9e48526906191423cb88
-* 0.4.0 [XOAUTH2](https://developers.google.com/google-apps/gmail/xoauth2_protocol) support, thanks to [glongman](https://github.com/glongman)
+* 0.4.3 Maintenance: Use Net::IMAP::SASL.add_authenticator to silence deprecation warning, thanks to [mantas](https://github.com/mantas)
+* 0.4.2 SMTP: on 3xx response to 'AUTH XOAUTH2' send CR-LF to get actual error, thanks to [rafalyesware](https://github.com/rafalyesware)
+* 0.4.1 [XOAUTH2](https://developers.google.com/google-apps/gmail/xoauth2_protocol) support, thanks to [glongman](https://github.com/glongman)
 * 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, thanks to [wojciech](https://github.com/wojciech)
@@ -133,7 +136,7 @@ The only external dependency is the [oauth gem](http://rubygems.org/gems/oauth).
 * 0.1.0 Initial release with IMAP support and 3-legged 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
@@ -144,8 +147,8 @@ The only external dependency is the [oauth gem](http://rubygems.org/gems/oauth).
 
 ## Contact me
 
-http://about.me/nfo
+https://nicolasfouche.com
 
 ## License
 
-See LICENSE for details.
+See LICENSE for details.

data/lib/gmail_xoauth/imap_xoauth2_authenticator.rb

@@ -21,4 +21,8 @@ module GmailXoauth
   end
 end
 
-Net::IMAP.add_authenticator('XOAUTH2', GmailXoauth::ImapXoauth2Authenticator)
+if Net::IMAP.const_defined?('SASL') && Net::IMAP::SASL.respond_to?(:add_authenticator)
+  Net::IMAP::SASL.add_authenticator('XOAUTH2', GmailXoauth::ImapXoauth2Authenticator)
+else
+  Net::IMAP.add_authenticator('XOAUTH2', GmailXoauth::ImapXoauth2Authenticator)
+end

data/lib/gmail_xoauth/imap_xoauth_authenticator.rb

@@ -28,4 +28,8 @@ module GmailXoauth
   end
 end
 
-Net::IMAP.add_authenticator('XOAUTH', GmailXoauth::ImapXoauthAuthenticator)
+if Net::IMAP.const_defined?('SASL') && Net::IMAP::SASL.respond_to?(:add_authenticator)
+  Net::IMAP::SASL.add_authenticator('XOAUTH', GmailXoauth::ImapXoauthAuthenticator)
+else
+  Net::IMAP.add_authenticator('XOAUTH', GmailXoauth::ImapXoauthAuthenticator)
+end

data/lib/gmail_xoauth/smtp_xoauth2_authenticator.rb

@@ -3,14 +3,31 @@ require 'base64'
 
 module GmailXoauth
   module SmtpXoauth2Authenticator
-    
+
+    def send_xoauth2(auth_token)
+      critical {
+        get_response("AUTH XOAUTH2 #{auth_token}")
+      }
+    end
+    private :send_xoauth2
+
+    def get_final_status
+      critical {
+        get_response("")
+      }
+    end
+    private :get_final_status
+
     def auth_xoauth2(user, oauth2_token)
       check_auth_args user, oauth2_token
 
       auth_string = build_oauth2_string(user, oauth2_token)
-      res = critical {
-        get_response("AUTH XOAUTH2 #{base64_encode(auth_string)}")
-      }
+      res = send_xoauth2(base64_encode(auth_string))
+
+      # See note about SMTP protocol exchange in https://developers.google.com/gmail/xoauth2_protocol
+      if res.continue?
+        res = get_final_status
+      end
       
       check_auth_response res
       res

data/lib/gmail_xoauth/version.rb

@@ -1,3 +1,3 @@
 module GmailXoauth
-  VERSION = "0.4.1"
-end
+  VERSION = "0.4.3"
+end

data/test/helper.rb

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

data/test/test_smtp_xoauth2_authenticator.rb

@@ -29,4 +29,30 @@ class TestSmtpXoauthAuthenticator < Test::Unit::TestCase
   ensure
     smtp.finish if smtp && smtp.started?
   end
+
+  # Test the handling of 3xx response to an "AUTH XOAUTH2" request... client
+  # should send a "\r\n" to get the actual error that occurred.
+  #
+  # See note about SMTP protocol exchange in https://developers.google.com/
+  # gmail/xoauth2_protocol
+  #
+  def test_authenticate_with_continuation
+    smtp = Net::SMTP.new('smtp.gmail.com', 587)
+
+    # Stub return from initial "AUTH XOAUTH2" request as well as the empty line sent to get final error
+    smtp.stubs(:send_xoauth2).returns(Net::SMTP::Response.parse("334 eyJzdGF0dXMiOiI0MDAiLCJzY2hlbWVzIjoiQmVhcmVyIiwic2NvcGUiOiJodHRwczovL21haWwuZ29vZ2xlLmNvbS8ifQ=="))
+    smtp.stubs(:get_final_status).returns(Net::SMTP::Response.parse("454 4.7.0 Too many login attempts, please try again later. j63sm3521185itj.19 - gsmtp"))
+
+    smtp.enable_starttls_auto
+
+    # Validate an error is still raised
+    ex = assert_raise(Net::SMTPAuthenticationError) do
+      smtp.start('gmail.com', 'roger@moore.com', 'a', :xoauth2)
+    end
+
+    # ...and that the 334 is not passed back to the caller.
+    assert_equal("454 4.7.0 Too many login attempts, please try again later. j63sm3521185itj.19 - gsmtp", ex.message)
+  ensure
+    smtp.finish if smtp && smtp.started?
+  end
 end

metadata

@@ -1,46 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: gmail_xoauth
 version: !ruby/object:Gem::Version
-  version: 0.4.1
-  prerelease: 
+  version: 0.4.3
 platform: ruby
 authors:
 - Nicolas Fouché
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-16 00:00:00.000000000 Z
+date: 2024-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.6
   type: :runtime
   prerelease: false
   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
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Get access to Gmail IMAP and STMP via OAuth, using the standard Ruby
@@ -51,45 +60,43 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.markdown
+- lib/gmail_xoauth.rb
 - lib/gmail_xoauth/imap_xoauth2_authenticator.rb
 - lib/gmail_xoauth/imap_xoauth_authenticator.rb
 - lib/gmail_xoauth/oauth_string.rb
 - lib/gmail_xoauth/smtp_xoauth2_authenticator.rb
 - lib/gmail_xoauth/smtp_xoauth_authenticator.rb
 - lib/gmail_xoauth/version.rb
-- lib/gmail_xoauth.rb
 - test/helper.rb
 - test/test_imap_xoauth2_authenticator.rb
 - test/test_imap_xoauth_authenticator.rb
 - test/test_oauth_string.rb
 - test/test_smtp_xoauth2_authenticator.rb
 - test/test_smtp_xoauth_authenticator.rb
-- LICENSE
-- README.markdown
 homepage: https://github.com/nfo/gmail_xoauth
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options:
-- --charset=UTF-8
+- "--charset=UTF-8"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 3.0.3.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Get access to Gmail IMAP and STMP via OAuth, using the standard Ruby Net
   libraries
 test_files: []