gnumarcelo-campaigning 0.8.2 → 0.10.0

data/README.rdoc

@@ -46,9 +46,9 @@ Sample use of the Client class:
   #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,
+    :clientID => client.clientID,
     :title => "List of people from Brazil",
-    :comfirm_opt_in => false
+    :confirmOptIn => false
   )
 
 For further examples please check at the *sample* directory.

data/VERSION.yml

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

data/lib/campaigning/campaigning.rb

@@ -14,23 +14,27 @@ module Campaigning
   #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
+    dateTime = handle_response response.user_GetSystemDateResult
   end
   
   #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
+  def self.timezones
+    handle_response Campaigning::SOAPDriver.instance.get_driver.getTimezones(:apiKey => CAMPAIGN_MONITOR_API_KEY).user_GetTimezonesResult
   end
   
   #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
+    dateTime = handle_response response.user_GetCountriesResult
   end
   
   #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 
+  
+  def self.set_endpoint_url(endpoint_url)
+     Campaigning::SOAPDriver.instance.set_endpoint_url endpoint_url
+  end
 end

data/lib/campaigning/helpers/helpers.rb

@@ -1,19 +1,27 @@
 module Campaigning
-module Helpers #:nodoc:
-  #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
+  module Helpers #:nodoc:
+    def self.included(base)
+      base.extend(ClassMethods) # Make all ClassMethods methods avaiable to the object including this module.
+      private :handle_response
+    end
+     
+    def handle_response(response)
+      self.class.handle_response(response)
+    end
+    
+    # All methods above will became Object methods
+    module ClassMethods #:nodoc:
+      
+      #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_response(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

@@ -19,8 +19,12 @@ module Campaigning
     #SOAP requests made to the API server.
     def setup_debug_mode(dev)
       dev = STDERR if dev == true
+      get_driver
       @driver.wiredump_dev = dev
     end
     
+    def set_endpoint_url(endpoint_url)
+      @driver = Campaigning::ApiSoap.new(endpoint_url)
+    end
   end
 end

data/lib/campaigning/types/campaign.rb

@@ -58,7 +58,7 @@ module Campaigning
            :listSegments => params[:listSegments]
           )
 
-        campaign_id = Helpers.handle_request response.campaign_CreateResult
+        campaign_id = handle_response response.campaign_CreateResult
         Campaign.new campaign_id
     end
     
@@ -73,7 +73,7 @@ module Campaigning
     #*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
+      handle_response response.campaign_GetBouncesResult
     end
     
     #Returns an array of Campaigning::List objects that a given campaign was sent to.
@@ -85,8 +85,7 @@ module Campaigning
     #*Error*: An Exception containing the cause of the error will be raised.
     def lists
       response = @soap.getCampaignLists(:apiKey => CAMPAIGN_MONITOR_API_KEY, :campaignID => @campaignID )
-      lists = handle_request response.campaign_GetListsResult
-      puts "LISTAS!!!!!!!!!!" + lists.inspect
+      lists = handle_response response.campaign_GetListsResult
       lists.collect do |list|  
         List.new(list.listID, list.name)
       end
@@ -103,7 +102,7 @@ module Campaigning
     #*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
+      handle_response 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,
@@ -128,7 +127,7 @@ module Campaigning
     #*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
+      handle_response response.campaign_GetSubscriberClicksResult
     end
     
     #Gets a statistical summary, including number of recipients and open count, for a given campaign.
@@ -142,7 +141,7 @@ module Campaigning
     #*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
+      handle_response response.campaign_GetSummaryResult
     end
     
     #Gets a list of all subscribers who unsubscribed for a given campaign.
@@ -155,7 +154,7 @@ module Campaigning
     #*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
+      handle_response response.campaign_GetUnsubscribesResult
     end
     
     #Schedules an existing campaign for sending.
@@ -166,8 +165,8 @@ module Campaigning
     #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".
