gmail 0.3.4 → 0.4.0

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Gmail gem changelog
 
+## 0.4.0
+
+* Added XOAUTH authentication method (Thanks Stefano Bernardi and Nicolas Fouché)
+* Separated clients
+* Fixed specs
+
 ## 0.3.4
 
 * Fixes in mailbox filters shortcuts (Thanks Benjamin Bock)

data/README.md

@@ -14,6 +14,9 @@ API, is well tested, better documented and have many other improvements.
 
 Extra thanks for specific feature contributions from:
 
+* [Nicolas Fouché](http://github.com/nfo)
+* [Stefano Bernardi](http://github.com/stefanobernardi)
+* [Benjamin Bock](http://github.com/bb)
 * [Arthur Chiu](http://github.com/achiu)
 * [Justin Perkins](http://github.com/justinperkins)
 * [Mikkel Malmberg](http://github.com/mikker)

data/TODO.md

@@ -1,6 +1,7 @@
 # TODO
 
-* Update docs and readme
+* Info about xoauth and plain authentication in readme
+* Specs for xoauth 
 * Specs for message operations
 * Specs for filters in mailbox
 * Non-English accounts

data/gmail.gemspec

@@ -15,8 +15,9 @@ Gem::Specification.new do |s|
   s.require_paths    = %w[lib]
   s.extra_rdoc_files = %w[LICENSE README.md CHANGELOG.md TODO.md]
 
-  s.add_runtime_dependency     'mime',  ['>= 0.1']
-  s.add_runtime_dependency     'mail',  ['>= 2.2.1']
-  s.add_development_dependency 'rspec', ['~> 2.0']
-  s.add_development_dependency 'mocha', ['>= 0.9']
+  s.add_runtime_dependency     'mime', '>= 0.1'
+  s.add_runtime_dependency     'mail', '>= 2.2.1'
+  s.add_runtime_dependency     'gmail_xoauth', '>= 0.3.0'
+  s.add_development_dependency 'rspec', '~> 2.0'
+  s.add_development_dependency 'mocha', '>= 0.9'
 end

data/lib/gmail.rb

@@ -22,26 +22,61 @@ module Gmail
   autoload :Message, "gmail/message"
 
   class << self
-    def new(username, password, options={}, &block)
-      client = Client.new(username, password, options)
+
+    # Creates new Gmail connection using given authorization options.
+    #
+    # ==== Examples
+    #
+    #   Gmail.new(:plain, "foo@gmail.com", "password")
+    #   Gmail.new(:xoauth, "foo@gmail.com", 
+    #     :consumer_key => "",
+    #     :consumer_secret => "",
+    #     :token => "",
+    #     :secret => "")
+    #
+    # To use plain authentication mehod you can also call:
+    #
+    #   Gmail.new("foo@gmail.com", "password")
+    #
+    # You can also use block-style call:
+    #
+    #   Gmail.new("foo@gmail.com", "password") do |client|
+    #     # ...
+    #   end
+    #
+    def new(*args, &block)
+      client = connect_with_proper_client(*args)
       client.connect and client.login
-      if block_given?
-        yield client
-        client.logout
-      end
-      client
+      perform_block(client, &block)
     end
     alias :connect :new
-    
-    def new!(username, password, options={}, &block)
-      client = Client.new(username, password, options)
+
+    def new!(*args, &block)
+      client = connect_with_proper_client(*args)
       client.connect! and client.login!
+      perform_block(client, &block)
+    end
+    alias :connect! :new!
+    
+    protected
+
+    def connect_with_proper_client(*args)
+      if args.first.is_a?(Symbol)        
+        login_method = args.shift  
+      else
+        login_method ||= :plain
+      end
+
+      Client.send("new_#{login_method}", *args)
+    end
+
+    def perform_block(client, &block)
       if block_given?
         yield client
         client.logout
       end
       client
     end
-    alias :connect! :new!
+
   end # << self
 end # Gmail

data/lib/gmail/client.rb

@@ -1,221 +1,22 @@
 module Gmail
-  class Client
+  module Client
     # 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. 
     class DeliveryError < ArgumentError; end
-  
-    # GMail IMAP defaults
-    GMAIL_IMAP_HOST = 'imap.gmail.com'
-    GMAIL_IMAP_PORT = 993
     
-    # GMail SMTP defaults
-    GMAIL_SMTP_HOST = "smtp.gmail.com"
-    GMAIL_SMTP_PORT = 587
-  
-    attr_reader :username
-    attr_reader :password
-    attr_reader :options
-  
-    def initialize(username, password, options={})
-      defaults  = {}
-      @username = fill_username(username)
-      @password = password
-      @options  = defaults.merge(options)
-    end
-    
-    # Connect to gmail service. 
-    def connect(raise_errors=false)
-      @imap = Net::IMAP.new(GMAIL_IMAP_HOST, GMAIL_IMAP_PORT, true, nil, false)
-    rescue SocketError
-      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 
-    # it is necessary.
-    def connection
-      login and at_exit { logout } unless logged_in?
-      @imap
-    end
-    alias :conn :connection
-    
-    # Login to specified account.
-    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}"
-    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. 
-    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.
-    # 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 
-    #     from "test@gmail.org"
-    #     to "friend@gmail.com"
-    #     subject "Hello!"
-    #     body "Hello my friend! long time..."
-    #   end
-    #
-    # Now you can deliver your mail:
-    #
-    #   gmail.deliver(mail)
-    def compose(mail=nil, &block)
-      if block_given?
-        mail = Mail.new(&block)
-      elsif !mail 
-        mail = Mail.new
-      end 
-      mail.delivery_method(*smtp_settings)
-      mail.from = username unless mail.from
-      mail
-    end
-    alias :message :compose
-    
-    # Compose (optionaly) and send given email. 
-    #
-    # ==== Examples
-    #
-    #   gmail.deliver do 
-    #     to "friend@gmail.com"
-    #     subject "Hello friend!"
-    #     body "Hi! How are you?"
-    #   end
-    #
-    # ... or with already created message:
-    #
-    #   mail = Mail.new { ... }
-    #   gmail.deliver(mail)
-    #
-    #   mail = gmail.compose { ... }
-    #   gmail.deliver(mail)
-    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)
-      deliver(mail, true, &block)
-    end
-    
-    # Do something with given mailbox or within it context. 
-    #
-    # ==== Examples
-    #
-    #   mailbox = gmail.mailbox("INBOX")
-    #   mailbox.emails(:all)
-    #   mailbox.count(:unread, :before => Time.now-(20*24*3600))
-    #
-    # ... or block style:
-    #
-    #   gmail.label("Work") do |mailbox|
-    #     mailbox.emails(:unread)
-    #     mailbox.count(:all)
-    #     ...
-    #   end
-    def mailbox(name, &block)
-      name = name.to_s
-      mailbox = (mailboxes[name] ||= Mailbox.new(self, name))
-      switch_to_mailbox(name) if @current_mailbox != name
-      if block_given?
-        mailbox_stack << @current_mailbox
-        result = block.arity == 1 ? block.call(mailbox) : block.call
-        mailbox_stack.pop
-        switch_to_mailbox(mailbox_stack.last)
-        return result
-      end
-      mailbox
-    end
-    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
+    autoload :Base,   'gmail/client/base'
+    autoload :Plain,  'gmail/client/plain'
+    autoload :XOAuth, 'gmail/client/xoauth'
 
-    def mail_domain
-      username.split('@')[0]
-    end
-    
-    private
-    
-    def switch_to_mailbox(mailbox)
-      conn.select(mailbox) if mailbox
-      @current_mailbox = mailbox
-    end
-    
-    def mailbox_stack
-      @mailbox_stack ||= []
+    def self.new_plain(*args)
+      Gmail::Client::Plain.new(*args)
     end
-    
-    def smtp_settings
-      [:smtp, {
-        :address => GMAIL_SMTP_HOST,
-        :port => GMAIL_SMTP_PORT,
-        :domain => mail_domain,
-        :user_name => username,
-        :password => password,
-        :authentication => 'plain',
-        :enable_starttls_auto => true
-      }]
+
+    def self.new_xoauth(*args)
+      Gmail::Client::XOAuth.new(*args)
     end
   end # Client
 end # Gmail

data/lib/gmail/client/base.rb

@@ -0,0 +1,220 @@
+require 'thread'
+
+module Gmail
+  module Client
+    class Base
+      # GMail IMAP defaults
+      GMAIL_IMAP_HOST = 'imap.gmail.com'
+      GMAIL_IMAP_PORT = 993
+      
+      # GMail SMTP defaults
+      GMAIL_SMTP_HOST = "smtp.gmail.com"
+      GMAIL_SMTP_PORT = 587
+      
+      attr_reader :username
+      attr_reader :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)
+        @imap = Net::IMAP.new(GMAIL_IMAP_HOST, GMAIL_IMAP_PORT, true, nil, false)
+      rescue SocketError
+        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 
+      # 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. 
+      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.
+      # 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 
+      #     from "test@gmail.org"
+      #     to "friend@gmail.com"
+      #     subject "Hello!"
+      #     body "Hello my friend! long time..."
+      #   end
+      #
+      # Now you can deliver your mail:
+      #
+      #   gmail.deliver(mail)
+      def compose(mail=nil, &block)
+        if block_given?
+          mail = Mail.new(&block)
+        elsif !mail 
+          mail = Mail.new
+        end 
+
+        mail.delivery_method(*smtp_settings)
+        mail.from = username unless mail.from
+        mail
+      end
+      alias :message :compose
+      
+      # Compose (optionaly) and send given email. 
+      #
+      # ==== Examples
+      #
+      #   gmail.deliver do 
+      #     to "friend@gmail.com"
+      #     subject "Hello friend!"
+      #     body "Hi! How are you?"
+      #   end
+      #
+      # ... or with already created message:
+      #
+      #   mail = Mail.new { ... }
+      #   gmail.deliver(mail)
+      #
+      #   mail = gmail.compose { ... }
+      #   gmail.deliver(mail)
+      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)
+        deliver(mail, true, &block)
+      end
+      
+      # Do something with given mailbox or within it context. 
+      #
+      # ==== Examples
+      #
+      #   mailbox = gmail.mailbox("INBOX")
+      #   mailbox.emails(:all)
+      #   mailbox.count(:unread, :before => Time.now-(20*24*3600))
+      #
+      # ... or block style:
+      #
+      #   gmail.label("Work") do |mailbox|
+      #     mailbox.emails(:unread)
+      #     mailbox.count(:all)
+      #     ...
+      #   end
+      def mailbox(name, &block)
+        @mailbox_mutex.synchronize do
+          name = Net::IMAP.encode_utf7(name.to_s)
+          mailbox = (mailboxes[name] ||= Mailbox.new(self, name))
+          switch_to_mailbox(name) if @current_mailbox != name
+
+          if block_given?
+            mailbox_stack << @current_mailbox
+            result = block.arity == 1 ? block.call(mailbox) : block.call
+            mailbox_stack.pop
+            switch_to_mailbox(mailbox_stack.last)
+            return result
+          end
+
+          return mailbox
+        end
+      end
+      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
+
+      def mail_domain
+        username.split('@')[0]
+      end
+      
+      private
+      
+      def switch_to_mailbox(mailbox)
+        conn.select(mailbox) if mailbox
+        @current_mailbox = mailbox
+      end
+      
+      def mailbox_stack
+        @mailbox_stack ||= []
+      end
+      
+      def smtp_settings
+        [:smtp, {
+          :address => GMAIL_SMTP_HOST,
+          :port => GMAIL_SMTP_PORT,
+          :domain => mail_domain,
+          :user_name => username,
+          :password => password,
+          :authentication => 'plain',
+          :enable_starttls_auto => true
+        }]
+      end
+    end # Base
+  end # Client
+end # Gmail

data/lib/gmail/client/plain.rb

@@ -0,0 +1,18 @@
+module Gmail
+  module Client
+    class Plain < Base
+      attr_reader :password
+      
+      def initialize(username, password, options={})
+        @password = password
+        super(username, options)
+      end
+
+      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}"
+      end
+    end # Plain
+  end # Client
+end # Gmail

data/lib/gmail/client/xoauth.rb

@@ -0,0 +1,49 @@
+require 'gmail_xoauth'
+
+module Gmail
+  module Client
+    class XOAuth < Base
+      attr_reader :token
+      attr_reader :secret
+      attr_reader :consumer_key
+      attr_reader :consumer_secret
+
+      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)
+        @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}"        
+      end
+
+      def smtp_settings
+        [:smtp, {
+           :address => GMAIL_SMTP_HOST,
+           :port => GMAIL_SMTP_PORT,
+           :domain => mail_domain,
+           :user_name => username,
+           :password => secret = {
+             :consumer_key    => consumer_key,
+             :consumer_secret => consumer_secret,
+             :token           => token,
+             :token_secret    => token_secret
+           },
+           :authentication => :xoauth,
+           :enable_starttls_auto => true
+         }]
+      end
+    end # XOAuth
+  end # Client
+end # Gmail

