mime 0.3.0 → 0.4.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mime
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-28 00:00:00.000000000 Z
+date: 2014-04-18 00:00:00.000000000 Z
 dependencies: []
 description: ! 'A library for building RFC compliant Multipurpose Internet Mail Extensions
 
@@ -32,14 +32,14 @@ files:
 - lib/mime/headers/internet.rb
 - lib/mime/discrete_media_factory.rb
 - lib/mime/error.rb
-- lib/mime/header_container.rb
 - lib/mime/parser.rb
 - lib/mime/content_types.rb
-- lib/mime/media_type.rb
-- lib/mime/composite_media_type.rb
-- lib/mime/discrete_media_type.rb
-- lib/mime/message.rb
+- lib/mime/media.rb
+- lib/mime/composite_media.rb
 - lib/mime/content_formats/text_flowed.rb
+- lib/mime/header.rb
+- lib/mime/mail.rb
+- lib/mime/discrete_media.rb
 - lib/mime.rb
 - test/scaffold/application.msg
 - test/scaffold/unknown.yyy
@@ -47,23 +47,24 @@ files:
 - test/scaffold/mini.mov
 - test/scaffold/image.jpg
 - test/scaffold/book.pdf
-- test/scaffold/plain_text_email.msg
 - test/scaffold/song.mp3
 - test/scaffold/ruby.png
 - test/scaffold/multipart_alternative.msg
-- test/scaffold/multipart_alternative_related.msg
-- test/scaffold/multipart_related.msg
 - test/scaffold/multipart_mixed_inline_and_attachment2.msg
 - test/scaffold/image.msg
 - test/scaffold/multipart_form_data_file_and_text.msg
 - test/scaffold/data.xml
-- test/scaffold/multipart_form_data_mixed.msg
+- test/scaffold/rfc822_composite.msg
 - test/scaffold/text.msg
 - test/scaffold/main.css
-- test/scaffold/multipart_mixed_inline_and_attachment.msg
+- test/scaffold/multipart_alternative_related.msg
 - test/scaffold/multipart_form_data_text.msg
 - test/scaffold/audio.msg
+- test/scaffold/multipart_related.msg
+- test/scaffold/rfc822_discrete.msg
 - test/scaffold/data.htm
+- test/scaffold/multipart_form_data_mixed.msg
+- test/scaffold/multipart_mixed_inline_and_attachment.msg
 - test/test_mime.rb-try
 - test/test_mime.rb
 - test/test_text_flowed.rb

data/lib/mime/composite_media_type.rb

