createsend 2.2.0 → 2.3.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    createsend (2.2.0)
+    createsend (2.3.0)
       hashie (~> 1.0)
       httparty (~> 0.8)
       json
@@ -18,7 +18,7 @@ GEM
     httparty (0.8.1)
       multi_json
       multi_xml
-    i18n (0.6.0)
+    i18n (0.6.1)
     jnunemaker-matchy (0.4.0)
     json (1.7.4)
     metaclass (0.0.1)
@@ -27,11 +27,11 @@ GEM
     multi_json (1.0.3)
     multi_xml (0.4.1)
     rake (0.9.2.2)
-    shoulda (3.1.1)
+    shoulda (3.3.0)
       shoulda-context (~> 1.0)
-      shoulda-matchers (~> 1.2)
+      shoulda-matchers (~> 1.4)
     shoulda-context (1.0.0)
-    shoulda-matchers (1.2.0)
+    shoulda-matchers (1.4.0)
       activesupport (>= 3.0.0)
 
 PLATFORMS
@@ -44,4 +44,4 @@ DEPENDENCIES
   jnunemaker-matchy (~> 0.4)
   mocha (~> 0.9)
   rake
-  shoulda (~> 3.1.1)
+  shoulda (~> 3.3.0)

data/createsend.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency('fakeweb', '~> 1.3')
   s.add_development_dependency('jnunemaker-matchy', '~> 0.4')
   s.add_development_dependency('mocha', '~> 0.9')
-  s.add_development_dependency('shoulda', '~> 3.1.1')
+  s.add_development_dependency('shoulda', '~> 3.3.0')
   s.add_development_dependency('cane')
   s.add_runtime_dependency('json')
   s.add_runtime_dependency('hashie', '~> 1.0')

data/lib/createsend/campaign.rb

@@ -27,6 +27,25 @@ module CreateSend
       response.parsed_response
     end
 