+    #   * :confirmationEmail - The email address that the confirmation email that the campaign has been sent will go to.
+    #   * :sendDate - 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*:
@@ -178,10 +177,10 @@ module Campaigning
       response = @soap.sendCampaign(
         :apiKey => CAMPAIGN_MONITOR_API_KEY,
         :campaignID => @campaignID,
-        :confirmationEmail => params[:confirmation_email],
-        :sendDate => params[:send_date]
+        :confirmationEmail => params[:confirmationEmail],
+        :sendDate => params[:sendDate]
          )
-      handle_request response.campaign_SendResult
+      handle_response response.campaign_SendResult
     end
     
   end

data/lib/campaigning/types/client.rb

@@ -24,7 +24,7 @@ class Client
   #*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 = handle_response response.client_GetListsResult
     lists.collect {|list| List.new(list.listID, list.name)}
   end
   
@@ -69,7 +69,7 @@ class Client
   #*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 = handle_response response.user_GetClientsResult
     clients.collect {|client| Client.new(client.clientID, client.name)}
   end
   
@@ -78,13 +78,13 @@ class Client
   #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.
+  #   * :companyName - The client company name.
+  #   * :contactName - The personal name of the principle contact for this client.
+  #   * :emailAddress - 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.
+  #   * :timezone - Client timezone for tracking and reporting data. A valid timezone list is available here or by using the API
+  #                  procedure Campaigning.timezones.
   #*Return*:
   #
   #*Success*: Upon a successful call, this method will return a Campaigning::Client object representing the newly created client.
@@ -93,13 +93,13 @@ class Client
   def self.create(params)
     response = Campaigning::SOAPDriver.instance.get_driver.createClient(
       :apiKey => CAMPAIGN_MONITOR_API_KEY,
-      :companyName => params[:company_name],
-      :contactName => params[:contact_name],
-      :emailAddress => params[:email_address],
+      :companyName => params[:companyName],
+      :contactName => params[:contactName],
+      :emailAddress => params[:emailAddress],
       :country => params[:country],
-      :timezone => params[:time_zone]
+      :timezone => params[:timezone]
     )
-    Client.new( Helpers.handle_request(response.client_CreateResult), params[:company_name] )
+    Client.new( handle_response(response.client_CreateResult), params[:companyName] )
   end
   
   #Deletes a client from your account.
@@ -126,7 +126,7 @@ class Client
   #*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
+    handle_response response.client_DeleteResult
   end
   
   #Gets a list of all subscriber segments for a client.
@@ -139,7 +139,7 @@ class 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
+    handle_response response.client_GetSegmentsResult
   end
   
   #This method finds campaigns by a given subject, since the subject isn't unique, it returns an collection of
@@ -170,7 +170,7 @@ class Client
   #*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
+    campaign_list = handle_response response.client_GetCampaignsResult
     campaign_list.collect do |campaign|  
       Campaign.new(campaign.campaignID, campaign.subject, campaign.sentDate, campaign.totalRecipients)
     end
@@ -207,7 +207,7 @@ class Client
   #*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
+    handle_response response.client_GetDetailResult
   end
   
   #Gets all subscribers in the client-wide suppression list.
@@ -219,7 +219,7 @@ class Client
   #*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    
+    handle_response response.client_GetSuppressionListResult    
   end
   
   #Update the access and billing settings of an existing client, leaving the basic details untouched.
@@ -229,23 +229,23 @@ class Client
   #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
+  #   * :accessLevel - 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
+  #   * :billingType - Client billing type, only required if :accessLevel is set to allow the client to create and send campaigns
+  #   * :currency - Billing currency for this client, only required if :billingType 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
+  #   * :deliveryFee - 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
+  #   * :costPerRecipient - 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
+  #   * :designAndSpamTestFee - 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).  
   #
