aws-ses-v4 0.8.1

data/Rakefile

@@ -0,0 +1,83 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'erb'
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+# require 'rcov/rcovtask'
+# Rcov::RcovTask.new do |test|
+#   test.libs << 'test'
+#   test.pattern = 'test/**/*_test.rb'
+#   test.verbose = true
+# end
+
+task :default => :test
+
+require 'rdoc/task'
+require File.dirname(__FILE__) + '/lib/aws/ses'
+
+namespace :doc do
+  Rake::RDocTask.new do |rdoc|  
+    rdoc.rdoc_dir = 'doc'  
+    version = File.exist?('VERSION') ? File.read('VERSION') : ""
+    rdoc.title    = "AWS::SES -- Support for Amazon SES's REST api #{version}"  
+    rdoc.options << '--line-numbers' << '--inline-source'
+    rdoc.rdoc_files.include('README.rdoc')
+    rdoc.rdoc_files.include('LICENSE')
+    rdoc.rdoc_files.include('CHANGELOG')
+    rdoc.rdoc_files.include('TODO')
+    rdoc.rdoc_files.include('VERSION')
+    rdoc.rdoc_files.include('lib/**/*.rb')
+  end
+  
+  task :rdoc => 'doc:readme'
+  
+  task :refresh => :rerdoc do
+    system 'open doc/index.html'
+  end
+
+  desc "Generate readme.rdoc from readme.erb"
+  task :readme do
+    require 'support/rdoc/code_info'
+    RDoc::CodeInfo.parse('lib/**/*.rb')
+    
+    strip_comments = lambda {|comment| comment.gsub(/^# ?/, '')}
+    docs_for       = lambda do |location| 
+      info = RDoc::CodeInfo.for(location)
+      raise RuntimeError, "Couldn't find documentation for `#{location}'" unless info
+      strip_comments[info.comment]
+    end
+    
+    open('README.rdoc', 'w') do |file|
+      file.write ERB.new(IO.read('README.erb')).result(binding)
+    end
+  end
+end
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "aws-ses"
+  gem.homepage = "http://github.com/drewblas/aws-ses"
+  gem.license = "MIT"
+  gem.summary = "Client library for Amazon's Simple Email Service's REST API"
+  gem.description = "Client library for Amazon's Simple Email Service's REST API"
+  gem.email = "drew.blas@gmail.com"
+  gem.authors = ["Drew Blas", "Marcel Molina Jr."]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new

data/TODO

@@ -0,0 +1,3 @@
+* Use a better XML parser (and be consistent)
+* Rename Base to something else (probably Mailer):  Nothing else actually inherits from Base, so that is a very poor naming convention.  I intend to change it in the future
+* Integer responses should probably be cast to ints instead of left as strings

data/VERSION

@@ -0,0 +1 @@
+0.8.1

data/aws-ses.gemspec

@@ -0,0 +1,102 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: aws-ses 0.7.1 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "aws-ses-v4".freeze
+  s.version = "0.8.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Drew Blas".freeze, "Marcel Molina Jr.".freeze]
+  s.date = "2021-04-10"
+  s.description = "Client library for Amazon's Simple Email Service's REST API".freeze
+  s.email = "drew.blas@gmail.com".freeze
+  s.extra_rdoc_files = [
+    "CHANGELOG",
+    "LICENSE",
+    "README.erb",
+    "README.rdoc",
+    "TODO"
+  ]
+  s.files = [
+    ".document",
+    "CHANGELOG",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.erb",
+    "README.rdoc",
+    "Rakefile",
+    "TODO",
+    "VERSION",
+    "aws-ses.gemspec",
+    "lib/aws/actionmailer/ses_extension.rb",
+    "lib/aws/ses.rb",
+    "lib/aws/ses/addresses.rb",
+    "lib/aws/ses/base.rb",
+    "lib/aws/ses/extensions.rb",
+    "lib/aws/ses/info.rb",
+    "lib/aws/ses/response.rb",
+    "lib/aws/ses/send_email.rb",
+    "lib/aws/ses/version.rb",
+    "test/address_test.rb",
+    "test/base_test.rb",
+    "test/extensions_test.rb",
+    "test/fixtures.rb",
+    "test/helper.rb",
+    "test/info_test.rb",
+    "test/mocks/fake_response.rb",
+    "test/response_test.rb",
+    "test/send_email_test.rb"
+  ]
+  s.homepage = "http://github.com/sertangulveren/aws-ses".freeze
+  s.licenses = ["MIT".freeze]
+  s.rubygems_version = "2.5.2.3".freeze
+  s.summary = "Client library for Amazon's Simple Email Service's REST API".freeze
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<builder>.freeze, [">= 0"])
+      s.add_runtime_dependency(%q<mail>.freeze, ["> 2.2.5"])
+      s.add_runtime_dependency(%q<mime-types>.freeze, [">= 0"])
+      s.add_runtime_dependency(%q<xml-simple>.freeze, [">= 0"])
+      s.add_development_dependency(%q<bundler>.freeze, [">= 1.17"])
+      s.add_development_dependency(%q<flexmock>.freeze, ["~> 0.8.11"])
+      s.add_development_dependency(%q<jeweler>.freeze, [">= 0"])
+      s.add_development_dependency(%q<rake>.freeze, [">= 0"])
+      s.add_development_dependency(%q<shoulda-context>.freeze, [">= 0"])
+      s.add_development_dependency(%q<test-unit>.freeze, [">= 0"])
+      s.add_development_dependency(%q<timecop>.freeze, [">= 0"])
+    else
+      s.add_dependency(%q<builder>.freeze, [">= 0"])
+      s.add_dependency(%q<mail>.freeze, ["> 2.2.5"])
+      s.add_dependency(%q<mime-types>.freeze, [">= 0"])
+      s.add_dependency(%q<xml-simple>.freeze, [">= 0"])
+      s.add_dependency(%q<bundler>.freeze, [">= 1.17"])
+      s.add_dependency(%q<flexmock>.freeze, ["~> 0.8.11"])
+      s.add_dependency(%q<jeweler>.freeze, [">= 0"])
+      s.add_dependency(%q<rake>.freeze, [">= 0"])
+      s.add_dependency(%q<shoulda-context>.freeze, [">= 0"])
+      s.add_dependency(%q<test-unit>.freeze, [">= 0"])
+      s.add_dependency(%q<timecop>.freeze, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<builder>.freeze, [">= 0"])
+    s.add_dependency(%q<mail>.freeze, ["> 2.2.5"])
+    s.add_dependency(%q<mime-types>.freeze, [">= 0"])
+    s.add_dependency(%q<xml-simple>.freeze, [">= 0"])
+    s.add_dependency(%q<bundler>.freeze, [">= 1.17"])
+    s.add_dependency(%q<flexmock>.freeze, ["~> 0.8.11"])
+    s.add_dependency(%q<jeweler>.freeze, [">= 0"])
+    s.add_dependency(%q<rake>.freeze, [">= 0"])
+    s.add_dependency(%q<shoulda-context>.freeze, [">= 0"])
+    s.add_dependency(%q<test-unit>.freeze, [">= 0"])
+    s.add_dependency(%q<timecop>.freeze, [">= 0"])
+  end
+end
+

