patientslikeme-campaign_monitor 1.1 → 1.2

data/README.rdoc

@@ -11,16 +11,8 @@ http://www.campaignmonitor.com
 
 Install
 
-* gem install campaign_monitor
-
-Home Page
-
-* http://github.com/jordanbrock/campaign-monitor-ruby/wikis
-
-Bugtracking
-
-* http://jordanbrock.lighthouseapp.com/projects/13212/home
+* gem install patientslikeme-campaign_monitor
 
 Git Repository
 
-* http://github.com/jordanbrock/campaign-monitor-ruby
+* http://github.com/patientslikeme/campaign_monitor

data/campaign_monitor.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.name        = 'campaign_monitor'
-  s.version     = "1.1"
+  s.version     = "1.2"
   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
+    A simple wrapper class that provides basic access to the Campaign Monitor API.
   EOF
   s.author      = 'Jeremy Weiskotten'
   s.email       = 'jweiskotten@patientslikeme.com'

data/lib/campaign_monitor/campaign.rb

@@ -1,7 +1,9 @@
 class CampaignMonitor
   # Provides access to the information about a campaign
   class Campaign
-    attr_reader :id, :subject, :sent_date, :total_recipients
+    include Helpers
+    
+    attr_reader :id, :subject, :sent_date, :total_recipients, :cm_client
 
     def initialize(id=nil, subject=nil, sent_date=nil, total_recipients=nil)
       @id = id
@@ -19,12 +21,8 @@ class CampaignMonitor
     #    puts subscriber.email
     #  end
     def opens
-      response = @cm_client.Campaign_GetOpens("CampaignID" => @id)
-      return [] if response.empty?
-      unless response["Code"].to_i != 0
+      handle_response(cm_client.Campaign_GetOpens("CampaignID" => self.id)) do |response|
         response["SubscriberOpen"].collect{|s| SubscriberOpen.new(s["EmailAddress"], s["ListID"], s["NumberOfOpens"])}
-      else
-        raise response["Code"] + " - " + response["Message"]
       end
     end
 
@@ -36,12 +34,8 @@ class CampaignMonitor
     #    puts subscriber.email
     #  end
     def bounces
-      response = @cm_client.Campaign_GetBounces("CampaignID"=> @id)
-      return [] if response.empty?
-      unless response["Code"].to_i != 0
+      handle_response(cm_client.Campaign_GetBounces("CampaignID"=> self.id)) do |response|
         response["SubscriberBounce"].collect{|s| SubscriberBounce.new(s["EmailAddress"], s["ListID"], s["BounceType"])}
-      else
-        raise response["Code"] + " - " + response["Message"]
       end
     end
 
@@ -53,12 +47,8 @@ class CampaignMonitor
     #    puts subscriber.email
     #  end
     def clicks
-      response = @cm_client.Campaign_GetSubscriberClicks("CampaignID" => @id)
-      return [] if response.empty?
-      unless response["Code"].to_i != 0
+      handle_response(cm_client.Campaign_GetSubscriberClicks("CampaignID" => self.id)) do |response|
         response["SubscriberClick"].collect{|s| SubscriberClick.new(s["EmailAddress"], s["ListID"], s["ClickedLinks"])}
-      else
-        raise response["Code"] + " - " + response["Message"]
       end
     end
 
@@ -70,12 +60,8 @@ class CampaignMonitor
     #    puts subscriber.email
     #  end
     def unsubscribes
-      response = @cm_client.Campaign_GetUnsubscribes("CampaignID" => @id)
-      return [] if response.empty?
-      unless response["Code"].to_i != 0
+      handle_response(cm_client.Campaign_GetUnsubscribes("CampaignID" => self.id)) do |response|
         response["SubscriberUnsubscribe"].collect{|s| SubscriberUnsubscribe.new(s["EmailAddress"], s["ListID"])}
-      else
-        raise response["Code"] + " - " + response["Message"]
       end
     end
 
@@ -83,47 +69,51 @@ class CampaignMonitor
     #  @campaign = Campaign.new(12345)
     #  puts @campaign.number_recipients
     def number_recipients
-      @number_recipients.nil? ? getInfo.number_recipients : @number_recipients
+      @number_recipients ||= attributes[:number_recipients]
     end
 
     # Example
     #  @campaign = Campaign.new(12345)
     #  puts @campaign.number_opened
     def number_opened