@@ -263,16 +263,16 @@ class Client
     response = @soap.updateClientAccessAndBilling(
      :apiKey => CAMPAIGN_MONITOR_API_KEY,
      :clientID => @clientID,
-     :accessLevel => params[:access_level],
+     :accessLevel => params[:accessLevel],
      :username => params.fetch(:username, ""),
      :password => params.fetch(:password, ""),
-     :billingType => params.fetch(:billing_type, ""),
+     :billingType => params.fetch(:billingType, ""),
      :currency => params.fetch(:currency, ""),
-     :deliveryFee => params.fetch(:delivery_fee, ""),
-     :costPerRecipient => params.fetch(:cost_per_recipient, ""),
-     :designAndSpamTestFee => params.fetch(:design_and_spam_test_fee, "")
+     :deliveryFee => params.fetch(:deliveryFee, ""),
+     :costPerRecipient => params.fetch(:costPerRecipient, ""),
+     :designAndSpamTestFee => params.fetch(:designAndSpamTestFee, "")
     )
-    handle_request response.client_UpdateAccessAndBillingResult
+    handle_response response.client_UpdateAccessAndBillingResult
   end
   
   #Updates the basic details of an existing client.
@@ -280,12 +280,12 @@ class Client
   #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.
+  #   * :companyName - The client company name.
+  #   * :contactName - The personal name of the principle contact for this client.
+  #   * :emailAddress - 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.
+  #   * :timezone - Client timezone for tracking and reporting data. Valid timezone strings are obtainable by means of the
+  #                  API procedure Campaigning.timezones.
   #
   #*Return*:
   #
@@ -297,13 +297,13 @@ class Client
     response = @soap.updateClientBasics(
       :apiKey => CAMPAIGN_MONITOR_API_KEY,
       :clientID => @clientID,
-      :companyName => params[:company_name],
-      :contactName => params[:contact_name],
-      :emailAddress => params[:email_address],
+      :companyName => params[:companyName],
+      :contactName => params[:contactName],
+      :emailAddress => params[:emailAddress],
       :country => params[:country],
-      :timezone => params[:time_zone]
+      :timezone => params[:timezone]
     )
-    handle_request response.client_UpdateBasicsResult
+    handle_response response.client_UpdateBasicsResult
   end
 
   

data/lib/campaigning/types/list.rb

@@ -19,13 +19,13 @@ module Campaigning
     #Creates a brand new subscriber list
     #
     #Available _params_ argument are:
-    #   * :client_id - The ID of the client who will owner of the list.
+    #   * :clientID - 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.
+    #   * :unsubscribePage - 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
+    #   * :confirmOptIn - 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
+    #   * :confirmationSuccessPage - 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*:
     #
@@ -35,21 +35,21 @@ module Campaigning
     def self.create(params)
       response = Campaigning::SOAPDriver.instance.get_driver.createList(
         :apiKey => CAMPAIGN_MONITOR_API_KEY,
-        :clientID => params[:client_id],
+        :clientID => params[:clientID],
         :title => params[:title],
-        :unsubscribePage => params.fetch(:unsubscribe_page, ""),
-        :confirmOptIn => params[:comfirm_opt_in],
-        :confirmationSuccessPage => params.fetch(:confirmation_success_page, "")
+        :unsubscribePage => params.fetch(:unsubscribePage, ""),
+        :confirmOptIn => params[:confirmOptIn],
+        :confirmationSuccessPage => params.fetch(:confirmationSuccessPage, "")
       )      
-      new_list_id = Helpers.handle_request response.list_CreateResult
+      new_list_id = handle_response response.list_CreateResult
       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
+    #   * :fieldName - The Name for the new Custom Field. This will be used to generate the custom fields Key.
+    #   * :dataType - 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
     #
@@ -63,11 +63,11 @@ module Campaigning
       response = @soap.createListCustomField(
         :apiKey => CAMPAIGN_MONITOR_API_KEY,
         :listID => @listID,
-        :fieldName => params[:field_name],
-        :dataType => params[:data_type],
+        :fieldName => params[:fieldName],
+        :dataType => params[:dataType],
         :options => params.fetch(:options, "") 
       )
