karthik-ruby-gmail 1.0.0 → 1.0.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NDIzM2RjNjAxMDM1MjVlODlkY2VmMWY5NjQ3MDVjZWMyOTM5MGMzOA==
-  data.tar.gz: !binary |-
-    MzM0OTg1YzdkOGFiYzhjMDU2YTQ2MjU5YTM4MDk4ZDQ1YjkyNzBiOA==
+SHA1:
+  metadata.gz: a2db109d6fd679f2d827ad0ae62c50eecf1be252
+  data.tar.gz: e7ddfa43853d76f42ece898ac0d3de17e3a0df07
 SHA512:
-  metadata.gz: !binary |-
-    YmUxMWNiMGY4NjM0ZTc0YmNlZTcwM2FhNmJhNzg0MjE0MDliNWE5MDEwMmY0
-    NTg3ZjBhOTM0NzUxZjUwOThkNWQ3N2YzZDdjMTBkZmVhYjJiYjRhOTc2ODk1
-    YzZlZTc0M2ZmNDRjNjJjNmEyMGE5ZTk3N2IyYTI5ODMzMTE3Njk=
-  data.tar.gz: !binary |-
-    MTM1YzE5NTI4NzIwNzBkZTA0N2Q5MGVhOWFiYWI0Y2JjYzE1YzVhYjYwMWFk
-    MDJlYjRmMGY2NGU1MGY0Y2E5YjQ4NzEwYjZiNjMyYmQ5MzZlNGU2OGE1YjVm
-    ZTk1ZmIxNGJjODNkODdhNTcyMzNiNjgzNDYwMjJlZGIzMjJlN2I=
+  metadata.gz: 0b159845574cf1ea98d2885d1583b1b2775b6e80bc6078efd516f694415c12cda8042d06d0d04c2c925a8a6c6c4e7505ec96a29817721a69ac768f175983d7d9
+  data.tar.gz: 664c4ad265476844821cf932ceb5780d12deb97a584cf6129423383e7ebcb95b87767f3f7f57456a638208aa02c14b56b1e53926711f4641f998d4fedf2b1869

data/History.txt

@@ -1,75 +1,14 @@
-=== 0.1.1 / 2010-05-11
 
-* 1 minor fix
+=== 1.0.1 / 04-04-2014
 
-  * Added explicit tmail dependency in gemspec
-  * Added better README tutorial content
+* 1 minor fix and updated README
 
-=== 0.0.9 / 2010-04-17
+  * Modified search by subject to accommodate non-ASCII strings. Retrieves all matching emails and then filter by the subject field (slower method but no way around the encoding issues with IMAP)
+  * Updated README
 