-      @number_opened.nil? ? getInfo.number_opened : @number_opened
+      @number_opened ||= attributes[:number_opened]
     end
 
     # Example
     #  @campaign = Campaign.new(12345)
     #  puts @campaign.number_clicks
     def number_clicks
-      @number_clicks.nil? ? getInfo.number_clicks : @number_clicks
+      @number_clicks ||= attributes[:number_clicks]
     end
 
     # Example
     #  @campaign = Campaign.new(12345)
     #  puts @campaign.number_unsubscribed
     def number_unsubscribed
-      @number_unsubscribed.nil? ? getInfo.number_unsubscribed : @number_unsubscribed
+      @number_unsubscribed ||= attributes[:number_unsubscribed]
     end
 
     # Example
     #  @campaign = Campaign.new(12345)
     #  puts @campaign.number_bounced
     def number_bounced
-      @number_bounced.nil? ? getInfo.number_bounced : @number_bounced
+      @number_bounced ||= attributes[:number_bounced]
     end
 
     private
-      def getInfo
-        info = @cm_client.Campaign_GetSummary('CampaignID'=>@id)
-        @title = info['title']
-        @number_recipients = info["Recipients"].to_i
-        @number_opened = info["TotalOpened"].to_i
-        @number_clicks = info["Click"].to_i
-        @number_unsubscribed = info["Unsubscribed"].to_i
-        @number_bounced = info["Bounced"].to_i
-        self
+      def attributes
+        if @attributes.nil?
+          summary = cm_client.Campaign_GetSummary('CampaignID' => self.id)
+          @attributes = {
+            :number_recipients   => summary['Recipients'].to_i,
+            :number_opened       => summary['TotalOpened'].to_i,
+            :number_clicks       => summary['Click'].to_i,
+            :number_unsubscribed => summary['Unsubscribed'].to_i,
+            :number_bounced      => summary['Bounced'].to_i
+          }
+        end
+        
+        @attributes
       end
   end
 end

data/lib/campaign_monitor/client.rb

@@ -1,6 +1,8 @@
 class CampaignMonitor
   # Provides access to the lists and campaigns associated with a client
   class Client
+    include Helpers
+
     attr_reader :id, :name, :cm_client
 
     # Example
@@ -19,12 +21,8 @@ class CampaignMonitor
     #    puts list.name
     #  end
     def lists
-      response = @cm_client.Client_GetLists("ClientID" => @id)
-      return [] if response.empty?
-      unless response["Code"].to_i != 0
+      handle_response(cm_client.Client_GetLists("ClientID" => self.id)) do |response|
         response["List"].collect{|l| List.new(l["ListID"], l["Name"])}
-      else
-        raise response["Code"] + " - " + response["Message"]
       end
     end
 
@@ -36,11 +34,8 @@ class CampaignMonitor
     #    puts campaign.subject
     #  end
     def campaigns
-      response = @cm_client.Client_GetCampaigns("ClientID" => @id)
-      unless response["Code"].to_i != 0
+      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)}
-      else
-        raise response["Code"] + " - " + response["Message"]
       end
     end
   end

data/lib/campaign_monitor/list.rb

@@ -1,7 +1,11 @@
+require 'soap/wsdlDriver'
+
 class CampaignMonitor
   # Provides access to the subscribers and info about subscribers
   # associated with a Mailing List
   class List
+    include Helpers
+    
     attr_reader :id, :name, :cm_client
 
     # Example
@@ -19,8 +23,20 @@ class CampaignMonitor
     #  if result.succeeded?
     #    puts "Added Subscriber"
     #  end
-    def add_subscriber(email, name = nil)
-      Result.new(@cm_client.Subscriber_Add("ListID" => @id, "Email" => email, "Name" => name))
+    def add_subscriber(email, name=nil, custom_fields=nil)
+      if custom_fields.nil?
+        Result.new(cm_client.Subscriber_Add("ListID" => self.id, "Email" => email, "Name" => name))
+      else
+        add_subscriber_with_custom_fields(email, name, custom_fields)
+      end
+    end
+    
+    def add_and_resubscribe(email, name=nil, custom_fields=nil)
+      if custom_fields.nil?
+        Result.new(cm_client.Subscriber_AddAndResubscribe("ListID" => self.id, "Email" => email, "Name" => name))        
+      else
+        add_and_resubscribe_with_custom_fields(email, name, custom_fields)
+      end
     end
 
     # Example