data/lib/gmail/labels.rb

@@ -11,7 +11,7 @@ module Gmail
     # Get list of all defined labels.
     def all
       (conn.list("", "%")+conn.list("[Gmail]/", "%")).inject([]) do |labels,label|
-        label[:name].each_line {|l| labels << l }
+        label[:name].each_line {|l| labels << Net::IMAP.decode_utf7(l) }
         labels 
       end
     end
@@ -24,20 +24,20 @@ module Gmail
     
     # Returns +true+ when given label defined. 
     def exists?(label)
-      all.include?(label)
+      all.include?(Net::IMAP.encode_utf7(label))
     end
     alias :exist? :exists?
     
     # Creates given label in your account.
     def create(label)
-      !!conn.create(label) rescue false
+      !!conn.create(Net::IMAP.encode_utf7(label)) rescue false
     end
     alias :new :create
     alias :add :create
     
     # Deletes given label from your account. 
     def delete(label)
-      !!conn.delete(label) rescue false
+      !!conn.delete(Net::IMAP.encode_utf7(label)) rescue false
     end
     alias :remove :delete
     

data/lib/gmail/mailbox.rb

@@ -17,9 +17,11 @@ module Gmail
     }
   
     attr_reader :name
+    attr_reader :external_name
 
     def initialize(gmail, name="INBOX")
       @name  = name