+    # Creates a new campaign for a client, from a template.
+    def self.create_from_template(client_id, subject, name, from_name,
+      from_email, reply_to, list_ids, segment_ids, template_id,
+      template_content)
+      options = { :body => {
+        :Subject => subject,
+        :Name => name,
+        :FromName => from_name,
+        :FromEmail => from_email,
+        :ReplyTo => reply_to,
+        :ListIDs => list_ids,
+        :SegmentIDs => segment_ids,
+        :TemplateID => template_id,
+        :TemplateContent => template_content }.to_json }
+      response = CreateSend.post(
+        "/campaigns/#{client_id}/fromtemplate.json", options)
+      response.parsed_response
+    end
+
     # Sends a preview of this campaign.
     def send_preview(recipients, personalize="fallback")
       options = { :body => {

data/lib/createsend/client.rb

@@ -93,6 +93,13 @@ module CreateSend
       Hashie::Mash.new(response)
     end
 
+    # Unsuppresses an email address by removing it from the the client's
+    # suppression list
+    def unsuppress(email)
+      options = { :query => { :email => email }, :body => '' }
+      response = put "unsuppress", options
+    end
+
     # Gets the templates belonging to this client.
     def templates
       response = get 'templates'

data/lib/createsend/version.rb

@@ -1,3 +1,3 @@
 module CreateSend
-  VERSION = "2.2.0" unless defined?(CreateSend::VERSION)
+  VERSION = "2.3.0" unless defined?(CreateSend::VERSION)
 end

data/test/campaign_test.rb

@@ -17,6 +17,88 @@ class CampaignTest < Test::Unit::TestCase
       campaign_id.should == "787y87y87y87y87y87y87"
     end
 
+    should "create a campaign from a template" do
+      template_content = {
+        :Singlelines => [
+          {
+            :Content => "This is a heading",
+            :Alt => "This is alt text",
+            :Href => "http://example.com/"
+          }
+        ],
+        :Multilines => [
+          {
+            :Content => "<p>This is example</p><p>multiline \
+            <a href=\"http://example.com\">content</a>...</p>"
+          }
+        ],
+        :Images => [
+          {
+            :Content => "http://example.com/image.png",
+            :Alt => "This is alt text for an image",
+            :Href => "http://example.com/"
+          }
+        ],
+        :Repeaters => [
+          {
+            :Items => [
+              {
+                :Layout => "My layout",
+                :Singlelines => [
+                  {
+                    :Content => "This is a repeater heading",
+                    :Href => "http://example.com/"
+                  }
+                ],
+                :Multilines => [
+                  {
+                    :Content => "<p>This is example</p><p>multiline \
+                    <a href=\"http://example.com\">content</a>...</p>"
+                  }
+                ],
+                :Images => [
+                  {
+                    :Content => "http://example.com/repeater-image.png",
+                    :Alt => "This is alt text for a repeater image",
+                    :Href => "http://example.com/"
+                  }
+                ]
+              }
+            ]
+          }
+        ]
+      }
+
+      # template_content as defined above would be used to fill the content of
+      # a template with markup similar to the following:
+      # 
+      # <html>
+      #   <head><title>My Template</title></head>
+      #   <body>
+      #     <p><singleline>Enter heading...</singleline></p>
+      #     <div><multiline>Enter description...</multiline></div>
+      #     <img id="header-image" editable="true" width="500" />
+      #     <repeater>
+      #       <layout label="My layout">
+      #         <div class="repeater-item">
+      #           <p><singleline></singleline></p>
+      #           <div><multiline></multiline></div>
+      #           <img editable="true" width="500" />
+      #         </div>
+      #       </layout>
+      #     </repeater>
+      #     <p><unsubscribe>Unsubscribe</unsubscribe></p>
+      #   </body>
+      # </html>     
+
+      client_id = '87y8d7qyw8d7yq8w7ydwqwd'
+      stub_post(@api_key, "campaigns/#{client_id}/fromtemplate.json", "create_campaign.json")
+      campaign_id = CreateSend::Campaign.create_from_template client_id, "subject", "name", "g'day", "good.day@example.com", "good.day@example.com", 
+      [ '7y12989e82ue98u2e', 'dh9w89q8w98wudwd989' ], [ 'y78q9w8d9w8ud9q8uw', 'djw98quw9duqw98uwd98' ],
+      "7j8uw98udowy12989e8298u2e", template_content
+      campaign_id.should == "787y87y87y87y87y87y87"
+    end
+
     should "send a preview of a draft campaign" do
       stub_post(@api_key, "campaigns/#{@campaign.campaign_id}/sendpreview.json", nil)
       @campaign.send_preview [ "test+89898u9@example.com", "test+787y8y7y8@example.com" ], "random"

data/test/client_test.rb

@@ -14,7 +14,7 @@ class ClientTest < Test::Unit::TestCase
       client_id = CreateSend::Client.create "Client Company Name", "(GMT+10:00) Canberra, Melbourne, Sydney", "Australia"
       client_id.should == "32a381c49a2df99f1d0c6f3c112352b9"
     end
-    
+
     should "get details of a client" do
       stub_get(@api_key, "clients/#{@client.client_id}.json", "client_details.json")
       cl = @client.details
@@ -107,6 +107,12 @@ class ClientTest < Test::Unit::TestCase
       res.Results.first.State.should == "Suppressed"
     end
 
+    should "unsuppress an email address" do
+      email = "example@example.com"
+      stub_put(@api_key, "clients/#{@client.client_id}/unsuppress.json?email=#{CGI.escape(email)}", nil)
+      result = @client.unsuppress email
+    end
+
     should "get all people" do
       stub_get(@api_key, "clients/#{@client.client_id}/people.json", "people.json")
       people = @client.people
@@ -147,26 +153,35 @@ class ClientTest < Test::Unit::TestCase
       stub_put(@api_key, "clients/#{@client.client_id}/setpaygbilling.json", nil)
       @client.set_payg_billing "CAD", true, true, 150
     end
-    
+
     should "set monthly billing (implicit)" do
       stub_put(@api_key, "clients/#{@client.client_id}/setmonthlybilling.json", nil)
       @client.set_monthly_billing "CAD", true, 150 
       request = FakeWeb.last_request.body
-      assert_equal("{\"Currency\":\"CAD\",\"ClientPays\":true,\"MarkupPercentage\":150,\"MonthlyScheme\":null}", request, "Request wasn't as expected")
+      request.include?("\"Currency\":\"CAD\"").should == true
+      request.include?("\"ClientPays\":true").should == true
+      request.include?("\"MarkupPercentage\":150").should == true
+      request.include?("\"MonthlyScheme\":null").should == true
     end
 
     should "set monthly billing (basic)" do
       stub_put(@api_key, "clients/#{@client.client_id}/setmonthlybilling.json", nil)
       @client.set_monthly_billing "CAD", true, 150, "Basic"
       request = FakeWeb.last_request.body
-      assert_equal("{\"Currency\":\"CAD\",\"ClientPays\":true,\"MarkupPercentage\":150,\"MonthlyScheme\":\"Basic\"}", request, "Request wasn't as expected")
+      request.include?("\"Currency\":\"CAD\"").should == true
+      request.include?("\"ClientPays\":true").should == true
+      request.include?("\"MarkupPercentage\":150").should == true
+      request.include?("\"MonthlyScheme\":\"Basic\"").should == true
     end
        
     should "set monthly billing (unlimited)" do
       stub_put(@api_key, "clients/#{@client.client_id}/setmonthlybilling.json", nil)
       @client.set_monthly_billing "CAD", false, 120, "Unlimited"
       request = FakeWeb.last_request.body
-      assert_equal("{\"Currency\":\"CAD\",\"ClientPays\":false,\"MarkupPercentage\":120,\"MonthlyScheme\":\"Unlimited\"}", request, "Request wasn't as expected")
+      request.include?("\"Currency\":\"CAD\"").should == true
+      request.include?("\"ClientPays\":false").should == true
+      request.include?("\"MarkupPercentage\":120").should == true
+      request.include?("\"MonthlyScheme\":\"Unlimited\"").should == true
     end
      
     should "delete a client" do

data/test/fixtures/active_subscribers.json

@@ -10,6 +10,14 @@
           "Key": "website",
           "Value": "http://example.com"
         },
+        {
+          "Key": "multi select field",
+          "Value": "option one"
+        },
+        {
+          "Key": "multi select field",
+          "Value": "option two"
+        },
         {
           "Key": "age",
           "Value": "24"

data/test/list_test.rb

@@ -117,7 +117,13 @@ class ListTest < Test::Unit::TestCase
       res.Results.first.Name.should =="Person One"
       res.Results.first.Date.should == "2010-10-25 10:28:00"
       res.Results.first.State.should == "Active"
-      res.Results.first.CustomFields.size.should == 3
+      res.Results.first.CustomFields.size.should == 5
+      res.Results.first.CustomFields[0].Key.should == "website"
+      res.Results.first.CustomFields[0].Value.should == "http://example.com"
+      res.Results.first.CustomFields[1].Key.should == "multi select field"
+      res.Results.first.CustomFields[1].Value.should == "option one"
+      res.Results.first.CustomFields[2].Key.should == "multi select field"
+      res.Results.first.CustomFields[2].Value.should == "option two"
     end
     
     should "get the unsubscribed subscribers for a list" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: createsend
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-17 00:00:00.000000000 Z
+date: 2012-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70099797096200 !ruby/object:Gem::Requirement
+  requirement: &70321789088920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70099797096200
+  version_requirements: *70321789088920
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70099797095560 !ruby/object:Gem::Requirement
+  requirement: &70321789088160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *70099797095560
+  version_requirements: *70321789088160
 - !ruby/object:Gem::Dependency
   name: jnunemaker-matchy
-  requirement: &70099797094880 !ruby/object:Gem::Requirement
+  requirement: &70321789084600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.4'
   type: :development
   prerelease: false
-  version_requirements: *70099797094880
+  version_requirements: *70321789084600
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70099797094220 !ruby/object:Gem::Requirement
+  requirement: &70321789096560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,21 +54,21 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *70099797094220
+  version_requirements: *70321789096560
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70099797093460 !ruby/object:Gem::Requirement
+  requirement: &70321789092060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.1.1
+        version: 3.3.0
   type: :development
   prerelease: false
-  version_requirements: *70099797093460
+  version_requirements: *70321789092060
 - !ruby/object:Gem::Dependency
   name: cane
-  requirement: &70099797093080 !ruby/object:Gem::Requirement
+  requirement: &70321789105720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70099797093080
+  version_requirements: *70321789105720
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70099797092480 !ruby/object:Gem::Requirement
+  requirement: &70321789104280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70099797092480
+  version_requirements: *70321789104280
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70099797091760 !ruby/object:Gem::Requirement
+  requirement: &70321789103040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70099797091760
+  version_requirements: *70321789103040
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70099797091260 !ruby/object:Gem::Requirement
+  requirement: &70321789101200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,7 +109,7 @@ dependencies:
         version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *70099797091260
+  version_requirements: *70321789101200
 description: Implements the complete functionality of the createsend API.
 email:
 - jdennes@gmail.com
@@ -212,6 +212,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3175201096736061315
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: