patientslikeme-campaign_monitor 1.2 → 1.2.1

data/README.rdoc

@@ -1,18 +1,52 @@
 = campaign_monitor
 
-This library provides access to the Campaign Monitor API (http://www.campaignmonitor.com/api)
+This RubyGem provides access to the Campaign Monitor API (http://www.campaignmonitor.com/api).
 
-== Pre-requisites
+Campaign Monitor recently made some changes to their API.
 
-An account with Campaign Monitor and the API Key. Accounts are free and can be obtained from
-http://www.campaignmonitor.com
+This fork makes the following changes:
 
-== Resources
+    * host changed from http://app.campaignmonitor.com to http://api.createsend.com
+    * ID values are no longer sent #to_i because they are hex strings
+    * added support for subscribers with custom fields using SOAP API
+    * refactored gemspec to build on github
+    * misc. cleanup and refactoring
 
-Install
 
-* gem install patientslikeme-campaign_monitor
+== Pre-requisites
 
-Git Repository
+An account with Campaign Monitor and the API Key. Accounts are free and can be created at
+http://www.campaignmonitor.com.
+
+== Resources
 
-* http://github.com/patientslikeme/campaign_monitor
+=== Install
+gem install patientslikeme-campaign_monitor
+
+=== Git Repository
+http://github.com/patientslikeme/campaign_monitor
+
+
+== Usage
+
+  cm = CampaignMonitor.new # assumes you've set CAMPAIGN_MONITOR_API_KEY in your project
+
+  for client in cm.clients
+    for list in client.lists
+      client.name # => returns the name
+    
+      # modify a subscriber list
+      list.add_subscriber(email, name, custom_fields_hash)
+      list.remove_subscriber(email)
+      list.add_and_resubscribe(email, name, custom_fields_hash)
+    
+      # get subscriber list details
+      subscribers = list.active_subscribers(since_time)
+      unsubscribed = list.unsubscribed(since_time)
+      bounced = list.bounced(since_time)
+    end
+  
+    for campaign in client.campaigns
+  
+    end
+  end

data/campaign_monitor.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.name        = 'campaign_monitor'
-  s.version     = "1.2"
+  s.version     = "1.2.1"
   s.summary     = 'Provides access to the Campaign Monitor API.'
   s.description = <<-EOF
     A simple wrapper class that provides basic access to the Campaign Monitor API.
@@ -25,14 +25,15 @@ Gem::Specification.new do |s|
       'lib/campaign_monitor.rb',
       'lib/campaign_monitor/campaign.rb',
       'lib/campaign_monitor/client.rb',
+      'lib/campaign_monitor/helpers.rb',
       'lib/campaign_monitor/list.rb',
       'lib/campaign_monitor/result.rb',
       'lib/campaign_monitor/subscriber.rb',
       
       'support/faster-xml-simple/lib/faster_xml_simple.rb',
-      'support/faster-xml-simple/test/xml_simple_comparison_test.rb',
       'support/faster-xml-simple/test/regression_test.rb',
-      'support/faster-xml-simple/lib/faster_xml_simple.rb',
+      'support/faster-xml-simple/test/test_helper.rb',
+      'support/faster-xml-simple/test/xml_simple_comparison_test.rb',
       
       'test/campaign_monitor_test.rb',
     ]

data/lib/campaign_monitor.rb

@@ -68,8 +68,8 @@ Dir[File.join(File.dirname(__FILE__), 'campaign_monitor/*.rb')].each do |f|
 end
 
 class CampaignMonitor
-  include Helpers
-
+  include CampaignMonitor::Helpers
+  
   attr_reader :api_key, :api_url
   
   # Replace this API key with your own (http://www.campaignmonitor.com/api/)
@@ -92,7 +92,12 @@ class CampaignMonitor
   # Takes a CampaignMonitor API method name and set of parameters; returns the correct URL for the REST API.
   def request_url(method, params={})
     params.merge!('ApiKey' => api_key)
-    "#{api_url}/#{method}?#{params.to_query}"
+    
+    query = params.collect do |key, value|
+      "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}"
+    end.sort * '&'
+    
+    "#{api_url}/#{method}?#{query}"
   end
 
   # Does an HTTP GET on a given URL and returns the response body
@@ -116,17 +121,13 @@ class CampaignMonitor
   #    puts client.name
   #  end
   def clients
-    response = User_GetClients()
-    handle_response(response) do
+    handle_response(User_GetClients()) do |response|
       response["Client"].collect{|c| Client.new(c["ClientID"], c["Name"])}
     end
   end
   
   def system_date
-    response = User_GetSystemDate()
-    handle_response(response) do
-      response
-    end
+    User_GetSystemDate()
   end
 
   def parsed_system_date
@@ -143,8 +144,7 @@ class CampaignMonitor
   #    puts campaign.subject
   #  end
   def campaigns(client_id)
-    response = Client_GetCampaigns("ClientID" => client_id)
-    handle_response(response) do
+    handle_response(Client_GetCampaigns("ClientID" => client_id)) do |response|
       response["Campaign"].collect{|c| Campaign.new(c["CampaignID"], c["Subject"], c["SentDate"], c["TotalRecipients"].to_i)}
     end
   end
@@ -159,8 +159,7 @@ class CampaignMonitor
   #    puts list.name
   #  end
   def lists(client_id)
-    response = Client_GetLists("ClientID" => client_id)
-    handle_response(response) do
+    handle_response(Client_GetLists("ClientID" => client_id)) do |response|
       response["List"].collect{|l| List.new(l["ListID"], l["Name"])}
     end
   end
@@ -177,6 +176,7 @@ class CampaignMonitor
   def add_subscriber(list_id, email, name)
     Result.new(Subscriber_Add("ListID" => list_id, "Email" => email, "Name" => name))
   end
+  
 
   # Encapsulates
   class SubscriberBounce

data/lib/campaign_monitor/campaign.rb

@@ -1,7 +1,7 @@
 class CampaignMonitor
   # Provides access to the information about a campaign
   class Campaign
-    include Helpers
+    include CampaignMonitor::Helpers
     
     attr_reader :id, :subject, :sent_date, :total_recipients, :cm_client
 

data/lib/campaign_monitor/client.rb

@@ -1,7 +1,7 @@
 class CampaignMonitor
   # Provides access to the lists and campaigns associated with a client
   class Client
-    include Helpers
+    include CampaignMonitor::Helpers
 
     attr_reader :id, :name, :cm_client
 
@@ -21,9 +21,7 @@ class CampaignMonitor
     #    puts list.name
     #  end
     def lists
-      handle_response(cm_client.Client_GetLists("ClientID" => self.id)) do |response|
-        response["List"].collect{|l| List.new(l["ListID"], l["Name"])}
-      end
+      cm_client.lists(self.id)
     end
 
     # Example
@@ -34,9 +32,7 @@ class CampaignMonitor
     #    puts campaign.subject
     #  end
     def campaigns
-      handle_response(cm_client.Client_GetCampaigns("ClientID" => self.id)) do |response|
-        response["Campaign"].collect{|c| Campaign.new(c["CampaignID"], c["Subject"], c["SentDate"], c["TotalRecipients"].to_i)}
-      end
+      cm_client.campaigns(self.id)
     end
   end
 end

data/lib/campaign_monitor/helpers.rb

@@ -0,0 +1,35 @@
+class CampaignMonitor
+  module Helpers
+
+    def handle_response(response)      
+      return [] if response.empty?
+
+      if response["Code"].to_i == 0
+        # success!
+        yield(response)
+      else
+        # error!
+        raise response["Code"] + " - " + response["Message"]
+      end      
+    end
+
+    def wsdl_driver_factory
+      SOAP::WSDLDriverFactory.new("#{api_url}?WSDL")
+    end
+
+    def using_soap
+      driver = wsdl_driver_factory.create_rpc_driver
+      response = yield(driver)
+      driver.reset_stream
+    end
+
+    def timestamp_format
+      '%Y-%m-%d %H:%M:%S'
+    end
+
+    def formatted_timestamp(datetime, format=timestamp_format)
+      datetime.strftime(format)
+    end
+    
+  end
+end

data/lib/campaign_monitor/list.rb

@@ -4,8 +4,8 @@ class CampaignMonitor
   # Provides access to the subscribers and info about subscribers
   # associated with a Mailing List
   class List
-    include Helpers
-    
+    include CampaignMonitor::Helpers
+
     attr_reader :id, :name, :cm_client
 
     # Example

data/lib/campaign_monitor/subscriber.rb

@@ -1,9 +1,10 @@
 class CampaignMonitor
   # Provides the ability to add/remove subscribers from a list
   class Subscriber
-    include Helpers
+    include CampaignMonitor::Helpers
 
     attr_accessor :email_address, :name, :date_subscribed
+    attr_reader :cm_client
 
     def initialize(email_address, name=nil, date=nil)
       @email_address = email_address
@@ -16,25 +17,25 @@ class CampaignMonitor
     #  @subscriber = Subscriber.new("ralph.wiggum@simpsons.net")
     #  @subscriber.add(12345)
     def add(list_id)
-      Result.new(@cm_client.Subscriber_Add("ListID" => list_id, "Email" => @email_address, "Name" => @name))
+      Result.new(cm_client.Subscriber_Add("ListID" => list_id, "Email" => @email_address, "Name" => @name))
     end
 
     # Example
     #  @subscriber = Subscriber.new("ralph.wiggum@simpsons.net")
     #  @subscriber.add_and_resubscribe(12345)
     def add_and_resubscribe(list_id)
-      Result.new(@cm_client.Subscriber_AddAndResubscribe("ListID" => list_id, "Email" => @email_address, "Name" => @name))
+      Result.new(cm_client.Subscriber_AddAndResubscribe("ListID" => list_id, "Email" => @email_address, "Name" => @name))
     end
 
     # Example
     #  @subscriber = Subscriber.new("ralph.wiggum@simpsons.net")
     #  @subscriber.unsubscribe(12345)
     def unsubscribe(list_id)
-      Result.new(@cm_client.Subscriber_Unsubscribe("ListID" => list_id, "Email" => @email_address))
+      Result.new(cm_client.Subscriber_Unsubscribe("ListID" => list_id, "Email" => @email_address))
     end
 
     def is_subscribed?(list_id)
-      result = @cm_client.Subscribers_GetIsSubscribed("ListID" => list_id, "Email" => @email_address)
+      result = cm_client.Subscribers_GetIsSubscribed("ListID" => list_id, "Email" => @email_address)
       return true if result == 'True'
       return false if result == 'False'
       raise "Invalid value for is_subscribed?: #{result}"

data/support/faster-xml-simple/test/test_helper.rb

@@ -0,0 +1,17 @@
+
+require 'test/unit'
+require 'faster_xml_simple'
+
+class FasterXSTest < Test::Unit::TestCase
+  def default_test
+  end
+  
+  def silence_stderr
+    str = STDERR.dup
+    STDERR.reopen("/dev/null")
+    STDERR.sync=true
+    yield
+  ensure
+    STDERR.reopen(str)
+  end
+end

data/test/campaign_monitor_test.rb

@@ -1,6 +1,58 @@
+require 'rubygems'
+require 'campaign_monitor'
+require 'test/unit'
+
+CAMPAIGN_MONITOR_API_KEY  = 'Your API Key'
+CLIENT_NAME               = '_Test'
+LIST_NAME                 = '_List1'
+
 class CampaignMonitorTest < Test::Unit::TestCase
   
   def setup
+    @cm = CampaignMonitor.new    
+  end
+  
+  def test_clients
+    clients = @cm.clients
+    assert clients.size > 0
     
+    assert_equal CLIENT_NAME, find_test_client(clients).name
+  end
+  
+  def test_lists
+    client = find_test_client
+    assert_not_nil client
+
+    lists = client.lists
+    assert lists.size > 0
+    
+    list = find_test_list(lists)
+    assert_equal LIST_NAME, list.name
+  end
+  
+  def test_list_add_subscriber
+    list = find_test_list
+
+    assert_success list.add_and_resubscribe('a@test.com', 'Test A')
+    assert_success list.remove_subscriber('a@test.com')
   end
+  
+  def test_campaigns
+    client = find_test_client
+    assert_not_nil client.campaigns
+  end
+  
+  
+  protected
+    def assert_success(result)
+      assert result.succeeded?, result.message      
+    end
+    
+    def find_test_client(clients=@cm.clients)
+      clients.detect { |c| c.name == CLIENT_NAME }
+    end
+    
+    def find_test_list(lists=find_test_client.lists)
+      lists.detect { |l| l.name == LIST_NAME }
+    end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: patientslikeme-campaign_monitor
 version: !ruby/object:Gem::Version 
-  version: "1.2"
+  version: 1.2.1
 platform: ruby
 authors: 
 - Jeremy Weiskotten
@@ -31,12 +31,14 @@ files:
 - lib/campaign_monitor.rb
 - lib/campaign_monitor/campaign.rb
 - lib/campaign_monitor/client.rb
+- lib/campaign_monitor/helpers.rb
 - lib/campaign_monitor/list.rb
 - lib/campaign_monitor/result.rb
 - lib/campaign_monitor/subscriber.rb
 - support/faster-xml-simple/lib/faster_xml_simple.rb
-- support/faster-xml-simple/test/xml_simple_comparison_test.rb
 - support/faster-xml-simple/test/regression_test.rb
+- support/faster-xml-simple/test/test_helper.rb
+- support/faster-xml-simple/test/xml_simple_comparison_test.rb
 - test/campaign_monitor_test.rb
 has_rdoc: true
 homepage: http://github.com/patientslikeme/campaign_monitor/