aws-ses 0.1.0 → 0.2.0

data/CHANGELOG

@@ -1,4 +1,8 @@
-head:
+0.2.0:
+* Added info support
+* Added send_email
+
+0.1.0:
 - Initial creation that supports:
 
 * addresses.list

data/Gemfile

@@ -6,7 +6,7 @@ source "http://rubygems.org"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "shoulda", ">= 0"
+  gem "shoulda-context", ">= 0"
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.5.2"
   gem "rcov", ">= 0"

data/Gemfile.lock

@@ -11,7 +11,7 @@ GEM
     mime-types (1.16)
     rake (0.8.7)
     rcov (0.9.9)
-    shoulda (2.11.3)
+    shoulda-context (1.0.0.beta1)
     xml-simple (1.0.13)
 
 PLATFORMS
@@ -24,5 +24,5 @@ DEPENDENCIES
   jeweler (~> 1.5.2)
   mime-types
   rcov
-  shoulda
+  shoulda-context
   xml-simple

data/README

@@ -20,7 +20,20 @@ Before you can do anything, you must establish a connection using Base.new.  A b
 The minimum connection options that you must specify are your access key id and your secret access key.
 
 
-= Addresses
+== Send E-mail
+
+Adds functionality for send_email and send_raw_email
+Use the following to send an e-mail:
+
+  ses = AWS::SES::Base.new( ... connection info ... )
+  ses.send_email :to        => ['jon@example.com', 'dave@example.com'],
+               :source    => 'steve@example.com',
+               :subject   => 'Subject Line'
+               :text_body => 'Internal text body'
+
+
+
+== Addresses
 
 AWS::SES::Addresses provides for:
 * Listing verified e-mail addresses
@@ -28,6 +41,11 @@ AWS::SES::Addresses provides for:
 * Deleting verified e-mail addresses
 
 
+== Info
+
+Adds functionality for the statistics and info functionality
+
+
 == Contributing to aws-ses
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/README.erb

@@ -2,10 +2,18 @@
 
 <%= docs_for['AWS::SES'] %>
 
-= Addresses
+== Send E-mail
+
+<%= docs_for ['AWS::SES::SendEmail'] %>
+
+== Addresses
 
 <%= docs_for['AWS::SES::Addresses'] %>
 
+== Info
+
+<%= docs_for['AWS::SES::Info'] %>
+
 == Contributing to aws-ses
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/Rakefile

@@ -57,7 +57,7 @@ namespace :doc do
     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_files.include('COPYING')
+    rdoc.rdoc_files.include('LICENSE')
     rdoc.rdoc_files.include('lib/**/*.rb')
   end
   

data/TODO

@@ -1,2 +1,2 @@
-* Implement the rest of the API
+* Implement the Send Raw E-mail option
 * Use a better XML parser (and be consistent)

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/aws-ses.gemspec