@@ -31,7 +47,39 @@ class CampaignMonitor
     #    puts "Deleted Subscriber"
     #  end
     def remove_subscriber(email)
-      Result.new(@cm_client.Subscriber_Unsubscribe("ListID" => @id, "Email" => email))
+      Result.new(cm_client.Subscriber_Unsubscribe("ListID" => self.id, "Email" => email))
+    end
+
+    # email           The subscriber's email address.
+    # name            The subscriber's name.
+    # custom_fields   A hash of field name => value pairs.
+    def add_subscriber_with_custom_fields(email, name, custom_fields)
+      response = using_soap do |driver|
+        driver.addSubscriberWithCustomFields \
+            :ApiKey       => api_key,
+            :ListID       => self.id,
+            :Email        => email,
+            :Name         => name,
+            :CustomFields => { :SubscriberCustomField => custom_fields_array(custom_fields) }
+      end
+      
+      response.subscriber_AddWithCustomFieldsResult
+    end
+
+    # email           The subscriber's email address.
+    # name            The subscriber's name.
+    # custom_fields   A hash of field name => value pairs.
+    def add_and_resubscribe_with_custom_fields(email, name, custom_fields)      
+      response = using_soap do |driver|
+        driver.addAndResubscribeWithCustomFields \
+            :ApiKey       => api_key,
+            :ListID       => self.id,
+            :Email        => email,
+            :Name         => name,
+            :CustomFields => { :SubscriberCustomField => custom_fields_array(custom_fields) }
+      end
+
+      response.subscriber_AddAndResubscribeWithCustomFieldsResult
     end
 
     # Example
@@ -43,12 +91,9 @@ class CampaignMonitor
     #    puts subscriber.email
     #  end
     def active_subscribers(date)
-      response = @cm_client.Subscribers_GetActive('ListID' => @id, "Date" => date.strftime("%Y-%m-%d %H:%M:%S"))
-      return [] if response.empty?
-      unless response["Code"].to_i != 0
-        response["Subscriber"].collect{|s| Subscriber.new(s["EmailAddress"], s["Name"], s["Date"])}
-      else
-        raise response["Code"] + " - " + response["Message"]
+      response = cm_client.Subscribers_GetActive('ListID' => self.id, 'Date' => formatted_timestamp(date))
+      handle_response(response) do
+        response['Subscriber'].collect{|s| Subscriber.new(s['EmailAddress'], s['Name'], s['Date'])}
       end
     end
 
@@ -61,12 +106,12 @@ class CampaignMonitor
     #    puts subscriber.email
     #  end
     def unsubscribed(date)
-      response = @cm_client.Subscribers_GetUnsubscribed('ListID' => @id, 'Date' => date.strftime("%Y-%m-%d %H:%M:%S"))
-      return [] if response.empty?
-      unless response["Code"].to_i != 0
-        response["Subscriber"].collect{|s| Subscriber.new(s["EmailAddress"], s["Name"], s["Date"])}
-      else
-        raise response["Code"] + " - " + response["Message"]
+      date = formatted_timestamp(date) unless date.is_a?(String)
+      
+      response = cm_client.Subscribers_GetUnsubscribed('ListID' => self.id, 'Date' => date)
+      
+      handle_response(response) do
+        response['Subscriber'].collect{|s| Subscriber.new(s['EmailAddress'], s['Name'], s['Date'])}
       end
     end
 
@@ -79,14 +124,24 @@ class CampaignMonitor
     #    puts subscriber.email
     #  end
     def bounced(date)
-      response = @cm_client.Subscribers_GetBounced('ListID' => @id, 'Date' => date.strftime("%Y-%m-%d %H:%M:%S"))
-      return [] if response.empty?
-      unless response["Code"].to_i != 0
-        response["Subscriber"].collect{|s| Subscriber.new(s["EmailAddress"], s["Name"], s["Date"])}
-      else
-        raise response["Code"] + " - " + response["Message"]
+      response = cm_client.Subscribers_GetBounced('ListID' => self.id, 'Date' => formatted_timestamp(date))
+
+      handle_response(response) do
+        response["Subscriber"].collect{|s| Subscriber.new(s["EmailAddress"], s["Name"], s["Date"])}        
       end
     end