data/lib/aws/actionmailer/ses_extension.rb

@@ -0,0 +1,19 @@
+# A quick little extension to use this lib with with rails 2.3.X
+# To use it, in your environment.rb or some_environment.rb you simply set
+#
+# config.after_initialize do
+#  ActionMailer::Base.delivery_method = :amazon_ses
+#  ActionMailer::Base.custom_amazon_ses_mailer = AWS::SES::Base.new(:secret_access_key => S3_CONFIG[:secret_access_key], :access_key_id => S3_CONFIG[:access_key_id])
+# end
+            
+module ActionMailer
+  class Base
+    cattr_accessor :custom_amazon_ses_mailer
+    
+    def perform_delivery_amazon_ses(mail)
+      raise 'AWS::SES::Base has not been intitialized.' unless @@custom_amazon_ses_mailer
+      @@custom_amazon_ses_mailer.deliver!(mail)
+    end
+
+  end
+end

data/lib/aws/ses.rb

@@ -0,0 +1,28 @@
+%w[ base64 cgi openssl digest/sha1 net/https net/http rexml/document time ostruct mail].each { |f| require f }
+
+begin
+  require 'URI' unless defined? URI
+rescue Exception => e
+  # nothing
+end
+
+begin
+  require 'xmlsimple' unless defined? XmlSimple
+rescue Exception => e
+  require 'xml-simple' unless defined? XmlSimple
+end
+
+$:.unshift(File.dirname(__FILE__))
+require 'ses/extensions'
+
+require 'ses/response'
+require 'ses/send_email'
+require 'ses/info'
+require 'ses/base'
+require 'ses/version'
+require 'ses/addresses'
+
+if defined?(Rails)
+  major, minor = Rails.version.to_s.split('.')
+  require 'actionmailer/ses_extension' if major == '2' && minor == '3'
+end