@@ -0,0 +1,107 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{aws-ses}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Drew Blas", "Marcel Molina Jr."]
+  s.date = %q{2011-01-26}
+  s.description = %q{Client library for Amazon's Simple Email Service's REST API}
+  s.email = %q{drew.blas@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README",
+    "README.erb",
+    "TODO"
+  ]
+  s.files = [
+    ".document",
+    "CHANGELOG",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README",
+    "README.erb",
+    "Rakefile",
+    "TODO",
+    "VERSION",
+    "aws-ses.gemspec",
+    "lib/aws/ses.rb",
+    "lib/aws/ses/addresses.rb",
+    "lib/aws/ses/base.rb",
+    "lib/aws/ses/exceptions.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/base_test.rb",
+    "test/extensions_test.rb",
+    "test/fixtures.rb",
+    "test/helper.rb",
+    "test/mocks/fake_response.rb",
+    "test/response_test.rb",
+    "test/send_email_test.rb"
+  ]
+  s.homepage = %q{http://github.com/drewblas/aws-ses}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.4.2}
+  s.summary = %q{Client library for Amazon's Simple Email Service's REST API}
+  s.test_files = [
+    "test/base_test.rb",
+    "test/extensions_test.rb",
+    "test/fixtures.rb",
+    "test/helper.rb",
+    "test/mocks/fake_response.rb",
+    "test/response_test.rb",
+    "test/send_email_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<xml-simple>, [">= 0"])
+      s.add_runtime_dependency(%q<builder>, [">= 0"])
+      s.add_runtime_dependency(%q<mime-types>, [">= 0"])
+      s.add_development_dependency(%q<shoulda-context>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<flexmock>, ["~> 0.8.11"])
+      s.add_runtime_dependency(%q<xml-simple>, [">= 0"])
+      s.add_runtime_dependency(%q<builder>, [">= 0"])
+      s.add_runtime_dependency(%q<mime-types>, [">= 0"])
+    else
+      s.add_dependency(%q<xml-simple>, [">= 0"])
+      s.add_dependency(%q<builder>, [">= 0"])
+      s.add_dependency(%q<mime-types>, [">= 0"])
+      s.add_dependency(%q<shoulda-context>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<flexmock>, ["~> 0.8.11"])
+      s.add_dependency(%q<xml-simple>, [">= 0"])
+      s.add_dependency(%q<builder>, [">= 0"])
+      s.add_dependency(%q<mime-types>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<xml-simple>, [">= 0"])
+    s.add_dependency(%q<builder>, [">= 0"])
+    s.add_dependency(%q<mime-types>, [">= 0"])
+    s.add_dependency(%q<shoulda-context>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<flexmock>, ["~> 0.8.11"])
+    s.add_dependency(%q<xml-simple>, [">= 0"])
+    s.add_dependency(%q<builder>, [">= 0"])
+    s.add_dependency(%q<mime-types>, [">= 0"])
+  end
+end
+

data/lib/aws/ses.rb

@@ -15,8 +15,10 @@ end
 $:.unshift(File.dirname(__FILE__))
 require 'ses/extensions'
 
-require 'ses/base'
 require 'ses/response'
+require 'ses/send_email'
+require 'ses/info'
+require 'ses/base'
 require 'ses/exceptions'
 require 'ses/version'
 require 'ses/addresses'

data/lib/aws/ses/base.rb

@@ -56,6 +56,8 @@ module AWS #:nodoc:
     
     # 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
 
@@ -199,7 +201,7 @@ module AWS #:nodoc:
         if AWS.const_defined?(error_code)
           raise AWS.const_get(error_code), error_message
         else
-          raise AWS::Error, error_message
+          raise AWS::Error, error_message + error_code
         end
 
       end

data/lib/aws/ses/exceptions.rb

@@ -20,15 +20,6 @@ module AWS
   # Server : Internal Error.
   class InternalError < Error; end
 
-  # Server : Not enough available addresses to satisfy your minimum request.
-  class InsufficientAddressCapacity < Error; end
-
-  # Server : There are not enough available instances to satisfy your minimum request.
-  class InsufficientInstanceCapacity < Error; end
-
-  # Server : There are not enough available reserved instances to satisfy your minimum request.
-  class InsufficientReservedInstanceCapacity < Error; end
-
   # Server : The server is overloaded and cannot handle the request.
   class Unavailable < Error; end
 

data/lib/aws/ses/info.rb

@@ -0,0 +1,26 @@
+module AWS
+  module SES
+    # Adds functionality for the statistics and info functionality
+    #
+    # You can call 'quota' or 'statistics'
+    module Info
+      # Returns quota information provided by SES
+      # 
+      # The return format inside the response result will look like:
+      #   {"SentLast24Hours"=>"0.0", "MaxSendRate"=>"1.0", "Max24HourSend"=>"200.0"}
+      def quota
+        request('GetSendQuota')
+      end
+      
+      def statistics
+        request('GetSendStatistics')
+      end
+    end
+    
+    class GetSendQuotaResponse < AWS::SES::Response
+    end
+    
+    class GetSendStatisticsResponse < AWS::SES::Response
+    end
+  end
+end

data/lib/aws/ses/send_email.rb

@@ -0,0 +1,74 @@
+module AWS
+  module SES
+    # Adds functionality for send_email and send_raw_email
+    # Use the following to send an e-mail:
+    #
+    #   ses = AWS::SES::Base.new( ... connection info ... )
+    #   ses.send_email :to        => ['jon@example.com', 'dave@example.com'],
+    #                :source    => 'steve@example.com',
+    #                :subject   => 'Subject Line'
+    #                :text_body => 'Internal text body'
+    #
+    module SendEmail
+      
+      # Sends an email through SES
+      # 
+      # the destination parameters can be:
+      # 
+      # [A single e-mail string]  "jon@example.com"
+      # [A array of e-mail addresses]  ['jon@example.com', 'dave@example.com']
+      #
+      # ---
+      # = "Email address is not verified.MessageRejected (AWS::Error)"
+      # If you are receiving this message and you HAVE verified the [source] please <b>check to be sure you are not in sandbox mode!</b>
+      # If you have not been granted production access, you will have to <b>verify all recipients</b as well.
+      # http://docs.amazonwebservices.com/ses/2010-12-01/DeveloperGuide/index.html?InitialSetup.Customer.html
+      # ---
+      #
+      # @option options [String] :source Source e-mail (from)
+      # @option options [String] :from alias for :source
+      # @option options [String] :to Destination e-mails
+      # @option options [String] :cc Destination e-mails
+      # @option options [String] :bcc Destination e-mails
+      # @option options [String] :subject
+      # @option options [String] :html_body
+      # @option options [String] :text_body
+      # @option options [String] :return_path The email address to which bounce notifications are to be forwarded. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter.
+      # @option options
+      # @return [Response] the response to sending this e-mail
+      def send_email(options = {})
+        package     = {}
+        
+        package['Source'] = options[:source] || options[:from]
+        
+        add_array_to_hash!(package, 'Destination.ToAddresses', options[:to]) if options[:to]
+        add_array_to_hash!(package, 'Destination.CcAddresses', options[:cc]) if options[:cc]
+        add_array_to_hash!(package, 'Destination.BccAddresses', options[:bcc]) if options[:bcc]
+        
+        package['Message.Subject.Data'] = options[:subject]
+        
+        package['Message.Body.Html.Data'] = options[:html_body] if options[:html_body]
+        package['Message.Body.Text.Data'] = options[:text_body] || options[:body] if options[:text_body] || options[:body]
+        
+        package['ReturnPath'] = options[:return_path] if options[:return_path]
+        
+        request('SendEmail', package)
+      end
+      
+      private
+      
+      # Adds all elements of the ary with the appropriate member elements
+      def add_array_to_hash!(hash, key, ary)
+        cnt = 1
+        [*ary].each do |o|
+          hash["#{key}.member.#{cnt}"] = o
+          cnt += 1
+        end
+      end
+    end
+    
+    class SendEmailResponse < AWS::SES::Response
+      
+    end
+  end
+end

data/lib/aws/ses/version.rb

@@ -2,7 +2,7 @@ module AWS
   module SES
     module VERSION #:nodoc:
       MAJOR    = '0'
-      MINOR    = '1'
+      MINOR    = '2'
       TINY     = '0' 
       BETA     = Time.now.to_i.to_s
     end

data/test/helper.rb

@@ -8,7 +8,7 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 require 'test/unit'
-require 'shoulda'
+require 'shoulda-context'
 
 begin
   require 'ruby-debug'
@@ -26,10 +26,12 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'aws/ses'
 
 class Test::Unit::TestCase
+  require 'net/http'
+  require 'net/https'
+  
   include AWS::SES
   
-  def mock_connection_for(instance, klass, options = {})    
-    data = options[:returns]
+  def mock_connection(object, data = {})
     return_values = case data
     when Hash
       FakeResponse.new(data)
@@ -39,10 +41,16 @@ class Test::Unit::TestCase
       abort "Response data for mock connection must be a Hash or an Array. Was #{data.inspect}."
     end
     
-    connection = flexmock('Mock connection') do |mock|
+    connection = flexmock(Net::HTTP.new) do |mock|
       mock.should_receive(:request).and_return(*return_values).at_least.once
     end
 
-    instance.should_receive(:connection).and_return(connection)
+    mock = flexmock(object)
+    mock.should_receive(:connection).and_return(connection)
+    mock
+  end
+  
+  def generate_base
+    Base.new(:access_key_id=>'123', :secret_access_key=>'abc')
   end
 end

data/test/send_email_test.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '/helper'
+
+class SendEmailTest < Test::Unit::TestCase
+  context "when sending email" do
+    setup do
+      @base = generate_base
+    end
+    
+    context "adding to a hash" do
+      should 'add array elements to the hash' do
+        hash = {}
+        ary  = ['x', 'y']
+        @base.send(:add_array_to_hash!, hash, 'SomeKey', ary)
+        expected = {'SomeKey.member.1' => 'x', 'SomeKey.member.2' => 'y'}
+        assert_equal expected, hash
+      end
+      
+      should 'add singular elements to the hash' do
+        hash = {}
+        ary  = 'z'
+        @base.send(:add_array_to_hash!, hash, 'SomeKey', ary)
+        expected = {'SomeKey.member.1' => 'z'}
+        assert_equal expected, hash
+      end
+    end
+    
+    # should "send an e-mail" do
+    #   mock_connection(@base)
+    #   
+    #   result = @base.send_email :from => 'jon@example.com', 
+    #                             :to   => 'dave@example.com',
+    #                             :subject => 'Subject1', 
+    #                             :text_body => 'Body1'
+    #   assert result.success?
+    # end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: aws-ses
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Drew Blas
@@ -63,7 +63,7 @@ dependencies:
   requirement: *id003
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  name: shoulda
+  name: shoulda-context
   type: :development
   version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -201,12 +201,15 @@ files:
 - Rakefile
 - TODO
 - VERSION
+- aws-ses.gemspec
 - lib/aws/ses.rb
 - lib/aws/ses/addresses.rb
 - lib/aws/ses/base.rb
 - lib/aws/ses/exceptions.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/base_test.rb
 - test/extensions_test.rb
@@ -214,6 +217,7 @@ files:
 - test/helper.rb
 - test/mocks/fake_response.rb
 - test/response_test.rb
+- test/send_email_test.rb
 has_rdoc: true
 homepage: http://github.com/drewblas/aws-ses
 licenses: 
@@ -255,3 +259,4 @@ test_files:
 - test/helper.rb
 - test/mocks/fake_response.rb
 - test/response_test.rb
+- test/send_email_test.rb