postageapp 1.2.0 → 1.2.5

data/.gitignore

@@ -7,3 +7,4 @@ test/log
 test/gemfiles/*.lock
 Gemfile.lock
 .ruby-version
+*.gem

data/.travis.yml

@@ -1,10 +1,13 @@
 language: ruby
-before_install: gem install bundler
+before_install: "WITH_VERBOSE=1 script/with current bootstrap"
+install: "WITH_VERBOSE=1 script/with current bundle install"
+script: "WITH_VERBOSE=1 script/with current bundle exec rake test"
 rvm:
   - 1.9.3-p551
   - 2.0.0-p598
   - 2.1.5
   - 2.2.0
+  - 2.3.0
 gemfile:
   - test/gemfiles/Gemfile.ruby
   - test/gemfiles/Gemfile.rails-2.3.x
@@ -22,3 +25,13 @@ matrix:
       gemfile: test/gemfiles/Gemfile.rails-2.3.x
     - rvm: 2.2.0
       gemfile: test/gemfiles/Gemfile.rails-2.3.x
+    - rvm: 2.3.0
+      gemfile: test/gemfiles/Gemfile.rails-2.3.x
+    - rvm: 1.9.3-p551
+      gemfile: test/gemfiles/Gemfile.rails-2.3.x
+    - rvm: 1.9.3-p551
+      gemfile: test/gemfiles/Gemfile.rails-4.0.x
+    - rvm: 1.9.3-p551
+      gemfile: test/gemfiles/Gemfile.rails-4.1.x
+    - rvm: 1.9.3-p551
+      gemfile: test/gemfiles/Gemfile.rails-4.2.x

data/README.md

@@ -274,4 +274,4 @@ end
 
 # Copyright
 
-(C) 2011-2015 Scott Tadman, Oleg Khabarov, [The Working Group, Inc](http://www.twg.ca/)
+(C) 2011-2016 Scott Tadman, Oleg Khabarov, [PostageApp](http://www.postageapp.com/)

data/generators/postageapp/postageapp_generator.rb

@@ -21,11 +21,11 @@ class PostageappGenerator < Rails::Generator::Base
     
     record do |m|
       m.template 'initializer.rb', 'config/initializers/postageapp.rb', 
-        :assigns => { :api_key => options[:api_key] },
-        :collision => :force
+        assigns: { api_key: options[:api_key] },
+        collision: :force
       m.directory 'lib/tasks'
       m.file 'postageapp_tasks.rake', 'lib/tasks/postageapp_tasks.rake',
-        :collision => :force
+        collision: :force
       m.rake 'postageapp:test'
     end
   end

data/generators/postageapp/templates/postageapp_tasks.rake

@@ -1,23 +1,52 @@
 namespace :postageapp do
-  
-  desc 'Verify postageapp gem installation by requesting project info from PostageApp.com'
+  desc 'Show the current PostageApp configuration'
+  task :config => :environment do
+    puts "PostageApp Configuration"
+    puts "------------------------"
+    puts
+
+    config = PostageApp.config
+
+    puts "API Key: %s" % config.api_key
+    puts "API Endpoint: %s" % config.url
+    puts "Secure: %s" % [ config.secure? ? 'Yes' : 'No' ]
+
+    if (config.proxy_host)
+      puts "SOCKS5 Proxy: %s:%d" % [ config.proxy_host, config.proxy_port ]
+
+      if (config.proxy_user)
+        puts "SOCKS5 Auth: %s / %s" % [ config.proxy_user, config.proxy_pass ]
+      end
+    end
+
+    puts "Open Timeout: %d seconds" % [ config.http_open_timeout ]
+    puts "Read Timeout: %d seconds" % [ config.http_read_timeout ]
+
+    if (config.recipient_override)
+      puts "Recipient Override: %s" % [ config.recipient_override ]
+    end
+
+    puts "Environment: %s" % [ config.environment ]
+  end
+
+  desc 'Verify the PostageApp gem installation by requesting project info from the API'
   task :test => :environment do 
     
     puts "Attempting to contact #{PostageApp.configuration.host} ..."
     response = PostageApp::Request.new(:get_project_info).send
     
     if response.ok?
-      project_name  = response.data['project']['name']
-      project_url   = response.data['project']['url']
-      user_emails   = response.data['project']['users']
+      project_name = response.data['project']['name']
+      project_url = response.data['project']['url']
+      user_emails = response.data['project']['users']
       
-      puts %{
+      puts <<END
   Found Project:
   ----------------------------
    Name:  #{ project_name }
     URL:  #{ project_url }
   Users:  #{ user_emails.keys.join(', ') }
-      }
+END
         
       # Sending test email to all users in the project
       # Most likely a single user if it's a new project
@@ -47,15 +76,15 @@ namespace :postageapp do
   
 end
 
-HTML_MESSAGE = %{
+HTML_MESSAGE = <<END
 <h3> Hello {{name}}, </h3>
-<p> This is a html message generated by Postage plugin. </p>
-<p> If you received this message it means that your application is properly configured and is ready to use PostageApp service. </p>
-<p> Thank you, </p>
-<p> The PostageApp Team </p>
-}
+<p>This is a html message generated by Postage plugin.</p>
+<p>If you received this message it means that your application is properly configured and is ready to use PostageApp service.</p>
+<p>Thank you,</p>
+<p>The PostageApp Team</p>
+END
 
-TEXT_MESSAGE = %{
+TEXT_MESSAGE = <<END
 Hello {{name}}
 
 This is a plain text message generated by Postage plugin.
@@ -63,23 +92,27 @@ If you received this message it means that your application is properly configur
 
 Thank you,
 The PostageApp Team
-}
+END
 
 def send_test_message(recipients)
-  recipients_with_variables = {}
+  recipients_with_variables = { }
+
   recipients.each do |email, name|
-    recipients_with_variables[email] = { 'name' => name }
+    recipients_with_variables[email] = {
+      'name' => name
+    }
   end
   
-  PostageApp::Request.new(:send_message,
-    :message => {
-      'text/html'  => HTML_MESSAGE,
+  PostageApp::Request.new(
+    :send_message,
+    message: {
+      'text/html' => HTML_MESSAGE,
       'text/plain' => TEXT_MESSAGE
     },
-    :recipients => recipients_with_variables,
-    :headers    => {
+    recipients: recipients_with_variables,
+    headers: {
       'Subject' => '[PostageApp] Test Message',
-      'From'    => 'no-return@postageapp.com'
+      'From' => 'no-return@postageapp.com'
     }
   ).send
-end
+end

data/lib/generators/postageapp/postageapp_generator.rb

@@ -3,14 +3,14 @@ require 'rails/generators'
 # Rails 3 Generator
 class PostageappGenerator < Rails::Generators::Base
   class_option :api_key,
-    :aliases => [ '-k=value', '--api-key=value' ],
-    :type => :string,
-    :desc => 'Your PostageApp API key'
+    aliases: [ '-k=value', '--api-key=value' ],
+    type: :string,
+    desc: 'Your PostageApp API key'
   
   def self.source_root
-    @_hoptoad_source_root ||= File.expand_path(
-      '../../../../generators/postageapp/templates',
-      __FILE__
+    @__source_root ||= File.expand_path(
+      '../../../generators/postageapp/templates',
+      File.dirname(__FILE__)
     )
   end
   

data/lib/postageapp.rb

@@ -63,4 +63,6 @@ end
 
 require 'postageapp/mail/extensions'
 
-PostageApp::Mail::Extensions.install!
+if (defined?(::Mail))
+  PostageApp::Mail::Extensions.install!
+end

data/lib/postageapp/configuration.rb

@@ -1,64 +1,76 @@
+# PostageApp::Configuration is used to retrieve and manipulate the options
+# used to connect to the API. There are a number of options which can be set.
+# The recommended method for doing this is via the initializer file that's
+# generated upon installation: config/initializers/postageapp.rb
+
+# Basic Options
+# -------------
+# :api_key - The API key used to send requests, can also be set via the
+#            POSTAGEAPP_API_KEY environment variable. (required)
+# :secure - true for HTTPS, false for HTTP connections (default: true)
+# :recipient_override - Email address to send all email to regardless of
+#                       specified recipients. Used for testing.
+
+# Non-Rails Options
+# -----------------
+# :project_root - The base path of the project, used to determine where to
+#                 save log files and failed API calls.
+# :framework - A string identifier for the framework being used. Shows up in
+#              the User-Agent identifier of requests.
+# :environment - The operational mode of the application, typically either
+#                'production' or 'development' but any string value is allowed.
+#                (default: 'production')
+# :logger - Used to assign a specific logger.
+
+# Network Options
+# ---------------
+# :host - The API host to connect to (default: 'api.postageapp.com')
+# :http_open_timeout - HTTP open timeout in seconds (default: 2)
+# :http_read_timeout - Read timeout in seconds (default: 5)
+
+# Proxy Options
+# -------------
+# :proxy_host - Proxy server hostname
+# :proxy_port - Proxy server port
+# :proxy_user - Proxy server username
+# :proxy_pass - Proxy server password
+
+# Advanced Options
+# ----------------
+# :port - The port to make HTTP/HTTPS requests (default based on secure option)
+# :protocol - Set to either `http` or `https` (default based on secure option)
+# :requests_to_resend - List of API calls that should be replayed if they fail.
+#                       (default: send_message)
+
 class PostageApp::Configuration
-  # +true+ for https, +false+ for http connections (default: is +true+)
   attr_accessor :secure
-  
-  # The protocol used to connect to the service (default: 'https' for secure 
-  # and 'http' for insecure connections)
-  attr_accessor :protocol
-  
-  # The host to connect to (default: 'api.postageapp.com')
+  attr_writer :protocol
   attr_accessor :host
-  
-  # The port on which PostageApp service runs (default: 443 for secure, 80 for 
-  # insecure connections)
   attr_writer :port
-  
-  # The hostname of the proxy server (if using a proxy)
   attr_accessor :proxy_host
-  
-  # The port of the proxy server (if using proxy)
   attr_accessor :proxy_port
-  
-  # The username for the proxy server (if using proxy)
   attr_accessor :proxy_user
-  
-  # The password for the proxy server (if using proxy)
   attr_accessor :proxy_pass
-  
-  # The HTTP open timeout in seconds (defaults to 2).
   attr_accessor :http_open_timeout
-  
-  # The HTTP read timeout in seconds (defaults to 5).
   attr_accessor :http_read_timeout
-  
-  # The email address that all send_message method should address
-  # all messages while overriding original addresses
   attr_accessor :recipient_override
-  
-  # A list of API method names payloads of which are captured and resent
-  # in case of service unavailability
   attr_accessor :requests_to_resend
-  
-  # The file path of the project. This is where logs and failed requests
-  # can be stored
   attr_accessor :project_root
-  
-  # The framework PostageApp gem runs in
   attr_accessor :framework
-  
-  # Environment gem is running in
   attr_accessor :environment
-  
-  # The logger used by this gem
   attr_accessor :logger
   
   def initialize
     @secure = true
     @host = 'api.postageapp.com'
+
     @http_open_timeout = 5
     @http_read_timeout = 10
-    @requests_to_resend = %w( send_message )
-    @framework = 'undefined framework'
+
+    @requests_to_resend = %w[ send_message ]
+
+    @framework = 'Ruby'
+
     @environment = 'production'
   end
   
@@ -91,7 +103,7 @@ class PostageApp::Configuration
     "#{self.protocol}://#{self.host}:#{self.port}"
   end
 
-  # Returns a properly config
+  # Returns a properly configured Net::HTTP connection
   def http
     http = Net::HTTP::Proxy(
       self.proxy_host,

data/lib/postageapp/failed_request.rb

@@ -5,7 +5,7 @@ module PostageApp::FailedRequest
     return false unless (self.store_path) 
     return false unless (PostageApp.configuration.requests_to_resend.member?(request.method.to_s))
     
-    unless (File.exists?(file_path(request.uid)))
+    unless (File.exist?(file_path(request.uid)))
       open(file_path(request.uid), 'wb') do |f|
         f.write(Marshal.dump(request))
       end
@@ -34,7 +34,7 @@ module PostageApp::FailedRequest
       
       receipt_response = PostageApp::Request.new(
         :get_message_receipt,
-        :uid => filename
+        uid: filename
       ).send(true)
 
       if (receipt_response.fail?)
@@ -67,7 +67,7 @@ module PostageApp::FailedRequest
   # Initializing PostageApp::Request object from the file
   def self.initialize_request(uid)
     return false unless (self.store_path)
-    return false unless (File.exists?(file_path(uid)))
+    return false unless (File.exist?(file_path(uid)))
 
     Marshal.load(File.read(file_path(uid))) 
 
@@ -86,7 +86,7 @@ protected
       'tmp/postageapp_failed_requests'
     )
     
-    unless (File.exists?(dir))
+    unless (File.exist?(dir))
       FileUtils.mkdir_p(dir)
     end
     

data/lib/postageapp/mailer.rb

@@ -11,94 +11,11 @@ if (defined?(ActionMailer))
   # currently installed on the system. Assuming we're dealing only with
   # ones that come with Rails 2 and 3
   case (ActionMailer::VERSION::MAJOR)
-  when 4
-    require File.expand_path('mailer/mailer_4', File.dirname(__FILE__))
   when 3
     require File.expand_path('mailer/mailer_3', File.dirname(__FILE__))
-  else
+  when 2
     require File.expand_path('mailer/mailer_2', File.dirname(__FILE__))
-  end
-end
-
-# General helper methods for Request object to act more like TMail::Mail
-# of Mail for testing
-class PostageApp::Request
-  # 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
-
-  def body
-    out = self.arguments_to_send.dig('arguments', 'content')
-    out.is_a?(Hash) ? out.values.join("\n\n") : out.to_s
+  else
+    require File.expand_path('mailer/mailer_4', File.dirname(__FILE__))
   end
 end