data/lib/aws/ses/addresses.rb

@@ -0,0 +1,75 @@
+module AWS
+  module SES
+    # AWS::SES::Addresses provides for:
+    # * Listing verified e-mail addresses
+    # * Adding new e-mail addresses to verify
+    # * Deleting verified e-mail addresses
+    #
+    # You can access these methods as follows:
+    #
+    #   ses = AWS::SES::Base.new( ... connection info ... )
+    #
+    #   # Get a list of verified addresses
+    #   ses.addresses.list.result
+    #
+    #   # Add a new e-mail address to verify
+    #   ses.addresses.verify('jon@example.com')
+    #
+    #   # Delete an e-mail address
+    #   ses.addresses.delete('jon@example.com')
+    class Addresses < Base
+      def initialize(ses)
+        @ses = ses
+      end
+
+      # List all verified e-mail addresses
+      # 
+      # Usage:
+      # ses.addresses.list.result
+      # =>
+      # ['email1@example.com', email2@example.com']
+      def list
+        @ses.request('ListVerifiedEmailAddresses')
+      end
+      
+      def verify(email)
+        @ses.request('VerifyEmailAddress',
+          'EmailAddress' => email
+        )
+      end
+      
+      def delete(email)
+        @ses.request('DeleteVerifiedEmailAddress',
+          'EmailAddress' => email
+        )
+      end
+    end
+    
+    class ListVerifiedEmailAddressesResponse < AWS::SES::Response
+      def result
+        if members = parsed['ListVerifiedEmailAddressesResult']['VerifiedEmailAddresses']
+          [members['member']].flatten
+        else
+          []
+        end
+      end
+      memoized :result
+    end
+    
+    class VerifyEmailAddressResponse < AWS::SES::Response
+    end
+    
+    class DeleteVerifiedEmailAddressResponse < AWS::SES::Response
+      def result
+        success?
+      end
+    end
+    
+    class Base
+      def addresses
+        @addresses ||= Addresses.new(self)
+      end
+    end
+    
+  end
+end

data/lib/aws/ses/base.rb

