gnumarcelo-campaigning 0.7.0 → 0.8.0

data/README.rdoc

@@ -1,16 +1,47 @@
-== THIS GEM IS UNDER DEVELOPMENT
-
-= campaigning
+= Campaigning
 
 This RubyGem provides access to the CampaignMonitor API(www.campaignmonitor.com/api) using SOAP.
 
-== Dependencies
-This gem requires the following gems
+
+== Pre-requisites
+An account with Campaign Monitor and the API Key (www.campaignmonitor.com).
+
+
+== Resources
+
+=== Dependencies
+
+This gem requires the following gems:
  
  Soap4r (1.5.8)
  
  Jeweler (http://technicalpickles.com/posts/craft-the-perfect-gem-with-jeweler)
 
+=== Installing
+
+  sudo gem install gnumarcelo-campaigning -s http://gems.github.com
+
+
+== How to play
+
+Just set a constant named *CAMPAIGN_MONITOR_API_KEY* with your Campaign monitor API key and start to play like the examples below:
+
+Sample use of the Client class:
+
+  #Here is how to get a list of all clients...
+  clients = Campaigning::Client.get_all_clients
+
+
+  #Here is how to create a brand new subscriber list for an Client
+  client = Campaigning::Client.find_by_name("Client One Company")
+  list = Campaigning::List.create(
+    :client_id => client.clientID,
+    :title => "List of people from Brazil",
+    :comfirm_opt_in => false
+  )
+
+For further examples please check at the *sample* directory.
+
 
 == Copyright
 

data/Rakefile

@@ -53,5 +53,7 @@ Rake::RDocTask.new do |rdoc|
   rdoc.title = "campaigning #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.exclude('lib/campaigning/soap/generated/*.rb')
+  rdoc.options << "--inline-source"
 end
 

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
-:minor: 7
+:minor: 8
 :patch: 0

data/lib/campaigning/campaigning.rb

@@ -7,37 +7,29 @@ require File.expand_path(File.dirname(__FILE__)) + '/types/list.rb'
 require File.expand_path(File.dirname(__FILE__)) + '/helpers/helpers.rb'
 
 module Campaigning
-class Base
   include Helpers
-  attr_reader :api_key 
 
-  def initialize(options = {})
-    options = {
-      :api_key => CAMPAIGN_MONITOR_API_KEY,
-      :debug => false
-    }.merge(options)
-    @api_key = options[:api_key]
-    @soap = Campaigning::SOAPDriver.instance.get_driver
-    setup_debug_mode options[:debug]
+  #Gets the server system time for your time zone.
+  #This is handy for when you are syncing your {Campaign Monitor}[http://www.campaignmonitor.com] lists with some other in-house list,
+  #allowing you accurately determine the time on our server when you carry out the synchronization.
+  def self.system_date
+    response = Campaigning::SOAPDriver.instance.get_driver.getSystemDate(:apiKey => CAMPAIGN_MONITOR_API_KEY)
+    dateTime = Helpers.handle_request response.user_GetSystemDateResult
   end
-
-  def clients
-    response = @soap.getClients(:apiKey => @api_key)
-    clients = handle_request response.user_GetClientsResult
-    clients.collect {|client| Client.new(client.clientID, client.name)}
-  end
-
-  def system_date
-    handle_request @soap.getSystemDate(:apiKey => @api_key).user_GetSystemDateResult
+  
+  #This method returns an Array of Strings representing all the available timezones.
+  def self.time_zones
+    Helpers.handle_request Campaigning::SOAPDriver.instance.get_driver.getTimezones(:apiKey => CAMPAIGN_MONITOR_API_KEY).user_GetTimezonesResult
   end
   
-  def time_zones
-    handle_request @soap.getTimezones(:apiKey => @api_key).user_GetTimezonesResult
+  #This method returns an Array of Strings representing all the available countries.
+  def self.countries
+    response = Campaigning::SOAPDriver.instance.get_driver.getCountries(:apiKey => CAMPAIGN_MONITOR_API_KEY)
+    dateTime = Helpers.handle_request response.user_GetCountriesResult
   end
   
-  def setup_debug_mode(dev)
+  #This method turns on and off the API debug mode, which will display at the console all SOAP requests made to the API server.
+  def self.setup_debug_mode(dev)
     Campaigning::SOAPDriver.instance.setup_debug_mode dev
-  end
-    
-end
+  end    
 end

data/lib/campaigning/helpers/helpers.rb

@@ -1,14 +1,19 @@
-  module Helpers
-    
-    def handle_request(response)
-      Helpers.handle_request response
+module Campaigning
+module Helpers
+  #Method responsable to handle all response from the API server and raising an exception when
+  #the API returns an error code (different from 0 (zero) ).
+  def handle_request(response)
+    Helpers.handle_request response
+  end
+  
+  #Method responsable to handle all response from the API server and raising an exception when
+  #the API returns an error code (different from 0 (zero) ).
+  def Helpers.handle_request(response)
+    if (response.class == Campaigning::Result && response.code != 0)
+       raise response.code.to_s + " - " + response.message
     end
-    
-    def Helpers.handle_request(response)
-      if (response.class == Campaigning::Result && response.code != 0)
-         raise response.code.to_s + " - " + response.message
-      end
-      response
-    end
-    
-  end
+    response
+  end
+  
+end
+end

data/lib/campaigning/soap/soap_driver.rb

@@ -2,14 +2,20 @@ require File.expand_path(File.dirname(__FILE__)) + '/generated/defaultDriver.rb'
 require 'singleton'
 
 module Campaigning
+  #A SOAPDriver is a singleton object responsable to supply a way to interact with the SOAP::RPC::Driver object.
   class SOAPDriver #It could be a module
     include Singleton
     DefaultEndpointUrl = "http://api.createsend.com/api/api.asmx"
     
+    #Return a unique Campaigning::SOAP::ApiSoap instance for the whole API client, which provides access to
+    #all the Campaign Monitor API methods.
     def get_driver
       @driver ||= Campaigning::ApiSoap.new(DefaultEndpointUrl)
     end
     
+    #This method turns the API debug mode to _on_ and _off_.
+    #When method called with _true_ argument, it will switch to _on_ mode, the API will display at the console all
+    #SOAP requests made to the API server.
     def setup_debug_mode(dev)
       dev = STDERR if dev == true
       @driver.wiredump_dev = dev

data/lib/campaigning/types/campaign.rb

@@ -20,6 +20,29 @@ module Campaigning
       @soap = Campaigning::SOAPDriver.instance.get_driver
     end
     
+    #Creates a campaign for an existing client. This campaign will be imported and ready to send to the subscribers in
+    #the specified lists and segments.
+    #The campaign must have both HTML and plain text content, imported from the internet. Styling for the HTML content
+    #will be automatically brought inline.
+    #
+    #Available _params_ argument are:
+    #   * :clientID - The ID of the Client you want to create a campaign
+    #   * :campaignName - The name of the new campaign. This must be unique across all draft campaigns for the client.
+    #   * :campaignSubject - The subject of the new campaign.
+    #   * :fromName - The name to appear in the From field in the recipients email client when they receive the new campaign.
+    #   * :fromEmail - The email address that the new campaign will come from.
+    #   * :replyTo - The email address that any replies to the new campaign will be sent to.
+    #   * :htmlUrl - The URL of the HTML content for the new campaign. If no unsubscribe link is found then one will be added automatically. Styling in
+    #                the campaign will be automatically brought inline. If your URL has querystring values, you will need to encode them.
+    #   * :textUrl - The URL of the Text content for the new campaign. If no unsubscribe link is found then one will be added automatically.
+    #   * :subscriberListIDs - An array of lists to send the campaign to. See http://www.campaignmonitor.com/api/required/#listid for more details.
+    #   * :listSegments - An array of Segment Names and their appropriate List ID s to send the campaign to.
+    #
+    #*Return*:
+    #
+    #*Success*: Upon a successful call, this method will return a Campaigning::Campaign object which was recently created.
+    #
+    #*Error*: An Exception containing the cause of the error will be raised.    
     def self.create(params)  
         response = Campaigning::SOAPDriver.instance.get_driver.createCampaign(
            :apiKey => CAMPAIGN_MONITOR_API_KEY,
@@ -39,36 +62,118 @@ module Campaigning
         Campaign.new campaign_id
     end
     
+    #Gets a list of all subscribers who bounced for a given campaign, and the type of bounce (H=Hard Bounce, S=Soft Bounce).
+    #
+    #*Return*:
+    #
+    #*Success*: Upon a successful call, this method will return a collection of <code>SubscriberBounce</code> objects, each of
+    #which consists of the subscribers <code>:emailAddress</code>, the <code>listID</code> they belong to, and the <code>bounceType</code>
+    #of bounce they experienced, whether hard or soft.
+    #
+    #*Error*: An Exception containing the cause of the error will be raised.
     def bounces
       response = @soap.getCampaignBounces(:apiKey => CAMPAIGN_MONITOR_API_KEY, :campaignID => @campaignID )
       handle_request response.campaign_GetBouncesResult
     end
     
+    #Returns an array of Campaigning::List objects that a given campaign was sent to.
+    #
+    #*Return*:
+    #
+    #*Success*: Upon a successful call, this method will return a collection of Campaigning::List object.
+    #
+    #*Error*: An Exception containing the cause of the error will be raised.
     def lists
       response = @soap.getCampaignLists(:apiKey => CAMPAIGN_MONITOR_API_KEY, :campaignID => @campaignID )
-      handle_request response.campaign_GetListsResult
+      lists = handle_request response.campaign_GetListsResult
+      puts "LISTAS!!!!!!!!!!" + lists.inspect
+      lists.collect do |list|  
+        List.new(list.listID, list.name)
+      end
     end
     
+    #Gets a list of all subscribers who opened a given campaign, and the number of times they opened the campaign.
+    #
+    #*Return*:
+    #
+    #*Success*: Upon a successful call, this method will return a collection of <code>SubscriberOpen</code> objects, each of
+    #which consists of the subscribers <code>:emailAddress</code>, the <code>listID</code> they belong to, and the <code>numberOfOpens</code>
+    #representing the number of times they opened the given campaign.
+    #
+    #*Error*: An Exception containing the cause of the error will be raised.
     def opens
       response = @soap.getCampaignOpens(:apiKey => CAMPAIGN_MONITOR_API_KEY, :campaignID => @campaignID )
       handle_request response.campaign_GetOpensResult
     end
     
+    #Gets a list of all subscribers who clicked a link for a given campaign, the ID of the list they belong to,
+    #the links they clicked, and the number of times they clicked the link.
+    #
+    #Example of usage:
+    #
+    # campaign_obj.subscriber_clicks.each do |subscriber|
+    #   puts "Subscriber: #{subscriber.emailAddress}"
+    #   subscriber.clickedLinks.each do |clicked| 
+    #     puts "Clicked link: #{clicked.link} - Number of clicks: #{clicked.clicks}"
+    #   end
+    # end
+    #
+    #
+    #*Return*:
+    #
+    #*Success*: Upon a successful call, this method will return a collection of <code>SubscriberClick</code> objects, each of which consists of
+    #the subscribers <code>emailAddress</code>, the <code>listID</code> representing list they belong to, and the <code>clickedLinks</code>array 
+    #representing the links they have clicked and the number of times they clicked each link.
+    #
+    #*Error*: An Exception containing the cause of the error will be raised.
     def subscriber_clicks
       response = @soap.getSubscriberClicks(:apiKey => CAMPAIGN_MONITOR_API_KEY, :campaignID => @campaignID )
       handle_request response.campaign_GetSubscriberClicksResult
     end
     
+    #Gets a statistical summary, including number of recipients and open count, for a given campaign.
+    #
+    #*Return*:
+    #
+    #*Success*: Upon a successful call, this method will return summary statistical values about this particular campaign
+    #including the number of recipients, the number of total opens, the number of link clicks, the number of recipients
+    #who unsubscribed and the number who bounced.
+    #
+    #*Error*: An Exception containing the cause of the error will be raised.
     def summary
       response = @soap.getCampaignSummary(:apiKey => CAMPAIGN_MONITOR_API_KEY, :campaignID => @campaignID )
       handle_request response.campaign_GetSummaryResult
     end
     
+    #Gets a list of all subscribers who unsubscribed for a given campaign.
+    #
+    #*Return*:
+    #
+    #*Success*: Upon a successful call, this method will return a collection of SubscriberUnsubscribe objects, each of which consists
+    #of the <code>emailAddress</code> representing subscribers email address and the <code>listID</code> representing the list they belong to.
+    #
+    #*Error*: An Exception containing the cause of the error will be raised.
     def unsubscribes
       response = @soap.getCampaignUnsubscribes(:apiKey => CAMPAIGN_MONITOR_API_KEY, :campaignID => @campaignID )
       handle_request response.campaign_GetUnsubscribesResult
     end
     
+    #Schedules an existing campaign for sending.
+    #
+    #The campaign must be imported with defined recipients. For campaigns with more than 5 recipients the user must have
+    #sufficient credits or their credit card details saved within the application for the campaign to be sent via the API.
+    #For campaigns with 5 recipients or less the user must have enough test campaigns remaining in their API account.
+    #For further information about credits for campaigns please check at: http://www.campaignmonitor.com/api/method/campaign-send/
+    #
+    #Available _params_ argument are:
+    #   * :confirmation_email - The email address that the confirmation email that the campaign has been sent will go to.
+    #   * :send_date - The date the campaign should be scheduled to be sent. To send a campaign immediately pass in "Immediately".
+    #                  This date should be in the users timezone and formatted as YYYY-MM-DD HH:MM:SS.
+    #
+    #*Return*:
+    #Upon a successful call, this method will return a Result object with the newly create Campaign's ID as the Code.
+    #
+    #*Error*: An Exception containing the cause of the error will be raised.
     def send(params)
       response = @soap.sendCampaign(
         :apiKey => CAMPAIGN_MONITOR_API_KEY,

data/lib/campaigning/types/client.rb

@@ -12,28 +12,84 @@ class Client
   def initialize(clientID = nil, name = nil)
     @clientID = clientID
     @name = name
-    #@cm = Campaigning::Base.new
     @soap = Campaigning::SOAPDriver.instance.get_driver
   end
   
+  #Gets a list of all subscriber lists for a client.
+  #
+  #*Return*:
+  #
+  #*Success*: Upon a successful call, this method will return a collection of Campaigning::List objects.
+  #
+  #*Error*: An Exception containing the cause of the error will be raised.
   def lists
     response = @soap.getClientLists(:apiKey => CAMPAIGN_MONITOR_API_KEY, :clientID => @clientID)
     lists = handle_request response.client_GetListsResult
     lists.collect {|list| List.new(list.listID, list.name)}
   end
   
+  #This method find a List by a given name
+  #
+  #*Return*:
+  #
+  #*Success*:
+  #
+  #List FOUND: If it found any client with the given name it will return a Campaigning::List object containing the found list.
+  #
+  #List NOT FOUND: If it doesn't found a list with the given name it will return +nil+ .
+  #
+  #*Error*: An Exception containing the cause of the error will be raised.
   def find_list_by_name(list_name)
     lists.find {|list| list_name == list.name}
   end 
   
-  # TODO: Refactor this method and increase performance? 
-  # TODO: Tha campaign monitor permit two users with the same name, what to do? 
+  #This method find a Client by a given name
+  #
+  #*Return*:
+  #
+  #Client FOUND: If it found any client with the given name it will return a Campaigning::Client object containing the found client.
+  #
+  #Client NOT FOUND: If it doesn't found a client with the given name it will return +nil+ .
+  #
+  #*Error*: An Exception containing the cause of the error will be raised.
+  #-- TODO: Refactor this method and increase performance? 
+  #-- TODO: Tha campaign monitor permit two users with the same name, what to do? 
   def self.find_by_name(name)
-    client_list = Helpers.handle_request Campaigning::Base.new.clients  
+    client_list = Client.get_all_clients 
     client_found = client_list.find {|client| name == client.name}
     Client.new(client_found.clientID, client_found.name) if client_found
   end
   
+  #Gets all clients for a given user (CAMPAIGN_MONITOR_API_KEY).
+  #
+  #*Return*:
+  #
+  #*Success*: Upon a successful call, this method will return a collection of Campaigning::Client objects.
+  #
+  #*Error*: An Exception containing the cause of the error will be raised.
+  def self.get_all_clients
+    response = Campaigning::SOAPDriver.instance.get_driver.getClients(:apiKey => CAMPAIGN_MONITOR_API_KEY)
+    clients = Helpers.handle_request response.user_GetClientsResult
+    clients.collect {|client| Client.new(client.clientID, client.name)}
+  end
+  
+  #This method creates a brand new client with no access to the application.
+  #By default a new client has no direct access to the application. Access and billing settings (if needed) must be set by
+  #means of a subsequent call to Campaigning::Client#update_access_and_billing.
+  #
+  #Available _params_ argument are:
+  #   * :company_name - The client company name.
+  #   * :contact_name - The personal name of the principle contact for this client.
+  #   * :email_address - An email address to which this client will be sent application-related emails.
+  #   * :country - This client's country. A valid country list is available in http://www.campaignmonitor.com/api/countries/ or by
+  #                using the API procedure Campaigning.countries
+  #   * :time_zone - Client timezone for tracking and reporting data. A valid timezone list is available here or by using the API
+  #                  procedure Campaigning.time_zones.
+  #*Return*:
+  #
+  #*Success*: Upon a successful call, this method will return a Campaigning::Client object representing the newly created client.
+  #
+  #*Error*: An Exception containing the cause of the error will be raised.
   def self.create(params)
     response = Campaigning::SOAPDriver.instance.get_driver.createClient(
       :apiKey => CAMPAIGN_MONITOR_API_KEY,
@@ -43,33 +99,75 @@ class Client
       :country => params[:country],
       :timezone => params[:time_zone]
     )
-    Client.new( Helpers.handle_request(response.client_CreateResult) )
+    Client.new( Helpers.handle_request(response.client_CreateResult), params[:company_name] )
   end
   
+  #Deletes a client from your account.
+  #
+  #*Return*:
+  #
+  #*Success*: Upon a successful call, this method will return a Campaigning::Result object wich consists of a +code+ and +message+ fields
+  #containing a successful message.
+  #
+  #*Error*: An Exception containing the cause of the error will be raised.
   def delete
-    Client.delete(@clientID)
-    self.clientID = nil
-    self.name = nil
+    response = Client.delete(@clientID)
+    self.clientID, self.name = nil
+    response
   end
   
+  #Deletes a client from your account.
+  #
+  #*Return*:
+  #
+  #*Success*: Upon a successful call, this method will return a Campaigning::Result object wich consists of a +code+ and +message+ fields
+  #containing a successful message.
+  #
+  #*Error*: An Exception containing the cause of the error will be raised.
   def self.delete(client_id)
     response = Campaigning::SOAPDriver.instance.get_driver.deleteClient(:apiKey => CAMPAIGN_MONITOR_API_KEY, :clientID => client_id)
     Helpers.handle_request response.client_DeleteResult
   end
   
-  def segments
+  #Gets a list of all subscriber segments for a client.
+  #
+  #*Return*:
+  #
+  #*Success*: Upon a successful call, this method will return a collection of Campaigning::List objects, each of which consists of the ListID
+  #for the parent list and Segment Name for each segment for a client.
+  #
+  #*Error*: An Exception containing the cause of the error will be raised.
+  def segments # TODO: Verify the type return for this method.
     response = @soap.getClientSegments(:apiKey => CAMPAIGN_MONITOR_API_KEY, :clientID => @clientID )
     handle_request response.client_GetSegmentsResult
   end
   
-  # TODO: Refactor this method
-  def find_campaigns_by_subject(subject)
+  #This method finds campaigns by a given subject, since the subject isn't unique, it returns an collection of
+  #Campaigning::Campaign object.
+  #
+  #*Return*:
+  #
+  #*Success*: Upon a successful call, this method will return a collection of Campaigning::Campaign objects.
+  #
+  #Campaign FOUND: If it found any campaign with the given subject it will return a collection of Campaigning::Campaign that match the criteria.
+  #
+  #Campaign NOT FOUND: If it doesn't found a campaign with the given subject it will return an empty array.
+  #
+  #*Error*: An Exception containing the cause of the error will be raised.
+  def find_campaigns_by_subject(subject)#-- TODO: Refactor this method
     arr = []
     #return campaigns.find {|campaign| subject == campaign.subject} if params[:single] 
     campaigns.each { |campaign| arr << campaign if campaign.subject == subject }
     arr
   end
   
+  #Gets a list of all campaigns that have been sent for a client.
+  #
+  #*Return*:
+  #
+  #*Success*: Upon a successful call, this method will return a collection of Campaigning::Campaign objects.
+  #
+  #*Error*: An Exception containing the cause of the error will be raised.
   def campaigns
     response = @soap.getClientCampaigns(:apiKey => CAMPAIGN_MONITOR_API_KEY, :clientID => @clientID )    
     campaign_list = handle_request response.client_GetCampaignsResult
@@ -78,32 +176,123 @@ class Client
     end
   end
   
+  #This method gets the complete account and billing details for a particular client.
+  #
+  #Example of usage:
+  # client_details = client_obj.details
+  # basic_details = client_details.basicDetails
+  # access_and_billing_details = client_details.accessAndBilling
+  # puts "Basic details:"
+  # puts "Client ID: #{basic_details.clientID}\n
+  #       Company: #{basic_details.companyName}\n
+  #       Contact: #{basic_details.contactName}\n
+  #       Country: #{basic_details.country}\n
+  #       Timezone: #{basic_details.timezone}"
+  # 
+  # puts "Access and Billing Details:"
+  # puts "Username: #{access_and_billing_details.username}\n 
+  #       Password: #{access_and_billing_details.password}\n
+  #       Billing Type: #{access_and_billing_details.billingType}\n
+  #       Currency: #{access_and_billing_details.currency}\n
+  #       Delivery Fee: #{access_and_billing_details.deliveryFee}\n
+  #       Cost per Recipient: #{access_and_billing_details.costPerRecipient}\n
+  #       Design and Span test Fee: #{access_and_billing_details.designAndSpamTestFee}\n
+  #       Access Level: #{access_and_billing_details.accessLevel}"
+  #
+  #*Return*:
+  #
+  #*Success*: A successful call to this method will return a ClientDetail object, comprised of ClientBasicDetails 
+  #and ClientAccessAndBilling.
+  #
+  #*Error*: An Exception containing the cause of the error will be raised.
   def details
     response = @soap.getClientDetail(:apiKey => CAMPAIGN_MONITOR_API_KEY, :clientID => @clientID )    
     handle_request response.client_GetDetailResult
   end
   
+  #Gets all subscribers in the client-wide suppression list.
+  #
+  #*Return*:
+  #
+  #*Success*: Upon a successful call, this method will return a collection of Subscriber objects.
+  #
+  #*Error*: An Exception containing the cause of the error will be raised.
   def suppression_list
     response = @soap.getClientSuppressionList(:apiKey => CAMPAIGN_MONITOR_API_KEY, :clientID => @clientID )
     handle_request response.client_GetSuppressionListResult    
   end
   
+  #Update the access and billing settings of an existing client, leaving the basic details untouched.
+  #
+  #Here's a list of all the parameters you'll need to pass to the Campaigning::Client#update_access_and_billing method. Only the :+access_level+ parameter
+  #is required for all calls. The relevance and necessity of the other parameters depends on the chosen AccessLevel (and BillingType),
+  #and will be fully described along with each parameter.
+  #
+  #Available _params_ argument are:
+  #   * :access_level - An integer describing the client's ability to access different areas of the application. Influences the significance
+  #                     and requirements of the following parameters. See http://www.campaignmonitor.com/api/method/client-updateaccessandbilling/#accesslevels
+  #                     for a full description of available levels.
+  #   * :username - Client login username. Not required and ignored if AccessLevel is set to 0.
+  #   * :password - Client login password. Not required and ignored if AccessLevel is set to 0.
+  #   * :billing_type - Client billing type, only required if :access_level is set to allow the client to create and send campaigns
+  #   * :currency - Billing currency for this client, only required if :billing_type is set to either ClientPaysAtStandardRate or
+  #                 ClientPaysWithMarkup. See full details: http://www.campaignmonitor.com/api/method/client-updateaccessandbilling/#currencies.
+  #   * :delivery_fee - Flat rate delivery fee to be charged to the client for each campaign sent, expressed in the chosen currency's
+  #                     major unit, but without the currency symbol (for example, sending "6.5" means "$6.50" if USD is used). Only
+  #                     required if BillingType is set to ClientPaysWithMarkup, in which case it should be at least equal to the standard rate.
+  #                     Further detail is available at http://help.campaignmonitor.com/topic.aspx?t=118.
+  #   * :cost_per_recipient - Additional cost added to the campaign for each email address the campaign is sent to, expressed in the chosen
+  #                           currency's minor unit (for example, sending "1.5" means 1.5 cents per email address if USD is used). Only required
+  #                           if BillingType is set to ClientPaysWithMarkup, in which case it should be at least equal to the standard cost/recipient
+  #                           rate. Further detail is available at http://help.campaignmonitor.com/topic.aspx?t=118.
+  #   * :design_and_spam_test_fee - Expressed in the chosen currency's major unit (for example, sending "10" means "$10" if USD is used). Only required
+  #                                 if BillingType is set to ClientPaysWithMarkup and client has access to design and spam tests, in which case the fee
+  #                                 should be equal to or higher than the standard rate (identical to the standard DeliveryFee for that currency).  
+  #
+  #
+  #
+  #Please note that for reasons of security there is no way to set a client's credit card details via the API. It will have to be done in the application.
+  #
+  #*Return*:
+  #
+  #*Success*: Upon a successful call, this method will return a Campaigning::Result object wich consists of a +code+ and +message+ fields
+  #containing a successful message.
+  #
+  #*Error*: An Exception containing the cause of the error will be raised.
   def update_access_and_billing(params)
     response = @soap.updateClientAccessAndBilling(
      :apiKey => CAMPAIGN_MONITOR_API_KEY,
      :clientID => @clientID,
      :accessLevel => params[:access_level],
-     :username => params[:username],
-     :password => params[:password],
-     :billingType => params[:billing_type],
-     :currency => params[:currency],
-     :deliveryFee => params[:delivery_fee],
-     :costPerRecipient => params[:cost_per_recipient],
-     :designAndSpamTestFee => params[:design_and_spam_test_fee]
+     :username => params.fetch(:username, ""),
+     :password => params.fetch(:password, ""),
+     :billingType => params.fetch(:billing_type, ""),
+     :currency => params.fetch(:currency, ""),
+     :deliveryFee => params.fetch(:delivery_fee, ""),
+     :costPerRecipient => params.fetch(:cost_per_recipient, ""),
+     :designAndSpamTestFee => params.fetch(:design_and_spam_test_fee, "")
     )
     handle_request response.client_UpdateAccessAndBillingResult
   end
   
+  #Updates the basic details of an existing client.
+  #If you wish to change only some details, the others must be included as they currently are. Please note that the client's existing
+  #access and billing details will remain unchanged by a call to this method.
+  #
+  #Available _params_ argument are:
+  #   * :company_name - The client company name.
+  #   * :contact_name - The personal name of the principle contact for this client.
+  #   * :email_address - An email address to which this client will be sent application-related emails.
+  #   * :country - This client's country.
+  #   * :time_zone - Client timezone for tracking and reporting data. Valid timezone strings are obtainable by means of the
+  #                  API procedure Campaigning.time_zones.
+  #
+  #*Return*:
+  #
+  #*Success*: Upon a successful call, this method will return a Campaigning::Result object wich consists of a +code+ and +message+ fields
+  #containing a successful message.
+  #
+  #*Error*: An Exception containing the cause of the error will be raised.
   def update_basics(params)
     response = @soap.updateClientBasics(
       :apiKey => CAMPAIGN_MONITOR_API_KEY,

data/lib/campaigning/types/list.rb

@@ -16,6 +16,22 @@ module Campaigning
       @soap = Campaigning::SOAPDriver.instance.get_driver
     end
 
+    #Creates a brand new subscriber list
+    #
+    #Available _params_ argument are:
+    #   * :client_id - The ID of the client who will owner of the list.
+    #   * :title - The list title. Must be unique for this client.
+    #   * :unsubscribe_page - The URL to which subscribers will be directed when unsubscribing from the list.
+    #                         If left blank or omitted a generic unsubscribe page is used.
+    #   * :comfirm_opt_in - Either true or false depending on whether the list requires email confirmation or not. Please see
+    #                       the help documentation for more details of what this means.
+    #   * :confirmation_success_page - Successful email confirmations will be redirected to this URL. Ignored if ConfirmOptIn
+    #                                  is false. If left blank or omitted a generic confirmation page is used.
+    #*Return*:
+    #
+    #*Success*: Upon a successful call, this method will return a Campaigning::List object representing the newly created list.
+    #
+    #*Error*: An Exception containing the cause of the error will be raised.
     def self.create(params)
       response = Campaigning::SOAPDriver.instance.get_driver.createList(
         :apiKey => CAMPAIGN_MONITOR_API_KEY,
@@ -29,6 +45,20 @@ module Campaigning
       List.new(new_list_id, params[:title])
     end
     
+    #Creates a new custom field for a list
+    #
+    #Available _params_ argument are:
+    #   * :field_name - The Name for the new Custom Field. This will be used to generate the custom fields Key.
+    #   * :data_type - The Data Type for the new Custom Field. This must be one of Text, Number, MultiSelectOne, or MultiSelectMany
+    #   * :options - The available options for a multi-valued custom field. Options should be an Array of Strings, like: %w[Brazil Ireland England].
+    #                You can't pass this field for Text and Number custom fields
+    #
+    #*Return*:
+    #
+    #*Success*: Upon a successful call, this method will return a Campaigning::Result object wich consists of a +code+ and +message+ fields
+    #containing a successful message.
+    #
+    #*Error*: An Exception containing the cause of the error will be raised.
     def create_custom_field(params)      
       response = @soap.createListCustomField(
         :apiKey => CAMPAIGN_MONITOR_API_KEY,
@@ -40,32 +70,155 @@ module Campaigning
       handle_request response.list_CreateCustomFieldResult
     end
     
+    #Deletes a list
+    #
+    #*Return*:
+    #
+    #*Success*: Upon a successful call, this method will return a Campaigning::Result object wich consists of a +code+ and +message+ fields
+    #containing a successful message.
+    #
+    #*Error*: An Exception containing the cause of the error will be raised.
     def delete
       List.delete(@listID)
       self.listID, self.name  = nil, nil
     end
 
+    #Deletes a list
+    #
+    #*Return*:
+    #
+    #*Success*: Upon a successful call, this method will return a Campaigning::Result object wich consists of a +code+ and +message+ fields
+    #containing a successful message.
+    #
+    #*Error*: An Exception containing the cause of the error will be raised.
     def self.delete(list_id)
       response = Campaigning::SOAPDriver.instance.get_driver.deleteList(:apiKey => CAMPAIGN_MONITOR_API_KEY, :listID => list_id)
       Helpers.handle_request response.list_DeleteResult
     end
     
+    #Deletes a custom field from a list
+    #
+    #*Return*:
+    #
+    #*Success*: Upon a successful call, this method will return a Campaigning::Result object wich consists of a +code+ and +message+ fields
+    #containing a successful message.
+    #
+    #*Error*: An Exception containing the cause of the error will be raised.
     def delete_custom_field(key)
       response = @soap.deleteListCustomField(:apiKey => CAMPAIGN_MONITOR_API_KEY, :listID => @listID, :key => '['+key+']')
       handle_request response.list_DeleteCustomFieldResult
     end
     
+    #Gets all the Custom Fields available for a list
+    #
+    #*Return*:
+    #
+    #*Success*: Upon a successful call, this method will return a collection of Campaigning::ListCustomField complex types. The individual ListCustomField
+    #record consists of a +fieldName+, +key+, +dataType+ and a +fieldOptions+ containing a list of possible options for multi-valued custom fields.
+    #
+    #*Error*: An Exception containing the cause of the error will be raised.
     def custom_fields
       response = @soap.getListCustomFields(:apiKey => CAMPAIGN_MONITOR_API_KEY, :listID => @listID)
       handle_request response.list_GetCustomFieldsResult
     end
     
+    #Gets a list's configuration detail
+    #
+    #*Return*:
+    #
+    #*Success*: A successful call to this method will return a Campaigning::ListDetail object, consisting of +listID+, +title+, +unsubscribePage+, +confirmOptIn+, and
+    #+confirmationSuccessPage+ (all as described in Campaigning::List#update and Campaigning::List.create).
+    #
+    #*Error*: An Exception containing the cause of the error will be raised.
     def details
       response = @soap.getListDetail(:apiKey => CAMPAIGN_MONITOR_API_KEY, :listID => @listID)
       handle_request response.list_GetDetailResult
     end
+  
+    #Gets a list of all active subscribers for a list.
+    #
+    #*Return*:
+    #
+    #*Success*: Upon a successful call, this method will return a collection of Campaigning::Subscriber objects.
+    #
+    #*Error*: An Exception containing the cause of the error will be raised.
+    def get_all_active_subscribers
+      find_active_subscribers(DateTime.new(y=1911,m=1,d=01, h=01,min=00,s=00))
+    end
+  
+    #Gets a list of all active subscribers for a list that have been joined since the specified date.
+    #The +joined_at+ param has to be a DateTime object, like:
+    #
+    #        list.find_active_subscribers(DateTime.new(y=2009,m=4,d=01, h=01,min=00,s=00))
+    #
+    #*Return*:
+    #
+    #*Success*: Upon a successful call, this method will return a collection of Campaigning::Subscriber objects.
+    #
+    #*Error*: An Exception containing the cause of the error will be raised.
+    def find_active_subscribers(joined_at)
+      response = @soap.getSubscribers(
+       :apiKey => CAMPAIGN_MONITOR_API_KEY,
+       :listID => @listID,
+       :date =>joined_at.strftime('%Y-%m-%d %H:%M:%S')
+      )
+      handle_request response.subscribers_GetActiveResult
+    end
+
+    #Gets a list of all subscribers for a list that have unsubscribed since the specified date.
+    #The +unjoined_at+ param has to be a DateTime object, like:
+    #
+    #        list.find_unsubscribed(DateTime.new(y=2009,m=4,d=01, h=01,min=00,s=00))
+    #
+    #*Return*:
+    #
+    #*Success*: Upon a successful call, this method will return a collection of Campaigning::Subscriber objects. In this case
+    #every returned object will contain the value "Unsubscribed" in the +state+ field.
+    #
+    #*Error*: An Exception containing the cause of the error will be raised.    
+    def find_unsubscribed(unjoined_at)
+      response = @soap.getUnsubscribed(
+       :apiKey => CAMPAIGN_MONITOR_API_KEY,
+       :listID => @listID,
+       :date => unjoined_at.strftime('%Y-%m-%d %H:%M:%S') # TODO: Move that to a helper method
+      )
+      handle_request response.subscribers_GetUnsubscribedResult
+    end
     
-    
+    #This method returns all of a particular subscribers details, including email address, name, active/inactive
+    #status and all custom field data. If a subscriber with that email address does not exist in that list, a +nil+ value is returned.
+    #
+    #*Return*:
+    #*Success*: Upon a successful call, this method will return a collection of Campaigning::Subscriber objects. In this case
+    #every returned object will contain the value "Unsubscribed" in the +state+ field.
+    #
+    #*Error*: An Exception containing the cause of the error will be raised.    
+    def find_single_subscriber(email_address) # TODO: Create a mehod to handle with custom fields returned like (names from "State Name" to "state_name")
+      response = @soap.getSingleSubscriber(
+       :apiKey => CAMPAIGN_MONITOR_API_KEY,
+       :listID => @listID,
+       :emailAddress => email_address
+      )
+      handle_request response.subscribers_GetSingleSubscriberResult
+    end
+        
+    #Update a subscriber list’s details
+    #
+    #Available _params_ argument are:
+    #   * :title - The list title, as it will be shown in the application and through the API.
+    #   * :unsubscribe_page - The URL to which subscribers will be directed when unsubscribing from the list.
+    #                         If left blank or omitted a generic unsubscribe page is used.
+    #   * :comfirm_opt_in - Either true or false depending on whether the list requires email confirmation or not. Please see
+    #                       the help documentation for more details of what this means.
+    #   * :confirmation_success_page - Successful email confirmations will be redirected to this URL. Ignored if ConfirmOptIn
+    #                                  is false. If left blank or omitted a generic confirmation page is used.
+    #
+    #*Return*:
+    #
+    #*Success*: Upon a successful call, this method will return a Campaigning::Result object wich consists of a +code+ and +message+ fields
+    #containing a successful message.
+    #
+    #*Error*: An Exception containing the cause of the error will be raised.
     def update(params)
       response = @soap.updateList(
         :apiKey => CAMPAIGN_MONITOR_API_KEY,

data/lib/campaigning/types/subscriber.rb

@@ -21,6 +21,21 @@ class Subscriber
     @soap = Campaigning::SOAPDriver.instance.get_driver
   end
   
+  #Adds a subscriber (email address, name) to an existing subscriber list. If the subscriber (email address) already exists,
+  #the name value is updated with whatever is passed in.
+  #
+  #If the list has been set as double opt-in, they will be sent the verification email, otherwise they will be sent the
+  #confirmation email you have set up for the list being subscribed to.
+  #
+  #<b>Please note</b>: If the subscriber is in an inactive state or has previously been unsubscribed, they will *not* be re-added
+  #to the active list. Therefore, this method should be used with caution and only where suitable.
+  #
+  #*Return*:
+  #
+  #*Success*: Upon a successful call, this method will return a Campaigning::Result object wich consists of a +code+ and +message+ fields
+  #containing a successful message.
+  #
+  #*Error*: An Exception containing the cause of the error will be raised.
   def add(list_id)
     response = @soap.addSubscriber(
       :apiKey => CAMPAIGN_MONITOR_API_KEY,
@@ -31,6 +46,21 @@ class Subscriber
     handle_request response.subscriber_AddResult
   end
   
+  #Adds a subscriber (email address, name) to an existing subscriber list. If the subscriber (email address) already exists,
+  #the name value is updated with whatever is passed in.
+  #
+  #If the list has been set as double opt-in, they will be sent the verification email, otherwise they will be sent the
+  #confirmation email you have set up for the list being subscribed to.
+  #
+  #<b>Please note</b>: If the subscriber is in an inactive state or has previously been unsubscribed, they will be re-added to
+  #the active list. Therefore, this method should be used with caution and only where suitable.
+  #
+  #*Return*:
+  #
+  #*Success*: Upon a successful call, this method will return a Campaigning::Result object wich consists of a +code+ and +message+ fields
+  #containing a successful message.
+  #
+  #*Error*: An Exception containing the cause of the error will be raised.
   def add_and_resubscribe(list_id)
     response = @soap.addAndResubscribe(
       :apiKey => CAMPAIGN_MONITOR_API_KEY,
@@ -41,6 +71,22 @@ class Subscriber
     handle_request response.subscriber_AddAndResubscribeResult
   end
   
+  
+  #Adds a subscriber to a subscriber list, including adding custom field data for the subscriber. If the subscriber (email address)
+  #already exists, then the custom fields are updated with whatever is passed in.
+  #
+  #If the list has been set as double opt-in, they will be sent the verification email, otherwise they will be sent the confirmation
+  #email you have set up for the list being subscribed to.
+  #
+  #<b>Please note</b>: If the subscriber is in an inactive state or has previously been unsubscribed, they will be re-added to the
+  #active list. Therefore, this method should be used with caution and only where suitable.
+  #
+  #*Return*:
+  #
+  #*Success*: Upon a successful call, this method will return a Campaigning::Result object wich consists of a +code+ and +message+ fields
+  #containing a successful message.
+  #
+  #*Error*: An Exception containing the cause of the error will be raised.
   def add_and_resubscribe_with_custom_fields(list_id, custom_fields)
     response = @soap.addAndResubscribeWithCustomFields(
     :apiKey => CAMPAIGN_MONITOR_API_KEY,
@@ -52,6 +98,21 @@ class Subscriber
     handle_request response.subscriber_AddAndResubscribeWithCustomFieldsResult
   end
  
+  #Adds a subscriber to a subscriber list, including adding custom field data for the subscriber. If the subscriber (email address)
+  #already exists, then the custom fields are updated with whatever is passed in.
+  #
+  #If the list has been set as double opt-in, they will be sent the verification email, otherwise they will be sent the confirmation
+  #email you have set up for the list being subscribed to.
+  #
+  #<b>Please note</b>: If the subscriber is in an inactive state or has previously been unsubscribed, they will *not* be re-added to
+  #the active list. Therefore, this method should be used with caution and only where suitable.
+  #
+  #*Return*:
+  #
+  #*Success*: Upon a successful call, this method will return a Campaigning::Result object wich consists of a +code+ and +message+ fields
+  #containing a successful message.
+  #
+  #*Error*: An Exception containing the cause of the error will be raised.
   def add_with_custom_fields(list_id, custom_fields)
     response = @soap.addSubscriberWithCustomFields(
     :apiKey => CAMPAIGN_MONITOR_API_KEY,
@@ -63,10 +124,24 @@ class Subscriber
     handle_request response.subscriber_AddWithCustomFieldsResult
   end 
  
+  #Changes the status of an Active Subscriber to an Unsubscribed Subscriber who will no longer receive
+  #campaigns sent to that Subscriber List.
+  #
+  #If the list is set to add unsubscribing subscribers to the suppression list, then the subscriber’s email address will
+  #also be added to the suppression list.
+  #
+  #*Return*:
+  #
+  #*Success*: Upon a successful call, this method will return a Campaigning::Result object wich consists of a +code+ and +message+ fields
+  #containing a successful message.
+  #
+  #*Error*: An Exception containing the cause of the error will be raised.
   def unsubscribe(list_id)
     Subscriber.unsubscribe(@emailAddress, list_id)
   end
   
+  #Changes the status of an Active Subscriber to an Unsubscribed Subscriber who will no longer receive
+  #campaigns sent to that Subscriber List (Same that the instance method with the same name).
   def self.unsubscribe(email, list_id)
     response = Campaigning::SOAPDriver.instance.get_driver.unsubscribe(
     :apiKey => CAMPAIGN_MONITOR_API_KEY,
@@ -76,30 +151,12 @@ class Subscriber
     Helpers.handle_request response.subscriber_UnsubscribeResult
   end
   
-  # TODO: May I move this method to List type?
-  def self.active_subscribers(list_id, datetime)
-    response = Campaigning::SOAPDriver.instance.get_driver.getSubscribers(
-     :apiKey => CAMPAIGN_MONITOR_API_KEY,
-     :listID => list_id,
-     :date => datetime.strftime('%Y-%m-%d %H:%M:%S') # TODO: Move that to a helper method
-    )
-    Helpers.handle_request response.subscribers_GetActiveResult
-  end
-  
-  # TODO: May I move this method to List type?
-  def self.get_unsubscribed(list_id, datetime)
-    response = Campaigning::SOAPDriver.instance.get_driver.getUnsubscribed(
-     :apiKey => CAMPAIGN_MONITOR_API_KEY,
-     :listID => list_id,
-     :date => datetime.strftime('%Y-%m-%d %H:%M:%S') # TODO: Move that to a helper method
-    )
-    Helpers.handle_request response.subscribers_GetUnsubscribedResult
-  end
-  
+  #Returns True or False as to the existence of the given email address in the list supplied.
   def is_subscribed?(list_id)
     Subscriber.is_subscribed?(@emailAddress, list_id)
   end
   
+  #Returns True or False as to the existence of the given email address in the list supplied.
   def self.is_subscribed?(email, list_id)
     response = Campaigning::SOAPDriver.instance.get_driver.getIsSubscribed(
      :apiKey => CAMPAIGN_MONITOR_API_KEY,
@@ -109,16 +166,7 @@ class Subscriber
     response = Helpers.handle_request response.subscribers_GetIsSubscribedResult
     response == 'True' ? true : false
   end
-  
-  # TODO: Create a mehod to handle with custom fields returned like (names from "State Name" to "state_name")
-  def self.get_single_subscriber(list_id, email_address)
-    response = Campaigning::SOAPDriver.instance.get_driver.getSingleSubscriber(
-     :apiKey => CAMPAIGN_MONITOR_API_KEY,
-     :listID => list_id,
-     :emailAddress => email_address
-    )
-    Helpers.handle_request response.subscribers_GetSingleSubscriberResult
-  end
+
   
   
   protected

data/test/campaigning_test.rb

@@ -1,18 +1,31 @@
 require 'test_helper'
 
 # Replace this API key with your own (http://www.campaignmonitor.com/api/)
-CAMPAIGN_MONITOR_API_KEY  = '__PUT__YOUR__API__KEY__HERE__'
+CAMPAIGN_MONITOR_API_KEY  = '54cae7f3aa1f35cb3bb5bc41756d8b7f'
 CLIENT_ID = 'd7acfd4cd2ffffc2d86b8903d18a1276'
 CLIENT_TWO_ID = '730acd1e8d27d56bdb87e88685613d72'
 
 class CampaigningTest < Test::Unit::TestCase
   
-  def setup
-    @cm = Campaigning::Base.new
-  end
  
-  # def test_clients
-  #   clients = @cm.clients
+ # def test_campaigning_system_date
+ #   date = Campaigning.system_date
+ #   assert !date.nil?
+ #   puts date
+ # end
+ # 
+ # def test_user_get_time_zones
+ #   time_zones = Campaigning.time_zones
+ #   assert !time_zones.nil?
+ # end 
+ 
+ # def test_user_countries
+ #   countries = Campaigning.countries
+ #   assert !countries.nil?
+ # end
+ 
+  # def test_client_get_all_clients
+  #   clients = Campaigning::Client.get_all_clients
   #   assert clients.length > 0
   #   clients.each{ |c| puts c.clientID + " - " + c.name }
   # end
@@ -22,8 +35,8 @@ class CampaigningTest < Test::Unit::TestCase
   #   client = Campaigning::Client.new(CLIENT_ID)
   #   assert client.lists.length > 0
   # end
-  # 
-  #  
+  
+   
   # def test_client_create
   #   client_created = Campaigning::Client.create(
   #    :company_name => "Orange Company 15",
@@ -45,36 +58,57 @@ class CampaigningTest < Test::Unit::TestCase
   #   client = Campaigning::Client.find_by_name("Orange Company 7")
   #   client.delete
   # end
-  # 
+  
   # def test_client_segments
   #   client = Campaigning::Client.find_by_name("Client One Company")
   #   assert client.segments.length > 0
   #   puts client.segments.inspect
   # end
-  # 
-  # 
-  def test_find_client_by_name
-    client = Campaigning::Client.find_by_name("Client One Company")
-    puts client.inspect
-    # assert client != nil && client.name == "Client One Company"
-  end
-  # 
-  # 
+  
+  
+  # def test_find_client_by_name
+  #   client = Campaigning::Client.find_by_name("Client One Company")
+  #   puts client.inspect
+  #   # assert client != nil && client.name == "Client One Company"
+  # end
+  
+  
   # def test_get_client_campaigns
   #   client = Campaigning::Client.find_by_name("Client One Company")
   #   puts client.campaigns.inspect
   # end
    
-  # def test_get_client_details
-  #   client = Campaigning::Client.find_by_name("Client Two ")
-  #   puts client.details.inspect
-  # end 
-  # 
+  def test_get_client_details
+    client = Campaigning::Client.find_by_name("Client One Company")
+    # client_details = client.details
+    # basic_details = client_details.basicDetails
+    # access_and_billing_details = client_details.accessAndBilling
+    # puts "Basic details:"
+    # puts "Client ID: #{basic_details.clientID} - \n
+    #       Company: #{basic_details.companyName} - \n
+    #       Contact: #{basic_details.contactName} - \n
+    #       Country: #{basic_details.country} - \n
+    #       Timezone: #{basic_details.timezone}"
+    # 
+    # puts "Access and Billing Details:"
+    # puts "Username: #{access_and_billing_details.username} - \n 
+    #       Password: #{access_and_billing_details.password} - \n
+    #       Billing Type: #{access_and_billing_details.billingType} - \n
+    #       Currency: #{access_and_billing_details.currency} - \n
+    #       Delivery Fee: #{access_and_billing_details.deliveryFee} - \n
+    #       Cost per Recipient: #{access_and_billing_details.costPerRecipient} - \n
+    #       Design and Span test Fee: #{access_and_billing_details.designAndSpamTestFee} - \n
+    #       Access Level: #{access_and_billing_details.accessLevel}"
+    
+    puts client.details.inspect != nil
+    
+  end 
+  
   # def test_get_client_suppression_list
-  #   client = Campaigning::Client.find_by_name("Client Two ")
-  #   puts client.suppression_list
+  #   client = Campaigning::Client.find_by_name("Client One Company")
+  #   puts client.suppression_list.inspect
   # end
-  # 
+  
   # def test_client_update_access_and_billing
   #   client = Campaigning::Client.find_by_name("Client One Company")
   #   response = client.update_access_and_billing(
@@ -110,20 +144,6 @@ class CampaigningTest < Test::Unit::TestCase
   # end
 
   
-  # 
-  #  def test_user_get_time_zones
-  #    time_zones = @cm.time_zones
-  #    assert !time_zones.nil?
-  #  end 
-  #    
-  #    
-  #  def test_system_date
-  #    sys_date = @cm.system_date
-  #    assert !sys_date.nil?
-  #    puts sys_date
-  #  end 
-  #   
-  # 
   # def test_campaign_create
   #   client = Campaigning::Client.find_by_name("Client One Company")    
   #   response = Campaigning::Campaign.create(
@@ -149,7 +169,7 @@ class CampaigningTest < Test::Unit::TestCase
   #  
   # def test_campaign_lists
   #   client = Campaigning::Client.find_by_name("Client One Company")
-  #   puts client.campaigns[2].lists.inspect
+  #   client.campaigns[0].lists
   # end
   # 
   # def test_campaign_opens
@@ -164,9 +184,15 @@ class CampaigningTest < Test::Unit::TestCase
   # end
   # 
   # 
-  # def test_campaign_subscriber_clicks
+  # def test_campaign_summary
   #   client = Campaigning::Client.find_by_name("Client One Company")
-  #   puts client.campaigns[0].subscriber_clicks
+  #   # client.campaigns[2].subscriber_clicks.each do |subscriber|
+  #   #   puts "Subscriber: #{subscriber.emailAddress}"
+  #   #   subscriber.clickedLinks.each { |clicked| puts "Link: #{clicked.link} - Number of clicks: #{clicked.clicks}"}
+  #   # end
+  #   assert client.campaigns[2].subscriber_clicks != nil
+  #   assert client.campaigns[2].subscriber_clicks != []
+  #   
   # end
   # 
   #   
@@ -233,11 +259,6 @@ class CampaigningTest < Test::Unit::TestCase
   #   assert response.code == 0    
   # end
   # 
-  # def test_subscriber_actives
-  #   subscriber_list = Campaigning::Subscriber.active_subscribers("ac52b645c048888a44c87b5f1ecf6b7d", DateTime.new(y=2009,m=5,d=01, h=01,min=00,s=00))
-  #   puts subscriber_list.inspect
-  #   assert subscriber_list.length > 0    
-  # end
   # 
   # def test_subscriber_is_subscribed
   #   subscriber = Campaigning::Subscriber.new("user_to_test@test.com") # TODO: Change to get the Subscriber, not to CREATE a new one
@@ -246,19 +267,40 @@ class CampaigningTest < Test::Unit::TestCase
   #   assert response == false
   # end
   # 
-  # def test_subscriber_get_single_subscriber
-  #   subscriber = Campaigning::Subscriber.get_single_subscriber("ac52b645c048888a44c87b5f1ecf6b7d", "user_custon2@test.com")
+  # 
+  # def test_list_find_single_subscriber
+  #   client = Campaigning::Client.find_by_name("Client One Company")
+  #   list = client.find_list_by_name "My Friends"
+  #   subscriber = list.find_single_subscriber("user_custon2@test.com")
   #   puts subscriber.inspect
   #   assert subscriber.name != nil
-  # end
+  # end 
   # 
-  # def test_subscriber_get_unsubscribed
-  #   subscriber_list = Campaigning::Subscriber.get_unsubscribed("ac52b645c048888a44c87b5f1ecf6b7d", DateTime.new(y=2009,m=4,d=01, h=01,min=00,s=00))
+  # def test_list_find_unsubscribed
+  #   client = Campaigning::Client.find_by_name("Client One Company")
+  #   list = client.find_list_by_name "My Friends"
+  #   subscriber_list = list.find_unsubscribed(DateTime.new(y=2009,m=4,d=01, h=01,min=00,s=00))
   #   puts subscriber_list.inspect
   #   assert subscriber_list.length > 0    
   # end
   # 
-  # 
+  # def test_list_find_active_subscribers
+  #   client = Campaigning::Client.find_by_name("Client One Company")
+  #   list = client.find_list_by_name "My Friends"
+  #   subscriber_list = list.find_active_subscribers(DateTime.new(y=2009,m=5,d=01, h=01,min=00,s=00))        
+  #   assert subscriber_list.length > 0
+  # end
+ 
+  # def test_list_get_all_active_subscribers
+  #   client = Campaigning::Client.find_by_name("Client One Company")
+  #   list = client.find_list_by_name "My Friends"
+  #   subscriber_list = list.get_all_active_subscribers  
+  #   puts subscriber_list.inspect
+  #   assert subscriber_list.length > 0
+  # end 
+
+
+  
   # def test_list_create
   #   client = Campaigning::Client.find_by_name("Client One Company")
   #   list = Campaigning::List.create(

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gnumarcelo-campaigning
 version: !ruby/object:Gem::Version 
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Marcelo Menezes
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-07 00:00:00 -07:00
+date: 2009-05-22 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency