postageapp 1.2.5 → 1.4.0

data/doc/RAILS2.md

@@ -0,0 +1,54 @@
+# Rails 2.x
+
+These notes describe behavior specific to the Rails 2.x environment. Unless
+otherwise specified the approach in the main documentation applies.
+
+## Installation
+
+In `config/environment.rb` add the following:
+
+    config.gem 'postageapp'
+
+Then from the Rails project's root run:
+
+    rake gems:install
+    rake gems:unpack GEM=postageapp
+    script/generate postageapp --api-key PROJECT_API_KEY
+
+## Mailer Creation
+
+Here's an example of a mailer you'd set in in a Rails 2 environment:
+
+```ruby
+require 'postageapp/mailer'
+
+class Notifier < PostageApp::Mailer
+  def signup_notification
+    from 'system@example.com'
+    subject 'New Account Information'
+
+    # Recipients can be in any format API allows.
+    # Here's an example of a hash format
+    recipients(
+      'recipient_1@example.com' => {
+        'variable_name_1' => 'value',
+        'variable_name_2' => 'value'
+      },
+      'recipient_2@example.com' => {
+        'variable_name_1' => 'value',
+        'variable_name_2' => 'value'
+      },
+    )
+
+    attachment(
+      :content_type => 'application/zip',
+      :filename => 'example.zip',
+      :body => File.read('/path/to/example.zip'
+    )
+
+    # PostageApp specific elements:
+    postageapp_template 'example_template'
+    postageapp_variables 'global_variable' => 'value'
+  end
+end
+```

data/doc/RAILS3.md

@@ -0,0 +1,15 @@
+# Rails 3.x
+
+These notes describe behavior specific to the Rails 2.x environment. Unless
+otherwise specified the approach in the main documentation applies.
+
+## Installation
+
+Add the `postageapp` gem to your Gemfile:
+
+    gem 'postageapp'
+
+Then from the Rails project's root run:
+
+    bundle install
+    script/rails generate postageapp --api-key PROJECT_API_KEY

data/exe/postageapp

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.expand_path('../lib', __dir__)
+
+require 'postageapp'
+require 'postageapp/cli'
+
+exit_code = -1
+
+begin
+  if (ARGV.length > 0)
+    PostageApp::CLI.parse!(*ARGV)
+
+    exit(0)
+  end
+
+rescue PostageApp::CLI::Command::MissingArguments
+  exit(-20)
+rescue PostageApp::CLI::Command::APICallError
+  exit(-30)
+rescue PostageApp::CLI::UnknownCommand => e
+  $stderr.puts("Error: #{e}")
+  exit_code = -11
+end
+
+puts "usage: postageapp command [options]"
+puts
+puts "commands:"
+
+PostageApp::CLI::Command.defined.each do |command, _|
+  puts "  #{command}"
+end
+
+puts
+puts "* Documentation: https://dev.postageapp.com/api/"
+
+exit(exit_code)

data/generators/postageapp/templates/postageapp_tasks.rake

@@ -1,6 +1,6 @@
 namespace :postageapp do
   desc 'Show the current PostageApp configuration'
-  task :config => :environment do
+  task config: :environment do
     puts "PostageApp Configuration"
     puts "------------------------"
     puts
@@ -30,12 +30,29 @@ namespace :postageapp do
   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} ..."
+  task test: :environment do
+    diag = PostageApp::Diagnostics.new(PostageApp.config)
+
+    puts "Resolving #{PostageApp.config.host.inspect}"
+    if (resolved = diag.host_resolved)
+      puts "\t#{resolved.join(',')}"
+    else
+      puts "\tCouldn't be resolved. [ERROR]"
+    end
+
+    if (PostageApp.config.proxy?)
+      puts "Resolving #{PostageApp.config.proxy_host.inspect}"
+      if (resolved = diag.proxy_host_resolved)
+        puts "\t#{resolved.join(',')}"
+      else
+        puts "\tCouldn't be resolved. [ERROR]"
+      end
+    end
+
+    puts "Trying to contact #{PostageApp.configuration.url}..."
     response = PostageApp::Request.new(:get_project_info).send
     
-    if response.ok?
+    if (response.ok?)
       project_name = response.data['project']['name']
       project_url = response.data['project']['url']
       user_emails = response.data['project']['users']
@@ -52,7 +69,8 @@ END
       # Most likely a single user if it's a new project
       puts 'Sending test message to users in the project...'
       r = send_test_message(user_emails)
-      if r.ok?
+
+      if (r.ok?)
         puts "Message was successfully sent!\n\n"
         puts 'Your application is ready to use PostageApp!'
       else
@@ -60,7 +78,6 @@ END
         puts 'This was the response:'
         puts r.to_yaml
       end
-      
     else
       puts 'Failed to fetch information about your project. This was the response:'
       puts response.to_yaml
@@ -68,7 +85,7 @@ END
   end
   
   desc 'Manually trigger resend of all failed emails'
-  task :resend_failed_emails => :environment do
+  task resend_failed_emails: :environment do
     puts 'Attempting to resend failed emails...'
     PostageApp::FailedRequest.resend_all
     puts 'Done!'

data/lib/generators/postageapp/postageapp_generator.rb

@@ -10,18 +10,21 @@ class PostageappGenerator < Rails::Generators::Base
   def self.source_root
     @__source_root ||= File.expand_path(
       '../../../generators/postageapp/templates',
-      File.dirname(__FILE__)
+      __dir__
     )
   end
   
   def install
-    unless (options[:api_key])
-      puts 'Must pass --api-key with API key of your PostageApp.com project'
+    unless (PostageApp::Env.rails_with_encrypted_credentials?)
+      unless (options[:api_key])
+        puts 'Must pass --api-key with API key of your PostageApp.com project'
 
-      exit(-1)
+        exit(-1)
+      end
+      
+      template('initializer.rb', 'config/initializers/postageapp.rb')
     end
-    
-    template('initializer.rb', 'config/initializers/postageapp.rb')
+
     copy_file('postageapp_tasks.rake', 'lib/tasks/postageapp_tasks.rake')
 
     puts run('rake postageapp:test')

data/lib/postageapp.rb

@@ -2,66 +2,95 @@ require 'net/http'
 require 'net/https'
 require 'digest'
 require 'logger'
+require 'fileutils'
 
 require 'json'
 require 'base64'
 
-require 'postageapp/utils'
-require 'postageapp/version'
-require 'postageapp/configuration'
-require 'postageapp/logger'
-require 'postageapp/request'
-require 'postageapp/failed_request'
-require 'postageapp/response'
-require 'postageapp/mail'
-require 'postageapp/mail/delivery_method'
-
-require 'postageapp/rails/railtie' if (defined?(Rails::Railtie))
-
 module PostageApp
   class Error < StandardError ; end
-  
+
   # Call this method to modify your configuration
   # Example:
   #   PostageApp.configure do |config|
-  #     config.api_key             = '1234567890abcdef'
-  #     config.recipient_override  = 'test@test.test' if Rails.env.staging?
+  #     config.api_key = '1234567890abcdef'
+  #
+  #     if Rails.env.staging?
+  #       config.recipient_override = 'test@test.test'
+  #     end
   #   end
-  # 
+  #
   # If you do not want/need to initialize the gem in this way, you can use the environment
   # variable POSTAGEAPP_API_KEY to set up your key.
-  
-  def self.configure
-    yield(configuration)
+
+  VERSION = File.read(File.expand_path('../VERSION', __dir__)).gsub(/\s/, '')
+
+  def self.version
+    VERSION
   end
-  
+
+  def self.configure(reset: false)
+    if (reset)
+      self.config_reset!
+    end
+
+    yield(self.config)
+  end
+
   # Accessor for the PostageApp::Configuration object
   # Example use:
   #   PostageApp.configuration.api_key = '1234567890abcdef'
-  def self.configuration
-    @configuration ||= Configuration.new
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.config_reset!
+    @config = nil
   end
 
   class << self
-    alias :config :configuration
+    alias_method :configuration_reset!, :config_reset!
+    alias_method :configuration, :config
   end
-  
+
   # Logger for the plugin
   def self.logger
     @logger ||= begin