+      @external_name = Net::IMAP.decode_utf7(name)
       @gmail = gmail
     end
 
@@ -53,8 +55,10 @@ module Gmail
         opts[:subject]    and search.concat ['SUBJECT', opts[:subject]]
         opts[:label]      and search.concat ['LABEL', opts[:label]]
         opts[:attachment] and search.concat ['HAS', 'attachment']
-        opts[:search]     and search.concat [opts[:search]]
-        
+        opts[:search]     and search.concat ['BODY', opts[:search]]
+        opts[:body]       and search.concat ['BODY', opts[:body]]
+        opts[:query]      and search.concat opts[:query]
+
         @gmail.mailbox(name) do
           @gmail.conn.uid_search(search).collect do |uid| 
             message = (messages[uid] ||= Message.new(self, uid))
@@ -97,7 +101,7 @@ module Gmail
     end
     
     def inspect
-      "#<Gmail::Mailbox#{'0x%04x' % (object_id << 1)} name=#{@name}>"
+      "#<Gmail::Mailbox#{'0x%04x' % (object_id << 1)} name=#{external_name}>"
     end
 
     def to_s

data/lib/gmail/message.rb

@@ -64,11 +64,14 @@ module Gmail
       unflag('[Gmail]/Starred')
     end
     
-    # Move to trash.
+    # Move to trash / bin.
     def delete!
       @mailbox.messages.delete(uid)