+    
+
+    protected
+    
+      # Converts hash of custom field name/values to array of hashes for the SOAP API.
+      def custom_fields_array(custom_fields)
+        arr = []
+        custom_fields.each do |key, value|
+          arr << { "Key" => key, "Value" => value }
+        end
+        arr
+      end
 
   end
 end

data/lib/campaign_monitor/subscriber.rb

@@ -1,6 +1,8 @@
 class CampaignMonitor
   # Provides the ability to add/remove subscribers from a list
   class Subscriber
+    include Helpers
+
     attr_accessor :email_address, :name, :date_subscribed
 
     def initialize(email_address, name=nil, date=nil)

data/lib/campaign_monitor.rb

@@ -68,12 +68,16 @@ Dir[File.join(File.dirname(__FILE__), 'campaign_monitor/*.rb')].each do |f|
 end
 
 class CampaignMonitor
+  include Helpers
+
+  attr_reader :api_key, :api_url
+  
   # Replace this API key with your own (http://www.campaignmonitor.com/api/)
   def initialize(api_key=CAMPAIGN_MONITOR_API_KEY)
     @api_key = api_key
-    @host = 'http://api.createsend.com'
-    @api = '/api/api.asmx/'
+    @api_url = 'http://api.createsend.com/api/api.asmx'
    end
+   
 
    # Takes a CampaignMonitor API method name and set of parameters;
    # returns an XmlSimple object with the response
@@ -87,11 +91,8 @@ 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={})
-    url = "#{@host}#{@api}/#{method}?ApiKey=#{@api_key}"
-    params.each_pair do |key, val|
-      url += "&#{key}=" + CGI::escape(val.to_s)
-    end
-    url
+    params.merge!('ApiKey' => api_key)
+    "#{api_url}/#{method}?#{params.to_query}"
   end
 
   # Does an HTTP GET on a given URL and returns the response body
@@ -116,14 +117,22 @@ class CampaignMonitor
   #  end
   def clients
     response = User_GetClients()
-    return [] if response.empty?
-    unless response["Code"].to_i != 0
+    handle_response(response) do
       response["Client"].collect{|c| Client.new(c["ClientID"], c["Name"])}
-    else
-      raise response["Code"] + " - " + response["Message"]
+    end
+  end
+  
+  def system_date
+    response = User_GetSystemDate()
+    handle_response(response) do
+      response
     end
   end
 
+  def parsed_system_date
+    DateTime.strptime(system_date, timestamp_format)
+  end
+  
   # Returns an array of Campaign objects associated with the specified Client ID
   #
   # Example
@@ -135,11 +144,8 @@ class CampaignMonitor
   #  end
   def campaigns(client_id)
     response = Client_GetCampaigns("ClientID" => client_id)
-    return [] if response.empty?
-    unless response["Code"].to_i != 0
+    handle_response(response) do
       response["Campaign"].collect{|c| Campaign.new(c["CampaignID"], c["Subject"], c["SentDate"], c["TotalRecipients"].to_i)}
-    else
-      raise response["Code"] + " - " + response["Message"]
     end
   end
 
@@ -154,11 +160,8 @@ class CampaignMonitor
   #  end
   def lists(client_id)
     response = Client_GetLists("ClientID" => client_id)
-    return [] if response.empty?
-    unless response["Code"].to_i != 0
+    handle_response(response) do
       response["List"].collect{|l| List.new(l["ListID"], l["Name"])}
-    else
-      raise response["Code"] + " - " + response["Message"]
     end
   end
 
@@ -217,6 +220,7 @@ class CampaignMonitor
       @list_id = list_id
     end
   end
+    
 end
 
 # If libxml is installed, we use the FasterXmlSimple library, that provides most of the functionality of XmlSimple

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: patientslikeme-campaign_monitor
 version: !ruby/object:Gem::Version 
-  version: "1.1"
+  version: "1.2"
 platform: ruby
 authors: 
 - Jeremy Weiskotten
@@ -13,7 +13,7 @@ date: 2008-12-22 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
-description: A simple wrapper class that provides basic access to the Campaign Monitor API
+description: A simple wrapper class that provides basic access to the Campaign Monitor API.
 email: jweiskotten@patientslikeme.com
 executables: []