gmail 0.4.2 → 0.5.0

data/Rakefile

@@ -33,3 +33,14 @@ rescue LoadError
 end
 
 task :default => :spec
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'spec/support/obfuscation'
+desc 'Obfuscates account.yml file.'
+task :obfuscate do
+  Spec::Obfuscation.encrypt_file(File.join(File.dirname(__FILE__), 'spec', 'account.yml'))
+end
+
+task :deobfuscate do
+  puts Spec::Obfuscation.decrypt_file(File.join(File.dirname(__FILE__), 'spec', 'account.yml.obfus'))
+end

data/gmail.gemspec

@@ -14,21 +14,21 @@ Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   s.authors = ["Chris Kowalik"]
   s.email = ["chris@nu7hat.ch"]
-  s.homepage = "http://github.com/nu7hatch/gmail"
-  
+  s.homepage = "http://github.com/gmailgem/gmail"
+  s.licenses = ["MIT"]
+
   # runtime dependencies
-  s.add_dependency "mime", ">= 0.1"
   s.add_dependency "mail", ">= 2.2.1"
   s.add_dependency "gmail_xoauth", ">= 0.3.0"
-  
+
   # development dependencies
   s.add_development_dependency "rake"
-  s.add_development_dependency "rspec", "~> 2.0"
-  s.add_development_dependency "mocha", ">= 0.9"
+  s.add_development_dependency "rspec", ">= 3.1"
+  s.add_development_dependency "rubocop"
   s.add_development_dependency "gem-release"
-  
+
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ["lib"]
 end

data/lib/gmail.rb

@@ -10,7 +10,8 @@ end
 
 class Object
   def to_imap_date
-    Date.parse(to_s).strftime("%d-%B-%Y")
+    date = respond_to?(:utc) ? utc.to_s : to_s
+    Date.parse(date).strftime("%d-%B-%Y")
   end
 end
 
@@ -27,7 +28,7 @@ module Gmail
     # ==== Examples
     #
     #   Gmail.new(:plain, "foo@gmail.com", "password")
-    #   Gmail.new(:xoauth, "foo@gmail.com", 
+    #   Gmail.new(:xoauth, "foo@gmail.com",
     #     :consumer_key => "",
     #     :consumer_secret => "",
     #     :token => "",
@@ -44,22 +45,34 @@ module Gmail
     #   end
     #
 
-    ['', '!'].each { |kind|
-      define_method("new#{kind}") do |*args, &block|                  # def new(*args, &block)
-        args.unshift(:plain) unless args.first.is_a?(Symbol)          #   args.unshift(:plain) unless args.first.is_a?(Symbol)  
-        client = Gmail::Client.new(*args)                             #   client = Gmail::Client.new(*args) 
-        client.send("connect#{kind}") and client.send("login#{kind}") #   client.connect and client.login
-                                                                      #  
-        if block_given?                                               #   if block_given?
-          yield client                                                #     yield client
-          client.logout                                               #     client.logout
-        end                                                           #   end
-                                                                      #   
-        client                                                        #   client
-      end                                                             # end
-    }
+    def new(*args, &block)
+      args.unshift(:plain) unless args.first.is_a?(Symbol)
+      client = Gmail::Client.new(*args)
+      client.connect
+      client.login
 
-    alias :connect :new
-    alias :connect! :new!
+      if block_given?
+        yield client
+        client.logout
+      end
+
+      client
+    end
+    alias_method :connect, :new
+
+    def new!(*args, &block)
+      args.unshift(:plain) unless args.first.is_a?(Symbol)
+      client = Gmail::Client.new(*args)
+      client.connect!
+      client.login!
+
+      if block_given?
+        yield client
+        client.logout
+      end
+
+      client
+    end
+    alias_method :connect!, :new!
   end # << self
 end # Gmail

data/lib/gmail/client.rb

@@ -1,30 +1,34 @@
 module Gmail
   module Client
-    # Raised when connection with GMail IMAP service couldn't be established. 
+    # Raised when connection with Gmail IMAP service couldn't be established.
     class ConnectionError < SocketError; end
     # Raised when given username or password are invalid.
     class AuthorizationError < Net::IMAP::NoResponseError; end
-    # Raised when delivered email is invalid. 
+    # Raised when delivered email is invalid.
     class DeliveryError < ArgumentError; end
     # Raised when given client is not registered
     class UnknownClient < ArgumentError; end
 
-    def self.register(name, klass)
+    def self.clients
       @clients ||= {}
-      @clients[name] = klass
+    end
+
+    def self.register(name, klass)
+      clients[name] = klass
     end
 
     def self.new(name, *args)
-      if client = @clients[name]
+      if client = clients[name]
         client.new(*args)
       else
-        raise UnknownClient, "No such client: #{name}" 
+        raise UnknownClient, "No such client: #{name}"
       end
     end
 
-    require 'gmail/client/imap_extensions'
+    require 'gmail/imap_extensions'
     require 'gmail/client/base'
     require 'gmail/client/plain'
     require 'gmail/client/xoauth'