-      flag(:Deleted)
-      move_to('[Gmail]/Trash') unless %w[[Gmail]/Spam [Gmail]/Trash].include?(@mailbox.name)
+      flag(:deleted)
+
+      # For some, it's called "Trash", for others, it's called "Bin". Support both.
+      trash =  @gmail.labels.exist?('[Gmail]/Bin') ? '[Gmail]/Bin' : '[Gmail]/Trash'
+      move_to(trash) unless %w[[Gmail]/Spam [Gmail]/Bin [Gmail]/Trash].include?(@mailbox.name)
     end
 
     # Archive this message.
@@ -78,7 +81,8 @@ module Gmail
     
     # Move to given box and delete from others.  
     def move_to(name, from=nil)
-      label(name, from) && delete!
+      label(name, from)
+      delete! if !%w[[Gmail]/Bin [Gmail]/Trash].include?(name)
     end
     alias :move :move_to
     
@@ -94,11 +98,10 @@ module Gmail
     #
     # See also <tt>Gmail::Message#label!</tt>.
     def label(name, from=nil)
-      @gmail.mailbox(from || @mailbox.name) { @gmail.conn.uid_copy(uid, name) }
+      @gmail.mailbox(Net::IMAP.encode_utf7(from || @mailbox.external_name)) { @gmail.conn.uid_copy(uid, Net::IMAP.encode_utf7(name)) }
     rescue Net::IMAP::NoResponseError
       raise NoLabelError, "Label '#{name}' doesn't exist!"
     end
