createsend 0.2.1 → 0.3.0

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    createsend (0.2.0)
-      hashie (~> 0.4.0)
-      httparty (~> 0.6.1)
+    createsend (0.2.1)
+      hashie (~> 1.0)
+      httparty (~> 0.7)
       json
 
 GEM
@@ -11,14 +11,12 @@ GEM
   specs:
     crack (0.1.8)
     fakeweb (1.3.0)
-    hashie (0.4.0)
-    httparty (0.6.1)
+    hashie (1.0.0)
+    httparty (0.7.4)
       crack (= 0.1.8)
     jnunemaker-matchy (0.4.0)
-    json (1.4.6)
-    mocha (0.9.10)
-      rake
-    rake (0.8.7)
+    json (1.5.1)
+    mocha (0.9.12)
     shoulda (2.11.3)
 
 PLATFORMS
@@ -27,9 +25,9 @@ PLATFORMS
 DEPENDENCIES
   createsend!
   fakeweb (~> 1.3)
-  hashie (~> 0.4.0)
-  httparty (~> 0.6.1)
-  jnunemaker-matchy (~> 0.4.0)
+  hashie (~> 1.0)
+  httparty (~> 0.7)
+  jnunemaker-matchy (~> 0.4)
   json
   mocha (~> 0.9)
   shoulda (~> 2.11)

data/createsend.gemspec

@@ -5,12 +5,12 @@ require File.expand_path('lib/createsend/version')
 
 Gem::Specification.new do |s|
   s.add_development_dependency('fakeweb', '~> 1.3')
-  s.add_development_dependency('jnunemaker-matchy', '~> 0.4.0')
+  s.add_development_dependency('jnunemaker-matchy', '~> 0.4')
   s.add_development_dependency('mocha', '~> 0.9')
   s.add_development_dependency('shoulda', '~> 2.11')
   s.add_runtime_dependency('json')
-  s.add_runtime_dependency('hashie', '~> 0.4.0')
-  s.add_runtime_dependency('httparty', '~> 0.6.1')
+  s.add_runtime_dependency('hashie', '~> 1.0')
+  s.add_runtime_dependency('httparty', '~> 0.7')
   s.name = "createsend"
   s.author = "James Dennes"
   s.description = %q{A library which implements the complete functionality of v3 of the createsend API.}

data/lib/createsend.rb

@@ -57,7 +57,10 @@ module CreateSend
   class CreateSend
     include HTTParty
 
-    headers({ 'User-Agent' => "createsend-ruby-#{CreateSend::VERSION}", 'Content-Type' => 'application/json' })
+    headers({ 
+      'User-Agent' => "createsend-ruby-#{CreateSend::VERSION}", 
+      'Content-Type' => 'application/json; charset=utf-8',
+      'Accept-Encoding' => 'gzip, deflate' })
     base_uri CreateSendOptions['base_uri']
     basic_auth CreateSendOptions['api_key'], 'x'
 

data/lib/createsend/subscriber.rb

@@ -51,6 +51,21 @@ module CreateSend
       Hashie::Mash.new(response)
     end
 
