mail-portertech 2.6.2.edge

data/lib/mail/indifferent_hash.rb

@@ -0,0 +1,146 @@
+# encoding: utf-8
+
+# This is an almost cut and paste from ActiveSupport v3.0.6, copied in here so that Mail
+# itself does not depend on ActiveSupport to avoid versioning conflicts
+
+module Mail
+  class IndifferentHash < Hash
+
+    def initialize(constructor = {})
+      if constructor.is_a?(Hash)
+        super()
+        update(constructor)
+      else
+        super(constructor)
+      end
+    end
+
+    def default(key = nil)
+      if key.is_a?(Symbol) && include?(key = key.to_s)
+        self[key]
+      else
+        super
+      end
+    end
+
+    def self.new_from_hash_copying_default(hash)
+      IndifferentHash.new(hash).tap do |new_hash|
+        new_hash.default = hash.default
+      end
+    end
+
+    alias_method :regular_writer, :[]= unless method_defined?(:regular_writer)
+    alias_method :regular_update, :update unless method_defined?(:regular_update)
+
+    # Assigns a new value to the hash:
+    #
+    #   hash = HashWithIndifferentAccess.new
+    #   hash[:key] = "value"
+    #
+    def []=(key, value)
+      regular_writer(convert_key(key), convert_value(value))
+    end
+
+    alias_method :store, :[]=
+
+    # Updates the instantized hash with values from the second:
+    #
+    #   hash_1 = HashWithIndifferentAccess.new
+    #   hash_1[:key] = "value"
+    #
+    #   hash_2 = HashWithIndifferentAccess.new
+    #   hash_2[:key] = "New Value!"
+    #
+    #   hash_1.update(hash_2) # => {"key"=>"New Value!"}
+    #
+    def update(other_hash)
+      other_hash.each_pair { |key, value| regular_writer(convert_key(key), convert_value(value)) }
+      self
+    end
+
+    alias_method :merge!, :update
+
+    # Checks the hash for a key matching the argument passed in:
+    #
+    #   hash = HashWithIndifferentAccess.new
+    #   hash["key"] = "value"
+    #   hash.key? :key  # => true
+    #   hash.key? "key" # => true
+    #
+    def key?(key)
+      super(convert_key(key))
+    end
+
+    alias_method :include?, :key?
+    alias_method :has_key?, :key?
+    alias_method :member?, :key?
+
+    # Fetches the value for the specified key, same as doing hash[key]
+    def fetch(key, *extras)
+      super(convert_key(key), *extras)
+    end
+
+    # Returns an array of the values at the specified indices:
+    #
+    #   hash = HashWithIndifferentAccess.new
+    #   hash[:a] = "x"
+    #   hash[:b] = "y"
+    #   hash.values_at("a", "b") # => ["x", "y"]
+    #
+    def values_at(*indices)
+      indices.collect {|key| self[convert_key(key)]}
+    end
+
+    # Returns an exact copy of the hash.
+    def dup
+      IndifferentHash.new(self)
+    end
+
+    # Merges the instantized and the specified hashes together, giving precedence to the values from the second hash
+    # Does not overwrite the existing hash.
+    def merge(hash)
+      self.dup.update(hash)
+    end
+
+    # Performs the opposite of merge, with the keys and values from the first hash taking precedence over the second.
+    # This overloaded definition prevents returning a regular hash, if reverse_merge is called on a HashWithDifferentAccess.
+    def reverse_merge(other_hash)
+      super self.class.new_from_hash_copying_default(other_hash)
+    end
+
+    def reverse_merge!(other_hash)
+      replace(reverse_merge( other_hash ))
+    end
+
+    # Removes a specified key from the hash.
+    def delete(key)
+      super(convert_key(key))
+    end
+
+    def stringify_keys!; self end
+    def stringify_keys; dup end
+    def symbolize_keys; to_hash.symbolize_keys end
+    def to_options!; self end
+
+    def to_hash
+      Hash.new(default).merge!(self)
+    end
+
+  protected
+
+    def convert_key(key)
+      key.kind_of?(Symbol) ? key.to_s : key
+    end
+
+    def convert_value(value)
+      if value.class == Hash
+        self.class.new_from_hash_copying_default(value)
+      elsif value.is_a?(Array)
+        value.dup.replace(value.map { |e| convert_value(e) })
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/mail/mail.rb