-      handle_request response.list_CreateCustomFieldResult
+      handle_response response.list_CreateCustomFieldResult
     end
     
     #Deletes a list
@@ -93,7 +93,7 @@ module Campaigning
     #*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
+      handle_response response.list_DeleteResult
     end
     
     #Deletes a custom field from a list
@@ -106,7 +106,7 @@ module Campaigning
     #*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
+      handle_response response.list_DeleteCustomFieldResult
     end
     
     #Gets all the Custom Fields available for a list
@@ -119,7 +119,7 @@ module Campaigning
     #*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
+      handle_response response.list_GetCustomFieldsResult
     end
     
     #Gets a list's configuration detail
@@ -132,7 +132,7 @@ module Campaigning
     #*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
+      handle_response response.list_GetDetailResult
     end
   
     #Gets a list of all active subscribers for a list.
@@ -162,7 +162,7 @@ module Campaigning
        :listID => @listID,
        :date =>joined_at.strftime('%Y-%m-%d %H:%M:%S')
       )
-      handle_request response.subscribers_GetActiveResult
+      handle_response response.subscribers_GetActiveResult
     end
 
     #Gets a list of all subscribers for a list that have unsubscribed since the specified date.
@@ -182,7 +182,7 @@ module Campaigning
        :listID => @listID,
        :date => unjoined_at.strftime('%Y-%m-%d %H:%M:%S') # TODO: Move that to a helper method
       )
-      handle_request response.subscribers_GetUnsubscribedResult
+      handle_response response.subscribers_GetUnsubscribedResult
     end
     
     #This method returns all of a particular subscribers details, including email address, name, active/inactive
@@ -199,18 +199,18 @@ module Campaigning
        :listID => @listID,
        :emailAddress => email_address
       )
-      handle_request response.subscribers_GetSingleSubscriberResult
+      handle_response 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.
+    #   * :unsubscribePage - 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
+    #   * :confirmOptIn - 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
+    #   * :confirmationSuccessPage - 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*:
@@ -224,11 +224,11 @@ module Campaigning
         :apiKey => CAMPAIGN_MONITOR_API_KEY,
         :listID => @listID,
         :title => params[:title],
-        :unsubscribePage => params.fetch(:unsubscribe_page, ""),
-        :confirmOptIn => params[:comfirm_opt_in],
-        :confirmationSuccessPage => params.fetch(:confirmation_success_page, "") 
+        :unsubscribePage => params.fetch(:unsubscribePage, ""),
+        :confirmOptIn => params[:confirmOptIn],
+        :confirmationSuccessPage => params.fetch(:confirmationSuccessPage, "") 
       )
-      handle_request response.list_UpdateResult
+      handle_response response.list_UpdateResult
     end
     
     protected

data/lib/campaigning/types/subscriber.rb

@@ -43,7 +43,7 @@ class Subscriber
       :email => @emailAddress,
       :name => @name
      )
-    handle_request response.subscriber_AddResult
+    handle_response response.subscriber_AddResult
   end
   
   #Adds a subscriber (email address, name) to an existing subscriber list. If the subscriber (email address) already exists,
@@ -68,7 +68,7 @@ class Subscriber
       :email => @emailAddress,
       :name => @name
      )
-    handle_request response.subscriber_AddAndResubscribeResult
+    handle_response response.subscriber_AddAndResubscribeResult
   end
   
   
@@ -95,7 +95,7 @@ class Subscriber
     :name => @name,
     :customFields => custom_fields_array(custom_fields)
     )
-    handle_request response.subscriber_AddAndResubscribeWithCustomFieldsResult
+    handle_response response.subscriber_AddAndResubscribeWithCustomFieldsResult
   end
  
   #Adds a subscriber to a subscriber list, including adding custom field data for the subscriber. If the subscriber (email address)
