campaigning 0.15.0

data/sample/list_sample.rb

@@ -0,0 +1,159 @@
+require 'rubygems'
+require 'campaigning'
+
+CAMPAIGN_MONITOR_API_KEY  = '__PUT__YOUR__API__KEY__HERE__'
+
+
+#Here is how to create a brand new subscriber list
+client = Campaigning::Client.find_by_name("Client One Company")
+list = Campaigning::List.create!(
+  :clientID => client.clientID,
+  :title => "List from Sample Exec",
+  :unsubscribePage => "http://www.mycompany.com/campaign/ubsubscribe.html", #If not suplied or equals blank (""), default value will be used
+  :confirmOptIn => false,
+  :confirmationSuccessPage => "" #Default value will be used
+)
+puts "Here is the new created List: #{list.name} #{list.listID}"
+#OR you can remove both optional parameters from the method call like below and default values will be used as well:
+list2 = Campaigning::List.create!(
+  :clientID => client.clientID,
+  :title => "List from Sample Exec2",
+  :confirmOptIn => false
+)
+puts "Here is my second new created List (without some params): #{list.name} #{list.listID}"
+
+
+# SETUP FOR THIS SAMPLE ---------------------------------------------------------------------
+
+EMAIL_1 = "another@example.com"
+EMAIL_2 = "mrgree@example.com"
+
+#Here is how to add a subscriber (email address, name) to an existing subscriber list.
+subscriber = Campaigning::Subscriber.new(EMAIL_1, "Robert Franklin Jr.")
+result = subscriber.add!(list.listID)
+puts "Was the subscriber add tho the list: #{result.message}"
+
+#Here is how to add and resubscribe a Subscriber to an existing subscriber list.
+subscriber = Campaigning::Subscriber.new(EMAIL_2, "Nora Green Mor")
+result = subscriber.add_and_resubscribe!(list.listID)
+puts "Was the subscriber add and resubscribed tho the list: #{result.message}"
+
+# /SETUP FOR THIS SAMPLE ---------------------------------------------------------------------
+
+
+
+#Here is how to create a new custom field for a list
+client = Campaigning::Client.find_by_name("Client One Company")
+puts client.inspect
+list = client.find_list_by_name "List from Sample Exec"
+result = list.create_custom_field!(
+  :fieldName => "Color" ,
+  :dataType => "MultiSelectOne", #This must be one of Text, Number, MultiSelectOne, or MultiSelectMany
+  :options => %w[Blue Red Orange]
+)
+#Let's create one more custom field
+result1 = list.create_custom_field!(
+  :fieldName => "Contact Type" ,
+  :dataType => "MultiSelectOne",
+  :options => %w[email post telephone]
+)
+puts "Was my Color custom field created successfuly? #{result.message}"
+puts "Was my Contact Type custom field created successfuly? #{result1.message}"
+
+
+#Here is how to get all the Custom Fields available for a list
+client = Campaigning::Client.find_by_name("Client One Company")
+list = client.find_list_by_name "List from Sample Exec"
+result = list.custom_fields
+puts result.inspect
+puts "Here is all my Custom fields from the given list:  #{result.inspect}"
+  
+  
+#How to delete a custom field from a list
+client = Campaigning::Client.find_by_name("Client One Company")
+list = client.find_list_by_name "List from Sample Exec"    
+result = list.delete_custom_field!("Color")
+puts "Was my Color custom field deleted successfuly? #{result.message}"
+#Deleting my Contact Type custom Field
+result = list.delete_custom_field!("ContactType")
+puts "Was my Contact Type custom field deleted successfuly? #{result.message}"  
+  
+  
+#Here is how to get a list of all ACTIVE subscribers for a list that have been added since the specified date.
+client = Campaigning::Client.find_by_name("Client One Company")
+list = client.find_list_by_name "List from Sample Exec"
+subscriber_list = list.find_active_subscribers(DateTime.new(y=2009,m=5,d=01, h=01,min=00,s=00))
+result = subscriber_list.inspect
+
+
+#Here is how to get all ACTIVE subscribers since ever
+subscriber_list = list.get_all_active_subscribers
+result = subscriber_list.inspect
+puts "Here is all active subscribers from the list: #{result}"
+  
+
+#Here is how to get a range of subscribers by regular expression
+subscriber_list = list.get_all_active_subscribers
+subs_list_found = subscriber_list.find_all{|subscriber| subscriber.emailAddress =~ /[\w]+@example.com/}
+puts "Here is how to get a range of subscribers by regular expression: #{subs_list_found.inspect}"
+
+
+#Here is how to get a range of subscribers by string matching
+subscriber_list = list.get_all_active_subscribers
+subs_list_found = subscriber_list.find_all{|subscriber| subscriber.name == "Robert Franklin Jr."}
+puts "Here is how to get a range of subscribers by regular expression: #{subs_list_found.inspect}"  
+  
+  
+#Here is how to get a list’s configuration detail
+client = Campaigning::Client.find_by_name("Client One Company")
+list = client.find_list_by_name "List from Sample Exec"
+result = list.details
+puts "Here is my list configuration details:  #{result.inspect}"
+
+
+#Here is hot to update a subscriber list’s details
+client = Campaigning::Client.find_by_name("Client One Company")
+list = client.find_list_by_name "List from Sample Exec"
+result = list.update!(
+  :title => "My new list created by ruby list_sample",
+  :unsubscribePage => "", # Default will be used
+  :confirmOptIn => false,
+  :confirmationSuccessPage => "" #Default will be used
+)
+puts "Was my list updated successfully?  #{result.message}"
+
+
+#Gets a list of all subscribers for a list that have unsubscribed since the specified date.
+client = Campaigning::Client.find_by_name "Client One Company"
+list = client.find_list_by_name "My new list created by ruby list_sample"
+subscriber_list = list.find_unsubscribed(DateTime.new(y=2009,m=4,d=01, h=01,min=00,s=00))
+puts "All subscriber that have unsubscribed from the list: #{subscriber_list.inspect}"
+
+
+#This method returns all of a particular subscribers details, including email address, name, active/inactive status
+#and all custom field data.
+client = Campaigning::Client.find_by_name "Client One Company"
+list = client.find_list_by_name "My new list created by ruby list_sample"
+subscriber = list.find_single_subscriber(EMAIL_2)
+puts "Subscriber details: #{subscriber.inspect}"
+
+
+#Here is how to delete a list
+client = Campaigning::Client.find_by_name("Client One Company")
+list = client.find_list_by_name "My new list created by ruby list_sample"
+result = Campaigning::List.delete!(list.listID)
+puts "Was my list deleted successfully?  #{result.message}"
+
+
+#Deleting another list (instance method)
+list = client.find_list_by_name "List from Sample Exec2" 
+list.delete!
+puts "Was my second list deleted successfully: #{list.listID}"
+
+#Get statistics from a List
+client = Campaigning::Client.find_by_name("Client One Company")
+list = client.find_list_by_name "New list to test BLA"
+puts "List statistics: #{list.stats}"
+
+
+