@@ -1,169 +0,0 @@
-module MIME
-
-  #
-  # Composite entities are handled using MIME mechanisms. A MIME processor must
-  # handle the body directly. A CompositeMediaType object is composed of one or
-  # more CompositeMediaType and/or DiscreteMediaType objects.
-  #
-  # This class is abstract.
-  #
-  class CompositeMediaType < MediaType
-
-    def initialize content_type
-      AbstractClassError.no_instantiation(self, CompositeMediaType)
-
-      super(nil, content_type)
-      @entities = Array.new
-    end
-
-    #
-    # Add a MediaType object to the message.
-    #
-    def add_entity entity
-      raise Error.new('can only add MediaType objects')  unless entity.is_a? MediaType
-      @entities.unshift(entity)
-    end
-
-    #
-    # Attach a MediaType object to the message.
-    #
-    def attach_entity entity, params = {}
-      entity.set_content_disposition('attachment', params)
-      add_entity(entity)
-    end
-
-    #
-    # Inline a MediaType object in the message.
-    #
-    def inline_entity entity, params = {}
-      entity.set_content_disposition('inline', params)
-      add_entity(entity)
-    end
-
-  end
-
-  #
-  # MessageMedia is intended to encapsulate another message. In particular,
-  # the <em>message/rfc822</em> content type is used to encapsulate RFC 822
-  # messages.
-  #
-  # TODO Implement
-  #
-  class MessageMedia < CompositeMediaType
-  end
-
-  #
-  # The abstract base class for all multipart message subtypes. The entities of
-  # a multipart message are delimited by a unique boundary.
-  #
-  class MultipartMedia < CompositeMediaType
-
-    def initialize content_type
-      AbstractClassError.no_instantiation(self, MultipartMedia)
-      super
-    end
-
-    #
-    # The boundary used to separate the message entities.
-    #
-    def boundary
-      @boundary ||= "Boundary_#{unique_id}"
-    end
-
-    #
-    # Return the multipart representation of the body.
-    #
-    def body
-      all_entities = @entities.join("\r\n--#{boundary}\r\n")
-      "--#{boundary}\r\n#{all_entities}\r\n--#{boundary}--\r\n"
-    end
-
-  end
-
-  #
-  # The Alternative subtype indicates that each contained entity is an
-  # alternatively formatted version of the same content. The most complex
-  # version should be added to the message first, i.e. it will be sequentially
-  # last in the message.
-  #
-  class MultipartMedia::Alternative < MultipartMedia
-
-    #
-    # Returns a MultipartMedia::Alternative object with a content type of
-    # multipart/alternative.
-    #
-    def initialize
-      super("multipart/alternative; boundary=#{boundary}")
-    end
-
-  end
-
-  #
-  # The FormData subtype expresses values for HTML form data submissions.
-  # ---
-  # RFCs consulted during implementation:
-  #
-  # * RFC-1867  Form-based File Upload in HTML
-  # * RFC-2388  Returning Values from Forms: multipart/form-data
-  #
-  class MultipartMedia::FormData < MultipartMedia
-
-    #
-    # Returns a MultipartMedia::FormData object with a content type of
-    # multipart/form-data.
-    #
-    def initialize
-      super("multipart/form-data; boundary=#{boundary}")
-    end
-
-    #
-    # Add the MediaType object, +entity+, to the FormData object. +name+ is
-    # typically an HTML input tag variable name. If the input tag is of type
-    # _file_, then +filename+ must be specified to indicate a file upload.
-    #
-    def add_entity entity, name, filename = nil
-      entity.set_content_disposition('form-data', 'name' => name, 'filename' => filename)
-      super(entity)
-    end
-
-  end
-
-  #
-  # The Mixed subtype aggregates contextually independent entities.
-  #
-  class MultipartMedia::Mixed < MultipartMedia
-
-    #
-    # Returns a MultipartMedia::Mixed object with a content type of
-    # multipart/mixed.
-    #
-    def initialize
-      super("multipart/mixed; boundary=#{boundary}")
-    end
-
-  end
-
-  #
-  # The Related subtype aggregates multiple related entities. The message
-  # consists of a root (the first entity) which references subsequent inline
-  # entities. Message entities should be referenced by their Content-ID header.
-  # The syntax of a reference is unspecified and is instead dictated by the
-  # encoding or protocol used in the entity.
-  # ---
-  # RFC consulted during implementation:
-  # 
-  # * RFC-2387  The MIME Multipart/Related Content-type
-  #
-  class MultipartMedia::Related < MultipartMedia
-
-    #
-    # Returns a MultipartMedia::Related object with a content type of
-    # multipart/related.
-    #
-    def initialize
-      super("multipart/related; boundary=#{boundary}")
-    end
-
-  end
-
-end

data/lib/mime/discrete_media_type.rb

@@ -1,78 +0,0 @@
-module MIME
-
-  #
-  # Discrete media types must be handled by non-MIME mechanisms; they are
-  # opaque to MIME processors. Therefore, the body of a DiscreteMediaType
-  # object does not need further MIME processing.
-  #
-  # This class is abstract.
-  #
-  class DiscreteMediaType < MediaType
-    def initialize(body, media_subtype, content_params)
-      AbstractClassError.no_instantiation(self, DiscreteMediaType)
-      super(body, "#{@media_type}/#{media_subtype}", content_params)
-    end
-  end
-
-  #
-  # ApplicationMedia is intended for discrete data that is to be processed by
-  # some type of application program. The body contains information which must
-  # be processed by an application before it is viewable or usable by a user.
-  #
-  # ApplicationMedia is the catch all class. If your content cannot be
-  # identified as another DiscreteMediaType, then it is application media.
-  #
-  class ApplicationMedia < DiscreteMediaType
-    def initialize(body, subtype = 'octet-stream', params = {})
-      @media_type = 'application'
-      super
-    end
-  end
-
-  #
-  # AudioMedia is intended for discrete audio content. The +subtype+ indicates
-  # the specific audio format, such as *mpeg* or *midi*.
-  #
-  class AudioMedia < DiscreteMediaType
-    def initialize(body, subtype = 'basic', params = {})
-      @media_type = 'audio'
-      super
-    end
-  end
-
-  #
-  # ImageMedia is intented for discrete image content. The +subtype+ indicates
-  # the specific image format, such as *jpeg* or *gif*.
-  #
-  class ImageMedia < DiscreteMediaType
-    def initialize(body, subtype = 'jpeg', params = {})
-      @media_type = 'image'
-      super
-    end
-  end
-
-  #
-  # TextMedia is intended for content which is principally textual in form. The
-  # +subtype+ indicates the specific text type, such as *plain* or *html*.
-  #
-  class TextMedia < DiscreteMediaType
-    def initialize(body, subtype = 'plain', params = {})
-      @media_type = 'text'
-      super
-    end
-  end
-
-  #
-  # VideoMedia is intended for discrete video content. The content +subtype+
-  # indicates the specific video format. The RFC describes video media as
-  # content that contains a time-varying-picture image, possibly with color and
-  # coordinated sound.
-  #
-  class VideoMedia < DiscreteMediaType
-    def initialize(body, subtype = 'mpeg', params = {})
-      @media_type = 'video'
-      super
-    end
-  end
-
-end

