mailchimp_ses 1.0.3 → 1.0.4

data/.rspec

@@ -1 +1,2 @@
 --color
+--format progress

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+1.0.4
+-----
+* Added BCC / CC options [dbalatero]
+* Added autogen_html option [dbalatero]
+
 1.0.3
 -----
 * Added reply_to option [jeffmcfadden]

data/Gemfile

@@ -6,7 +6,8 @@ gem 'json'
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "rspec", "~> 2.3.0"
+  gem "rspec", "~> 2.6"
+  gem 'ruby-debug'
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.5.2"
   gem "rcov", ">= 0"

data/Gemfile.lock

@@ -1,6 +1,7 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    columnize (0.3.3)
     diff-lcs (1.1.2)
     git (1.2.5)
     jeweler (1.5.2)
@@ -8,20 +9,28 @@ GEM
       git (>= 1.2.5)
       rake
     json (1.5.1)
+    linecache (0.46)
+      rbx-require-relative (> 0.0.4)
     mime-types (1.16)
     monster_mash (0.2.2)
       typhoeus (>= 0.2.3)
       typhoeus (>= 0.2.3)
     rake (0.8.7)
+    rbx-require-relative (0.0.5)
     rcov (0.9.9)
-    rspec (2.3.0)
-      rspec-core (~> 2.3.0)
-      rspec-expectations (~> 2.3.0)
-      rspec-mocks (~> 2.3.0)
-    rspec-core (2.3.1)
-    rspec-expectations (2.3.0)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.3.0)
+    rspec-mocks (2.6.0)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
     typhoeus (0.2.3)
       mime-types
       mime-types
@@ -36,5 +45,6 @@ DEPENDENCIES
   json
   monster_mash (>= 0.2.2)
   rcov
-  rspec (~> 2.3.0)
+  rspec (~> 2.6)
+  ruby-debug
   vcr

data/VERSION

@@ -1 +1 @@
-1.0.3
+1.0.4

data/lib/mailchimp_ses.rb

@@ -25,32 +25,16 @@ class MailchimpSes < MonsterMash::Base
     check_api_key!
 
     uri "http://#{datacenter}.sts.mailchimp.com/1.0/SendEmail"
+    params(parse_options(options))
 
-    # Message params.
-    message = {
-      :html => extract_param(options[:message], :html),
-      :text => options[:message][:text],
-      :subject => extract_param(options[:message], :subject),
-      :from_name => extract_param(options[:message], :from_name),
-      :from_email => extract_param(options[:message], :from_email),
-      :to_email => convert_to_hash_array(extract_param(options[:message], :to_email))
-    }
-
-    # Pull optional to_name.
-    if options[:message].has_key?(:to_name) && !options[:message][:to_name].empty?
-      message[:to_name] = convert_to_hash_array(options[:message][:to_name])
-    end
-    
-    # Pull optional reply_to.
-    if options[:message].has_key?(:reply_to) && !options[:message][:reply_to].blank?
-      message[:reply_to] = convert_to_hash_array(options[:message][:reply_to])
+    handler do |response|
+      json = JSON.parse(response.body)
     end
+  end
 
-    # Check on to_email and to_name length.
-    if message.has_key?(:to_email) && message.has_key?(:to_name) &&
-        message[:to_email].size != message[:to_name].size
-      raise ArgumentError, "to_email and to_name need the same number of values"
-    end
+  DEFAULT_OPTIONS = { :autogen_html => true }
+  def self.parse_options(options)
+    options = DEFAULT_OPTIONS.merge(options)
 
     # Handle tags.
     tags = nil
@@ -58,18 +42,57 @@ class MailchimpSes < MonsterMash::Base
       tags = convert_to_hash_array(options[:tags])
     end
 
-    params :message => message,
-           :track_opens => extract_param(options, :track_opens).to_s,
-           :track_clicks => extract_param(options, :track_clicks).to_s,
-           :tags => tags
-            
-    handler do |response|
-      json = JSON.parse(response.body)
+    {
+      :message => parse_message_options(options[:message]),
+      :track_opens => extract_param(options, :track_opens).to_s,
+      :track_clicks => extract_param(options, :track_clicks).to_s,
+      :autogen_html => extract_param(options, :autogen_html).to_s,
+      :tags => tags
+    }
+  end
+
+  OPTIONAL_MESSAGE_FIELDS = [:to_name, :reply_to, :cc_email, :cc_name, :bcc_email, :bcc_name]
+  def self.parse_message_options(message_options)
+    message = {
+      :html => extract_param(message_options, :html),
+      :text => message_options[:text],
+      :subject => extract_param(message_options, :subject),
+      :from_name => extract_param(message_options, :from_name),
+      :from_email => extract_param(message_options, :from_email),
+      :to_email => convert_to_hash_array(extract_param(message_options, :to_email))
+    }
+
+    OPTIONAL_MESSAGE_FIELDS.each do |field|
+      set_optional_field!(message, message_options, field)
     end