data/sample/subscriber_sample.rb

@@ -0,0 +1,88 @@
+require 'rubygems'
+require 'campaigning'
+
+CAMPAIGN_MONITOR_API_KEY  = '__PUT__YOUR__API__KEY__HERE__'
+
+
+# SETUP FOR THIS SAMPLE ---------------------------------------------------------------------
+#Creating a list for sample execution
+client = Campaigning::Client.find_by_name("Client One Company")
+list = Campaigning::List.create!(
+  :clientID => client.clientID,
+  :title => "List for Subscriber Sample Exec",
+  :confirmOptIn => false
+)
+LIST_ID = list.listID
+puts "New list created: #{list.name} #{list.listID}"
+#Creating a Custom Field for sample execution
+client = Campaigning::Client.find_by_name("Client One Company")
+list = client.find_list_by_name "List for Subscriber Sample Exec"
+result = list.create_custom_field!(:fieldName => "City Name", :dataType => "Text")
+puts "Custom field City Name created successfuly?: #{result.message}"
+result = list.create_custom_field!(:fieldName => "Sponsor Name", :dataType => "Text")
+puts "Custom field Sponsor Name created successfuly?: #{result.message}"
+# /SETUP FOR THIS SAMPLE ---------------------------------------------------------------------
+
+
+
+
+
+EMAIL_1 = "em4@example.com"
+EMAIL_2 = "em5@example.com"
+EMAIL_3 = "em6@example.com"
+
+#Here is how to add a subscriber (email address, name) to an existing subscriber list.
+subscriber = Campaigning::Subscriber.new(EMAIL_1, "Robert Franklin")
+result = subscriber.add!(LIST_ID)
+puts "Was the subscriber add tho the list: #{result.message}"
+
+
+#Here is how to add and resubscribe a Subscriber to an existing subscriber list.
+subscriber = Campaigning::Subscriber.new(EMAIL_2, "Nora Green")
+result = subscriber.add_and_resubscribe!(LIST_ID)
+puts "Was the subscriber add and resubscribed tho the list: #{result.message}"
+
+
+#Here is how to add a subscriber WITH CUSTOM FIELDS to an existing subscriber list.
+subscriber = Campaigning::Subscriber.new(EMAIL_3, "Mr. Custon")
+result = subscriber.add!(
+  LIST_ID,
+  :CityName => "London", :SponsorName => "Some Sponsor from London" #<-- Both Custom Fields for "City Name" and "Sponsor Name"
+)
+puts "Was the subscriber WITH custom fields add tho the list: #{result.message}"
+
+
+
+#Here is how to add and resubscribe a Subscriber WITH CUSTOM FIELDS to an existing subscriber list.
+subscriber = Campaigning::Subscriber.new(EMAIL_3, "Mr. Custon")
+result = subscriber.add_and_resubscribe!(
+  LIST_ID, 
+  :CityName => "Dublin", :SponsorName => "Some Sponsor" #<-- Both Custom Fields for "City Name" and "Sponsor Name"
+)
+puts "Was the subscriber WITH custom fields add and resubscribed tho the list: #{result.message}"
+
+
+#Here is how to change the status of an Active Subscriber to an Unsubscribed Subscriber who will no longer
+#receive campaigns sent to that Subscriber List.
+result = Campaigning::Subscriber.unsubscribe!(EMAIL_2, LIST_ID)
+#Or you can use a instance method like:
+subscriber = Campaigning::Subscriber.new(EMAIL_1)
+result = subscriber.unsubscribe!(LIST_ID)
+puts "Was the subscriber unsubscribed from the list: #{result.message}"
+
+
+#Returns True or False as to the existence of the given email address in the list supplied. 
+result = Campaigning::Subscriber.is_subscribed?(EMAIL_2, LIST_ID)
+#Or you can use a instance method like:
+subscriber = Campaigning::Subscriber.new(EMAIL_3)
+result = subscriber.is_subscribed?(LIST_ID)
+puts "Was the email subscribed in the list? #{result}"
+
+
+
+
+# TEARDOWN FOR THIS SAMPLE --------------------------------------------------------------------
+#Just deleting a list created for sample execution
+list = client.find_list_by_name "List for Subscriber Sample Exec"
+result = Campaigning::List.delete!( list.listID )
+puts "Was the list deleted successfully?  #{result.message}"