data/lib/mime/header_container.rb

@@ -1,32 +0,0 @@
-module MIME
-
-  #
-  # Storage for RFC 2822 headers.
-  #
-  class HeaderContainer
-
-    #
-    # Return a new header container object.
-    #
-    def initialize
-      @headers = Hash.new
-    end
-
-    #
-    # Convert all headers to their string equivalents and join them using the
-    # RFC 2822 CRLF line separator.
-    #
-    def to_s
-      @headers.to_a.map {|kv| kv.join(": ")}.join("\r\n")
-    end
-
-    #
-    # Add the +name+/+value+ pair to the header container.
-    #
-    def add name, value
-      @headers.store(name, value)
-    end
-
-  end
-
-end

data/lib/mime/media_type.rb

@@ -1,51 +0,0 @@
-require 'mime/error'
-require 'mime/header_container'
-require 'mime/headers/mime'
-
-module MIME
-
-  #
-  # Abstract top-level media type class.
-  #
-  class MediaType
-
-    include Headers::MIME
-
-    attr_reader :headers
-    attr_accessor :body
-    protected :body, :body=
-
-    def initialize body, content_type, content_params = {}
-      AbstractClassError.no_instantiation(self, MediaType)
-
-      @headers = HeaderContainer.new
-      @body = body
-      self.content_id = unique_id
-      self.content_type =
-        if content_params.empty?
-          content_type
-        else
-          params = content_params.to_a.map {|kv| kv.join('=')}.join('; ')
-          "#{content_type}; #{params}"
-        end
-    end
-
-    #
-    # Transform the the MediaType object into a MIME message.
-    #
-    def to_s
-      "#{headers}\r\n\r\n#{body}"
-    end
-
-    private
-
-    #
-    # Generate a globally unique identifier for use in boundaries and IDs.
-    #
-    def unique_id
-      "#{object_id.abs}#{rand}"
-    end
-
-  end
-
-end

data/lib/mime/message.rb

@@ -1,61 +0,0 @@
-require 'time'
-require 'mime/headers/internet'
-require 'mime/headers/mime'
-
-
-module MIME
-
-  #
-  # Construct textual messages using the RFC 2822 Internet message format.
-  #
-  class Message
-
-    include Headers::Internet
-    include Headers::MIME
-
-    # HeaderContainer access
-    attr_reader :headers
-
-    attr_accessor :body
-
-    #
-    # Return a Message object with body optionally set to +body+.
-    #
-    def initialize body = nil
-      @body = body
-      @headers = HeaderContainer.new
-      self.date = Time.now.rfc2822
-      self.message_id = "#{rand(1E9)}@#{__id__.abs}"
-      self.mime_version = "1.0 (Ruby MIME v#{VERSION})"
-    end
-
-    #
-    # Return the Internet message formatted representation of the instance.
-    #
-    def to_s
-      #--
-      # In an RFC 2822 message, the header and body sections must be separated
-      # by two line breaks (CRLF). One line break is deliberately missing,
-      # allowing a body supplier to append headers to the top-level message
-      # header section. Consequently, the body supplier is responsible for
-      # handling the body-header separation. Furthermore, if the +body+ is
-      # empty, the header section will be properly terminated, creating a
-      # standards compliant message.
-      #++
-
-      # FIXME writing directly to body VS setting body with a MediaType gives an
-      # imbalance of "\r\n". Setting body directly with string requires a CRLF
-      # prepended, but not the case for TextMedia for instance. So where do we
-      # handle this? Perhaps HeaderContainer#to_s should append a CRLF, or
-      # self#body should detect String and automatically prepend CRLF??? Then we
-      # remove the CRLF here between the headers and body.
-      #
-      # Also, TextMedia adds the Content-ID and Content-Type headers, which we
-      # don't get if body is set directly with String. Does this matter?
-
-      "#{headers}\r\n#{body}\r\n"
-    end
-
-  end
-
-end