-    alias :add_label :label
 
     # Mark this message with given label. When given label doesn't exist then
     # it will be automaticaly created. 
@@ -107,10 +110,11 @@ module Gmail
     def label!(name, from=nil)
       label(name, from) 
     rescue NoLabelError
-      @gmail.labels.add(name)
-      label!(name, from)
+      @gmail.labels.add(Net::IMAP.encode_utf7(name))
+      label(name, from)
     end
-    alias :add_label! :add_label
+    alias :add_label :label!
+    alias :add_label! :label!
     
     # Remove given label from this message. 
     def remove_label!(name)
@@ -119,7 +123,7 @@ module Gmail
     alias :delete_label! :remove_label!
     
     def inspect
-      "#<Gmail::Message#{'0x%04x' % (object_id << 1)} mailbox=#{@mailbox.name}#{' uid='+@uid.to_s if @uid}#{' message_id='+@message_id.to_s if @message_id}>"
+      "#<Gmail::Message#{'0x%04x' % (object_id << 1)} mailbox=#{@mailbox.external_name}#{' uid='+@uid.to_s if @uid}#{' message_id='+@message_id.to_s if @message_id}>"
     end
     
     def method_missing(meth, *args, &block)
@@ -132,19 +136,29 @@ module Gmail
         super(meth, *args, &block)
       end
     end
-    
+
+    def respond_to?(meth, *args, &block)
+      if envelope.respond_to?(meth)
+        return true
+      elsif message.respond_to?(meth)
+        return true
+      else
+        super(meth, *args, &block)
+      end
+    end
+
     def envelope
       @envelope ||= @gmail.mailbox(@mailbox.name) {
         @gmail.conn.uid_fetch(uid, "ENVELOPE")[0].attr["ENVELOPE"]
       }
     end
-
-    private
     
     def message
       @message ||= Mail.new(@gmail.mailbox(@mailbox.name) { 
         @gmail.conn.uid_fetch(uid, "RFC822")[0].attr["RFC822"] # RFC822
       })
     end
+    alias_method :raw_message, :message
+
   end # Message
 end # Gmail

data/lib/gmail/version.rb

@@ -1,8 +1,8 @@
 module Gmail
   class Version #:nodoc:
     MAJOR  = 0
-    MINOR  = 3
-    PATCH  = 4
+    MINOR  = 4
+    PATCH  = 0
     STRING = [MAJOR, MINOR, PATCH].join('.')
   end # Version
   

data/spec/client_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
-describe "Gmail client" do
-  subject { Gmail::Client }
+describe "Gmail client (Plain)" do
+  subject { Gmail::Client::Plain }
   
   context "on initialize" do
     it "should set username, password and options" do
@@ -19,7 +19,7 @@ describe "Gmail client" do
   
   context "instance" do
     def mock_client(&block) 