data/test/campaign_test.rb

@@ -0,0 +1,102 @@
+require 'test_helper'
+
+# Replace this API key with your own (http://www.campaignmonitor.com/api/)
+CAMPAIGN_MONITOR_API_KEY  = '__PUT_YOUR_API_KEY_HERE__'
+
+class CampaignTest < Test::Unit::TestCase
+
+
+  def setup
+    #Campaigning.set_endpoint_url "http://127.0.0.1:8088/mockapiSoap"
+    Campaigning.set_debug_mode(:on)
+  end
+
+  def test_campaign_create
+    client = Campaigning::Client.find_by_name("Client One Company")    
+    response = Campaigning::Campaign.create!(
+    :clientID => client.clientID,
+    :campaignName => "Campaign by Campaigning TO DELETE - CODEE",
+    :campaignSubject => "Campaign by myself - OK - CODEE",
+    :fromName => "Mr. Gordon23",
+    :fromEmail => "gordon23@test.com",
+    :replyTo => "no-reply@test.com",
+    :htmlUrl => "http://gnumarcelo.github.com",
+    :textUrl => "http://gnumarcelo.github.com",
+    :subscriberListIDs => ["ac52b645c048888a44c87b5f1ecf6b7d"],
+    :listSegments => client.segments
+    )
+    puts response.inspect
+  end
+  
+  
+  def test_campaign_delete!
+    #client = Campaigning::Client.find_by_name("Client One Company")    
+    response = Campaigning::Campaign.delete!("4e5952a0840869b77f05b29b9a7a292b")
+    puts response.inspect
+  end
+  
+  def test_campaign_bounces
+    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
+  end
+  
+  def test_campaign_opens
+    client = Campaigning::Client.find_by_name("Client One Company")
+    puts client.campaigns[0].opens
+  end
+  
+  def test_campaign_find_campaigns_by_subject
+    client = Campaigning::Client.find_by_name("Client One Company")
+    campaigns = client.find_campaigns_by_subject("Campaign to BOUNCE")    
+    assert campaign.length > 0
+  end
+  
+  
+  def test_campaign_summary
+    client = Campaigning::Client.find_by_name("Client One Company")
+    # 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
+  
+  
+  def test_campaign_summary
+    client = Campaigning::Client.find_by_name("Client One Company")
+    puts client.campaigns[1].summary
+  end
+  
+  def test_campaign_unsubscribes
+    client = Campaigning::Client.find_by_name("Client One Company")
+    puts client.campaigns[0].unsubscribes
+  end
+  
+  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
+    )
+  
+    puts client.campaigns[0].send!(
+    :confirmationEmail => "userhdhd@test.com",
+    :sendDate => "2009-04-30 11:55:01" # Date format YYYY-MM-DD HH:MM:SS.
+    ) 
+  end
+end