@@ -0,0 +1,267 @@
+# encoding: utf-8
+module Mail
+
+  # Allows you to create a new Mail::Message object.
+  # 
+  # You can make an email via passing a string or passing a block.
+  # 
+  # For example, the following two examples will create the same email
+  # message:
+  # 
+  # Creating via a string:
+  # 
+  #  string = "To: mikel@test.lindsaar.net\r\n"
+  #  string << "From: bob@test.lindsaar.net\r\n"
+  #  string << "Subject: This is an email\r\n"
+  #  string << "\r\n"
+  #  string << "This is the body"
+  #  Mail.new(string)
+  # 
+  # Or creating via a block:
+  # 
+  #  message = Mail.new do
+  #    to 'mikel@test.lindsaar.net'
+  #    from 'bob@test.lindsaar.net'
+  #    subject 'This is an email'
+  #    body 'This is the body'
+  #  end
+  # 
+  # Or creating via a hash (or hash like object):
+  # 
+  #  message = Mail.new({:to => 'mikel@test.lindsaar.net',
+  #                      'from' => 'bob@test.lindsaar.net',
+  #                      :subject => 'This is an email',
+  #                      :body => 'This is the body' })
+  # 
+  # Note, the hash keys can be strings or symbols, the passed in object
+  # does not need to be a hash, it just needs to respond to :each_pair
+  # and yield each key value pair.
+  # 
+  # As a side note, you can also create a new email through creating
+  # a Mail::Message object directly and then passing in values via string,
+  # symbol or direct method calls.  See Mail::Message for more information.
+  # 
+  #  mail = Mail.new
+  #  mail.to = 'mikel@test.lindsaar.net'
+  #  mail[:from] = 'bob@test.lindsaar.net'
+  #  mail['subject'] = 'This is an email'
+  #  mail.body = 'This is the body'
+  def self.new(*args, &block)
+    Message.new(args, &block)
+  end
+
+  # Sets the default delivery method and retriever method for all new Mail objects.
+  # The delivery_method and retriever_method default to :smtp and :pop3, with defaults
+  # set.
+  # 
+  # So sending a new email, if you have an SMTP server running on localhost is
+  # as easy as:
+  # 
+  #   Mail.deliver do
+  #     to      'mikel@test.lindsaar.net'
+  #     from    'bob@test.lindsaar.net'
+  #     subject 'hi there!'
+  #     body    'this is a body'
+  #   end
+  # 
+  # If you do not specify anything, you will get the following equivalent code set in
+  # every new mail object:
+  # 
+  #   Mail.defaults do
+  #     delivery_method :smtp, { :address              => "localhost",
+  #                              :port                 => 25,
+  #                              :domain               => 'localhost.localdomain',
+  #                              :user_name            => nil,
+  #                              :password             => nil,
+  #                              :authentication       => nil,
+  #                              :enable_starttls_auto => true  }
+  # 
+  #     retriever_method :pop3, { :address             => "localhost",
+  #                               :port                => 995,
+  #                               :user_name           => nil,
+  #                               :password            => nil,
+  #                               :enable_ssl          => true }
+  #   end
+  # 
+  #   Mail.delivery_method.new  #=> Mail::SMTP instance
+  #   Mail.retriever_method.new #=> Mail::POP3 instance
+  #
+  # Each mail object inherits the default set in Mail.delivery_method, however, on
+  # a per email basis, you can override the method:
+  #
+  #   mail.delivery_method :sendmail
+  # 
+  # Or you can override the method and pass in settings:
+  # 
+  #   mail.delivery_method :sendmail, { :address => 'some.host' }
+  # 
+  # You can also just modify the settings:
+  # 
+  #   mail.delivery_settings = { :address => 'some.host' }
+  # 
+  # The passed in hash is just merged against the defaults with +merge!+ and the result
+  # assigned the mail object.  So the above example will change only the :address value
+  # of the global smtp_settings to be 'some.host', keeping all other values
+  def self.defaults(&block)
+    Configuration.instance.instance_eval(&block)
+  end
+
+  # Returns the delivery method selected, defaults to an instance of Mail::SMTP
+  def self.delivery_method
+    Configuration.instance.delivery_method
+  end
+
+  # Returns the retriever method selected, defaults to an instance of Mail::POP3
+  def self.retriever_method
+    Configuration.instance.retriever_method
+  end
+
+  # Send an email using the default configuration.  You do need to set a default
+  # configuration first before you use self.deliver, if you don't, an appropriate
+  # error will be raised telling you to.
+  # 
+  # If you do not specify a delivery type, SMTP will be used.
+  # 
+  #  Mail.deliver do
+  #   to 'mikel@test.lindsaar.net'
+  #   from 'ada@test.lindsaar.net'
+  #   subject 'This is a test email'
+  #   body 'Not much to say here'
+  #  end
+  # 
+  # You can also do:
+  # 
+  #  mail = Mail.read('email.eml')
+  #  mail.deliver!
+  # 
+  # And your email object will be created and sent.
+  def self.deliver(*args, &block)
+    mail = self.new(args, &block)
+    mail.deliver
+    mail
+  end
+
+  # Find emails from the default retriever
+  # See Mail::Retriever for a complete documentation.
+  def self.find(*args, &block)
+    retriever_method.find(*args, &block)
+  end
+
+  # Finds and then deletes retrieved emails from the default retriever
+  # See Mail::Retriever for a complete documentation.
+  def self.find_and_delete(*args, &block)
+    retriever_method.find_and_delete(*args, &block)
+  end
+
+  # Receive the first email(s) from the default retriever
+  # See Mail::Retriever for a complete documentation.
+  def self.first(*args, &block)
+    retriever_method.first(*args, &block)
+  end
+
+  # Receive the first email(s) from the default retriever
+  # See Mail::Retriever for a complete documentation.
+  def self.last(*args, &block)
+    retriever_method.last(*args, &block)
+  end
+
+  # Receive all emails from the default retriever
+  # See Mail::Retriever for a complete documentation.
+  def self.all(*args, &block)
+    retriever_method.all(*args, &block)
+  end
+
+  # Reads in an email message from a path and instantiates it as a new Mail::Message
+  def self.read(filename)
+    self.new(File.open(filename, 'rb') { |f| f.read })
+  end
+
+  # Delete all emails from the default retriever
+  # See Mail::Retriever for a complete documentation.
+  def self.delete_all(*args, &block)
+    retriever_method.delete_all(*args, &block)
+  end
+
+  # Instantiates a new Mail::Message using a string
+  def Mail.read_from_string(mail_as_string)
+    Mail.new(mail_as_string)
+  end
+
+  def Mail.connection(&block)
+    retriever_method.connection(&block)
+  end
+
+  # Initialize the observers and interceptors arrays
+  @@delivery_notification_observers = []
+  @@delivery_interceptors = []
+
+  # You can register an object to be informed of every email that is sent through
+  # this method.
+  # 
+  # Your object needs to respond to a single method #delivered_email(mail)
+  # which receives the email that is sent.
+  def self.register_observer(observer)
+    unless @@delivery_notification_observers.include?(observer)
+      @@delivery_notification_observers << observer
+    end
+  end
+
+  # Unregister the given observer, allowing mail to resume operations
+  # without it.
+  def self.unregister_observer(observer)
+    @@delivery_notification_observers.delete(observer)
+  end
+
+  # You can register an object to be given every mail object that will be sent,
+  # before it is sent.  So if you want to add special headers or modify any
+  # email that gets sent through the Mail library, you can do so.
+  # 
+  # Your object needs to respond to a single method #delivering_email(mail)
+  # which receives the email that is about to be sent.  Make your modifications
+  # directly to this object.
+  def self.register_interceptor(interceptor)
+    unless @@delivery_interceptors.include?(interceptor)
+      @@delivery_interceptors << interceptor
+    end
+  end
+
+  # Unregister the given interceptor, allowing mail to resume operations
+  # without it.
+  def self.unregister_interceptor(interceptor)
+    @@delivery_interceptors.delete(interceptor)
+  end
+
+  def self.inform_observers(mail)
+    @@delivery_notification_observers.each do |observer|
+      observer.delivered_email(mail)
+    end
+  end
+
+  def self.inform_interceptors(mail)
+    @@delivery_interceptors.each do |interceptor|
+      interceptor.delivering_email(mail)
+    end
+  end
+
+  protected
+
+  def self.random_tag
+    t = Time.now
+    sprintf('%x%x_%x%x%d%x',
+            t.to_i, t.tv_usec,
+            $$, Thread.current.object_id.abs, self.uniq, rand(255))
+  end
+
+  private
+
+  def self.something_random
+    (Thread.current.object_id * rand(255) / Time.now.to_f).to_s.slice(-3..-1).to_i
+  end
+
+  def self.uniq
+    @@uniq += 1
+  end
+
+  @@uniq = self.something_random
+
+end