+
+    # Check lengths of arrays.
+    check_recipients!(message, :to_email, :to_name)
+    check_recipients!(message, :cc_email, :cc_name)
+    check_recipients!(message, :bcc_email, :bcc_name)
+
+    message
   end
 
 private
 
+  def self.set_optional_field!(message, options, key)
+    if options.has_key?(key) && !options[key].empty?
+      message[key] = convert_to_hash_array(options[key])
+    end
+  end
+
+  def self.check_recipients!(message, email_key, name_key)
+    if message.has_key?(email_key) || message.has_key?(name_key)
+      emails = message[email_key].size rescue 0
+      names = message[name_key].size rescue 0
+
+      if emails != names
+        raise ArgumentError, "#{email_key} and #{name_key} need the same number of values"
+      end
+    end
+  end
+
   def self.check_api_key!
     if self.api_key.nil?
       raise ArgumentError, "Set MailchimpSes.api_key in your config."

data/mailchimp_ses.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mailchimp_ses}
-  s.version = "1.0.3"
+  s.version = "1.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["David Balatero"]
-  s.date = %q{2011-03-22}
+  s.date = %q{2011-07-15}
   s.description = %q{Allows you to call MailChimp <-> Amazon SES integration methods.}
   s.email = %q{dbalatero@gmail.com}
   s.extra_rdoc_files = [
@@ -36,7 +36,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/dbalatero/mailchimp_ses}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.5.2}
   s.summary = %q{Gives API methods for MailChimp SES.}
   s.test_files = [
     "spec/mailchimp_ses_spec.rb",
@@ -44,13 +44,13 @@ Gem::Specification.new do |s|
   ]
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<monster_mash>, [">= 0.2.2"])
       s.add_runtime_dependency(%q<json>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.6"])
+      s.add_development_dependency(%q<ruby-debug>, [">= 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"])
@@ -63,7 +63,8 @@ Gem::Specification.new do |s|
     else
       s.add_dependency(%q<monster_mash>, [">= 0.2.2"])
       s.add_dependency(%q<json>, [">= 0"])
-      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.6"])
+      s.add_dependency(%q<ruby-debug>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
       s.add_dependency(%q<rcov>, [">= 0"])
@@ -77,7 +78,8 @@ Gem::Specification.new do |s|
   else
     s.add_dependency(%q<monster_mash>, [">= 0.2.2"])
     s.add_dependency(%q<json>, [">= 0"])
-    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.6"])
+    s.add_dependency(%q<ruby-debug>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
     s.add_dependency(%q<rcov>, [">= 0"])

data/spec/mailchimp_ses_spec.rb

@@ -1,60 +1,175 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "MailchimpSes" do
-  before(:each) do
-    # disabled in production.
-    MailchimpSes.api_key = "test-us1"
+  let(:message) do
+    {
+      :subject => 'Welcome to our website!',
+      :html => '<html>Welcome to our site.</html>',
+      :text => 'Welcome to our website.',
+      :from_name => 'David Balatero',
+      :from_email => 'david@mediapiston.com',
+      :to_email => ['dbalatero@gmail.com'],
+      :to_name => ['David Balatero']
+    }
+  end
 
-    @valid_params = {
-      :message => {
-        :subject => 'Welcome to our website!',
-        :html => '<html>Welcome to our site.</html>',
-        :text => 'Welcome to our website.',
-        :from_name => 'David Balatero',
-        :from_email => 'david@mediapiston.com',
-        :to_email => ['dbalatero@gmail.com',],
-        :to_name => ['David Balatero']
-      },
+  let(:options) do
+    {
+      :message => message,
       :tags => ['fun', 'message', 'unique'],
       :track_opens => true,
       :track_clicks => true
     }
   end
 
+  before(:each) do
+    # disabled in production.
+    MailchimpSes.api_key = "test-us1"
+  end
+
+  describe "#parse_options" do
+    subject { MailchimpSes.parse_options(options) }
+
+    it "should set autogen_html to true by default" do
+      subject[:autogen_html].should == 'true'
+    end
+
+    it "should allow overriding autogen_html to false" do
+      options[:autogen_html] = false
+      subject[:autogen_html].should == 'false'
+    end
+  end
+
+  describe "#parse_message_options" do
+    shared_examples_for 'basic message parser' do
+      it 'should set subject' do
+        subject[:subject].should == 'Welcome to our website!'
+      end
+
+      it 'should set html' do
+        subject[:html].should == '<html>Welcome to our site.</html>'
+      end
+
+      it 'should set text' do
+        subject[:text].should == 'Welcome to our website.'
+      end
+
+      it 'should set from_name' do
+        subject[:from_name].should == 'David Balatero'
+      end
+
+      it 'should set from_email' do
+        subject[:from_email].should == 'david@mediapiston.com'
+      end
+
+      it 'should set to_email' do
+        subject[:to_email][0].should == 'dbalatero@gmail.com'
+      end
+
+      it 'should set to_name' do
+        subject[:to_name][0].should == 'David Balatero'
+      end
+    end
+
+    subject { MailchimpSes.parse_message_options(message) }
+
+    describe "with cc options" do
+      before do
+        message.merge!(:cc_email => ['myfriend@gmail.com'],
+                       :cc_name  => ['My Friend'])
+      end
+
+      it "should set cc_email" do
+        subject[:cc_email][0].should == 'myfriend@gmail.com'
+      end
+
+      it 'should set cc_name' do
+        subject[:cc_name][0].should == 'My Friend'
+      end
+
+      it 'should raise an error if the names do not match emails' do
+        message[:cc_name] = ['One', 'Two']
+        lambda {
+          subject[:cc_name]
+        }.should raise_error(ArgumentError)
+      end
+
+      it_should_behave_like 'basic message parser'
+    end
+
+    describe "with bcc options" do
+      before do
+        message.merge!(:bcc_email => ['bccguy@gmail.com'],
+                       :bcc_name => ['BCC Guy'])
+      end
+
+      it "should set bcc_email" do
+        subject[:bcc_email][0].should == 'bccguy@gmail.com'
+      end
+
+      it 'should set cc_name' do
+        subject[:bcc_name][0].should == 'BCC Guy'
+      end
+
+      it 'should raise an error if the names do not match emails' do
+        message[:bcc_name] = ['One', 'Two']
+        lambda {
+          subject[:bcc_name]
+        }.should raise_error(ArgumentError)
+      end
+
+      it_should_behave_like 'basic message parser'
+
+    end
+  end
+
   describe "#send_email" do
     describe "error checking" do
       it "should raise error w/ no api key" do
         MailchimpSes.api_key = nil
         lambda {
-          MailchimpSes.send_email(@valid_params)
+          MailchimpSes.send_email(options)
         }.should raise_error(ArgumentError)
       end
 
       [:track_opens, :track_clicks].each do |field|
         it "should require #{field}" do
-          @valid_params.delete(field)
+          options.delete(field)
           lambda {
-            MailchimpSes.send_email(@valid_params)
+            MailchimpSes.send_email(options)
           }.should raise_error(ArgumentError)
         end
       end
 
       [:html, :subject, :from_name, :from_email, :to_email].each do |field|
         it "should require message #{field}" do
-          @valid_params[:message].delete(field)
+          options[:message].delete(field)
           lambda {
-            MailchimpSes.send_email(@valid_params)
+            MailchimpSes.send_email(options)
           }.should raise_error(ArgumentError)
         end
       end
 
-      it "should not allow to_email and to_name to be diff length" do
-        @valid_params[:message][:to_email] = ['fds@fds.com', 'a@b.com']
-        @valid_params[:message][:to_name] = ['My Friend Fds']
+      [[:to_email, :to_name]].each do |pair|
+        email_key = pair[0]
+        name_key = pair[1]
+        it "should not allow #{email_key} and #{name_key} to be different lengths" do
+          options[:message][email_key] = ['fds@fds.com', 'a@b.com']
+          options[:message][name_key] = ['My Friend Fds']
 
-        lambda {
-          MailchimpSes.send_email(@valid_params)
-        }.should raise_error(ArgumentError)
+          lambda {
+            MailchimpSes.send_email(options)
+          }.should raise_error(ArgumentError)
+        end
+
+        it "should not allow #{email_key} with an empty #{name_key}" do
+          options[:message][email_key] = ['fdsa@fdsa.com']
+          options[:message][name_key] = []
+
+          lambda {
+            MailchimpSes.send_email(options)
+          }.should raise_error(ArgumentError)
+        end
       end
     end
 
@@ -62,7 +177,7 @@ describe "MailchimpSes" do
       use_vcr_cassette 'send_email', :record => :new_episodes
 
       it "should return a success or failure" do
-        result = MailchimpSes.send_email(@valid_params)
+        result = MailchimpSes.send_email(options)
         result['status'].should == 'sent'
         result['message_id'].should_not be_nil
       end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mailchimp_ses
 version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: false
+  hash: 31
+  prerelease: 
   segments: 
   - 1
   - 0
-  - 3
-  version: 1.0.3
+  - 4
+  version: 1.0.4
 platform: ruby
 authors: 
 - David Balatero
@@ -15,13 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-22 00:00:00 -07:00
+date: 2011-07-15 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :runtime
-  prerelease: false
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -32,12 +30,12 @@ dependencies:
         - 2
         - 2
         version: 0.2.2
+  prerelease: false
   name: monster_mash
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
   type: :runtime
-  prerelease: false
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -46,28 +44,41 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  prerelease: false
   name: json
-  requirement: *id002
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  type: :development
-  prerelease: false
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 15
         segments: 
         - 2
-        - 3
-        - 0
-        version: 2.3.0
+        - 6
+        version: "2.6"
+  prerelease: false
   name: rspec
-  requirement: *id003
-- !ruby/object:Gem::Dependency 
   type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   prerelease: false
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  name: ruby-debug
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -78,12 +89,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
+  prerelease: false
   name: bundler
-  requirement: *id004
-- !ruby/object:Gem::Dependency 
   type: :development
-  prerelease: false
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -94,12 +105,12 @@ dependencies:
         - 5
         - 2
         version: 1.5.2
+  prerelease: false
   name: jeweler
-  requirement: *id005
-- !ruby/object:Gem::Dependency 
   type: :development
-  prerelease: false
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -108,12 +119,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  prerelease: false
   name: rcov
-  requirement: *id006
-- !ruby/object:Gem::Dependency 
   type: :development
-  prerelease: false
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -122,12 +133,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  prerelease: false
   name: vcr
-  requirement: *id007
-- !ruby/object:Gem::Dependency 
   type: :development
-  prerelease: false
-  version_requirements: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -138,12 +149,12 @@ dependencies:
         - 3
         - 0
         version: 2.3.0
+  prerelease: false
   name: rspec
-  requirement: *id008
-- !ruby/object:Gem::Dependency 
   type: :development
-  prerelease: false
-  version_requirements: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -154,12 +165,12 @@ dependencies:
         - 5
         - 2
         version: 1.5.2
+  prerelease: false
   name: jeweler
-  requirement: *id009
-- !ruby/object:Gem::Dependency 
   type: :development
-  prerelease: false
-  version_requirements: &id010 !ruby/object:Gem::Requirement 
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -168,12 +179,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  prerelease: false
   name: vcr
-  requirement: *id010
+  type: :development
+  version_requirements: *id011
 - !ruby/object:Gem::Dependency 
-  type: :runtime
-  prerelease: false
-  version_requirements: &id011 !ruby/object:Gem::Requirement 
+  requirement: &id012 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -184,12 +195,12 @@ dependencies:
         - 2
         - 2
         version: 0.2.2
+  prerelease: false
   name: monster_mash
-  requirement: *id011
-- !ruby/object:Gem::Dependency 
   type: :runtime
-  prerelease: false
-  version_requirements: &id012 !ruby/object:Gem::Requirement 
+  version_requirements: *id012
+- !ruby/object:Gem::Dependency 
+  requirement: &id013 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -198,8 +209,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  prerelease: false
   name: json
-  requirement: *id012
+  type: :runtime
+  version_requirements: *id013
 description: Allows you to call MailChimp <-> Amazon SES integration methods.
 email: dbalatero@gmail.com
 executables: []
@@ -256,7 +269,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Gives API methods for MailChimp SES.