-      configuration.logger || PostageApp::Logger.new(
-        if (configuration.project_root)
-          FileUtils.mkdir_p(File.join(File.expand_path(configuration.project_root), 'log'))
-          File.join(configuration.project_root, "log/postageapp_#{configuration.environment}.log")
+      config.logger || PostageApp::Logger.new(
+        if (config.project_root)
+          FileUtils.mkdir_p(File.join(File.expand_path(config.project_root), 'log'))
+          File.join(config.project_root, "log/postageapp_#{config.environment}.log")
         else
-          STDOUT
+          $stdout
         end
       )
     end
   end
 end
 
-require 'postageapp/mail/extensions'
+require_relative './postageapp/env'
+
+if (PostageApp::Env.rails?)
+  require_relative './postageapp/engine'
+  # require 'postageapp/ingresses/postage_app'
+end
+
+require_relative './postageapp/configuration'
+require_relative './postageapp/diagnostics'
+require_relative './postageapp/failed_request'
+require_relative './postageapp/http'
+require_relative './postageapp/logger'
+require_relative './postageapp/request'
+require_relative './postageapp/response'
+require_relative './postageapp/mail'
+require_relative './postageapp/mail/delivery_method'
+require_relative './postageapp/utils'
+
+if (defined?(Rails::Railtie))
+  require_relative './postageapp/rails/railtie'
+end
+
+require_relative './postageapp/mail/extensions'
 
 if (defined?(::Mail))
   PostageApp::Mail::Extensions.install!

data/lib/postageapp/cli.rb

@@ -0,0 +1,14 @@
+module PostageApp::CLI
+  class UnknownCommand < StandardError
+  end
+
+  def self.parse!(command_name, *args)
+    if (command = PostageApp::CLI::Command.defined[command_name.to_sym])
+      command.parse!(*args)
+    else
+      raise UnknownCommand, "The command #{command_name.inspect} is not known."
+    end
+  end
+end
+
+require_relative './cli/command'

data/lib/postageapp/cli/command.rb

@@ -0,0 +1,110 @@
+require 'optparse'
+
+class PostageApp::CLI::Command
+  class APICallError < StandardError
+  end
+
+  class MissingArguments < StandardError
+  end
+
+  def self.defined
+    @defined ||= { }
+  end
+
+  def self.define(command_name = nil, &block)
+    command_name ||= $command_name
+    command = self.defined[command_name] = new(command_name)
+
+    command.instance_eval(&block) if (block_given?)
+  end
+
+  def initialize(command_name)
+    @command_name = command_name
+    @api_key_context = :project
+    @argument = { }
+  end
+
+  def api_key(context)
+    @api_key_context = context
+  end
+
+  def argument(name, optional: false, type: String, desc: nil, boolean: false)
+    @argument[name] = {
+      optional: optional,
+      type: String,
+      desc: desc,
+      boolean: boolean
+    }
+  end
+
+  def perform(&block)
+    @perform = block
+  end
+
+  def parse!(*args)
+    arguments = { }
+
+    op = OptionParser.new do |parser|
+      parser.banner = "Usage: postageapp #{@command_name} [options]"
+
+      @argument.each do |name, attributes|
+        if (attributes[:boolean])
+          parser.on("--#{name}", attributes[:desc]) do
+            arguments[name] = true
+          end
+        else
+          parser.on("--#{name} VALUE", "#{attributes[:desc]} (#{attributes[:optional] ? 'optional' : 'required'})") do |v|
+            arguments[name] = v
+          end
+        end
+      end
+    end
+    
+    op.parse!(args)
+
+    missing = @argument.select do |name, attributes|
+      !attributes[:optional] && arguments[name].nil?
+    end.keys
+
+    if (missing.any?)
+      $stderr.puts("Error: missing options #{missing.join(', ')}")
+
+      puts op.help
+
+      raise MissingArguments
+    end
+
+    case (@api_key_context)
+    when :account
+      arguments['api_key'] = PostageApp.configuration.account_api_key
+    end
+
+    case (@perform&.arity)
+    when 1
+      return @perform.call(arguments)
+    when 0
+      return @perform.call
+    end
+
+    response = PostageApp::Request.new(@command_name, arguments).send
+
+    case (response.status)
+    when "ok"
+      puts JSON.pretty_generate(response.data)
+    else
+      $stderr.puts("Received error: #{response.status}")
+
+      if (response.message)
+        $stderr.puts('  ' + response.message)
+      end
+
+      raise APICallError
+    end
+  end
+end
+
+Dir.glob(File.expand_path('./command/*.rb', __dir__)) do |command|
+  $command_name = File.basename(command, '.rb').to_sym
+
+  require command
+end