@@ -0,0 +1,286 @@
+module AWS #:nodoc:
+  # AWS::SES is a Ruby library for Amazon's Simple Email Service's REST API (http://aws.amazon.com/ses).
+  # 
+  # == Getting started
+  # 
+  # To get started you need to require 'aws/ses':
+  # 
+  #   % irb -rubygems
+  #   irb(main):001:0> require 'aws/ses'
+  #   # => true
+  # 
+  # Before you can do anything, you must establish a connection using Base.new.  A basic connection would look something like this:
+  # 
+  #   ses = AWS::SES::Base.new(
+  #     :access_key_id     => 'abc', 
+  #     :secret_access_key => '123'
+  #   )
+  # 
+  # The minimum connection options that you must specify are your access key id and your secret access key.
+  #
+  # === Connecting to a server from another region
+  # 
+  # The default server API endpoint is "email.us-east-1.amazonaws.com", corresponding to the US East 1 region.
+  # To connect to a different one, just pass it as a parameter to the AWS::SES::Base initializer:
+  #
+  #   ses = AWS::SES::Base.new(
+  #     :access_key_id     => 'abc', 
+  #     :secret_access_key => '123',
+  #     :server => 'email.eu-west-1.amazonaws.com',
+  #     :message_id_domain => 'eu-west-1.amazonses.com'
+  #   )
+  #
+
+  module SES
+
+    API_VERSION = '2010-12-01'
+
+    DEFAULT_REGION = 'us-east-1'
+
+    SERVICE = 'ses'
+
+    DEFAULT_HOST = 'email.us-east-1.amazonaws.com'
+
+    DEFAULT_MESSAGE_ID_DOMAIN = 'email.amazonses.com'
+
+    USER_AGENT = 'github-aws-ses-ruby-gem'
+
+    DEFAULT_SIGNATURE_VERSION = 4
+
+    # Encodes the given string with the secret_access_key by taking the
+    # hmac-sha1 sum, and then base64 encoding it.  Optionally, it will also
+    # url encode the result of that to protect the string if it's going to
+    # be used as a query string parameter.
+    #
+    # @param [String] secret_access_key the user's secret access key for signing.
+    # @param [String] str the string to be hashed and encoded.
+    # @param [Boolean] urlencode whether or not to url encode the result., true or false
+    # @return [String] the signed and encoded string.
+    def SES.encode(secret_access_key, str, urlencode=true)
+      digest = OpenSSL::Digest.new('sha256')
+      b64_hmac =
+        Base64.encode64(
+          OpenSSL::HMAC.digest(digest, secret_access_key, str)).gsub("\n","")
+
+      if urlencode
+        return CGI::escape(b64_hmac)
+      else
+        return b64_hmac
+      end
+    end
+
+    # Generates the HTTP Header String that Amazon looks for
+    #
+    # @param [String] key the AWS Access Key ID
+    # @param [String] alg the algorithm used for the signature
+    # @param [String] sig the signature itself
+    def SES.authorization_header(key, alg, sig)
+      "AWS3-HTTPS AWSAccessKeyId=#{key}, Algorithm=#{alg}, Signature=#{sig}"
+    end
+
+    def SES.authorization_header_v4(credential, signed_headers, signature)
+      "AWS4-HMAC-SHA256 Credential=#{credential}, SignedHeaders=#{signed_headers}, Signature=#{signature}"
+    end
+
+    # AWS::SES::Base is the abstract super class of all classes who make requests against SES
+    class Base
+      include SendEmail
+      include Info
+
+      attr_reader :use_ssl, :server, :proxy_server, :port, :message_id_domain, :signature_version, :region,
+                  :action, :action_time, :query
+      attr_accessor :settings
+
+      # @option options [String] :access_key_id ("") The user's AWS Access Key ID
+      # @option options [String] :secret_access_key ("") The user's AWS Secret Access Key
+      # @option options [Boolean] :use_ssl (true) Connect using SSL?
+      # @option options [String] :server ("email.us-east-1.amazonaws.com") The server API endpoint host
+      # @option options [String] :proxy_server (nil) An HTTP proxy server FQDN
+      # @option options [String] :user_agent ("github-aws-ses-ruby-gem") The HTTP User-Agent header value
+      # @option options [String] :region ("us-east-1") The server API endpoint host
+      # @option options [String] :message_id_domain ("us-east-1.amazonses.com") Domain used to build message_id header
+      # @return [Object] the object.
+      def initialize( options = {} )
+
+        options = { :access_key_id => "",
+                    :secret_access_key => "",
+                    :use_ssl => true,
+                    :server => DEFAULT_HOST,
+                    :message_id_domain => DEFAULT_MESSAGE_ID_DOMAIN,
+                    :path => "/",
+                    :user_agent => USER_AGENT,
+                    :proxy_server => nil,
+                    :region => DEFAULT_REGION,
+                    :signature_version => DEFAULT_SIGNATURE_VERSION
+        }.merge(options)
+
+        @signature_version = options[:signature_version]
+        @server = options[:server]
+        @message_id_domain = options[:message_id_domain]
+        @proxy_server = options[:proxy_server]
+        @use_ssl = options[:use_ssl]
+        @path = options[:path]
+        @user_agent = options[:user_agent]
+        @region = options[:region]
+        @settings = {}
+
+        raise ArgumentError, "No :access_key_id provided" if options[:access_key_id].nil? || options[:access_key_id].empty?
+        raise ArgumentError, "No :secret_access_key provided" if options[:secret_access_key].nil? || options[:secret_access_key].empty?
+        raise ArgumentError, "No :use_ssl value provided" if options[:use_ssl].nil?
+        raise ArgumentError, "Invalid :use_ssl value provided, only 'true' or 'false' allowed" unless options[:use_ssl] == true || options[:use_ssl] == false
+        raise ArgumentError, "No :server provided" if options[:server].nil? || options[:server].empty?
+        raise ArgumentError, ":signature_version must be 2 or 4" unless [2, 4].include?(options[:signature_version])
+
+        if options[:port]
+          # user-specified port
+          @port = options[:port]
+        elsif @use_ssl
+          # https
+          @port = 443
+        else
+          # http
+          @port = 80
+        end
+
+        @access_key_id = options[:access_key_id]
+        @secret_access_key = options[:secret_access_key]
+
+        # Use proxy server if defined
+        # Based on patch by Mathias Dalheimer.  20070217
+        proxy = @proxy_server ? URI.parse(@proxy_server) : OpenStruct.new
+        @http = Net::HTTP::Proxy( proxy.host,
+                                  proxy.port,
+                                  proxy.user,
+                                  proxy.password).new(options[:server], @port)
+
+        @http.use_ssl = @use_ssl
+      end
+
+      def connection
+        @http
+      end
+
+      # Make the connection to AWS passing in our request.
+      # allow us to have a one line call in each method which will do all of the work
+      # in making the actual request to AWS.
+      def request(action, params = {})
+        @action = action
+        # Use a copy so that we don't modify the caller's Hash, remove any keys that have nil or empty values
+        params = params.reject { |_, value| value.nil? or value.empty?}
+
+        @action_time = Time.now.getutc
+
+        params.merge!( {"Action" => action,
+                        "SignatureVersion" => signature_version.to_s,
+                        "SignatureMethod" => 'HmacSHA256',
+                        "AWSAccessKeyId" => @access_key_id,
+                        "Version" => API_VERSION,
+                        "Timestamp" => action_time.iso8601 } )
+
+        @query = params.sort.collect do |param|
+          CGI::escape(param[0]) + "=" + CGI::escape(param[1])
+        end.join("&")
+        response = connection.post(@path, query, get_req_headers)
+
+        response_class = AWS::SES.const_get( "#{action}Response" )
+        result = response_class.new(action, response)
+
+        if result.error?
+          raise ResponseError.new(result)
+        end
+
+        result
+      end
+
+      def get_req_headers
+        headers = {}
+        if signature_version == 4
+          headers['host'] = @server
+          headers['authorization'] = get_aws_auth_header_v4
+          headers['x-amz-date'] = amzdate
+          headers['user-agent'] = @user_agent
+        else
+          headers['x-amzn-authorization'] = get_aws_auth_header_v2
+          headers['date'] = action_time.httpdate
+          headers['user-agent'] = @user_agent
+        end
+        headers
+      end
+
+      # Set the Authorization header using AWS signed header authentication
+      def get_aws_auth_header_v2
+        encoded_canonical = SES.encode(@secret_access_key, httpdate, false)
+        SES.authorization_header(@access_key_id, 'HmacSHA256', encoded_canonical)
+      end
+
+      def get_aws_auth_header_v4
+        SES.authorization_header_v4(sig_v4_auth_credential, sig_v4_auth_signed_headers, sig_v4_auth_signature)
+      end
+
+      private
+
+      def sig_v4_auth_credential
+        @access_key_id + '/' + credential_scope
+      end
+
+      def sig_v4_auth_signed_headers
+        'host;x-amz-date'
+      end
+
+      def credential_scope
+        datestamp + '/' + region + '/' + SERVICE + '/' + 'aws4_request'
+      end
+
+      def string_to_sign
+        "AWS4-HMAC-SHA256\n" +  amzdate + "\n" +  credential_scope + "\n" + Digest::SHA256.hexdigest(canonical_request.encode('utf-8').b)
+      end
+
+      def amzdate
+        @action_time ||= Time.now.getutc
+        action_time.strftime('%Y%m%dT%H%M%SZ')
+      end
+
+      def datestamp
+        @action_time ||= Time.now.getutc
+        action_time.strftime('%Y%m%d')
+      end
+
+      def httpdate
+        @action_time ||= Time.now.getutc.httpdate
+      end
+
+      def canonical_request
+        "POST" + "\n" + "/" + "\n" + canonical_querystring + "\n" + canonical_headers + "\n" + sig_v4_auth_signed_headers + "\n" + payload_hash
+      end
+
+      def canonical_querystring
+        signature_version == 2 ? "Action=#{action}&Version=2013-10-15" : ''
+      end
+
+      def canonical_headers
+        'host:' + server + "\n" + 'x-amz-date:' + amzdate + "\n"
+      end
+
+      def payload_hash
+        Digest::SHA256.hexdigest(query.to_s.encode('utf-8'))
+      end
+
+      def sig_v4_auth_signature
+        OpenSSL::HMAC.hexdigest("SHA256", getSignatureKey, string_to_sign.encode('utf-8'))
+      end
+
+      def getSignatureKey
+        kDate = sign(('AWS4' + @secret_access_key).encode('utf-8'), datestamp)
+        kRegion = sign(kDate, region)
+        kService = sign(kRegion, SERVICE)
+        kSigning = sign(kService, 'aws4_request')
+
+        kSigning
+      end
+
+      def sign(key, msg)
+        OpenSSL::HMAC.digest("SHA256", key, msg.encode('utf-8'))
+      end
+    end # class Base
+  end # Module SES
+end # Module AWS