diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d741c80 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +.project +doc/* +pkg/* diff --git a/Rakefile b/Rakefile new file mode 100644 index 0000000..d96dd89 --- /dev/null +++ b/Rakefile @@ -0,0 +1,29 @@ +require 'rubygems' +require 'rake/gempackagetask' +require 'rake/testtask' +require 'rake/rdoctask' + +# read the contents of the gemspec, eval it, and assign it to 'spec' +# this lets us maintain all gemspec info in one place. Nice and DRY. +spec = eval(IO.read("campaign_monitor.gemspec")) + +Rake::GemPackageTask.new(spec) do |pkg| + pkg.gem_spec = spec +end + +task :install => [:package] do + sh %{sudo gem install pkg/#{GEM}-#{VERSION}} +end + +Rake::TestTask.new do |t| + t.libs << "test" + t.test_files = FileList['test/test*.rb'] + t.verbose = true +end + +Rake::RDocTask.new do |rd| + rd.main = "README.rdoc" + rd.rdoc_files.include("README.rdoc", "lib/**/*.rb") + rd.rdoc_dir = 'doc' + rd.options = spec.rdoc_options +end diff --git a/doc/classes/CMCampaignSummary.html b/doc/classes/CMCampaignSummary.html deleted file mode 100644 index e29c069..0000000 --- a/doc/classes/CMCampaignSummary.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - -
-Class | -CMCampaignSummary | -
In: | -
-
- campaign_monitor_old.rb
-
- - |
-
Parent: | -- Object - | -
bounced | -[RW] | -- |
clicks | -[RW] | -- |
recipients | -[RW] | -- |
total_opened | -[RW] | -- |
unsubscribed | -[RW] | -- |
# File campaign_monitor_old.rb, line 318 - def initialize(recipients, total_opened, clicks, unsubscribed, bounced) - @recipients = recipients - @total_opened = total_opened - @clicks = clicks - @unsubscribed = unsubscribed - @bounced = bounced - end- - \ No newline at end of file diff --git a/doc/classes/CMClient.html b/doc/classes/CMClient.html deleted file mode 100644 index 672160e..0000000 --- a/doc/classes/CMClient.html +++ /dev/null @@ -1,111 +0,0 @@ - - - - - -
Class | -CMClient | -
In: | -
-
- campaign_monitor_old.rb
-
- - |
-
Parent: | -- Object - | -
Class | -CMResult | -
In: | -
-
- campaign_monitor_old.rb
-
- - |
-
Parent: | -- Object - | -
code | -[RW] | -- |
message | -[RW] | -- |
# File campaign_monitor_old.rb, line 308 - def initialize(message, code) - @message = message - @code = code - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.html b/doc/classes/CampaignMonitor.html deleted file mode 100644 index b8eafa6..0000000 --- a/doc/classes/CampaignMonitor.html +++ /dev/null @@ -1,355 +0,0 @@ - - - - - -
Class | -CampaignMonitor | -
In: | -
-
- lib/campaign_monitor.rb
-
- - |
-
Parent: | -- Object - | -
-Replace this API key with your own (www.campaignmonitor.com/api/) -
--A quick method of adding a subscriber to a list. Returns a Result object -
--Example -
-- @cm = CampaignMonitor.new() - result = @cm.add_subscriber(12345, "ralph.wiggum@simpsons.net", "Ralph Wiggum") - - if result.code == 0 - puts "Subscriber Added to List" - end --
-Returns an array of Client -objects associated with the API Key -
--Example -
-- @cm = CampaignMonitor.new() - @clients = @cm.clients - - for client in @clients - puts client.name - end --
-Returns an array of Subscriber Lists for the -specified Client ID -
--Example -
-- @cm = CampaignMonitor.new() - @lists = @cm.lists(12345) - - for list in @lists - puts list.name - end --
-By overriding the method_missing -method, it is possible to easily support all of the methods available in -the API -
--Takes a CampaignMonitor API method name -and set of parameters; returns an XmlSimple object with the response -
--Takes a CampaignMonitor API method name -and set of parameters; returns the correct URL for the REST API. -
-# File lib/campaign_monitor.rb, line 64 - def initialize(api_key=CAMPAIGN_MONITOR_API_KEY) - @api_key = api_key - @host = 'http://app.campaignmonitor.com' - @api = '/api/api.asmx/' - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000002.html b/doc/classes/CampaignMonitor.src/M000002.html deleted file mode 100644 index d1d9255..0000000 --- a/doc/classes/CampaignMonitor.src/M000002.html +++ /dev/null @@ -1,20 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 65 - def initialize(api_key=CAMPAIGN_MONITOR_API_KEY) - @api_key = api_key - @host = 'http://app.campaignmonitor.com' - @api = '/api/api.asmx/' - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000003.html b/doc/classes/CampaignMonitor.src/M000003.html deleted file mode 100644 index 1ad2ffb..0000000 --- a/doc/classes/CampaignMonitor.src/M000003.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 73 - def request(method, *params) - response = XmlSimple.xml_in(http_get(request_url(method, params)), { 'ForceArray' => false, 'ForceArray' => %r(List$|Campaign$|Subscriber$|Client$|SubscriberOpen$|SubscriberUnsubscribe$|SubscriberClick$|SubscriberBounce$), 'NoAttr' => true }) - response - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000004.html b/doc/classes/CampaignMonitor.src/M000004.html deleted file mode 100644 index fcdaa11..0000000 --- a/doc/classes/CampaignMonitor.src/M000004.html +++ /dev/null @@ -1,20 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 79 - def request_url(method, *params) - url = "#{@host}#{@api}/#{method}?ApiKey=#{@api_key}" - params[0][0].each_key do |key| url += "&#{key}=" + CGI::escape(params[0][0][key].to_s) end if params[0][0] - url - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000005.html b/doc/classes/CampaignMonitor.src/M000005.html deleted file mode 100644 index fff2dc0..0000000 --- a/doc/classes/CampaignMonitor.src/M000005.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 86 - def http_get(url) - Net::HTTP.get_response(URI.parse(url)).body.to_s - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000006.html b/doc/classes/CampaignMonitor.src/M000006.html deleted file mode 100644 index 219a8dd..0000000 --- a/doc/classes/CampaignMonitor.src/M000006.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 92 - def method_missing(method_id, *params) - request(method_id.id2name.gsub(/_/, '.'), params[0]) - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000007.html b/doc/classes/CampaignMonitor.src/M000007.html deleted file mode 100644 index f9b5132..0000000 --- a/doc/classes/CampaignMonitor.src/M000007.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 105 - def clients - response = User_GetClients() - unless response["Code"].to_i != 0 - response["Client"].collect{|c| Client.new(c["ClientID"].to_i, c["Name"])} - else - raise response["Code"] + " - " + response["Message"] - end - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000008.html b/doc/classes/CampaignMonitor.src/M000008.html deleted file mode 100644 index 7ff761d..0000000 --- a/doc/classes/CampaignMonitor.src/M000008.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 123 - def campaigns(client_id) - response = Client_GetCampaigns("ClientID" => client_id) - unless response["Code"].to_i != 0 - response["Campaign"].collect{|c| Campaign.new(c["CampaignID"].to_i, c["Subject"], c["SentDate"], c["TotalRecipients"].to_i)} - else - raise response["Code"] + " - " + response["Message"] - end - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000009.html b/doc/classes/CampaignMonitor.src/M000009.html deleted file mode 100644 index 3cf74d5..0000000 --- a/doc/classes/CampaignMonitor.src/M000009.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 141 - def lists(client_id) - response = Client_GetLists("ClientID" => client_id) - unless response["Code"].to_i != 0 - response["List"].collect{|l| List.new(l["ListID"].to_i, l["Name"])} - else - raise response["Code"] + " - " + response["Message"] - end - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000010.html b/doc/classes/CampaignMonitor.src/M000010.html deleted file mode 100644 index ad8e26e..0000000 --- a/doc/classes/CampaignMonitor.src/M000010.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 159 - def add_subscriber(list_id, email, name) - response = Subscriber_Add("ListID" => list_id, "Email" => email, "Name" => name) - Result.new(response["Message"], response["Code"].to_i) - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000011.html b/doc/classes/CampaignMonitor.src/M000011.html deleted file mode 100644 index 50eae1c..0000000 --- a/doc/classes/CampaignMonitor.src/M000011.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - -
# File campaign_monitor_old.rb, line 114 - def subscriber_unsubscribe(list_id, email) - result = request(get_path('Subscriber.Unsubscribe') + "&ListID=#{list_id}&Email=#{email}") - CMResult.new(result["Result"]["Message"], result["Result"]["Code"].to_i) - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000012.html b/doc/classes/CampaignMonitor.src/M000012.html deleted file mode 100644 index d3dd100..0000000 --- a/doc/classes/CampaignMonitor.src/M000012.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - -
# File campaign_monitor_old.rb, line 119 - def subscriber_get_active(list_id, since_date) - records "Subscriber", get_path('Subscribers.GetActive') + "&ListID=#{list_id}&Date=" + CGI::escape(since_date.strftime("%Y-%m-%d %H:%M:%S")) - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000013.html b/doc/classes/CampaignMonitor.src/M000013.html deleted file mode 100644 index 1f761f5..0000000 --- a/doc/classes/CampaignMonitor.src/M000013.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - -
# File campaign_monitor_old.rb, line 123 - def subscriber_get_unsubscribed(list_id, since_date) - records "Subscriber", get_path('Subscribers.GetUnsubscribed') + "&ListID=#{list_id}&Date=" + CGI::escape(since_date.strftime("%Y-%m-%d %H:%M:%S")) - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000014.html b/doc/classes/CampaignMonitor.src/M000014.html deleted file mode 100644 index 2cf7ccb..0000000 --- a/doc/classes/CampaignMonitor.src/M000014.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - -
# File campaign_monitor_old.rb, line 127 - def subscriber_get_bounced(list_id, since_date) - records "Subscriber", get_path('Subscribers.GetBounced') + "&ListID=#{list_id}&Date=" + CGI::escape(since_date.strftime("%Y-%m-%d %H:%M:%S")) - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000015.html b/doc/classes/CampaignMonitor.src/M000015.html deleted file mode 100644 index a0ec4ae..0000000 --- a/doc/classes/CampaignMonitor.src/M000015.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - -
# File campaign_monitor_old.rb, line 134 - def campaign_get_summary(campaign_id) - result = request(get_path("Campaign.GetSummary") + "&CampaignID=#{campaign_id}") - CMCampaignSummary.new(result["anyType"]["Recipients"].to_i, result["anyType"]["TotalOpened"].to_i, result["anyType"]["Clicks"].to_i, result["anyType"]["Unsubscribed"].to_i, result["anyType"]["Bounced"].to_i) - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000016.html b/doc/classes/CampaignMonitor.src/M000016.html deleted file mode 100644 index 7cb1318..0000000 --- a/doc/classes/CampaignMonitor.src/M000016.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - -
# File campaign_monitor_old.rb, line 139 - def campaign_get_opens(campaign_id) - records "SubscriberOpen", get_path("Campaign.GetOpens") + "&CampaignID=#{campaign_id}" - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000017.html b/doc/classes/CampaignMonitor.src/M000017.html deleted file mode 100644 index dd7b6e9..0000000 --- a/doc/classes/CampaignMonitor.src/M000017.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - -
# File campaign_monitor_old.rb, line 143 - def campaign_get_bounces(campaign_id) - records "SubscriberBounce", get_path("Campaign.GetBounces") + "&CampaignID=#{campaign_id}" - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000018.html b/doc/classes/CampaignMonitor.src/M000018.html deleted file mode 100644 index 0b25bae..0000000 --- a/doc/classes/CampaignMonitor.src/M000018.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - -
# File campaign_monitor_old.rb, line 147 - def campaign_get_subscriber_clicks(campaign_id) - records "SubscriberClick", get_path("Campaign.GetClicks") + "&CampaignID=#{campaign_id}" - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000019.html b/doc/classes/CampaignMonitor.src/M000019.html deleted file mode 100644 index 2611757..0000000 --- a/doc/classes/CampaignMonitor.src/M000019.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - -
# File campaign_monitor_old.rb, line 151 - def campaign_get_unsubscribes(campaign_id) - records "SubscriberUnsubscribe", get_path('Campaign.GetUnsubscribes') + "&CampaignID=#{campaign_id}" - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000020.html b/doc/classes/CampaignMonitor.src/M000020.html deleted file mode 100644 index c5a37af..0000000 --- a/doc/classes/CampaignMonitor.src/M000020.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - -
# File campaign_monitor_old.rb, line 157 - def client_get_lists(client_id) - records "List", get_path('Client.GetLists') + "&ClientID=#{client_id}" - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000021.html b/doc/classes/CampaignMonitor.src/M000021.html deleted file mode 100644 index ea8cda5..0000000 --- a/doc/classes/CampaignMonitor.src/M000021.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - -
# File campaign_monitor_old.rb, line 161 - def client_get_campaigns(client_id) - records "Campaign", get_path('Client.GetCampaigns') + "&ClientID=#{client_id}" - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000022.html b/doc/classes/CampaignMonitor.src/M000022.html deleted file mode 100644 index ca574c3..0000000 --- a/doc/classes/CampaignMonitor.src/M000022.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - -
# File campaign_monitor_old.rb, line 169 - def user_get_clients - records "Client", get_path('User.GetClients') - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000023.html b/doc/classes/CampaignMonitor.src/M000023.html deleted file mode 100644 index d316f6c..0000000 --- a/doc/classes/CampaignMonitor.src/M000023.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - -
# File campaign_monitor_old.rb, line 173 - def user_get_system_date - request(get_path('User.GetSystemDate'))["anyType"] - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000024.html b/doc/classes/CampaignMonitor.src/M000024.html deleted file mode 100644 index 93f1dae..0000000 --- a/doc/classes/CampaignMonitor.src/M000024.html +++ /dev/null @@ -1,29 +0,0 @@ - - - - - -
# File campaign_monitor_old.rb, line 180 - def request(path, parameters = {}, second_try = false) - #response = post(path, convert_body(parameters), "Content-Type" => content_type) - response = get(path) - - if response.code.to_i / 100 == 2 - result = XmlSimple.xml_in(response.body, 'keeproot' => true, 'NoAttr' => true, 'ForceArray' => false) - #typecast_value(result) - elsif response.code == "302" && !second_try - connect!(@url, !@use_ssl) - request(path, parameters, true) - else - raise "#{response.message} (#{response.code})" - end - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000025.html b/doc/classes/CampaignMonitor.src/M000025.html deleted file mode 100644 index 03f2529..0000000 --- a/doc/classes/CampaignMonitor.src/M000025.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - -
# File campaign_monitor_old.rb, line 197 - def record(path, parameters={}) - result = get(path) - (result) ? Record.new(result.keys.first, result.values.first) : nil - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000026.html b/doc/classes/CampaignMonitor.src/M000026.html deleted file mode 100644 index c92c17f..0000000 --- a/doc/classes/CampaignMonitor.src/M000026.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - -
# File campaign_monitor_old.rb, line 208 - def records(node, path, parameters={}) - result = request(path, parameters).values.first or return [] - result = result[node] or return [] - result = [result] unless Array === result - result.map { |row| Record.new(node, row) } - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000027.html b/doc/classes/CampaignMonitor.src/M000027.html deleted file mode 100644 index d1f0bbe..0000000 --- a/doc/classes/CampaignMonitor.src/M000027.html +++ /dev/null @@ -1,20 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 64 - def initialize(api_key=CAMPAIGN_MONITOR_API_KEY) - @api_key = api_key - @host = 'http://app.campaignmonitor.com' - @api = '/api/api.asmx/' - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000028.html b/doc/classes/CampaignMonitor.src/M000028.html deleted file mode 100644 index 2de56b3..0000000 --- a/doc/classes/CampaignMonitor.src/M000028.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 72 - def request(method, *params) - response = XmlSimple.xml_in(http_get(request_url(method, params)), { 'ForceArray' => false, 'ForceArray' => %r(List$|Campaign$|Subscriber$|Client$|SubscriberOpen$|SubscriberUnsubscribe$|SubscriberClick$|SubscriberBounce$), 'NoAttr' => true }) - response - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000029.html b/doc/classes/CampaignMonitor.src/M000029.html deleted file mode 100644 index 86e1489..0000000 --- a/doc/classes/CampaignMonitor.src/M000029.html +++ /dev/null @@ -1,20 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 78 - def request_url(method, *params) - url = "#{@host}#{@api}/#{method}?ApiKey=#{@api_key}" - params[0][0].each_key do |key| url += "&#{key}=" + CGI::escape(params[0][0][key].to_s) end if params[0][0] - url - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000030.html b/doc/classes/CampaignMonitor.src/M000030.html deleted file mode 100644 index c6129b5..0000000 --- a/doc/classes/CampaignMonitor.src/M000030.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 85 - def http_get(url) - Net::HTTP.get_response(URI.parse(url)).body.to_s - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000031.html b/doc/classes/CampaignMonitor.src/M000031.html deleted file mode 100644 index b5d4882..0000000 --- a/doc/classes/CampaignMonitor.src/M000031.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 89 - def method_missing(method_id, *params) - request(method_id.id2name.gsub(/_/, '.'), params[0]) - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000032.html b/doc/classes/CampaignMonitor.src/M000032.html deleted file mode 100644 index 4fa4257..0000000 --- a/doc/classes/CampaignMonitor.src/M000032.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 93 - def clients - response = User_GetClients() - unless response["Code"].to_i != 0 - response["Client"].collect{|c| Client.new(c["ClientID"].to_i, c["Name"])} - else - raise response["Code"] + " - " + response["Message"] - end - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000033.html b/doc/classes/CampaignMonitor.src/M000033.html deleted file mode 100644 index bd33bf1..0000000 --- a/doc/classes/CampaignMonitor.src/M000033.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 108 - def campaigns(client_id) - response = Client_GetCampaigns("ClientID" => client_id) - unless response["Code"].to_i != 0 - response["Campaign"].collect{|c| Campaign.new(c["CampaignID"].to_i, c["Subject"], c["SentDate"], c["TotalRecipients"].to_i)} - else - raise response["Code"] + " - " + response["Message"] - end - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000034.html b/doc/classes/CampaignMonitor.src/M000034.html deleted file mode 100644 index b9d8689..0000000 --- a/doc/classes/CampaignMonitor.src/M000034.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 117 - def lists(client_id) - response = Client_GetLists("ClientID" => client_id) - unless response["Code"].to_i != 0 - response["List"].collect{|l| List.new(l["ListID"].to_i, l["Name"])} - else - raise response["Code"] + " - " + response["Message"] - end - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000035.html b/doc/classes/CampaignMonitor.src/M000035.html deleted file mode 100644 index 2d42de8..0000000 --- a/doc/classes/CampaignMonitor.src/M000035.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 126 - def add_subscriber(list_id, email, name) - response = Subscriber_Add("ListID" => list_id, "Email" => email, "Name" => name) - Result.new(response["Message"], response["Code"].to_i) - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Campaign.html b/doc/classes/CampaignMonitor/Campaign.html deleted file mode 100644 index a480c0c..0000000 --- a/doc/classes/CampaignMonitor/Campaign.html +++ /dev/null @@ -1,387 +0,0 @@ - - - - - -
Class | -CampaignMonitor::Campaign | -
In: | -
-
- lib/campaign_monitor.rb
-
- - |
-
Parent: | -- Object - | -
-Provides access to the information about a campaign -
- -id | -[R] | -- |
sent_date | -[R] | -- |
subject | -[R] | -- |
total_recipients | -[R] | -- |
-Example -
-- @campaign = Campaign.new(12345) - @subscriber_bounces = @campaign.bounces - - for subscriber in @subscriber_bounces - puts subscriber.email - end --
-Example -
-- @campaign = Campaign.new(12345) - @subscriber_clicks = @campaign.clicks - - for subscriber in @subscriber_clicks - puts subscriber.email - end --
-Example -
-- @campaign = Campaign.new(12345) - puts @campaign.number_unsubscribed --
-Example -
-- @campaign = Campaign.new(12345) - @subscriber_opens = @campaign.opens - - for subscriber in @subscriber_opens - puts subscriber.email - end --
# File lib/campaign_monitor.rb, line 220 - def initialize(id=nil, subject=nil, sent_date=nil, total_recipients=nil) - @id = id - @subject = subject - @sent_date = sent_date - @total_recipients = total_recipients - @cm_client = CampaignMonitor.new - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Campaign.src/M000028.html b/doc/classes/CampaignMonitor/Campaign.src/M000028.html deleted file mode 100644 index acc7804..0000000 --- a/doc/classes/CampaignMonitor/Campaign.src/M000028.html +++ /dev/null @@ -1,22 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 303 - def initialize(id=nil, subject=nil, sent_date=nil, total_recipients=nil) - @id = id - @subject = subject - @sent_date = sent_date - @total_recipients = total_recipients - @cm_client = CampaignMonitor.new - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Campaign.src/M000029.html b/doc/classes/CampaignMonitor/Campaign.src/M000029.html deleted file mode 100644 index e31045f..0000000 --- a/doc/classes/CampaignMonitor/Campaign.src/M000029.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 318 - def opens - response = @cm_client.Campaign_GetOpens("CampaignID" => @id) - unless response["Code"].to_i != 0 - response["SubscriberOpen"].collect{|s| SubscriberOpen.new(s["EmailAddress"], s["ListID"].to_i, s["NumberOfOpens"])} - else - raise response["Code"] + " - " + response["Message"] - end - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Campaign.src/M000030.html b/doc/classes/CampaignMonitor/Campaign.src/M000030.html deleted file mode 100644 index fa025ca..0000000 --- a/doc/classes/CampaignMonitor/Campaign.src/M000030.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 334 - def bounces - response = @cm_client.Campaign_GetBounces("CampaignID"=> @id) - unless response["Code"].to_i != 0 - response["SubscriberBounce"].collect{|s| SubscriberBounce.new(s["EmailAddress"], s["ListID"].to_i, s["BounceType"])} - else - raise response["Code"] + " - " + response["Message"] - end - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Campaign.src/M000031.html b/doc/classes/CampaignMonitor/Campaign.src/M000031.html deleted file mode 100644 index f0152d9..0000000 --- a/doc/classes/CampaignMonitor/Campaign.src/M000031.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 350 - def clicks - response = @cm_client.Campaign_GetSubscriberClicks("CampaignID" => @id) - unless response["Code"].to_i != 0 - response["SubscriberClick"].collect{|s| SubscriberClick.new(s["EmailAddress"], s["ListID"].to_i, s["ClickedLinks"])} - else - raise response["Code"] + " - " + response["Message"] - end - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Campaign.src/M000032.html b/doc/classes/CampaignMonitor/Campaign.src/M000032.html deleted file mode 100644 index 864fa20..0000000 --- a/doc/classes/CampaignMonitor/Campaign.src/M000032.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 366 - def unsubscribes - response = @cm_client.Campaign_GetUnsubscribes("CampaignID" => @id) - unless response["Code"].to_i != 0 - response["SubscriberUnsubscribe"].collect{|s| SubscriberUnsubscribe.new(s["EmailAddress"], s["ListID"].to_i)} - else - raise response["Code"] + " - " + response["Message"] - end - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Campaign.src/M000033.html b/doc/classes/CampaignMonitor/Campaign.src/M000033.html deleted file mode 100644 index 100b769..0000000 --- a/doc/classes/CampaignMonitor/Campaign.src/M000033.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 378 - def number_recipients - @number_recipients.nil? ? getInfo.number_recipients : @number_recipients - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Campaign.src/M000034.html b/doc/classes/CampaignMonitor/Campaign.src/M000034.html deleted file mode 100644 index ca1eefc..0000000 --- a/doc/classes/CampaignMonitor/Campaign.src/M000034.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 385 - def number_opened - @number_opened.nil? ? getInfo.number_opened : @number_opened - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Campaign.src/M000035.html b/doc/classes/CampaignMonitor/Campaign.src/M000035.html deleted file mode 100644 index b8ce9d3..0000000 --- a/doc/classes/CampaignMonitor/Campaign.src/M000035.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 392 - def number_clicks - @number_clicks.nil? ? getInfo.number_clicks : @number_clicks - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Campaign.src/M000036.html b/doc/classes/CampaignMonitor/Campaign.src/M000036.html deleted file mode 100644 index afa6a4e..0000000 --- a/doc/classes/CampaignMonitor/Campaign.src/M000036.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 399 - def number_unsubscribed - @number_unsubscribed.nil? ? getInfo.number_unsubscribed : @number_unsubscribed - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Campaign.src/M000053.html b/doc/classes/CampaignMonitor/Campaign.src/M000053.html deleted file mode 100644 index bf420c1..0000000 --- a/doc/classes/CampaignMonitor/Campaign.src/M000053.html +++ /dev/null @@ -1,22 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 226 - def initialize(id=nil, subject=nil, sent_date=nil, total_recipients=nil) - @id = id - @subject = subject - @sent_date = sent_date - @total_recipients = total_recipients - @cm_client = CampaignMonitor.new - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Campaign.src/M000054.html b/doc/classes/CampaignMonitor/Campaign.src/M000054.html deleted file mode 100644 index cd9b4ea..0000000 --- a/doc/classes/CampaignMonitor/Campaign.src/M000054.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 234 - def opens - response = @cm_client.Campaign_GetOpens("CampaignID" => @id) - unless response["Code"].to_i != 0 - response["SubscriberOpen"].collect{|s| SubscriberOpen.new(s["EmailAddress"], s["ListID"].to_i, s["NumberOfOpens"])} - else - raise response["Code"] + " - " + response["Message"] - end - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Campaign.src/M000055.html b/doc/classes/CampaignMonitor/Campaign.src/M000055.html deleted file mode 100644 index 1d60147..0000000 --- a/doc/classes/CampaignMonitor/Campaign.src/M000055.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 243 - def bounces - response = @cm_client.Campaign_GetBounces("CampaignID"=> @id) - unless response["Code"].to_i != 0 - response["SubscriberBounce"].collect{|s| SubscriberBounce.new(s["EmailAddress"], s["ListID"].to_i, s["BounceType"])} - else - raise response["Code"] + " - " + response["Message"] - end - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Campaign.src/M000056.html b/doc/classes/CampaignMonitor/Campaign.src/M000056.html deleted file mode 100644 index 37008e9..0000000 --- a/doc/classes/CampaignMonitor/Campaign.src/M000056.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 252 - def clicks - response = @cm_client.Campaign_GetSubscriberClicks("CampaignID" => @id) - unless response["Code"].to_i != 0 - response["SubscriberClick"].collect{|s| SubscriberClick.new(s["EmailAddress"], s["ListID"].to_i, s["ClickedLinks"])} - else - raise response["Code"] + " - " + response["Message"] - end - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Campaign.src/M000057.html b/doc/classes/CampaignMonitor/Campaign.src/M000057.html deleted file mode 100644 index 0b4e41d..0000000 --- a/doc/classes/CampaignMonitor/Campaign.src/M000057.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 261 - def unsubscribes - response = @cm_client.Campaign_GetUnsubscribes("CampaignID" => @id) - unless response["Code"].to_i != 0 - response["SubscriberUnsubscribe"].collect{|s| SubscriberUnsubscribe.new(s["EmailAddress"], s["ListID"].to_i)} - else - raise response["Code"] + " - " + response["Message"] - end - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Campaign.src/M000058.html b/doc/classes/CampaignMonitor/Campaign.src/M000058.html deleted file mode 100644 index d6aca75..0000000 --- a/doc/classes/CampaignMonitor/Campaign.src/M000058.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 270 - def number_recipients - @number_recipients.nil? ? getInfo.number_recipients : @number_recipients - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Campaign.src/M000059.html b/doc/classes/CampaignMonitor/Campaign.src/M000059.html deleted file mode 100644 index 26dbf9f..0000000 --- a/doc/classes/CampaignMonitor/Campaign.src/M000059.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 274 - def number_opened - @number_opened.nil? ? getInfo.number_opened : @number_opened - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Campaign.src/M000060.html b/doc/classes/CampaignMonitor/Campaign.src/M000060.html deleted file mode 100644 index bd6a0c5..0000000 --- a/doc/classes/CampaignMonitor/Campaign.src/M000060.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 278 - def number_clicks - @number_clicks.nil? ? getInfo.number_clicks : @number_clicks - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Campaign.src/M000061.html b/doc/classes/CampaignMonitor/Campaign.src/M000061.html deleted file mode 100644 index 0bd7358..0000000 --- a/doc/classes/CampaignMonitor/Campaign.src/M000061.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 282 - def number_unsubscribed - @number_unsubscribed.nil? ? getInfo.number_unsubscribed : @number_unsubscribed - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Campaign.src/M000062.html b/doc/classes/CampaignMonitor/Campaign.src/M000062.html deleted file mode 100644 index e8cfb97..0000000 --- a/doc/classes/CampaignMonitor/Campaign.src/M000062.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 286 - def number_bounced - @number_bounced.nil? ? getInfo.number_bounced : @number_bounced - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Client.html b/doc/classes/CampaignMonitor/Client.html deleted file mode 100644 index b316d98..0000000 --- a/doc/classes/CampaignMonitor/Client.html +++ /dev/null @@ -1,226 +0,0 @@ - - - - - -
Class | -CampaignMonitor::Client | -
In: | -
-
- lib/campaign_monitor.rb
-
- - |
-
Parent: | -- Object - | -
-Provides access to the lists and campaigns associated with a client -
- -cm_client | -[R] | -- |
id | -[R] | -- |
name | -[R] | -- |
-Example -
-- @client = new Client(12345) - @campaigns = @client.campaigns - - for campaign in @campaigns - puts campaign.subject - end --
-Example -
-- @client = new Client(12345) - @lists = @client.lists - - for list in @lists - puts list.name - end --
# File lib/campaign_monitor.rb, line 141 - def initialize(id, name=nil) - @id = id - @name = name - @cm_client = CampaignMonitor.new - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Client.src/M000017.html b/doc/classes/CampaignMonitor/Client.src/M000017.html deleted file mode 100644 index 24ae58f..0000000 --- a/doc/classes/CampaignMonitor/Client.src/M000017.html +++ /dev/null @@ -1,20 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 170 - def initialize(id, name=nil) - @id = id - @name = name - @cm_client = CampaignMonitor.new - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Client.src/M000018.html b/doc/classes/CampaignMonitor/Client.src/M000018.html deleted file mode 100644 index 88aa161..0000000 --- a/doc/classes/CampaignMonitor/Client.src/M000018.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 183 - def lists - response = @cm_client.Client_GetLists("ClientID" => @id) - unless response["Code"].to_i != 0 - response["List"].collect{|l| List.new(l["ListID"].to_i, l["Name"])} - else - raise response["Code"] + " - " + response["Message"] - end - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Client.src/M000042.html b/doc/classes/CampaignMonitor/Client.src/M000042.html deleted file mode 100644 index d0aa327..0000000 --- a/doc/classes/CampaignMonitor/Client.src/M000042.html +++ /dev/null @@ -1,20 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 139 - def initialize(id, name=nil) - @id = id - @name = name - @cm_client = CampaignMonitor.new - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Client.src/M000043.html b/doc/classes/CampaignMonitor/Client.src/M000043.html deleted file mode 100644 index 50a2a84..0000000 --- a/doc/classes/CampaignMonitor/Client.src/M000043.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 145 - def lists - response = @cm_client.Client_GetLists("ClientID" => @id) - unless response["Code"].to_i != 0 - response["List"].collect{|l| List.new(l["ListID"].to_i, l["Name"])} - else - raise response["Code"] + " - " + response["Message"] - end - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Client.src/M000044.html b/doc/classes/CampaignMonitor/Client.src/M000044.html deleted file mode 100644 index 28f44b6..0000000 --- a/doc/classes/CampaignMonitor/Client.src/M000044.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 154 - def campaigns - response = @cm_client.Client_GetCampaigns("ClientID" => @id) - unless response["Code"].to_i != 0 - response["Campaign"].collect{|c| Campaign.new(c["CampaignID"].to_i, c["Subject"], c["SentDate"], c["TotalRecipients"].to_i)} - else - raise response["Code"] + " - " + response["Message"] - end - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/List.html b/doc/classes/CampaignMonitor/List.html deleted file mode 100644 index f7c4555..0000000 --- a/doc/classes/CampaignMonitor/List.html +++ /dev/null @@ -1,308 +0,0 @@ - - - - - -
Class | -CampaignMonitor::List | -
In: | -
-
- lib/campaign_monitor.rb
-
- - |
-
Parent: | -- Object - | -
-Provides access to the subscribers and info about subscribers associated -with a Mailing List -
- -cm_client | -[R] | -- |
id | -[R] | -- |
name | -[R] | -- |
-Example -
-- current_date = DateTime.new - @list = new List(12345) - @subscribers = @list.active_subscribers(current_date) - - for subscriber in @subscribers - puts subscriber.email - end --
-Example -
-- @list = new List(12345) - result = @list.add_subscriber("ralph.wiggum@simpsons.net") - - if result.code == 0 - puts "Added Subscriber" - end --
-Example -
-- current_date = DateTime.new - @list = new List(12345) - @subscribers = @list.bounced(current_date) - - for subscriber in @subscribers - puts subscriber.email - end --
-Example -
-- @list = new List(12345) - result = @list.remove_subscriber("ralph.wiggum@simpsons.net") - - if result.code == 0 - puts "Deleted Subscriber" - end --
# File lib/campaign_monitor.rb, line 171 - def initialize(id=nil, name=nil) - @id = id - @name = name - @cm_client = CampaignMonitor.new - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/List.src/M000022.html b/doc/classes/CampaignMonitor/List.src/M000022.html deleted file mode 100644 index 9289287..0000000 --- a/doc/classes/CampaignMonitor/List.src/M000022.html +++ /dev/null @@ -1,20 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 216 - def initialize(id=nil, name=nil) - @id = id - @name = name - @cm_client = CampaignMonitor.new - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/List.src/M000023.html b/doc/classes/CampaignMonitor/List.src/M000023.html deleted file mode 100644 index 041cd59..0000000 --- a/doc/classes/CampaignMonitor/List.src/M000023.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 229 - def add_subscriber(email, name = nil) - response = @cm_client.Subscriber_Add("ListID" => @id, "Email" => email, "Name" => name) - Result.new(response["Message"], response["Code"].to_i) - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/List.src/M000024.html b/doc/classes/CampaignMonitor/List.src/M000024.html deleted file mode 100644 index 2b7e38d..0000000 --- a/doc/classes/CampaignMonitor/List.src/M000024.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 241 - def remove_subscriber(email) - response = @cm_client.Subscriber_Unsubscribe("ListID" => @id, "Email" => email) - Result.new(response["Message"], response["Code"].to_i) - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/List.src/M000025.html b/doc/classes/CampaignMonitor/List.src/M000025.html deleted file mode 100644 index 48e1936..0000000 --- a/doc/classes/CampaignMonitor/List.src/M000025.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 254 - def active_subscribers(date) - response = @cm_client.Subscribers_GetActive('ListID' => @id, "Date" => date.strftime("%Y-%m-%d %H:%M:%S")) - unless response["Code"].to_i != 0 - response["Subscriber"].collect{|s| Subscriber.new(s["EmailAddress"], s["Name"], s["Date"])} - else - raise response["Code"] + " - " + response["Message"] - end - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/List.src/M000026.html b/doc/classes/CampaignMonitor/List.src/M000026.html deleted file mode 100644 index 569ba96..0000000 --- a/doc/classes/CampaignMonitor/List.src/M000026.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 271 - def unsubscribed(date) - response = @cm_client.Subscribers_GetUnsubscribed('ListID' => @id, 'Date' => date.strftime("%Y-%m-%d %H:%M:%S")) - unless response["Code"].to_i != 0 - response["Subscriber"].collect{|s| Subscriber.new(s["EmailAddress"], s["Name"], s["Date"])} - else - raise response["Code"] + " - " + response["Message"] - end - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/List.src/M000047.html b/doc/classes/CampaignMonitor/List.src/M000047.html deleted file mode 100644 index 474ee20..0000000 --- a/doc/classes/CampaignMonitor/List.src/M000047.html +++ /dev/null @@ -1,20 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 173 - def initialize(id=nil, name=nil) - @id = id - @name = name - @cm_client = CampaignMonitor.new - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/List.src/M000048.html b/doc/classes/CampaignMonitor/List.src/M000048.html deleted file mode 100644 index 74d07b2..0000000 --- a/doc/classes/CampaignMonitor/List.src/M000048.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 179 - def add_subscriber(email, name = nil) - response = @cm_client.Subscriber_Add("ListID" => @id, "Email" => email, "Name" => name) - Result.new(response["Message"], response["Code"].to_i) - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/List.src/M000049.html b/doc/classes/CampaignMonitor/List.src/M000049.html deleted file mode 100644 index a142ab1..0000000 --- a/doc/classes/CampaignMonitor/List.src/M000049.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 184 - def remove_subscriber(email) - response = @cm_client.Subscriber_Unsubscribe("ListID" => @id, "Email" => email) - Result.new(response["Message"], response["Code"].to_i) - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/List.src/M000050.html b/doc/classes/CampaignMonitor/List.src/M000050.html deleted file mode 100644 index 032026e..0000000 --- a/doc/classes/CampaignMonitor/List.src/M000050.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 189 - def active_subscribers(date) - response = @cm_client.Subscribers_GetActive('ListID' => @id, "Date" => date.strftime("%Y-%m-%d %H:%M:%S")) - unless response["Code"].to_i != 0 - response["Subscriber"].collect{|s| Subscriber.new(s["EmailAddress"], s["Name"], s["Date"])} - else - raise response["Code"] + " - " + response["Message"] - end - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/List.src/M000051.html b/doc/classes/CampaignMonitor/List.src/M000051.html deleted file mode 100644 index b64660d..0000000 --- a/doc/classes/CampaignMonitor/List.src/M000051.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 198 - def unsubscribed(date) - response = @cm_client.Subscribers_GetUnsubscribed('ListID' => @id, 'Date' => date.strftime("%Y-%m-%d %H:%M:%S")) - unless response["Code"].to_i != 0 - response["Subscriber"].collect{|s| Subscriber.new(s["EmailAddress"], s["Name"], s["Date"])} - else - raise response["Code"] + " - " + response["Message"] - end - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/List.src/M000052.html b/doc/classes/CampaignMonitor/List.src/M000052.html deleted file mode 100644 index 062ff73..0000000 --- a/doc/classes/CampaignMonitor/List.src/M000052.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 207 - def bounced(date) - response = @cm_client.Subscribers_GetBounced('ListID' => @id, 'Date' => date.strftime("%Y-%m-%d %H:%M:%S")) - unless response["Code"].to_i != 0 - response["Subscriber"].collect{|s| Subscriber.new(s["EmailAddress"], s["Name"], s["Date"])} - else - raise response["Code"] + " - " + response["Message"] - end - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Result.html b/doc/classes/CampaignMonitor/Result.html deleted file mode 100644 index faadf9b..0000000 --- a/doc/classes/CampaignMonitor/Result.html +++ /dev/null @@ -1,162 +0,0 @@ - - - - - -
Class | -CampaignMonitor::Result | -
In: | -
-
- lib/campaign_monitor.rb
-
- - |
-
Parent: | -- Object - | -
-Encapsulates the response received from the CampaignMonitor webservice. -
- -code | -[R] | -- |
message | -[R] | -- |
# File lib/campaign_monitor.rb, line 366 - def initialize(message, code) - @message = message - @code = code - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Result.src/M000046.html b/doc/classes/CampaignMonitor/Result.src/M000046.html deleted file mode 100644 index c7d0e76..0000000 --- a/doc/classes/CampaignMonitor/Result.src/M000046.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 396 - def initialize(message, code) - @message = message - @code = code - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Subscriber.html b/doc/classes/CampaignMonitor/Subscriber.html deleted file mode 100644 index 2ae9f46..0000000 --- a/doc/classes/CampaignMonitor/Subscriber.html +++ /dev/null @@ -1,212 +0,0 @@ - - - - - -
Class | -CampaignMonitor::Subscriber | -
In: | -
-
- lib/campaign_monitor.rb
-
- - |
-
Parent: | -- Object - | -
-Provides the ability to add/remove subscribers from a list -
- -date_subscribed | -[RW] | -- |
email_address | -[RW] | -- |
name | -[RW] | -- |
-Example -
-- @subscriber = Subscriber.new("ralph.wiggum@simpsons.net") - @subscriber.add(12345) --
# File lib/campaign_monitor.rb, line 301 - def initialize(email_address, name=nil, date=nil) - @email_address = email_address - @name = name - @date_subscribed = date_subscribed - @cm_client = CampaignMonitor.new - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Subscriber.src/M000013.html b/doc/classes/CampaignMonitor/Subscriber.src/M000013.html deleted file mode 100644 index 483a27a..0000000 --- a/doc/classes/CampaignMonitor/Subscriber.src/M000013.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 427 - def initialize(email_address, name=nil, date=nil) - @email_address = email_address - @name = name - @date_subscribed = date_subscribed - @cm_client = CampaignMonitor.new - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Subscriber.src/M000014.html b/doc/classes/CampaignMonitor/Subscriber.src/M000014.html deleted file mode 100644 index 1a7ed79..0000000 --- a/doc/classes/CampaignMonitor/Subscriber.src/M000014.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 437 - def add(list_id) - response = @cm_client.Subscriber_Add("ListID" => list_id, "Email" => @email_address, "Name" => @name) - Result.new(response["Message"], response["Code"].to_i) - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Subscriber.src/M000038.html b/doc/classes/CampaignMonitor/Subscriber.src/M000038.html deleted file mode 100644 index 8669f0b..0000000 --- a/doc/classes/CampaignMonitor/Subscriber.src/M000038.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 311 - def initialize(email_address, name=nil, date=nil) - @email_address = email_address - @name = name - @date_subscribed = date_subscribed - @cm_client = CampaignMonitor.new - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Subscriber.src/M000039.html b/doc/classes/CampaignMonitor/Subscriber.src/M000039.html deleted file mode 100644 index 945e54e..0000000 --- a/doc/classes/CampaignMonitor/Subscriber.src/M000039.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 318 - def add(list_id) - response = @cm_client.Subscriber_Add("ListID" => list_id, "Email" => @email_address, "Name" => @name) - Result.new(response["Message"], response["Code"].to_i) - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Subscriber.src/M000040.html b/doc/classes/CampaignMonitor/Subscriber.src/M000040.html deleted file mode 100644 index 5ff7c55..0000000 --- a/doc/classes/CampaignMonitor/Subscriber.src/M000040.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 323 - def unsubscribe(list_id) - response = @cm_client.Subscriber_Unsubscribe("ListID" => list_id, "Email" => @email_address) - Result.new(response["Message"], response["Code"].to_i) - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/SubscriberBounce.html b/doc/classes/CampaignMonitor/SubscriberBounce.html deleted file mode 100644 index 03e942f..0000000 --- a/doc/classes/CampaignMonitor/SubscriberBounce.html +++ /dev/null @@ -1,166 +0,0 @@ - - - - - -
Class | -CampaignMonitor::SubscriberBounce | -
In: | -
-
- lib/campaign_monitor.rb
-
- - |
-
Parent: | -- Object - | -
-Encapsulates -
- -bounce_type | -[R] | -- |
email_address | -[R] | -- |
list_id | -[R] | -- |
# File lib/campaign_monitor.rb, line 323 - def initialize(email_address, list_id, bounce_type) - @email_address = email_address - @bounce_type = bounce_type - @list_id = list_id - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/SubscriberBounce.src/M000045.html b/doc/classes/CampaignMonitor/SubscriberBounce.src/M000045.html deleted file mode 100644 index 7bc8f82..0000000 --- a/doc/classes/CampaignMonitor/SubscriberBounce.src/M000045.html +++ /dev/null @@ -1,20 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 337 - def initialize(email_address, list_id, bounce_type) - @email_address = email_address - @bounce_type = bounce_type - @list_id = list_id - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/SubscriberClick.html b/doc/classes/CampaignMonitor/SubscriberClick.html deleted file mode 100644 index f1e4745..0000000 --- a/doc/classes/CampaignMonitor/SubscriberClick.html +++ /dev/null @@ -1,166 +0,0 @@ - - - - - -
Class | -CampaignMonitor::SubscriberClick | -
In: | -
-
- lib/campaign_monitor.rb
-
- - |
-
Parent: | -- Object - | -
-Encapsulates -
- -clicked_links | -[R] | -- |
email_address | -[R] | -- |
list_id | -[R] | -- |
# File lib/campaign_monitor.rb, line 345 - def initialize(email_address, list_id, clicked_links) - @email_address = email_address - @list_id = list_id - @clicked_links = clicked_links - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/SubscriberClick.src/M000036.html b/doc/classes/CampaignMonitor/SubscriberClick.src/M000036.html deleted file mode 100644 index a63d68b..0000000 --- a/doc/classes/CampaignMonitor/SubscriberClick.src/M000036.html +++ /dev/null @@ -1,20 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 367 - def initialize(email_address, list_id, clicked_links) - @email_address = email_address - @list_id = list_id - @clicked_links = clicked_links - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/SubscriberOpen.html b/doc/classes/CampaignMonitor/SubscriberOpen.html deleted file mode 100644 index d058167..0000000 --- a/doc/classes/CampaignMonitor/SubscriberOpen.html +++ /dev/null @@ -1,166 +0,0 @@ - - - - - -
Class | -CampaignMonitor::SubscriberOpen | -
In: | -
-
- lib/campaign_monitor.rb
-
- - |
-
Parent: | -- Object - | -
-Encapsulates -
- -email_address | -[R] | -- |
list_id | -[R] | -- |
opens | -[R] | -- |
# File lib/campaign_monitor.rb, line 334 - def initialize(email_address, list_id, opens) - @email_address = email_address - @list_id = list_id - @opens = opens - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/SubscriberOpen.src/M000037.html b/doc/classes/CampaignMonitor/SubscriberOpen.src/M000037.html deleted file mode 100644 index d72a1cd..0000000 --- a/doc/classes/CampaignMonitor/SubscriberOpen.src/M000037.html +++ /dev/null @@ -1,20 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 352 - def initialize(email_address, list_id, opens) - @email_address = email_address - @list_id = list_id - @opens = opens - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/SubscriberUnsubscribe.html b/doc/classes/CampaignMonitor/SubscriberUnsubscribe.html deleted file mode 100644 index dde72be..0000000 --- a/doc/classes/CampaignMonitor/SubscriberUnsubscribe.html +++ /dev/null @@ -1,161 +0,0 @@ - - - - - -
Class | -CampaignMonitor::SubscriberUnsubscribe | -
In: | -
-
- lib/campaign_monitor.rb
-
- - |
-
Parent: | -- Object - | -
-Encapsulates -
- -email_address | -[R] | -- |
list_id | -[R] | -- |
# File lib/campaign_monitor.rb, line 356 - def initialize(email_address, list_id) - @email_address = email_address - @list_id = list_id - end- - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/SubscriberUnsubscribe.src/M000041.html b/doc/classes/CampaignMonitor/SubscriberUnsubscribe.src/M000041.html deleted file mode 100644 index 30c9aef..0000000 --- a/doc/classes/CampaignMonitor/SubscriberUnsubscribe.src/M000041.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - -
# File lib/campaign_monitor.rb, line 382 - def initialize(email_address, list_id) - @email_address = email_address - @list_id = list_id - end- - \ No newline at end of file diff --git a/doc/classes/Hash.html b/doc/classes/Hash.html deleted file mode 100644 index a39cc6c..0000000 --- a/doc/classes/Hash.html +++ /dev/null @@ -1,137 +0,0 @@ - - - - - -
Class | -Hash | -
In: | -
-
- campaign_monitor_old.rb
-
- - |
-
Parent: | -- Object - | -
# File campaign_monitor_old.rb, line 300 - def to_xml - XmlSimple.xml_out({:request => self}, 'keeproot' => true, 'noattr' => true) - end- - \ No newline at end of file diff --git a/doc/classes/Symbol.html b/doc/classes/Symbol.html deleted file mode 100644 index a8c530a..0000000 --- a/doc/classes/Symbol.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - -
Class | -Symbol | -
In: | -
-
- campaign_monitor_old.rb
-
- - |
-
Parent: | -- Object - | -
-A minor hack to let Xml-Simple serialize symbolic keys in hashes -
- -# File campaign_monitor_old.rb, line 294 - def [](*args) - to_s[*args] - end- - \ No newline at end of file diff --git a/doc/created.rid b/doc/created.rid deleted file mode 100644 index 42f9386..0000000 --- a/doc/created.rid +++ /dev/null @@ -1 +0,0 @@ -Fri May 12 10:43:52 WST 2006 diff --git a/doc/files/campaign_monitor_old_rb.html b/doc/files/campaign_monitor_old_rb.html deleted file mode 100644 index 05bac10..0000000 --- a/doc/files/campaign_monitor_old_rb.html +++ /dev/null @@ -1,119 +0,0 @@ - - - - - -
Path: | -campaign_monitor_old.rb - | -
Last Update: | -Thu May 04 14:05:37 WST 2006 | -
-the following are all standard ruby libraries -
- -Path: | -lib/campaign_monitor.rb - | -
Last Update: | -Fri May 12 10:43:39 WST 2006 | -
-CampaignMonitor A wrapper -class to access the Campaign Monitor API. Written using the wonderful -Flickr interface by Scott Raymond as a guide on how to access remote web -services -
--For more information on the Campaign Monitor API, visit campaignmonitor.com/api -
-Author: | Jordan Brock <jordan@spintech.com.au> - - |
Copyright: | Copyright © 2006 Jordan Brock <jordan@spintech.com.au> - - |
License: | MIT <www.opensource.org/licenses/mit-license.php> - - |
-USAGE: -
-- require 'campaign_monitor' - cm = CampaignMonitor.new(API_KEY) # creates a CampaignMonitor object - # Can set CAMPAIGN_MONITOR_API_KEY in environment.rb - cm.clients # Returns an array of clients associated with - # the user account - cm.campaigns(client_id) - cm.lists(client_id) - cm.add_subscriber(list_id, email, name) - - CLIENT - client = Client.new(client_id) - client.lists - client.campaigns - - LIST - list = List.new(list_id) - list.add_subscriber(email, name) - list.remove_subscriber(email) - list.active_subscribers(date) - list.unsubscribed(date) - list.bounced(date) - - CAMPAIGN - campaign = Campaign.new(campaign_id) - campaign.clicks - campaign.opens - campaign.bounces - campaign.unsubscribes - campaign.number_recipients - campaign.number_clicks - campaign.number_opens - campaign.number_bounces - campaign.number_unsubscribes - - SUBSCRIBER - subscriber = Subscriber.new(email) - subscriber.add(list_id) - subscriber.unsubscribe(list_id) - - Data Types - SubscriberBounce - SubscriberClick - SubscriberOpen - SubscriberUnsubscribe - Result -- -