+    # Updates any aspect of a subscriber, including email address, name, and 
+    # custom field data if supplied.
+    def update(new_email_address, name, custom_fields, resubscribe)
+      options = {
+        :query => { :email => @email_address },
+        :body => {
+          :EmailAddress => new_email_address,
+          :Name => name,
+          :CustomFields => custom_fields,
+          :Resubscribe => resubscribe }.to_json }
+      CreateSend.put "/subscribers/#{@list_id}.json", options
+      # Update @email_address, so this object can continue to be used reliably
+      @email_address = new_email_address
+    end
+
     # Unsubscribes this subscriber from the associated list.
     def unsubscribe
       options = { :body => {

data/lib/createsend/version.rb

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

data/test/client_test.rb

@@ -76,6 +76,7 @@ class ClientTest < Test::Unit::TestCase
       res.TotalNumberOfRecords.should == 5
       res.NumberOfPages.should == 1
       res.Results.size.should == 5
+      res.Results.first.SuppressionReason.should == "Unsubscribed"
       res.Results.first.EmailAddress.should == "example+1@example.com"
       res.Results.first.Date.should == "2010-10-26 10:55:31"
       res.Results.first.State.should == "Suppressed"

data/test/fixtures/suppressionlist.json

@@ -1,26 +1,31 @@
 {
   "Results": [
     {
+      "SuppressionReason": "Unsubscribed",
       "EmailAddress": "example+1@example.com",
       "Date": "2010-10-26 10:55:31",
       "State": "Suppressed"
     },
     {
+      "SuppressionReason": "Unsubscribed",
       "EmailAddress": "example+2@example.com",
       "Date": "2010-10-26 10:55:31",
       "State": "Suppressed"
     },
     {
+      "SuppressionReason": "Unsubscribed",
       "EmailAddress": "example+3@example.com",
       "Date": "2010-10-26 10:55:31",
       "State": "Suppressed"
     },
     {
+      "SuppressionReason": "Unsubscribed",
       "EmailAddress": "subscriber@example.com",
       "Date": "2010-10-25 13:11:04",
       "State": "Suppressed"
     },
     {
+      "SuppressionReason": "Unsubscribed",
       "EmailAddress": "subscriberone@example.com",
       "Date": "2010-10-25 13:04:15",
       "State": "Suppressed"

data/test/helper.rb

@@ -26,7 +26,7 @@ def stub_request(method, api_key, url, filename, status=nil)
   options = {:body => ""}
   options.merge!({:body => fixture_file(filename)}) if filename
   options.merge!({:status => status}) if status
-  options.merge!(:content_type => "application/json")
+  options.merge!(:content_type => "application/json; charset=utf-8")
   FakeWeb.register_uri(method, createsend_url(api_key, url), options)
 end
 

data/test/list_test.rb

@@ -15,12 +15,12 @@ class ListTest < Test::Unit::TestCase
       list_id = CreateSend::List.create @client_id, "List One", "", false, ""
       list_id.should == "e3c5f034d68744f7881fdccf13c2daee"
     end
-    
+
     should "update a list" do
       stub_put(@api_key, "lists/#{@list.list_id}.json", nil)
       @list.update "List One Renamed", "", false, ""
     end
-    
+
     should "delete a list" do
       stub_delete(@api_key, "lists/#{@list.list_id}.json", nil)
       @list.delete

data/test/subscriber_test.rb

@@ -34,6 +34,24 @@ class SubscriberTest < Test::Unit::TestCase
       email_address = CreateSend::Subscriber.add @list_id, "subscriber@example.com", "Subscriber", custom_fields, true
       email_address.should == "subscriber@example.com"
     end
+
+    should "add a subscriber with custom fields including multi-option fields" do
+      stub_post(@api_key, "subscribers/#{@list_id}.json", "add_subscriber.json")
+      custom_fields = [ { :Key => 'multioptionselectone', :Value => 'myoption' }, 
+        { :Key => 'multioptionselectmany', :Value => 'firstoption' },
+        { :Key => 'multioptionselectmany', :Value => 'secondoption' } ]
+      email_address = CreateSend::Subscriber.add @list_id, "subscriber@example.com", "Subscriber", custom_fields, true
+      email_address.should == "subscriber@example.com"
+    end
+
+    should "update a subscriber with custom fields" do
+      email = "subscriber@example.com"
+      new_email = "new_email_address@example.com"
+      stub_put(@api_key, "subscribers/#{@list_id}.json?email=#{CGI.escape(email)}", nil)
+      custom_fields = [ { :Key => 'website', :Value => 'http://example.com/' } ]
+      @subscriber.update new_email, "Subscriber", custom_fields, true
+      @subscriber.email_address.should == new_email
+    end
     
     should "import many subscribers at once" do
       stub_post(@api_key, "subscribers/#{@list_id}/import.json", "import_subscribers.json")

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: createsend
 version: !ruby/object:Gem::Version 
-  hash: 21
-  prerelease: false
+  hash: 19
+  prerelease: 
   segments: 
   - 0
-  - 2
-  - 1
-  version: 0.2.1
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - James Dennes
@@ -15,10 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-31 00:00:00 +11:00
+date: 2011-04-18 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  type: :development
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -29,27 +30,26 @@ dependencies:
         - 1
         - 3
         version: "1.3"
-  type: :development
-  prerelease: false
-  name: fakeweb
   version_requirements: *id001
+  name: fakeweb
+  prerelease: false
 - !ruby/object:Gem::Dependency 
+  type: :development
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
+        hash: 3
         segments: 
         - 0
         - 4
-        - 0
-        version: 0.4.0
-  type: :development
-  prerelease: false
-  name: jnunemaker-matchy
+        version: "0.4"
   version_requirements: *id002
+  name: jnunemaker-matchy
+  prerelease: false
 - !ruby/object:Gem::Dependency 
+  type: :development
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -60,11 +60,11 @@ dependencies:
         - 0
         - 9
         version: "0.9"
-  type: :development
-  prerelease: false
-  name: mocha
   version_requirements: *id003
+  name: mocha
+  prerelease: false
 - !ruby/object:Gem::Dependency 
+  type: :development
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -75,11 +75,11 @@ dependencies:
         - 2
         - 11
         version: "2.11"
-  type: :development
-  prerelease: false
-  name: shoulda
   version_requirements: *id004
+  name: shoulda
+  prerelease: false
 - !ruby/object:Gem::Dependency 
+  type: :runtime
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -89,11 +89,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
-  prerelease: false
-  name: json
   version_requirements: *id005
+  name: json
+  prerelease: false
 - !ruby/object:Gem::Dependency 
+  type: :runtime
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -101,15 +101,14 @@ dependencies:
       - !ruby/object:Gem::Version 
         hash: 15
         segments: 
+        - 1
         - 0
-        - 4
-        - 0
-        version: 0.4.0
-  type: :runtime
-  prerelease: false
-  name: hashie
+        version: "1.0"
   version_requirements: *id006
+  name: hashie
+  prerelease: false
 - !ruby/object:Gem::Dependency 
+  type: :runtime
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -118,13 +117,11 @@ dependencies:
         hash: 5
         segments: 
         - 0
-        - 6
-        - 1
-        version: 0.6.1
-  type: :runtime
-  prerelease: false
-  name: httparty
+        - 7
+        version: "0.7"
   version_requirements: *id007
+  name: httparty
+  prerelease: false
 description: A library which implements the complete functionality of v3 of the createsend API.
 email: 
 - jdennes@gmail.com
@@ -233,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: A library which implements the complete functionality of v3 of the createsend API.