+    require 'gmail/client/xoauth2'
   end # Client
 end # Gmail

data/lib/gmail/client/base.rb

@@ -3,89 +3,94 @@ require 'thread'
 module Gmail
   module Client
     class Base
-      # GMail IMAP defaults
+      # Gmail IMAP defaults
       GMAIL_IMAP_HOST = 'imap.gmail.com'
       GMAIL_IMAP_PORT = 993
-      
-      # GMail SMTP defaults
+
+      # Gmail SMTP defaults
       GMAIL_SMTP_HOST = "smtp.gmail.com"
       GMAIL_SMTP_PORT = 587
-      
+
       attr_reader :username
       attr_reader :options
-      
-      def initialize(username, options={})
+
+      def initialize(username, options = {})
         defaults       = {}
         @username      = fill_username(username)
         @options       = defaults.merge(options)
         @mailbox_mutex = Mutex.new
       end
-      
-      # Connect to gmail service. 
-      def connect(raise_errors=false)
+
+      # Connect to gmail service.
+      def connect(raise_errors = false)
         @imap = Net::IMAP.new(GMAIL_IMAP_HOST, GMAIL_IMAP_PORT, true, nil, false)
-        GmailImapExtensions.patch_net_imap_response_parser
+        Gmail::ImapExtensions.patch_net_imap_response_parser
         @imap
       rescue SocketError
-        raise_errors and raise ConnectionError, "Couldn't establish connection with GMail IMAP service"
+        raise_errors and raise ConnectionError, "Couldn't establish connection with Gmail IMAP service"
       end
-      
+
       # This version of connect will raise error on failure...
       def connect!
         connect(true)
       end
-      
-      # Return current connection. Log in automaticaly to specified account if 
+
+      # Return current connection. Log in automaticaly to specified account if
       # it is necessary.
       def connection
         login and at_exit { logout } unless logged_in?
         @imap
       end
       alias :conn :connection
-      
+
       # Login to specified account.
       def login(*args)
         raise NotImplementedError, "The `#{self.class.name}#login` method is not implemented."
       end
       alias :sign_in :login
-      
+
       # This version of login will raise error on failure...
       def login!
         login(true)
       end
       alias :sign_in! :login!
-      
+
       # Returns +true+ when you are logged in to specified account.
       def logged_in?
         !!@logged_in
       end
       alias :signed_in? :logged_in?
-      
-      # Logout from GMail service. 
+
+      # Logout from Gmail service.
       def logout
         @imap && logged_in? and @imap.logout
       ensure
         @logged_in = false
       end
       alias :sign_out :logout
-      
-      # Return labels object, which helps you with managing your GMail labels.
+
+      # Disconnect from Gmail service.
+      def disconnect
+        @imap && @imap.disconnect
+      end
+
+      # Return labels object, which helps you with managing your Gmail labels.
       # See <tt>Gmail::Labels</tt> for details.
       def labels
         @labels ||= Labels.new(conn)
       end
-      
+
       # Compose new e-mail.
       #
       # ==== Examples
-      #   
+      #
       #   mail = gmail.compose
       #   mail.from "test@gmail.org"
       #   mail.to "friend@gmail.com"
       #
       # ... or block style:
-      #  
-      #   mail = gmail.compose do 
+      #
+      #   mail = gmail.compose do
       #     from "test@gmail.org"
       #     to "friend@gmail.com"
       #     subject "Hello!"
@@ -95,24 +100,24 @@ module Gmail
       # Now you can deliver your mail:
       #
       #   gmail.deliver(mail)
-      def compose(mail=nil, &block)
+      def compose(mail = nil, &block)
         if block_given?
           mail = Mail.new(&block)
-        elsif !mail 
+        elsif !mail
           mail = Mail.new
-        end 
+        end
 
         mail.delivery_method(*smtp_settings)
         mail.from = username unless mail.from
         mail
       end
       alias :message :compose
-      
-      # Compose (optionaly) and send given email. 
+
+      # Compose (optionaly) and send given email.
       #
       # ==== Examples
       #
-      #   gmail.deliver do 
+      #   gmail.deliver do
       #     to "friend@gmail.com"
       #     subject "Hello friend!"
       #     body "Hi! How are you?"
@@ -125,19 +130,19 @@ module Gmail
       #
       #   mail = gmail.compose { ... }
       #   gmail.deliver(mail)
-      def deliver(mail=nil, raise_errors=false, &block)
+      def deliver(mail = nil, raise_errors = false, &block)
         mail = compose(mail, &block) if block_given?
         mail.deliver!
       rescue Object => ex
         raise_errors and raise DeliveryError, "Couldn't deliver email: #{ex.to_s}"
       end
-      
+
       # This version of deliver will raise error on failure...
-      def deliver!(mail=nil, &block)
+      def deliver!(mail = nil, &block)
         deliver(mail, true, &block)
       end
-      
-      # Do something with given mailbox or within it context. 
+
+      # Do something with given mailbox or within it context.
       #
       # ==== Examples
       #
@@ -154,9 +159,9 @@ module Gmail
       #   end
       def mailbox(name, &block)
         @mailbox_mutex.synchronize do
-          name = name.to_s
+          name = labels.localize(name)
           mailbox = (mailboxes[name] ||= Mailbox.new(self, name))
-          switch_to_mailbox(name) if @current_mailbox != name
+          switch_to_mailbox(mailbox) if @current_mailbox != mailbox
 
           if block_given?
             mailbox_stack << @current_mailbox
@@ -172,21 +177,21 @@ module Gmail
       alias :in_mailbox :mailbox
       alias :in_label :mailbox
       alias :label :mailbox
-      
+
       # Alias for <tt>mailbox("INBOX")</tt>. See <tt>Gmail::Client#mailbox</tt>
       # for details.
       def inbox
         mailbox("INBOX")
       end
-      
+
       def mailboxes
         @mailboxes ||= {}
       end
-      
+
       def inspect
         "#<Gmail::Client#{'0x%04x' % (object_id << 1)} (#{username}) #{'dis' if !logged_in?}connected>"
       end
-      
+
       def fill_username(username)
         username =~ /@/ ? username : "#{username}@gmail.com"
       end
@@ -194,21 +199,20 @@ module Gmail
       def mail_domain
         username.split('@').last
       end
-      
+
       private
-      
+
       def switch_to_mailbox(mailbox)
         if mailbox
-          mailbox = Net::IMAP.encode_utf7(mailbox)
-          conn.select(mailbox)
+          conn.select(mailbox.encoded_name)
         end
         @current_mailbox = mailbox
       end
-      
+
       def mailbox_stack
         @mailbox_stack ||= []
       end
-      
+
       def smtp_settings
         [:smtp, {
           :address => GMAIL_SMTP_HOST,

data/lib/gmail/client/plain.rb

@@ -2,16 +2,20 @@ module Gmail
   module Client
     class Plain < Base
       attr_reader :password
-      
-      def initialize(username, password, options={})
+
+      def initialize(username, password, options = {})
         @password = password
         super(username, options)
       end
 
-      def login(raise_errors=false)
+      def login(raise_errors = false)
         @imap and @logged_in = (login = @imap.login(username, password)) && login.name == 'OK'
-      rescue Net::IMAP::NoResponseError
-        raise_errors and raise AuthorizationError, "Couldn't login to given GMail account: #{username}"
+      rescue Net::IMAP::NoResponseError => e
+        if raise_errors
+          message = "Couldn't login to given Gmail account: #{username}"
+          message += " (#{e.response.data.text.strip})"
+          raise(AuthorizationError.new(e.response), message, e.backtrace)
+        end
       end
     end # Plain
 

data/lib/gmail/client/xoauth.rb

@@ -8,24 +8,40 @@ module Gmail
       attr_reader :consumer_key
       attr_reader :consumer_secret
 
-      def initialize(username, options={})
+      def initialize(username, options = {})
         @token           = options.delete(:token)
         @secret          = options.delete(:secret)
         @consumer_key    = options.delete(:consumer_key)
         @consumer_secret = options.delete(:consumer_secret)
-       
+
         super(username, options)
       end
 
-      def login(raise_errors=false)
+      def login(raise_errors = false)
         @imap and @logged_in = (login = @imap.authenticate('XOAUTH', username,
           :consumer_key    => consumer_key,
           :consumer_secret => consumer_secret,
           :token           => token,
           :token_secret    => secret
         )) && login.name == 'OK'
-      rescue
-        raise_errors and raise AuthorizationError, "Couldn't login to given GMail account: #{username}"        
+      rescue Net::IMAP::NoResponseError => e
+        if raise_errors
+          message = "Couldn't login to given Gmail account: #{username}"
+          message += " (#{e.response.data.text.strip})"
+          raise(AuthorizationError.new(e.response), message, e.backtrace)
+        end
+      end
+
+      def access_token
+        consumer_options = {
+          :site               => "https://www.google.com",
+          :request_token_path => "/accounts/OAuthGetRequestToken",
+          :authorize_path     => "/accounts/OAuthAuthorizeToken",
+          :access_token_path  => "/accounts/OAuthGetAccessToken"
+        }
+        consumer = OAuth::Consumer.new(consumer_key, consumer_secret, consumer_options)
+        @access_token ||= OAuth::AccessToken.new(consumer, token, secret)
+        @access_token
       end
 
       def smtp_settings
@@ -38,7 +54,8 @@ module Gmail
              :consumer_key    => consumer_key,
              :consumer_secret => consumer_secret,
              :token           => token,
-             :token_secret    => secret
+             :token_secret    => secret,
+             :access_token    => access_token
            },
            :authentication => :xoauth,
            :enable_starttls_auto => true