data/lib/mail/matchers/has_sent_mail.rb

@@ -0,0 +1,157 @@
+module Mail
+  module Matchers
+    def have_sent_email
+      HasSentEmailMatcher.new(self)
+    end
+
+    class HasSentEmailMatcher
+      def initialize(_context)
+      end
+
+      def matches?(subject)
+        matching_deliveries = filter_matched_deliveries(Mail::TestMailer.deliveries)
+        !(matching_deliveries.empty?)
+      end
+
+      def from(sender)
+        @sender = sender
+        self
+      end
+
+      def to(recipient_or_list)
+        @recipients ||= []
+
+        if recipient_or_list.kind_of?(Array)
+          @recipients += recipient_or_list
+        else
+          @recipients << recipient_or_list
+        end
+        self
+      end
+
+      def cc(recipient_or_list)
+        @copy_recipients ||= []
+
+        if recipient_or_list.kind_of?(Array)
+          @copy_recipients += recipient_or_list
+        else
+          @copy_recipients << recipient_or_list
+        end
+        self
+      end
+
+      def bcc(recipient_or_list)
+        @blind_copy_recipients ||= []
+
+        if recipient_or_list.kind_of?(Array)
+          @blind_copy_recipients += recipient_or_list
+        else
+          @blind_copy_recipients << recipient_or_list
+        end
+        self
+      end
+
+
+      def with_subject(subject)
+        @subject = subject
+        self
+      end
+
+      def matching_subject(subject_matcher)
+        @subject_matcher = subject_matcher
+        self
+      end
+
+      def with_body(body)
+        @body = body
+        self
+      end
+
+      def matching_body(body_matcher)
+        @body_matcher = body_matcher
+        self
+      end
+
+      def description
+        result = "send a matching email"
+        result
+      end
+
+      def failure_message
+        result = "Expected email to be sent "
+        result += explain_expectations
+        result += dump_deliveries
+        result
+      end
+
+      def negative_failure_message
+        result = "Expected no email to be sent "
+        result += explain_expectations
+        result += dump_deliveries
+        result
+      end
+
+      protected
+      
+      def filter_matched_deliveries(deliveries)
+        candidate_deliveries = deliveries
+
+        %w(sender recipients copy_recipients blind_copy_recipients subject subject_matcher body body_matcher).each do |modifier_name|
+          next unless instance_variable_defined?("@#{modifier_name}")
+          candidate_deliveries = candidate_deliveries.select{|matching_delivery| self.send("matches_on_#{modifier_name}?", matching_delivery)}
+        end
+
+        candidate_deliveries
+      end
+
+      def matches_on_sender?(delivery)
+        delivery.from.include?(@sender)
+      end
+
+      def matches_on_recipients?(delivery)
+        @recipients.all? {|recipient| delivery.to.include?(recipient) }
+      end
+
+      def matches_on_copy_recipients?(delivery)
+        @copy_recipients.all? {|recipient| delivery.cc.include?(recipient) }
+      end
+
+      def matches_on_blind_copy_recipients?(delivery)
+        @blind_copy_recipients.all? {|recipient| delivery.bcc.include?(recipient) }
+      end
+
+      def matches_on_subject?(delivery)
+        delivery.subject == @subject
+      end
+
+      def matches_on_subject_matcher?(delivery)
+        @subject_matcher.match delivery.subject
+      end
+
+      def matches_on_body?(delivery)
+        delivery.body == @body
+      end
+
+      def matches_on_body_matcher?(delivery)
+        @body_matcher.match delivery.body.raw_source
+      end
+
+      def explain_expectations
+        result = ''
+        result += "from #{@sender} " if instance_variable_defined?('@sender')
+        result += "to #{@recipients.inspect} " if instance_variable_defined?('@recipients')
+        result += "cc #{@copy_recipients.inspect} " if instance_variable_defined?('@copy_recipients')
+        result += "bcc #{@blind_copy_recipients.inspect} " if instance_variable_defined?('@blind_copy_recipients')
+        result += "with subject \"#{@subject}\" " if instance_variable_defined?('@subject')
+        result += "with subject matching \"#{@subject_matcher}\" " if instance_variable_defined?('@subject_matcher')
+        result += "with body \"#{@body}\" " if instance_variable_defined?('@body')
+        result += "with body matching \"#{@body_matcher}\" " if instance_variable_defined?('@body_matcher')
+        result
+      end
+
+      def dump_deliveries
+        "(actual deliveries: " + Mail::TestMailer.deliveries.inspect + ")"
+      end
+    end
+  end
+end