gmail 0.4.0 → 0.4.2

data/lib/gmail/client/imap_extensions.rb

@@ -0,0 +1,54 @@
+# Taken from https://github.com/oxos/gmail-oauth-thread-stats/blob/master/gmail_imap_extensions_compatibility.rb
+
+module GmailImapExtensions
+
+  def self.patch_net_imap_response_parser(klass = Net::IMAP::ResponseParser)
+    klass.class_eval do
+      def msg_att
+        match(Net::IMAP::ResponseParser::T_LPAR)
+        attr = {}
+        while true
+          token = lookahead
+          case token.symbol
+          when Net::IMAP::ResponseParser::T_RPAR
+            shift_token
+            break
+          when Net::IMAP::ResponseParser::T_SPACE
+            shift_token
+            token = lookahead
+          end
+          case token.value
+          when /\A(?:ENVELOPE)\z/ni
+            name, val = envelope_data
+          when /\A(?:FLAGS)\z/ni
+            name, val = flags_data
+          when /\A(?:INTERNALDATE)\z/ni
+            name, val = internaldate_data
+          when /\A(?:RFC822(?:\.HEADER|\.TEXT)?)\z/ni
+            name, val = rfc822_text
+          when /\A(?:RFC822\.SIZE)\z/ni
+            name, val = rfc822_size
+          when /\A(?:BODY(?:STRUCTURE)?)\z/ni
+            name, val = body_data
+          when /\A(?:UID)\z/ni
+            name, val = uid_data
+      
+          # Gmail extension additions.
+          # Cargo-Cult code warning: # I have no idea why the regexp - just copying a pattern
+          when /\A(?:X-GM-LABELS)\z/ni
+            name, val = flags_data
+          when /\A(?:X-GM-MSGID)\z/ni 
+            name, val = uid_data
+          when /\A(?:X-GM-THRID)\z/ni 
+            name, val = uid_data
+          else
+            parse_error("unknown attribute `%s'", token.value)
+          end
+          attr[name] = val
+        end
+        return attr
+      end
+    end
+  end
+
+end

data/lib/gmail/client/plain.rb

@@ -1,18 +1,20 @@
-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
+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
+
+    register :plain, Plain
+  end # Client
+end # Gmail

data/lib/gmail/client/xoauth.rb

@@ -1,49 +1,51 @@
-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
+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 => {
+             :consumer_key    => consumer_key,
+             :consumer_secret => consumer_secret,
+             :token           => token,
+             :token_secret    => secret
+           },
+           :authentication => :xoauth,
+           :enable_starttls_auto => true
+         }]
+      end
+    end # XOAuth
+
+    register :xoauth, XOAuth
+  end # Client
+end # Gmail

data/lib/gmail/labels.rb

@@ -1,48 +1,62 @@
-module Gmail
-  class Labels
-    include Enumerable
-    attr_reader :connection
-    alias :conn :connection
-     
-    def initialize(connection)
-      @connection = connection
-    end
-    
-    # Get list of all defined labels.
-    def all
-      (conn.list("", "%")+conn.list("[Gmail]/", "%")).inject([]) do |labels,label|
-        label[:name].each_line {|l| labels << Net::IMAP.decode_utf7(l) }
-        labels 
-      end
-    end
-    alias :list :all
-    alias :to_a :all
-
-    def each(*args, &block)
-      all.each(*args, &block)
-    end
-    
-    # Returns +true+ when given label defined. 
-    def exists?(label)
-      all.include?(Net::IMAP.encode_utf7(label))
-    end
-    alias :exist? :exists?
-    
-    # Creates given label in your account.
-    def create(label)
-      !!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(Net::IMAP.encode_utf7(label)) rescue false
-    end
-    alias :remove :delete
-    
-    def inspect
-      "#<Gmail::Labels#{'0x%04x' % (object_id << 1)}>"
-    end
-  end # Labels
-end # Gmail
+module Gmail
+  class Labels
+    include Enumerable
+    attr_reader :connection
+    alias :conn :connection
+     
+    def initialize(connection)
+      @connection = connection
+    end
+    
+    # Get list of all defined labels.
+    def all
+      @list = []
+      
+      ## check each item in list for subfolders
+      conn.list("", "%").each {|l| sublabels_or_label(l)}
+      
+      @list.inject([]) do |labels,label|
+        label[:name].each_line {|l| labels << Net::IMAP.decode_utf7(l) }
+        labels 
+      end
+    end
+    alias :list :all
+    alias :to_a :all
+
+    def sublabels_or_label(label)
+      if label.attr.include? :Hasnochildren
+        @list << label
+      else
+        @list << label
+        conn.list("#{label.name}/", "%").each {|l| sublabels_or_label(l)}
+      end
+    end
+    
+    def each(*args, &block)
+      all.each(*args, &block)
+    end
+    
+    # Returns +true+ when given label defined. 
+    def exists?(label)
+      all.include?(label)
+    end
+    alias :exist? :exists?
+    
+    # Creates given label in your account.
+    def create(label)
+      !!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(Net::IMAP.encode_utf7(label)) rescue false
+    end
+    alias :remove :delete
+    
+    def inspect
+      "#<Gmail::Labels#{'0x%04x' % (object_id << 1)}>"
+    end
+  end # Labels
+end # Gmail