data/test/campaigning_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+# Replace this API key with your own (http://www.campaignmonitor.com/api/)
+CAMPAIGN_MONITOR_API_KEY  = '__PUT_YOUR_API_KEY_HERE__'
+
+class CampaigningTest < Test::Unit::TestCase
+
+
+  def setup
+    #Campaigning.set_endpoint_url "http://127.0.0.1:8088/mockapiSoap"
+  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_lists
+    client = Campaigning::Client.find_by_name("Client One Company")    
+    assert client.lists.length > 0
+  end
+
+
+end

data/test/client_test.rb

@@ -0,0 +1,130 @@
+require 'test_helper'
+
+# Replace this API key with your own (http://www.campaignmonitor.com/api/)
+CAMPAIGN_MONITOR_API_KEY  = '__PUT_YOUR_API_KEY_HERE__'
+
+
+
+class ClientTest < Test::Unit::TestCase
+
+
+  def setup
+    #Campaigning.set_endpoint_url "http://127.0.0.1:8088/mockapiSoap"
+    #Campaigning.set_debug_mode(:on)
+  end
+
+  def test_client_get_templates
+    client = Campaigning::Client.get_all_clients.first
+    puts "#{client.name} - #{client.clientID}"
+    puts "Templates: #{client.templates.inspect}"
+  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_create!
+    client_created = Campaigning::Client.create!(
+    :companyName => "My test clients22",
+    :contactName => "Oswald Green15s25",
+    :emailAddress => "og1524s@example.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
+  end
+  
+  def test_client_delete_itself
+    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
+  end
+  
+  
+  def test_find_client_by_name
+    client = Campaigning::Client.find_by_name("Client One Company")
+    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 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}"
+  
+    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!(
+    :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
+  
+end