@@ -121,7 +121,7 @@ class Subscriber
     :name => @name,
     :customFields => custom_fields_array(custom_fields)
     )
-    handle_request response.subscriber_AddWithCustomFieldsResult
+    handle_response response.subscriber_AddWithCustomFieldsResult
   end 
  
   #Changes the status of an Active Subscriber to an Unsubscribed Subscriber who will no longer receive
@@ -148,7 +148,7 @@ class Subscriber
     :listID => list_id,
     :email => email
     )
-    Helpers.handle_request response.subscriber_UnsubscribeResult
+    handle_response response.subscriber_UnsubscribeResult
   end
   
   #Returns True or False as to the existence of the given email address in the list supplied.
@@ -163,7 +163,7 @@ class Subscriber
      :listID => list_id,
      :email => email
     )
-    response = Helpers.handle_request response.subscribers_GetIsSubscribedResult
+    response = handle_response response.subscribers_GetIsSubscribedResult
     response == 'True' ? true : false
   end
 

data/test/campaigning_test.rb

@@ -1,51 +1,54 @@
 require 'test_helper'
 
 # Replace this API key with your own (http://www.campaignmonitor.com/api/)
-CAMPAIGN_MONITOR_API_KEY  = '54cae7f3aa1f35cb3bb5bc41756d8b7f'
-#CLIENT_ID = 'd7acfd4cd2ffffc2d86b8903d18a1276'
-#CLIENT_TWO_ID = '730acd1e8d27d56bdb87e88685613d72'
+CAMPAIGN_MONITOR_API_KEY  = '__PUT_YOUR_API_KEY_HERE__'
 
 class CampaigningTest < Test::Unit::TestCase
-  
- 
- def test_campaigning_system_date
-   date = Campaigning.system_date
-   assert !date.nil?
- 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 setup
+    #Campaigning.set_endpoint_url "http://127.0.0.1:8088/mockapiSoap"
+    #Campaigning.setup_debug_mode(true)
+  end
+
+  def test_campaigning_system_date
+    date = Campaigning.system_date
+    assert !date.nil?
+  end
+
+  def test_user_get_timezones
+    timezones = Campaigning.timezones
+    assert !timezones.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
-   
+
   def test_client_lists
     client = Campaigning::Client.find_by_name("Client One Company")    
     assert client.lists.length > 0
   end
-  
-   
-  def test_client_create
-    client_created = Campaigning::Client.create(
-     :company_name => "My test client",
-     :contact_name => "Oswald Green15",
-     :email_address => "og15@user.com",
-     :country => "Ireland",
-     :time_zone => Campaigning.time_zones[1]
-    )
-    assert !client_created.clientID.nil?
-  end
-  
+
+  #   
+  #  def test_client_create
+  #    client_created = Campaigning::Client.create(
+  #     :companyName => "My test client",
+  #     :contactName => "Oswald Green15",
+  #     :emailAddress => "og15@user.com",
+  #     :country => "Ireland",
+  #     :timezone => Campaigning.timezones[1]
+  #    )
+  #    assert !client_created.clientID.nil?
+  #  end
+  # 
   # def test_client_delete
   #   response = Campaigning::Client.delete(client_created.clientID)  
   #   assert response.code == 0
@@ -55,26 +58,24 @@ 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_client_segments
+    client = Campaigning::Client.find_by_name("Client One Company")
+    assert client.segments.length > 0
+  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_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 One Company")
     # client_details = client.details
@@ -96,64 +97,63 @@ class CampaigningTest < Test::Unit::TestCase
     #       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}"
-    
+
     assert !client.details.nil?
-    
+
   end 