-      client = Gmail::Client.new(*TEST_ACCOUNT)
+      client = Gmail::Client::Plain.new(*TEST_ACCOUNT)
       if block_given?
         client.connect
         yield client
@@ -45,7 +45,7 @@ describe "Gmail client" do
     
     it "should raise error when given GMail account is invalid and errors enabled" do
       lambda {
-        client = Gmail::Client.new("foo", "bar")
+        client = Gmail::Client::Plain.new("foo", "bar")
         client.connect.should be_true
         client.login!.should_not be_true
       }.should raise_error(Gmail::Client::AuthorizationError)
@@ -53,7 +53,7 @@ describe "Gmail client" do
     
     it "shouldn't login when given GMail account is invalid" do
       lambda {
-        client = Gmail::Client.new("foo", "bar")
+        client = Gmail::Client::Plain.new("foo", "bar")
         client.connect.should be_true
         client.login.should_not be_true
       }.should_not raise_error(Gmail::Client::AuthorizationError)
@@ -137,7 +137,7 @@ describe "Gmail client" do
     
     context "labels" do
       subject { 
-        client = Gmail::Client.new(*TEST_ACCOUNT)
+        client = Gmail::Client::Plain.new(*TEST_ACCOUNT)
         client.connect
         client.labels
       }

data/spec/gmail_spec.rb

@@ -8,14 +8,14 @@ describe "Any object" do
   %w[new new!].each do |method|
     it "##{method} should properly connect with GMail service and return valid connection object" do
       gmail = Gmail.send(method, *TEST_ACCOUNT)
-      gmail.should be_kind_of(Gmail::Client)
+      gmail.should be_kind_of(Gmail::Client::Plain)
       gmail.connection.should_not be_nil
       gmail.should be_logged_in
     end
     
     it "##{method} should connect with client and give it context when block given" do
       Gmail.send(method, *TEST_ACCOUNT) do |gmail|
-        gmail.should be_kind_of(Gmail::Client)
+        gmail.should be_kind_of(Gmail::Client::Plain)
         gmail.connection.should_not be_nil
         gmail.should be_logged_in
       end

data/spec/mailbox_spec.rb

@@ -34,5 +34,16 @@ describe "A Gmail mailbox" do
         mailbox.emails(:all, :from => message.from.first.name) == message.from.first.name
       end
     end
+    
+    it "should be able to do a full text search of message bodies" do
+      pending "This can wait..."
+      #mock_mailbox do |mailbox|
+      #  message = mailbox.emails.first
+      #  body = message.parts.blank? ? message.body.decoded : message.parts[0].body.decoded
+      #  emails = mailbox.emails(:search => body.split(' ').first)
+      #  emails.size.should > 0
+      #end
+    end
+    
   end
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gmail
 version: !ruby/object:Gem::Version 
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
   - 4
-  version: 0.3.4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - BehindLogic
@@ -15,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-21 00:00:00 +01:00
+date: 2011-01-13 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,6 +27,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 9
         segments: 
         - 0
         - 1
@@ -40,6 +42,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 5
         segments: 
         - 2
         - 2
@@ -48,33 +51,51 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: gmail_xoauth
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 3
+        - 0
+        version: 0.3.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 2
         - 0
         version: "2.0"
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: mocha
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 25
         segments: 
         - 0
         - 9
         version: "0.9"
   type: :development
-  version_requirements: *id004
+  version_requirements: *id005
 description: A Rubyesque interface to Gmail, with all the tools you will need. Search, read and send multipart emails; archive, mark as read/unread, delete emails; and manage labels.
 email: 
 - chris@nu7hat.ch
@@ -97,6 +118,9 @@ files:
 - gmail.gemspec
 - lib/gmail.rb
 - lib/gmail/client.rb
+- lib/gmail/client/base.rb
+- lib/gmail/client/plain.rb
+- lib/gmail/client/xoauth.rb
 - lib/gmail/labels.rb
 - lib/gmail/mailbox.rb
 - lib/gmail/message.rb
@@ -121,6 +145,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -129,6 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"