data/lib/gmail/mailbox.rb

@@ -1,117 +1,117 @@
-module Gmail
-  class Mailbox
-    MAILBOX_ALIASES = {
-      :all       => ['ALL'],
-      :seen      => ['SEEN'],
-      :unseen    => ['UNSEEN'],
-      :read      => ['SEEN'],
-      :unread    => ['UNSEEN'],
-      :flagged   => ['FLAGGED'],
-      :unflagged => ['UNFLAGGED'],
-      :starred   => ['FLAGGED'],
-      :unstarred => ['UNFLAGGED'], 
-      :deleted   => ['DELETED'],
-      :undeleted => ['UNDELETED'],
-      :draft     => ['DRAFT'],
-      :undrafted => ['UNDRAFT']
-    }
-  
-    attr_reader :name
-    attr_reader :external_name
-
-    def initialize(gmail, name="INBOX")
-      @name  = name
-      @external_name = Net::IMAP.decode_utf7(name)
-      @gmail = gmail
-    end
-
-    # Returns list of emails which meets given criteria. 
-    #
-    # ==== Examples
-    #
-    #   gmail.inbox.emails(:all)
-    #   gmail.inbox.emails(:unread, :from => "friend@gmail.com")
-    #   gmail.inbox.emails(:all, :after => Time.now-(20*24*3600))
-    #   gmail.mailbox("Test").emails(:read)
-    #
-    #   gmail.mailbox("Test") do |box| 
-    #     box.emails(:read)
-    #     box.emails(:unread) do |email|
-    #       ... do something with each email...
-    #     end
-    #   end
-    def emails(*args, &block)
-      args << :all if args.size == 0
-
-      if args.first.is_a?(Symbol) 
-        search = MAILBOX_ALIASES[args.shift].dup
-        opts = args.first.is_a?(Hash) ? args.first : {}
-        
-        opts[:after]      and search.concat ['SINCE', opts[:after].to_imap_date]
-        opts[:before]     and search.concat ['BEFORE', opts[:before].to_imap_date]
-        opts[:on]         and search.concat ['ON', opts[:on].to_imap_date]
-        opts[:from]       and search.concat ['FROM', opts[:from]]
-        opts[:to]         and search.concat ['TO', opts[:to]]
-        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 ['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))
-            block.call(message) if block_given?
-            message
-          end
-        end
-      elsif args.first.is_a?(Hash)
-        emails(:all, args.first)
-      else
-        raise ArgumentError, "Invalid search criteria"
-      end
-    end
-    alias :mails :emails
-    alias :search :emails
-    alias :find :emails
-    alias :filter :emails
-
-    # This is a convenience method that really probably shouldn't need to exist, 
-    # but it does make code more readable, if seriously all you want is the count 
-    # of messages.
-    #
-    # ==== Examples
-    #
-    #   gmail.inbox.count(:all)
-    #   gmail.inbox.count(:unread, :from => "friend@gmail.com")
-    #   gmail.mailbox("Test").count(:all, :after => Time.now-(20*24*3600))
-    def count(*args)
-      emails(*args).size
-    end
-
-    # This permanently removes messages which are marked as deleted
-    def expunge
-      @gmail.mailbox(name) { @gmail.conn.expunge }
-    end
-
-    # Cached messages. 
-    def messages
-      @messages ||= {}
-    end
-    
-    def inspect
-      "#<Gmail::Mailbox#{'0x%04x' % (object_id << 1)} name=#{external_name}>"
-    end
-
-    def to_s
-      name
-    end
-
-    MAILBOX_ALIASES.each_key { |mailbox|
-      define_method(mailbox) do |*args, &block|
-        emails(mailbox, *args, &block)
-      end
-    }
-  end # Message
-end # Gmail
+module Gmail
+  class Mailbox
+    MAILBOX_ALIASES = {
+      :all       => ['ALL'],
+      :seen      => ['SEEN'],
+      :unseen    => ['UNSEEN'],
+      :read      => ['SEEN'],
+      :unread    => ['UNSEEN'],
+      :flagged   => ['FLAGGED'],
+      :unflagged => ['UNFLAGGED'],
+      :starred   => ['FLAGGED'],
+      :unstarred => ['UNFLAGGED'], 
+      :deleted   => ['DELETED'],
+      :undeleted => ['UNDELETED'],
+      :draft     => ['DRAFT'],
+      :undrafted => ['UNDRAFT']
+    }
+  
+    attr_reader :name
+    attr_reader :external_name
+
+    def initialize(gmail, name="INBOX")
+      @name  = name
+      @external_name = Net::IMAP.decode_utf7(name)
+      @gmail = gmail
+    end
+
+    # Returns list of emails which meets given criteria. 
+    #
+    # ==== Examples
+    #
+    #   gmail.inbox.emails(:all)
+    #   gmail.inbox.emails(:unread, :from => "friend@gmail.com")
+    #   gmail.inbox.emails(:all, :after => Time.now-(20*24*3600))
+    #   gmail.mailbox("Test").emails(:read)
+    #
+    #   gmail.mailbox("Test") do |box| 
+    #     box.emails(:read)
+    #     box.emails(:unread) do |email|
+    #       ... do something with each email...
+    #     end
+    #   end
+    def emails(*args, &block)
+      args << :all if args.size == 0
+
+      if args.first.is_a?(Symbol) 
+        search = MAILBOX_ALIASES[args.shift].dup
+        opts = args.first.is_a?(Hash) ? args.first : {}
+        
+        opts[:after]      and search.concat ['SINCE', opts[:after].to_imap_date]
+        opts[:before]     and search.concat ['BEFORE', opts[:before].to_imap_date]
+        opts[:on]         and search.concat ['ON', opts[:on].to_imap_date]
+        opts[:from]       and search.concat ['FROM', opts[:from]]
+        opts[:to]         and search.concat ['TO', opts[:to]]
+        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 ['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))
+            block.call(message) if block_given?
+            message
+          end
+        end
+      elsif args.first.is_a?(Hash)
+        emails(:all, args.first)
+      else
+        raise ArgumentError, "Invalid search criteria"
+      end
+    end
+    alias :mails :emails
+    alias :search :emails
+    alias :find :emails
+    alias :filter :emails
+
+    # This is a convenience method that really probably shouldn't need to exist, 
+    # but it does make code more readable, if seriously all you want is the count 
+    # of messages.
+    #
+    # ==== Examples
+    #
+    #   gmail.inbox.count(:all)
+    #   gmail.inbox.count(:unread, :from => "friend@gmail.com")
+    #   gmail.mailbox("Test").count(:all, :after => Time.now-(20*24*3600))
+    def count(*args)
+      emails(*args).size
+    end
+
+    # This permanently removes messages which are marked as deleted
+    def expunge
+      @gmail.mailbox(name) { @gmail.conn.expunge }
+    end
+
+    # Cached messages. 
+    def messages
+      @messages ||= {}
+    end
+    
+    def inspect
+      "#<Gmail::Mailbox#{'0x%04x' % (object_id << 1)} name=#{external_name}>"
+    end
+
+    def to_s
+      name
+    end
+
+    MAILBOX_ALIASES.each_key { |mailbox|
+      define_method(mailbox) do |*args, &block|
+        emails(mailbox, *args, &block)
+      end
+    }
+  end # Message
+end # Gmail