-  
-  # def test_get_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(
-  #      :access_level => 5 ,
-  #      :username => "client_one",
-  #      :password => "1234560",
-  #      :billing_type => "UserPaysOnClientsBehalf",
-  #      :currency => "USD",
-  #      :delivery_fee => 6.5,
-  #      :cost_per_recipient => 1.5 ,
-  #      :design_and_spam_test_fee => 5
-  #     )
-  #   assert response.code == 0
-  # end
-  # 
-  # def test_client_update_basics
-  #   client = Campaigning::Client.find_by_name("Client Two ")
-  #   response = client.update_basics(
-  #     :company_name => "My new Company",
-  #     :contact_name => "Mr. Gordon Newman",
-  #     :email_address => "gordon-newman@test.com",
-  #     :country => "Ireland",
-  #     :time_zone => @cm.time_zones[1]
-  #   )
-  #   assert response.code == 0
-  # end
-  # 
-  # def test_client_find_list_by_name
-  #   client = Campaigning::Client.find_by_name("Client One Company")
-  #   list = client.find_list_by_name "My Friends"
-  #   puts list.inspect
-  #   assert list.nil? == false
-  # end
 
-  
+  def test_get_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(
+    :accessLevel => 5 ,
+    :username => "client_one",
+    :password => "1234560",
+    :billingType => "UserPaysOnClientsBehalf",
+    :currency => "USD",
+    :deliveryFee => 6.5,
+    :costPerRecipient => 1.5 ,
+    :designAndSpamTestFee => 5
+    )
+    assert response.code == 0
+  end
+
+  def test_client_update_basics
+    client = Campaigning::Client.find_by_name("Client Two")
+    response = client.update_basics(
+    :companyName => "My new Company",
+    :contactName => "Mr. Gordon Newman",
+    :emailAddress => "gordon-newman@test.com",
+    :country => "Ireland",
+    :timezone => Campaigning.timezones[1]
+    )
+    assert response.code == 0
+  end
+
+  def test_client_find_list_by_name
+    client = Campaigning::Client.find_by_name("Client One Company")
+    list = client.find_list_by_name "My Friends"
+    assert list.nil? == false
+  end
+
+
   # def test_campaign_create
   #   client = Campaigning::Client.find_by_name("Client One Company")    
   #   response = Campaigning::Campaign.create(
-  #     :clientID => client.clientID,
-  #     :campaignName => "Campaign by myself RUBY TO DELETE - CODEEEEE",
-  #     :campaignSubject => "Campaign by myself - OK - CODEEEEE",
-  #     :fromName => "Mr. Gordon2",
-  #     :fromEmail => "gordon2@test.com",
-  #     :replyTo => "no-reply@test.com",
-  #     :htmlUrl => "http://www.campaignmonitor.com/api/method/campaign-create/",
-  #     :textUrl => "http://www.google.com.br",
-  #     :subscriberListIDs => ["ac52b645c048888a44c87b5f1ecf6b7d"],
-  #     :listSegments => client.segments
+  #   :clientID => client.clientID,
+  #   :campaignName => "Campaign by myself RUBY TO DELETE - CODEEEEE",
+  #   :campaignSubject => "Campaign by myself - OK - CODEEEEE",
+  #   :fromName => "Mr. Gordon2",
+  #   :fromEmail => "gordon2@test.com",
+  #   :replyTo => "no-reply@test.com",
+  #   :htmlUrl => "http://www.campaignmonitor.com/api/method/campaign-create/",
+  #   :textUrl => "http://www.google.com.br",
+  #   :subscriberListIDs => ["ac52b645c048888a44c87b5f1ecf6b7d"],
+  #   :listSegments => client.segments
   #   )
   #   puts response.inspect
   # end
@@ -163,7 +163,7 @@ class CampaigningTest < Test::Unit::TestCase
   #   client = Campaigning::Client.find_by_name("Client One Company")
   #   puts client.campaigns[1].bounces.inspect
   # end
-  #  
+  # 
   # def test_campaign_lists
   #   client = Campaigning::Client.find_by_name("Client One Company")
   #   client.campaigns[0].lists