-* 1 bugfix
-
-  * Fixed content-transfer-encoding when sending email
-
-=== 0.0.8 / 2009-12-23
-
-* 1 bugfix
-
-  * Fixed attaching a file to an empty message
-
-=== 0.0.7 / 2009-12-23
-
-* 1 bugfix
-
-  * Improved multipart message parsing reliability
-
-=== 0.0.6 / 2009-12-21
-
-* 1 bugfix
-
-  * Fixed multipart parsing for when the boundary is marked in quotes.
-
-=== 0.0.5 / 2009-12-16
-
-* 1 bugfix
-
-  * Fixed IMAP initializer to work with Ruby 1.9's net/imap
-
-* 4 minor enhancements
-
-  * Better logout depending on the IMAP connection itself
-  * Added MIME::Message#text and MIME::Message#html for easier access to an email body
-  * Improved the MIME-parsing API slightly
-  * Added some tests
-
-=== 0.0.4 / 2009-11-30
-
-* 4 minor enhancement
-
-  * Added label creation (thanks to Justin Perkins / http://github.com/justinperkins)
-  * Made the gem login automatically when first needed
-  * Added an optional block on the Gmail.new object that will login and logout for you
-  * Added several search options (thanks to Mikkel Malmberg / http://github.com/mikker)
-
-=== 0.0.3 / 2009-11-19
-
-* 1 bugfix
-
-  * Fixed MIME::Message#content= for messages without an encoding
-
-* 1 minor enhancement
-
-  * Added Gmail#new_message
-
-=== 0.0.2 / 2009-11-18
-
-* 1 minor enhancement
-
-  * Made all of the examples in the README possible
-
-=== 0.0.1 / 2009-11-18
-
-* 1 major enhancement
-
-  * Birthday!
+=== 1.0.0 / 03-04-2014
 
+* Modified email search 
+  
+  * Added search by subject
+  * Limit search results

data/README.markdown

@@ -1,5 +1,44 @@
+# Documentation
 
-# Original ruby-gmail documentation
+## New features
+
+*  Search by subject
+*  Limit the email search results
+
+## Description
+
+This is a fork of the original ruby-gmail gem created by Daniel Parker (http://github.com/dcparker/). Minor improvements have been made in email search functionality. 
+Search functionality now supports search by email subject and a limit on the number of search results. 
+
+## Example Code:
+  
+  All the examples of the old ruby-gmail gem also hold good. The following examples demonstrate the newer search and limit capabilities.
+
+### 1) Require gmail
+
+    require 'gmail'
+
+### 2) Search emails
+
+    # Start an authenticated gmail session
+    gmail = Gmail.new(username, password)
+
+    # Get unread emails
+    gmail.inbox.email(:unread)
+
+    # Get unread emails from a specific sender to a specific recipient.
+    gmail.inbox.emails(:unread, to: 'foo@bar.com', from: 'bar@foo.com')
+
+    # Get emails matching a subject
+    gmail.inbox.emails(:unread, to: 'foo@bar.com', from: 'bar@foo.com', subject: 'Hello')
+
+    # Limit email search results
+    gmail.inbox.emails(:unread, limit: 5)
+
+## Author
+* Karthik Mallavarapu
+
+# Old ruby-gmail documentation
 
 * Code: [http://github.com/dcparker/ruby-gmail](http://github.com/dcparker/ruby-gmail)
 * Gem: [http://gemcutter.org/gems/ruby-gmail](http://rubygems.org/gems/ruby-gmail)
@@ -18,12 +57,11 @@ Extra thanks for specific feature contributions from:
 
 ## Description
 
-This is a fork of the original ruby-gmail gem created by Daniel Parker (http://github.com/dcparker/). Minor improvements have been made in email search functionality. 
-Search functionality now supports search by email subject and a limit on the number of search results. A Rubyesque interface to Gmail, with all the tools you'll need. Search, read and send multipart emails; archive, mark as read/unread, delete emails; and manage labels.
+A Rubyesque interface to Gmail, with all the tools you'll need. Search, read and send multipart emails; archive, mark as read/unread, delete emails; and manage labels.
 
 ## Features
 
-* Search emails (including search by subject)
+* Search emails
 * Read emails (handles attachments)
 * Emails: Label, archive, delete, mark as read/unread/spam
 * Create and delete labels

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/gmail.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'net/imap'
 
 class Gmail

data/lib/gmail/mailbox.rb

@@ -1,5 +1,8 @@
+# encoding: utf-8
+
 require 'date'
 require 'time'
+
 class Object
   def to_imap_date
     Date.parse(to_s).strftime("%d-%B-%Y")
@@ -29,6 +32,9 @@ class Gmail
     # Adding subject as a search parameter option. 
     # Also adding a param called limit, for limiting the number of results. 
     def emails(key_or_opts = :all, opts={})
+      # filter results by search or limit if search or limit are not nil
+      subject = nil
+      limit = nil
       if key_or_opts.is_a?(Hash) && opts.empty?
         search = ['ALL']
         opts = key_or_opts
@@ -52,22 +58,15 @@ class Gmail
         search.concat ['ON', opts[:on].to_imap_date] if opts[:on]
         search.concat ['FROM', opts[:from]] if opts[:from]
         search.concat ['TO', opts[:to]] if opts[:to]
-        # Adding search support for subject field
-        search.concat ['SUBJECT', opts[:subject]] if opts[:subject]
-        if opts[:limit]
-          raise ArgumentError "limit parameter must be an integer to limit the email search results" unless opts[:limit].is_a? Integer
-        end
-      end
-
-      # puts "Gathering #{(aliases[key] || key).inspect} messages for mailbox '#{name}'..."
-      @gmail.in_mailbox(self) do
-        email_results = @gmail.imap.uid_search(search).collect { |uid| messages[uid] ||= Message.new(@gmail, self, uid) }
-        limit = email_results.count
-        if opts[:limit]
-          limit = opts[:limit]
+        subject = opts[:subject]
+        limit = opts[:limit]
+        if limit
+          raise ArgumentError "limit parameter must be an integer to limit the email search results" unless limit.is_a? Integer
         end
-        email_results.first(limit)
       end
+      result = search_emails(search, subject)
+      limit = result.count if limit.nil?
+      result.first(limit)
     end
 
     # This is a convenience method that really probably shouldn't need to exist, but it does make code more readable
@@ -76,6 +75,23 @@ class Gmail
       emails(*args).length
     end
 
+    # Search mailbox with the given search string params and filter results by subject. 
+    # Subject is not added to the search string, since IMAP raises an exception for non-ASCII strings
+    def search_emails(search, subject)
+      @gmail.in_mailbox(self) do
+        email_results = @gmail.imap.uid_search(search).collect { |uid| messages[uid] ||= Message.new(@gmail, self, uid) }
+        # If subject is not nil, filter results by subject and mark the rest of the emails as unread.
+        if subject
+          result = email_results.select {|email| email.subject == subject} 
+          email_results.reject {|email| email.subject == subject}.each do |email|
+            email.mark(:unread)
+          end
+          return result
+        end
+        return email_results
+      end
+    end
+
     def messages
       @messages ||= {}
     end

data/lib/gmail/message.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 class Gmail
   class Message
     def initialize(gmail, mailbox, uid)

data/lib/smtp_tls.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require "openssl"
 require "net/smtp"
 

data/ruby-gmail.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{karthik-ruby-gmail}
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Karthik Mallavarapu"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karthik-ruby-gmail
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Karthik Mallavarapu
@@ -14,45 +14,45 @@ dependencies:
   name: shared-mime-info
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.2.1
 - !ruby/object:Gem::Dependency
   name: mime
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0.1'
-description: ! "A Rubyesque interface to Gmail, with all the tools you'll need. Search,
+description: "A Rubyesque interface to Gmail, with all the tools you'll need. Search,
   read and send multipart emails; archive, mark as read/unread, delete emails; and
   manage labels. Fork of \n    the original ruby-gmail gem (https://github.com/dcparker/ruby-gmail).
   Added search by subject, limit number of email search results."
@@ -86,17 +86,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.0.0
 signing_key: 
 specification_version: 3
 summary: A Rubyesque interface to Gmail, with all the tools you'll need.