ruby-gmail 0.0.8 → 0.0.9

data/History.txt

@@ -1,4 +1,10 @@
-=== 0.0.8 / 2009/12-23
+=== 0.0.9 / 2010-04-17
+
+* 1 bugfix
+
+  * Fixed content-transfer-encoding when sending email
+
+=== 0.0.8 / 2009-12-23
 
 * 1 bugfix
 

data/Manifest.txt

@@ -6,6 +6,7 @@ lib/gmail.rb
 lib/ietf/rfc2045.rb
 lib/ietf/rfc822.rb
 lib/mime/entity.rb
+lib/mime/entity_tmail.rb
 lib/mime/message.rb
 lib/smtp_tls.rb
 Manifest.txt

data/README.markdown

@@ -12,7 +12,8 @@ Extra thanks for specific feature contributions from:
 
   * [Justin Perkins](http://github.com/justinperkins)
   * [Mikkel Malmberg](http://github.com/mikker)
-
+  * [Julien Blanchard](http://github.com/julienXX)
+  * [Federico Galassi](http://github.com/fgalassi)
 
 ## Description
 
@@ -74,11 +75,11 @@ A Rubyesque interface to Gmail, with all the tools you'll need. Search, read and
 * ruby
 * net/smtp
 * net/imap
-* shared-mime-info rubygem
+* shared-mime-info rubygem (for MIME-detection when attaching files)
 
 ## Install
 
-    sudo gem install ruby-gmail -s http://gemcutter.org
+    gem install ruby-gmail
 
 ## License
 

data/Rakefile

@@ -10,3 +10,21 @@ Hoe.spec 'ruby-gmail' do
   self.url = "http://dcparker.github.com/ruby-gmail"
   self.post_install_message = "\n\033[34mIf ruby-gmail saves you TWO hours of work, want to compensate me for, like, a half-hour?\nSupport me in making new and better gems:\033[0m \033[31;4mhttp://pledgie.com/campaigns/7087\033[0m\n\n"
 end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ruby-gmail"
+    gem.summary = %Q{A Rubyesque interface to Gmail, with all the tools you'll need.}
+    gem.description = %Q{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.}
+    gem.email = "gems@behindlogic.com"
+    gem.homepage = "http://dcparker.github.com/ruby-gmail"
+    gem.authors = ["BehindLogic"]
+    gem.post_install_message = "\n\033[34mIf ruby-gmail saves you TWO hours of work, want to compensate me for, like, a half-hour?\nSupport me in making new and better gems:\033[0m \033[31;4mhttp://pledgie.com/campaigns/7087\033[0m\n\n"
+    gem.add_dependency('shared-mime-info', '>= 0')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.9

data/lib/gmail.rb

@@ -3,7 +3,7 @@ require 'net/smtp'
 require 'smtp_tls'
 
 class Gmail
-  VERSION = '0.0.8'
+  VERSION = '0.0.9'
 
   class NoLabel < RuntimeError; end
 
@@ -53,6 +53,14 @@ class Gmail
     imap.create(name)
   end
 
+  # List the available labels
+  def labels
+    (@imap.list("", "%") + @imap.list("[Gmail]/", "%")).inject([]) do |lables,label|
+      label[:name].each_line { |l| labels << l }
+      labels
+    end
+  end
+
   def in_mailbox(mailbox, &block)
     raise ArgumentError, "Must provide a code block" unless block_given?
     mailbox_stack << mailbox
@@ -80,7 +88,7 @@ class Gmail
       block.call(lambda {|to, body|
         from = meta.username
         puts "Sending from #{from} to #{to}:\n#{body}"
-        smtp.send_message(body, from, to)
+        smtp.send_message(body.to_s, from, to)
       })
       puts "SMTP closing."
     end

data/lib/ietf/rfc2045.rb

@@ -4,7 +4,7 @@ module IETF
     def self.parse_rfc2045_from(raw)
       headers, raw = IETF::RFC822.parse_rfc822_from(raw)
 
-      if headers['content-type'] =~ /multipart\/(\w+); boundary=([\"\']?)(.*)\2?/
+      if headers['content-type'] =~ /multipart\/(\w+); boundary=([\"\'])(.*)\2/ || headers['content-type'] =~ /multipart\/(\w+); boundary(=)(.*)$/
         content = {}
         content[:type] = $1
         content[:boundary] = $3

data/lib/mime/entity.rb

@@ -11,11 +11,11 @@ module MIME
   end
   class Entity
     def initialize(one=nil,two=nil)
-      if one.is_a?(Hash) || two.is_a?(Hash)
+      if one.is_a?(Hash) || two.is_a?(Hash) # Intent is to generate a message from parameters
         @headers = one.is_a?(Hash) ? one : two
         set_content one if one.is_a?(String)
         @encoding = 'quoted-printable' unless encoding
-      elsif one.is_a?(String)
+      elsif one.is_a?(String) # Intent is to parse a message body
         @raw = one.gsub(/\r/,'').gsub(/\n/, "\r\n") # normalizes end-of-line characters
         from_parsed(IETF::RFC2045.parse_rfc2045_from(@raw))
       end
@@ -150,7 +150,7 @@ module MIME
     # Renders this data structure into a string, encoded
     def to_s
       multipart_boundary # initialize the boundary if necessary
-      headers.inject('') {|a,(k,v)| a << "#{MIME.capitalize_header(k)}: #{v}\r\n"} + "\r\n" + if content.is_a?(Array)
+      {'charset' => 'utf-8', 'content-transfer-encoding' => @encoding}.merge(headers).inject('') {|a,(k,v)| a << "#{MIME.capitalize_header(k)}: #{v}\r\n"} + "\r\n" + if content.is_a?(Array)
         "\r\n--#{multipart_boundary}\r\n" + content.collect {|part| part.to_s }.join("\r\n--#{multipart_boundary}\r\n") + "\r\n--#{multipart_boundary}--\r\n"
       else
         content.to_s

data/lib/mime/entity_tmail.rb

@@ -0,0 +1,217 @@
+require 'tmail'
+require 'ietf/rfc2045'
+String::ALPHANUMERIC_CHARACTERS = ('a'..'z').to_a + ('A'..'Z').to_a unless defined? String::ALPHANUMERIC_CHARACTERS
+def String.random(size)
+  length = String::ALPHANUMERIC_CHARACTERS.length
+  (0...size).collect { String::ALPHANUMERIC_CHARACTERS[Kernel.rand(length)] }.join
+end
+
+module MIME
+  def self.capitalize_header(header_name)
+    header_name.gsub(/^(\w)/) {|m| m.capitalize}.gsub(/-(\w)/) {|n| '-' + n[1].chr.capitalize}
+  end
+  class Entity
+    def initialize(one=nil,two=nil)
+      if one.is_a?(Hash) || two.is_a?(Hash) # Intent is to generate a message from parameters
+        @headers = one.is_a?(Hash) ? one : two
+        set_content one if one.is_a?(String)
+        @encoding = 'quoted-printable' unless encoding
+      elsif one.is_a?(String) # Intent is to parse a message body
+        @raw = one.gsub(/\r/,'').gsub(/\n/, "\r\n") # normalizes end-of-line characters
+        @tmail = TMail::Mail.parse(@raw)
+        from_tmail(@tmail)
+      elsif one.is_a?(TMail::Mail)
+        @tmail = one
+        from_tmail(@tmail)
+      end
+    end
+
+    def inspect
+      "<#{self.class.name}##{object_id} Headers:{#{headers.collect {|k,v| "#{k}=#{v}"}.join(' ')}} content:#{multipart? ? 'multipart' : 'flat'}>"
+    end
+
+    # This means we have a structure from IETF::RFC2045.
+    # Entity is: [headers, content], while content may be an array of Entities.
+    # Or, {:type, :boundary, :content}
+    def from_parsed(parsed)
+      case parsed
+      when Array
+        if parsed[0].is_a?(Hash) && (parsed[1].is_a?(Hash) || parsed[1].is_a?(String))
+          @headers = parsed[0]
+          @content = parsed[1].is_a?(Hash) ? parsed[1][:content].collect {|p| Entity.new.from_parsed(p)} : parsed[1]
+          if parsed[1].is_a?(Hash)
+            @multipart_type = parsed[1][:type]
+            @multipart_boundary = parsed[1][:boundary]
+            raise "IETF PARSING FAIL! (empty boundary)" if @multipart_boundary == ''
+          end
+        else
+          raise "IETF PARSING FAIL! ('A' structure)"
+        end
+        return self
+      when Hash
+        if parsed.has_key?(:type) && parsed.has_key?(:boundary) && parsed.has_key?(:content)
+          @content = parsed[:content].is_a?(Array) ? parsed[:content].collect {|p| Entity.new.from_parsed(p)} : parsed[:content]
+        else
+          raise "IETF PARSING FAIL! ('H' structure)"
+        end
+        return self
+      end
+      raise ArgumentError, "Must pass in either: [an array with two elements: headers(hash) and content(string or array)] OR [a hash containing :type, :boundary, and :content(being the former or a string)]"
+    end
+    def from_tmail(tmail)
+      raise ArgumentError, "Expecting a TMail::Mail object." unless tmail.is_a?(TMail::Mail)
+      @headers ||= Hash.new {|h,k| @tmail.header[k].to_s }
+      if multipart?
+        @content = @tmail.parts.collect { |tpart| Entity.new.from_tmail(tpart) }
+      else
+        set_content @tmail.body # TMail has already decoded it, but we need it still encoded
+      end
+    end
+
+    ##############
+    # ATTRIBUTES #
+
+    # An Entity has Headers.
+    def headers
+      @headers ||= {}
+    end
+    # An Entity has Content.
+    #   IF the Content-Type is a multipart type,
+    #   the content will be one or more Entities.
+    attr_reader :content, :multipart_type
+
+    #################
+    # Macro Methods #
+
+    def multipart?
+      return @tmail.multipart? if @tmail
+      !!(headers['content-type'] =~ /multipart\//) if headers['content-type']
+    end
+    def multipart_type
+      if headers['content-type'] =~ /multipart\/(\w+)/
+        $1
+      end if headers['content-type']
+    end
+    # Auto-generates a boundary if one doesn't yet exist.
+    def multipart_boundary
+      return nil unless multipart?
+      unless @multipart_boundary ||= (@tmail && @tmail.header['content-type'] ? @tmail.header['content-type'].params['boundary'] : nil)
+        # Content-Type: multipart/mixed; boundary=000e0cd28d1282f4ba04788017e5
+        @multipart_boundary = String.random(25)
+        headers['content-type'] = "multipart/#{multipart_type}; boundary=#{@multipart_boundary}"
+        @multipart_boundary
+      end
+      @multipart_boundary
+    end
+    def attachment?
+      @tmail.disposition_is_attachment? || headers['content-disposition'] =~ /^form-data;.* filename=[\"\']?[^\"\']+[\"\']?/ if headers['content-disposition']
+    end
+    alias :file? :attachment?
+    def part_filename
+      # Content-Disposition: attachment; filename="summary.txt"
+      if headers['content-disposition'] =~ /; filename=[\"\']?([^\"\']+)/
+        $1
+      end if headers['content-disposition']
+    end
+
+    def encoding
+      @encoding ||= headers['content-transfer-encoding'] || nil
+    end
+    # Re-encodes content if necessary when a new encoding is set
+    def encoding=(new_encoding)
+      raw_content = decoded_content # nil if multipart
+      @encoding = new_encoding
+      set_content(raw_content) if raw_content # skips if multipart
+      @encoding
+    end
+    alias :set_encoding :encoding=
+
+    def find_part(options)
+      find_parts(options,true).first
+    end
+    def find_parts(options,find_only_one=false)
+      parts = []
+      return nil unless (options[:content_type] && headers['content-type']) || (options[:content_disposition] && headers['content-disposition'])
+        # Do I match your search?
+        iam = true
+        iam = false if options[:content_type] && headers['content-type'] !~ /^#{options[:content_type]}(?=;|$)/
+        iam = false if options[:content_disposition] && headers['content-disposition'] !~ /^#{options[:content_disposition]}(?=;|$)/
+        parts << self if iam
+        return parts unless parts.empty?
+        # Do any of my children match your search?
+        content.each do |part|
+          parts.concat part.find_parts(options,find_only_one)
+          return parts if !parts.empty? && find_only_one
+        end if multipart?
+      return parts
+    end
+
+    def save_to_file(path=nil)
+      filename = path if path && !File.exists?(path) # If path doesn't exist, assume it's a filename
+      filename ||= path + '/' + part_filename if path && attachment? # If path does exist, and we're saving an attachment, use the attachment filename
+      filename ||= (attachment? ? part_filename : path) # If there is no path and we're saving an attachment, use the attachment filename; otherwise use path (whether it is present or not)
+      filename ||= '.' # No path supplied, and not saving an attachment. We'll just save it in the current directory.
+      if File.directory?(filename)
+        i = 0
+        begin
+          i += 1
+          filename = filename + "/attachment-#{i}"
+        end until !File.exists(filename)
+      end
+      # After all that trouble to get a filename to save to...
+      File.open(filename, 'w') do |file|
+        file << decoded_content
+      end
+    end
+
+    ##########################
+    # CONVERTING / RENDERING #
+
+    # Renders this data structure into a string, encoded
+    def to_s
+      multipart_boundary # initialize the boundary if necessary, so it will be included in the headers
+      headers.inject('') {|a,(k,v)| a << "#{MIME.capitalize_header(k)}: #{v}\r\n"} + "\r\n" + if content.is_a?(Array)
+        "\r\n--#{multipart_boundary}\r\n" + content.collect {|part| part.to_s }.join("\r\n--#{multipart_boundary}\r\n") + "\r\n--#{multipart_boundary}--\r\n"
+      else
+        content.to_s
+      end
+    end
+
+    # Converts this data structure into a string, but decoded if necessary
+    def decoded_content
+      return nil if @content.is_a?(Array)
+      case encoding.to_s.downcase
+      when 'quoted-printable'
+        @content.unpack('M')[0]
+      when 'base64'
+        @content.unpack('m')[0]
+      # when '7bit'
+      #   # should get this 7bit encoding done too...
+      else
+        @content
+      end
+    end
+
+    # You can set new content, and it will be saved in encoded form.
+    def set_content(raw)
+      @content = raw.is_a?(Array) ? raw :
+        case encoding.to_s.downcase
+        when 'quoted-printable'
+          [raw].pack('M')
+        when 'base64'
+          [raw].pack('m')
+        else
+          raw
+        end
+    end
+    alias :content= :set_content
+
+    private
+      def transfer_to(other)
+        other.instance_variable_set(:@content, @content.dup) if @content
+        other.headers.clear
+        other.headers.merge!(Hash[*headers.dup.select {|k,v| k =~ /content/}.flatten])
+      end
+
+  end
+end

data/lib/mime/message.rb

@@ -1,5 +1,4 @@
-require 'mime/entity'
-require 'shared-mime-info'
+require 'mime/entity_tmail'
 module MIME
   # A Message is really a MIME::Entity,
   # but should be used for the outermost Entity, because
@@ -52,6 +51,7 @@ module MIME
       short_filename = filename.match(/([^\\\/]+)$/)[1]
 
       # Generate the attachment piece
+      require 'shared-mime-info'
       attachment = Entity.new(
         'content-type' => MIME.check(filename).type + "; \r\n  name=\"#{short_filename}\"",
         'content-disposition' => "attachment; \r\n  filename=\"#{short_filename}\"",
@@ -61,10 +61,10 @@ module MIME
       
       # Enclose in a top-level multipart/mixed
       if multipart? && multipart_type == 'mixed'
-        # If already enclosed, all we have to do is add the attachment part
+        # If we're already dealing with a mixed multipart, all we have to do is add the attachment part
         (@content ||= []) << attachment
       else
-        # If there is no content, add a little message about the attachment(s).
+        # If there is no content yet, add a little message about the attachment(s).
         set_content 'See attachment(s)' if @content.nil?
         # Generate the new top-level multipart, transferring what is here already into a child object
         new_content = Entity.new
@@ -72,7 +72,7 @@ module MIME
         transfer_to(new_content)
         headers.reject! {|k,v| k =~ /content/}
         headers['content-type'] = 'multipart/mixed'
-        headers.delete 'content-transfer-encoding' # because now it's useless.
+        headers.delete 'content-transfer-encoding' # because we don't need a transfer-encoding on a multipart package.
         @content = [new_content, attachment]
       end
 

metadata

@@ -1,82 +1,60 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-gmail
 version: !ruby/object:Gem::Version 
-  version: 0.0.8
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 9
+  version: 0.0.9
 platform: ruby
 authors: 
-- Daniel Parker
+- BehindLogic
 autorequire: 
 bindir: bin
-cert_chain: 
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDNjCCAh6gAwIBAgIBADANBgkqhkiG9w0BAQUFADBBMQ0wCwYDVQQDDARnZW1z
-  MRswGQYKCZImiZPyLGQBGRYLYmVoaW5kbG9naWMxEzARBgoJkiaJk/IsZAEZFgNj
-  b20wHhcNMDkxMTE5MDQ0NzIzWhcNMTAxMTE5MDQ0NzIzWjBBMQ0wCwYDVQQDDARn
-  ZW1zMRswGQYKCZImiZPyLGQBGRYLYmVoaW5kbG9naWMxEzARBgoJkiaJk/IsZAEZ
-  FgNjb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDs+2PvSoBC5mCz
-  Nm95RXKOb/u+CmPA70DoG9cF0zipCie003Vm0DYL3Rtobcr32eMvHxkWoJ6xoz0I
-  h74yNKtHjTTCxj86HWBPsE6xVMxVCftClndjCyKsiMiqvvp1wDNO0FFK+6LijmL3
-  2Xkp4brWq1JO92y9vYct34R7o2X//+nwZs+sss+EYhNdvdUJfWy7tA5dghGdLvRn
-  UhJJSAtTefkBCwO7bufLEt+n7wIRbiJJ5dDCwE3NIX4wUSrNeYwXGXA/Ybki+BUl
-  3KJF9IC0XR9fY9DGF0FXBKrkfDlZRrnQOem2aIxeuln0KQLJXXJuDTQPHO+mK3EG
-  UPhR7IAHAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
-  BBQn32ZStKmqwFqs2vuglYzkvDzBZjANBgkqhkiG9w0BAQUFAAOCAQEAe3Z+iMmy
-  IX9ChQW4hNNb1HOpgCMc2RL+vUwku9WE95dZ+BE4A6mOYTj5JXdYf4R4Z2vavr+d
-  nwJWtXPeIBWxireb8gUU0DwqodYTpsmkj5LD1zIaZ59rXlwDA9O0V4fwE1iRG5MD
-  mB7m8fT8WNOeg4AfjH4aSiHI1+HX1RQkc7KFdLotKnCevzYU6Jza5VUbXyJ+yCEH
-  DFARN3mkfGI+18MRDEi39nK2O/bBd6Wf0cYPEKsGQjNNAIBtv9belepSMd1KKfQ2
-  L7j8CnNDCrsHDe7/251D85wSvTH4Q/41NE5ahdCkkHwzDJeyhXpmNuUSswdn7woz
-  teST6sOe8lUhZQ==
-  -----END CERTIFICATE-----
+cert_chain: []
 
-date: 2009-12-23 00:00:00 -05:00
+date: 2010-04-18 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: shared-mime-info
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 2.3.3
-    version: 
+  type: :runtime
+  version_requirements: *id001
 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.
-email: 
-- gems@behindlogic.com
+email: gems@behindlogic.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
-- Manifest.txt
+- README.markdown
 files: 
 - .autotest
 - History.txt
+- Manifest.txt
+- README.markdown
+- Rakefile
+- VERSION
+- lib/gmail.rb
 - lib/gmail/mailbox.rb
 - lib/gmail/message.rb
-- lib/gmail.rb
 - lib/ietf/rfc2045.rb
 - lib/ietf/rfc822.rb
 - lib/mime/entity.rb
+- lib/mime/entity_tmail.rb
 - lib/mime/message.rb
 - lib/smtp_tls.rb
-- Manifest.txt
-- Rakefile
-- README.markdown
+- test/test_gmail.rb
+- test/test_helper.rb
 has_rdoc: true
 homepage: http://dcparker.github.com/ruby-gmail
 licenses: []
@@ -85,29 +63,30 @@ post_install_message: "\n\
   \e[34mIf ruby-gmail saves you TWO hours of work, want to compensate me for, like, a half-hour?\n\
   Support me in making new and better gems:\e[0m \e[31;4mhttp://pledgie.com/campaigns/7087\e[0m\n\n"
 rdoc_options: 
-- --main
-- README.markdown
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
-rubyforge_project: ruby-gmail
-rubygems_version: 1.3.5
+rubyforge_project: 
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: A Rubyesque interface to Gmail, with all the tools you'll need
+summary: A Rubyesque interface to Gmail, with all the tools you'll need.
 test_files: 
 - test/test_gmail.rb
 - test/test_helper.rb

data.tar.gz.sig

@@ -1,2 +0,0 @@
-�j|,�r�%�B��ZC��B'�6,��r�g�V~�9ï�+�mcL���L��.�#�_�x.&�#LX��!�ȧi×T�_�e2������k�s��-[`�c���G���^J����y3EYY�<��^X	q
-�?D