@@ -189,10 +189,10 @@ class CampaigningTest < Test::Unit::TestCase
   #   # end
   #   assert client.campaigns[2].subscriber_clicks != nil
   #   assert client.campaigns[2].subscriber_clicks != []
-  #   
+  # 
   # end
   # 
-  #   
+  # 
   # def test_campaign_summary
   #   client = Campaigning::Client.find_by_name("Client One Company")
   #   puts client.campaigns[1].summary
@@ -206,24 +206,24 @@ class CampaigningTest < Test::Unit::TestCase
   # def test_campaign_send
   #   client = Campaigning::Client.find_by_name("Client One Company")
   #   response = Campaigning::Campaign.create(
-  #     :clientID => client.clientID,
-  #     :campaignName => "Campaign by myself RUBY NEW CREATED",
-  #     :campaignSubject => "Campaign by myself - OK",
-  #     :fromName => "Mr. Gordon2",
-  #     :fromEmail => "gordon2@test.com",
-  #     :replyTo => "no-reply@test.com",
-  #     :htmlUrl => "http://www.campaignmonitor.com/api/method/campaign-create/",
-  #     :textUrl => "http://www.google.com",
-  #     :subscriberListIDs => ["ac52b645c048888a44c87b5f1ecf6b7d"],
-  #     :listSegments => client.segments
+  #   :clientID => client.clientID,
+  #   :campaignName => "Campaign by myself RUBY NEW CREATED",
+  #   :campaignSubject => "Campaign by myself - OK",
+  #   :fromName => "Mr. Gordon2",
+  #   :fromEmail => "gordon2@test.com",
+  #   :replyTo => "no-reply@test.com",
+  #   :htmlUrl => "http://www.campaignmonitor.com/api/method/campaign-create/",
+  #   :textUrl => "http://www.google.com",
+  #   :subscriberListIDs => ["ac52b645c048888a44c87b5f1ecf6b7d"],
+  #   :listSegments => client.segments
   #   )
-  #   
+  # 
   #   puts client.campaigns[0].send(
-  #     :confirmation_email => "userhdhd@test.com",
-  #     :send_date => "2009-04-30 11:55:01" # Date format YYYY-MM-DD HH:MM:SS.
+  #   :confirmationEmail => "userhdhd@test.com",
+  #   :sendDate => "2009-04-30 11:55:01" # Date format YYYY-MM-DD HH:MM:SS.
   #   ) 
   # end
-  
+  # 
   # def test_subscriber_add
   #   subscriber = Campaigning::Subscriber.new("robertf@test.com", "Robert Franklin")
   #   response = subscriber.add("ac52b645c048888a44c87b5f1ecf6b7d")
@@ -235,8 +235,8 @@ class CampaigningTest < Test::Unit::TestCase
   #   response = subscriber.add_and_resubscribe("ac52b645c048888a44c87b5f1ecf6b7d")
   #   assert response.code == 0
   # end
-  
-  
+  # 
+  # 
   # def test_subscriber_add_and_resubscribe_with_custom_fields
   #   subscriber = Campaigning::Subscriber.new("user_custon@test.com", "Mr. Custon")
   #   response = subscriber.add_and_resubscribe_with_custom_fields("ac52b645c048888a44c87b5f1ecf6b7d", :CityName => "Dublin", :SponsorName => "Some Sponsor")
@@ -287,7 +287,7 @@ class CampaigningTest < Test::Unit::TestCase
   #   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"
@@ -295,17 +295,17 @@ class CampaigningTest < Test::Unit::TestCase
   #   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(
-  #     :client_id => client.clientID,
-  #     :title => "New list to test",
-  #     :unsubscribe_page => "",
-  #     :comfirm_opt_in => false,
-  #     :confirmation_success_page => ""
+  #   :clientID => client.clientID,
+  #   :title => "New list to test",
+  #   :unsubscribePage => "",
+  #   :confirmOptIn => false,
+  #   :confirmationSuccessPage => ""
   #   )
   #   assert list.listID != nil
   # end
