postageapp 1.2.0 → 1.2.5

data/lib/postageapp/mailer/mailer_4.rb

@@ -18,13 +18,15 @@
 #
 # Postage::Mailer introduces a few mailer methods specific to Postage:
 #
-# * postageapp_template  - template name that is defined in your PostageApp project
+# * postageapp_template - template name that is defined in your PostageApp project
 # * postageapp_variables - extra variables you want to send along with the message
 #
 # Sending email
 #
-#   request = Notifier.signup_notification(user) # creates PostageApp::Request object
-#   response = request.deliver # attempts to deliver the message and creates a PostageApp::Response
+#   # Create a PostageApp::Request object
+#   request = Notifier.signup_notification(user) 
+#   # Deliver the message and return a PostageApp::Response
+#   response = request.deliver_now
 
 class PostageApp::Mailer < ActionMailer::Base
   CONTENT_TYPE_MAP = {
@@ -128,9 +130,6 @@ class PostageApp::Mailer < ActionMailer::Base
     @_mail_was_called = true
     m = @_message
 
-    # At the beginning, do not consider class default for parts order neither content_type
-    content_type = headers[:content_type]
-
     # Call all the procs (if any)
     class_default = self.class.default
     default_values = class_default.merge(self.class.default) do |k,v|
@@ -140,9 +139,6 @@ class PostageApp::Mailer < ActionMailer::Base
     # Handle defaults
     headers = headers.reverse_merge(default_values)
 
-    # Apply charset at the beginning so all fields are properly quoted
-    charset = headers[:charset]
-
     # Set configure delivery behavior
     wrap_delivery_behavior!(
       headers.delete(:delivery_method),
@@ -201,7 +197,7 @@ class PostageApp::Request
 
   # Either doing an actual send, or passing it along to Mail::TestMailer
   # Probably not the best way as we're skipping way too many intermediate methods
-  def deliver
+  def deliver_now
     inform_interceptors
 
     if (perform_deliveries)
@@ -212,6 +208,7 @@ class PostageApp::Request
       end
     end
   end
+  alias_method :deliver, :deliver_now
 
   # Not 100% on this, but I need to assign this so I can properly handle deliver method
   def delivery_method(method = nil, settings = nil)

data/lib/postageapp/request.rb

@@ -7,12 +7,12 @@ class PostageApp::Request
   }
   
   # Unique ID (UID) for the request
-  attr_accessor :uid
+  attr_writer :uid
   
   # The API method being called (example: send_message)
   # This controls the url of the request (example: https://api.postageapp.com/v.1.0/send_message.json)
   attr_accessor :method
-  
+
   # A list of arguments in a Hash format passed along with the request
   attr_accessor :arguments
   
@@ -30,9 +30,9 @@ class PostageApp::Request
   end
   
   # Creates a new Request with the given API call method and arguments.
-  def initialize(method, arguments = { })
+  def initialize(method, arguments = nil)
     @method = method
-    @arguments = arguments.dup
+    @arguments = arguments ? arguments.dup : { }
 
     @uid = @arguments.delete('uid')
     @api_key = @arguments.delete('api_key') || PostageApp.configuration.api_key
@@ -110,18 +110,131 @@ class PostageApp::Request
     hash
   end
 
-  # Emulation of Mail::Message interface
-  def body
-    self.arguments and self.arguments['content'] and (self.arguments['content']['text/html'] or self.arguments['content']['text/plain'])
+  def content
+    self.arguments['content'] ||= { }
   end
 
-  # Emulates Mail::Message#html_part
+  # -- Mail::Message Emulation ----------------------------------------------
+
   def html_part
-    self.arguments and self.arguments['content'] and self.arguments['content']['text/html']
+    self.content['text/html']
   end
   
-  # Emulates Mail::Message#text_part
   def text_part
-    self.arguments and self.arguments['content'] and self.arguments['content']['text/plain']
+    self.content['text/plain']
+  end
+
+  def find_first_mime_type(type)
+    self.content[type]
+  end
+
+  def mime_type
+    self.content.keys.first
+  end
+
+  def header
+    self.arguments['headers'] ||= { }
+  end
+
+  def reply_to
+    self.header['reply-to']
+  end
+
+  def cc
+    self.header['cc']
+  end
+
+  def attachments
+    self.arguments['attachments']
+  end
+
+  def multipart?
+    self.content.keys.length > 1
+  end
+
+  # Getter and setter for headers. You can specify headers in the following
+  # formats:
+  #   headers['Custom-Header'] = 'Custom Value'
+  #   headers 'Custom-Header-1' => 'Custom Value 1',
+  #           'Custom-Header-2' => 'Custom Value 2'
+  def headers(value = nil)
+    _headers = self.arguments['headers'] ||= { }
+
+    case (value)
+    when Hash
+      value.each do |k, v|
+        _headers[k.to_s] = v.to_s
+      end
+    end
+
+    _headers
+  end
+
+  def [](key)
+    case (key)
+    when :to, 'to'
+      self.to
+    when :from, 'from'
+      self.from
+    when :bcc, 'bcc'
+      # Not supported via API at this time
+      [ ]
+    end
+  end
+
+  def to
+    out = self.arguments_to_send.dig('arguments', 'recipients')
+
+    case (out)
+    when Hash
+      out
+    else
+      [ out ].flatten
+    end
+  end
+
+  def to=(list)
+    self.arguments['recipients'] = list
+  end
+
+  def from
+    [ self.arguments_to_send.dig('arguments', 'headers', 'from') ].flatten
+  end
+
+  def from=(address)
+    _headers = self.arguments['headers'] ||= { }
+
+    _headers['from'] = address.to_s
+  end
+
+  def bcc
+    # Not supported natively via API at this time
+    [ ]
+  end
+
+  def bcc=(list)
+    # Not supported natively via API at this time
+  end
+
+  def subject
+    self.arguments_to_send.dig('arguments', 'headers', 'subject')
+  end
+
+  def subject=(subject)
+    _headers = self.arguments['headers'] ||= { }
+
+    _headers['subject'] = subject.to_s
+  end
+
+  # # Emulation of Mail::Message interface
+  # def body
+  #   _content = self.arguments && self.arguments['content']
+
+  #   _content and (_content['text/html'] or _content['text/plain'])
+  # end
+
+  def body
+    out = self.arguments_to_send.dig('arguments', 'content')
+    out.is_a?(Hash) ? out.values.join("\n\n") : out.to_s
   end
 end

data/lib/postageapp/response.rb

@@ -13,6 +13,8 @@ class PostageApp::Response
   # The data payload of the response. This is usually the return value of the
   # request we're looking for
   attr_reader :data
+
+  attr_reader :exception
   
   # Takes in Net::HTTPResponse object as the attribute.
   # If something goes wrong Response will be thought of as failed
@@ -27,8 +29,9 @@ class PostageApp::Response
 
     @data = hash['data']
 
-  rescue
+  rescue => e
     @status = 'fail'
+    @exception = '[%s] %s' % [ e.class, e ]
   end
   
   # Little helper that checks for the Response status

data/lib/postageapp/utils.rb

@@ -1,37 +1,42 @@
 class Hash
-  # Example usage:
-  #   @hash.dig(:k1)          # same as @hash[:k1]
-  #   @hash.dig(:k1, :k2)     # same as @hash[:k1] && @hash[:k1][:k2]
-  #   @hash.dig(:k1, :k2, k3) # same as @hash[:k1] && @hash[:k1][:k2] && @hash[:k1][:k2][:k3]
-  def dig(*path)
-    path.inject(self) do |location, key|
-      location.respond_to?(:keys) ? location[key] : nil
+  # Ruby 2.3.0 adds the dig method so this needs to be conditional.
+  unless ((instance_methods & [ :dig ]).any?)
+    # Example usage:
+    #   @hash.dig(:k1)          # same as @hash[:k1]
+    #   @hash.dig(:k1, :k2)     # same as @hash[:k1] && @hash[:k1][:k2]
+    #   @hash.dig(:k1, :k2, k3) # same as @hash[:k1] && @hash[:k1][:k2] && @hash[:k1][:k2][:k3]
+    def dig(*path)
+      path.inject(self) do |location, key|
+        location.respond_to?(:keys) ? location[key] : nil
+      end
     end
   end
   
-  # Destructively convert all keys to strings.
-  def recursive_stringify_keys!
-    keys.each do |key|
-      value = delete(key)
+  unless ((instance_methods & [ :recursive_stringify_keys! ]).any?)
+    # Destructively convert all keys to strings.
+    def recursive_stringify_keys!
+      keys.each do |key|
+        value = delete(key)
 
-      self[key.to_s] =
-        case (value)
-        when Hash
-          value.recursive_stringify_keys!
-        else
-          value
-        end
-    end
+        self[key.to_s] =
+          case (value)
+          when Hash
+            value.recursive_stringify_keys!
+          else
+            value
+          end
+      end
 
-    self
+      self
+    end
   end
 end
 
 class Net::HTTP
   # Getting rid of the 'warning: peer certificate won't be verified in this SSL session'
-  alias_method :old_initialize, :initialize
+  alias_method :__initialize, :initialize
   def initialize(*args)
-    old_initialize(*args)
+    __initialize(*args)
 
     @ssl_context = OpenSSL::SSL::SSLContext.new
     @ssl_context.verify_mode = OpenSSL::SSL::VERIFY_NONE

data/lib/postageapp/version.rb

@@ -1,3 +1,3 @@
 module PostageApp
-  VERSION = "1.2.0"
+  VERSION = '1.2.5'.freeze
 end

data/postageapp.gemspec

@@ -1,16 +1,25 @@
 # encoding: utf-8
 
-$:.unshift File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
 require 'postageapp/version'
 
 Gem::Specification.new do |s|
   s.name = "postageapp"
   s.version = PostageApp::VERSION
-  s.authors = [ "Oleg Khabarov", "Scott Tadman", "The Working Group Inc." ]
-  s.email = [ "oleg@khabarov.ca", "tadman@postageapp.com" ]
+  s.authors = [
+    "Oleg Khabarov",
+    "Scott Tadman",
+    "The Working Group Inc."
+  ]
+  s.email = [
+    "oleg@khabarov.ca",
+    "tadman@postageapp.com"
+  ]
+
   s.homepage = "http://github.com/postageapp/postageapp-ruby"
-  s.summary = "Easier way to send email from web apps"
-  s.description = "Gem that interfaces with PostageApp.com service to send emails from web apps"
+
+  s.summary = "Gem for communicating with the PostageApp email API"
+  s.description = "Gem that interfaces with PostageApp service to send emails from Ruby applications"
   s.license = 'MIT'
   
   s.files = `git ls-files`.split("\n")
@@ -20,4 +29,5 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 1.9.3'
   
   s.add_dependency 'json'
+  s.add_dependency 'mail'
 end

data/script/with

@@ -0,0 +1,116 @@
+#!/usr/bin/env ruby
+
+# This script can be used to engage a particular Gemfile for the purposes of
+# continuous integration testing.
+#
+# Usage: script/with <variant> <env|bootstrap|bundle|rake>
+#
+# Here <variant> refers to a pre-defined Gemfile located in test/gemfiles
+# and the commands include:
+#
+#  * env - Display the current BUNDLE_GEMFILE environment
+#  * bootstrap - Install the necessary hard dependencies (rubygems, bundler)
+#  * bundle - Execute arbitrary Bundler command
+#  * rake - Execute arbitrary rake command via `bundle exec`
+#
+# Examples:
+#  * script/with rails-3.0.x bootstrap
+#  * script/with rails-3.0.x bundle install
+#  * script/with rails-3.0.x rake test
+
+# == Constants ==============================================================
+
+GEMFILE_DIR = File.expand_path('../test/gemfiles', File.dirname(__FILE__))
+GEMFILE_ROOT = File.expand_path('../Gemfile', File.dirname(__FILE__))
+
+# == Support Methods ========================================================
+
+def dependencies(gemfile)
+  dependencies = { }
+
+  File.open(gemfile) do |f|
+    f.each do |line|
+      if (line.match(/\Agem\s+['"]bundler['"]\s*,\s*['"]([^'"]+)['"]/))
+        dependencies[:bundler] = $1
+      elsif (line.match(/\A\#\s*rubygems\s+(\S+)/))
+        dependencies[:rubygems] = $1
+      end
+    end
+  end
+
+  dependencies
+end
+
+def gemfile_list
+  Dir.entries(GEMFILE_DIR).reject do |name|
+    name[/\A\./] or name[/\.lock\z/]
+  end.collect do |name|
+    name.sub(/\AGemfile\./, '')
+  end
+end
+
+def with_variant(variant, &block)
+  case (variant)
+  when 'current'
+    if (ENV['BUNDLE_GEMFILE'])
+      yield(dependencies(ENV['BUNDLE_GEMFILE']))
+    else
+      yield(dependencies(GEMFILE_ROOT))
+    end
+  when 'each', 'all'
+    gemfile_list.each do |_variant|
+      with_variant(_variant, &block)
+    end
+  else
+    ENV['BUNDLE_GEMFILE'] = File.expand_path('Gemfile.%s' % variant, GEMFILE_DIR)
+
+    yield(dependencies(ENV['BUNDLE_GEMFILE']))
+  end
+end
+
+def shell(*args)
+  if (ENV['WITH_VERBOSE'])
+    puts args.join(' ')
+  end
+
+  unless (system(*args))
+    exit($?)
+  end
+end
+
+# == Main ===================================================================
+
+variant = ARGV[0]
+
+unless (variant)
+  puts "Usage: with <gemspec variant> <env|bootstrap|bundle|rake> ..."
+
+
+  puts
+  puts "Available variants:"
+  gemfile_list.each do |name|
+    puts name
+  end
+
+  exit(-1)
+end
+
+with_variant(variant) do |dependencies|
+  bundle_version_args = dependencies[:bundler] ? [ '_%s_' % dependencies[:bundler] ] : [ ]
+
+  case (ARGV[1])
+  when 'env'
+    puts 'BUNDLE_GEMFILE=%s' % ENV['BUNDLE_GEMFILE']
+  when 'bootstrap'
+    if (dependencies[:rubygems])
+      shell('gem', 'update', '--system', dependencies[:rubygems])
+    end
+    if (dependencies[:bundler])
+      shell('gem', 'install', 'bundler', '-v', dependencies[:bundler])
+    end
+  when 'bundle'
+    shell("bundle", *bundle_version_args, *ARGV.to_a[2, ARGV.length])
+  when 'rake'
+    shell("bundle", *bundle_version_args, "exec", "rake", *ARGV.to_a[2, ARGV.length])
+  end
+end