@@ -314,9 +314,9 @@ class CampaigningTest < Test::Unit::TestCase
   #   client = Campaigning::Client.find_by_name("Client One Company")
   #   list = client.find_list_by_name "My Friends"
   #   result = list.create_custom_field(
-  #     :field_name => "Country" ,
-  #     :data_type => "MultiSelectOne",
-  #     :options => %w[Brazil Ireland England]
+  #   :fieldName => "Country" ,
+  #   :dataType => "MultiSelectOne",
+  #   :options => %w[Brazil Ireland England]
   #   )
   #   assert result.code == 0
   # end
@@ -351,13 +351,13 @@ class CampaigningTest < Test::Unit::TestCase
   #   client = Campaigning::Client.find_by_name("Client One Company")
   #   list = client.find_list_by_name "My Friends"
   #   result = list.update(
-  #     :title => "NEW TITLE : My new list created by ruby list.create",
-  #     :unsubscribe_page => "",
-  #     :comfirm_opt_in => false,
-  #     :confirmation_success_page => ""
+  #   :title => "NEW TITLE : My new list created by ruby list.create",
+  #   :unsubscribePage => "",
+  #   :confirmOptIn => false,
+  #   :confirmationSuccessPage => ""
   #   )
   #   assert result.code == 0
   # end
-    
-  
+
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gnumarcelo-campaigning
 version: !ruby/object:Gem::Version 
-  version: 0.8.2
+  version: 0.10.0
 platform: ruby
 authors: 
 - Marcelo Menezes
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-22 00:00:00 -07:00
+date: 2009-06-18 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -35,7 +35,6 @@ files:
 - LICENSE
 - README.rdoc
 - Rakefile
-- TODO.txt
 - VERSION.yml
 - lib/campaigning.rb
 - lib/campaigning/campaigning.rb

data/TODO.txt

@@ -1,48 +0,0 @@
-*
-  Campaigns
-      o Campaign.Create - OK (Not tested)
-      o Campaign.GetBounces - OK
-      o Campaign.GetLists - OK
-      o Campaign.GetOpens - OK
-      o Campaign.GetSubscriberClicks - OK
-      o Campaign.GetSummary - OK
-      o Campaign.GetUnsubscribes - OK
-      o Campaign.Send - OK (Not Tested)
-*
-  Clients
-      o Client.Create - OK
-      o Client.Delete - OK
-      o Client.GetCampaigns - OK
-      o Client.GetDetail - OK
-      o Client.GetLists - OK
-      o Client.GetSegments - OK
-      o Client.GetSuppressionList - OK (Not tested)
-      o Client.UpdateAccessAndBilling - OK
-      o Client.UpdateBasics - OK
-*
-  Subscribers
-      o Subscriber.Add - OK
-      o Subscriber.AddAndResubscribe - OK
-      o Subscriber.AddAndResubscribeWithCustomFields - OK
-      o Subscriber.AddWithCustomFields - OK
-      o Subscriber.Unsubscribe - OK
-      o Subscribers.GetActive - OK - Here?
-      o Subscribers.GetBounced - OK
-      o Subscribers.GetIsSubscribed - OK
-      o Subscribers.GetSingleSubscriber - OK	
-      o Subscribers.GetUnsubscribed - OK - Here?
-*
-  Lists
-      o List.Create - OK
-      o List.CreateCustomField - OK
-      o List.Delete - OK
-      o List.DeleteCustomField - OK
-      o List.GetCustomFields - OK
-      o List.GetDetail - OK
-      o List.Update - OK
-*
-  Users
-      o User.GetClients - OK
-      o User.GetCountries - OK
-      o User.GetSystemDate - OK
-      o User.GetTimezones - OK