From ec436e6e00a4de84939b947d9a5779008fdd7406 Mon Sep 17 00:00:00 2001 From: Ben Woosley Date: Sat, 9 Aug 2008 02:37:16 -0700 Subject: [PATCH] Rather than keep the docs under source control, which doesn't make much sense since they're derivative, make it easy to generate them by adding a Rakefile --- .gitignore | 3 + Rakefile | 29 ++ doc/classes/CMCampaignSummary.html | 170 -------- .../CMCampaignSummary.src/M000003.html | 22 - doc/classes/CMClient.html | 111 ----- doc/classes/CMResult.html | 155 ------- doc/classes/CMResult.src/M000004.html | 19 - doc/classes/CampaignMonitor.html | 355 ---------------- doc/classes/CampaignMonitor.src/M000001.html | 20 - doc/classes/CampaignMonitor.src/M000002.html | 20 - doc/classes/CampaignMonitor.src/M000003.html | 19 - doc/classes/CampaignMonitor.src/M000004.html | 20 - doc/classes/CampaignMonitor.src/M000005.html | 18 - doc/classes/CampaignMonitor.src/M000006.html | 18 - doc/classes/CampaignMonitor.src/M000007.html | 23 -- doc/classes/CampaignMonitor.src/M000008.html | 23 -- doc/classes/CampaignMonitor.src/M000009.html | 23 -- doc/classes/CampaignMonitor.src/M000010.html | 19 - doc/classes/CampaignMonitor.src/M000011.html | 19 - doc/classes/CampaignMonitor.src/M000012.html | 18 - doc/classes/CampaignMonitor.src/M000013.html | 18 - doc/classes/CampaignMonitor.src/M000014.html | 18 - doc/classes/CampaignMonitor.src/M000015.html | 19 - doc/classes/CampaignMonitor.src/M000016.html | 18 - doc/classes/CampaignMonitor.src/M000017.html | 18 - doc/classes/CampaignMonitor.src/M000018.html | 18 - doc/classes/CampaignMonitor.src/M000019.html | 18 - doc/classes/CampaignMonitor.src/M000020.html | 18 - doc/classes/CampaignMonitor.src/M000021.html | 18 - doc/classes/CampaignMonitor.src/M000022.html | 18 - doc/classes/CampaignMonitor.src/M000023.html | 18 - doc/classes/CampaignMonitor.src/M000024.html | 29 -- doc/classes/CampaignMonitor.src/M000025.html | 19 - doc/classes/CampaignMonitor.src/M000026.html | 21 - doc/classes/CampaignMonitor.src/M000027.html | 20 - doc/classes/CampaignMonitor.src/M000028.html | 19 - doc/classes/CampaignMonitor.src/M000029.html | 20 - doc/classes/CampaignMonitor.src/M000030.html | 18 - doc/classes/CampaignMonitor.src/M000031.html | 18 - doc/classes/CampaignMonitor.src/M000032.html | 23 -- doc/classes/CampaignMonitor.src/M000033.html | 23 -- doc/classes/CampaignMonitor.src/M000034.html | 23 -- doc/classes/CampaignMonitor.src/M000035.html | 19 - doc/classes/CampaignMonitor/Campaign.html | 387 ------------------ .../CampaignMonitor/Campaign.src/M000027.html | 22 - .../CampaignMonitor/Campaign.src/M000028.html | 22 - .../CampaignMonitor/Campaign.src/M000029.html | 23 -- .../CampaignMonitor/Campaign.src/M000030.html | 23 -- .../CampaignMonitor/Campaign.src/M000031.html | 23 -- .../CampaignMonitor/Campaign.src/M000032.html | 23 -- .../CampaignMonitor/Campaign.src/M000033.html | 18 - .../CampaignMonitor/Campaign.src/M000034.html | 18 - .../CampaignMonitor/Campaign.src/M000035.html | 18 - .../CampaignMonitor/Campaign.src/M000036.html | 18 - .../CampaignMonitor/Campaign.src/M000053.html | 22 - .../CampaignMonitor/Campaign.src/M000054.html | 23 -- .../CampaignMonitor/Campaign.src/M000055.html | 23 -- .../CampaignMonitor/Campaign.src/M000056.html | 23 -- .../CampaignMonitor/Campaign.src/M000057.html | 23 -- .../CampaignMonitor/Campaign.src/M000058.html | 18 - .../CampaignMonitor/Campaign.src/M000059.html | 18 - .../CampaignMonitor/Campaign.src/M000060.html | 18 - .../CampaignMonitor/Campaign.src/M000061.html | 18 - .../CampaignMonitor/Campaign.src/M000062.html | 18 - doc/classes/CampaignMonitor/Client.html | 226 ---------- .../CampaignMonitor/Client.src/M000016.html | 20 - .../CampaignMonitor/Client.src/M000017.html | 20 - .../CampaignMonitor/Client.src/M000018.html | 23 -- .../CampaignMonitor/Client.src/M000042.html | 20 - .../CampaignMonitor/Client.src/M000043.html | 23 -- .../CampaignMonitor/Client.src/M000044.html | 23 -- doc/classes/CampaignMonitor/List.html | 308 -------------- .../CampaignMonitor/List.src/M000021.html | 20 - .../CampaignMonitor/List.src/M000022.html | 20 - .../CampaignMonitor/List.src/M000023.html | 19 - .../CampaignMonitor/List.src/M000024.html | 19 - .../CampaignMonitor/List.src/M000025.html | 23 -- .../CampaignMonitor/List.src/M000026.html | 23 -- .../CampaignMonitor/List.src/M000047.html | 20 - .../CampaignMonitor/List.src/M000048.html | 19 - .../CampaignMonitor/List.src/M000049.html | 19 - .../CampaignMonitor/List.src/M000050.html | 23 -- .../CampaignMonitor/List.src/M000051.html | 23 -- .../CampaignMonitor/List.src/M000052.html | 23 -- doc/classes/CampaignMonitor/Result.html | 162 -------- .../CampaignMonitor/Result.src/M000020.html | 19 - .../CampaignMonitor/Result.src/M000046.html | 19 - doc/classes/CampaignMonitor/Subscriber.html | 212 ---------- .../Subscriber.src/M000012.html | 21 - .../Subscriber.src/M000013.html | 21 - .../Subscriber.src/M000014.html | 19 - .../Subscriber.src/M000038.html | 21 - .../Subscriber.src/M000039.html | 19 - .../Subscriber.src/M000040.html | 19 - .../CampaignMonitor/SubscriberBounce.html | 166 -------- .../SubscriberBounce.src/M000019.html | 20 - .../SubscriberBounce.src/M000045.html | 20 - .../CampaignMonitor/SubscriberClick.html | 166 -------- .../SubscriberClick.src/M000010.html | 20 - .../SubscriberClick.src/M000036.html | 20 - .../CampaignMonitor/SubscriberOpen.html | 166 -------- .../SubscriberOpen.src/M000011.html | 20 - .../SubscriberOpen.src/M000037.html | 20 - .../SubscriberUnsubscribe.html | 161 -------- .../SubscriberUnsubscribe.src/M000015.html | 19 - .../SubscriberUnsubscribe.src/M000041.html | 19 - doc/classes/Hash.html | 137 ------- doc/classes/Hash.src/M000002.html | 18 - doc/classes/Symbol.html | 143 ------- doc/classes/Symbol.src/M000001.html | 18 - doc/created.rid | 1 - doc/files/campaign_monitor_old_rb.html | 119 ------ doc/files/lib/campaign_monitor_rb.html | 184 --------- doc/fr_class_index.html | 37 -- doc/fr_file_index.html | 30 -- doc/fr_method_index.html | 63 --- doc/index.html | 24 -- doc/rdoc-style.css | 208 ---------- 118 files changed, 32 insertions(+), 5567 deletions(-) create mode 100644 .gitignore create mode 100644 Rakefile delete mode 100644 doc/classes/CMCampaignSummary.html delete mode 100644 doc/classes/CMCampaignSummary.src/M000003.html delete mode 100644 doc/classes/CMClient.html delete mode 100644 doc/classes/CMResult.html delete mode 100644 doc/classes/CMResult.src/M000004.html delete mode 100644 doc/classes/CampaignMonitor.html delete mode 100644 doc/classes/CampaignMonitor.src/M000001.html delete mode 100644 doc/classes/CampaignMonitor.src/M000002.html delete mode 100644 doc/classes/CampaignMonitor.src/M000003.html delete mode 100644 doc/classes/CampaignMonitor.src/M000004.html delete mode 100644 doc/classes/CampaignMonitor.src/M000005.html delete mode 100644 doc/classes/CampaignMonitor.src/M000006.html delete mode 100644 doc/classes/CampaignMonitor.src/M000007.html delete mode 100644 doc/classes/CampaignMonitor.src/M000008.html delete mode 100644 doc/classes/CampaignMonitor.src/M000009.html delete mode 100644 doc/classes/CampaignMonitor.src/M000010.html delete mode 100644 doc/classes/CampaignMonitor.src/M000011.html delete mode 100644 doc/classes/CampaignMonitor.src/M000012.html delete mode 100644 doc/classes/CampaignMonitor.src/M000013.html delete mode 100644 doc/classes/CampaignMonitor.src/M000014.html delete mode 100644 doc/classes/CampaignMonitor.src/M000015.html delete mode 100644 doc/classes/CampaignMonitor.src/M000016.html delete mode 100644 doc/classes/CampaignMonitor.src/M000017.html delete mode 100644 doc/classes/CampaignMonitor.src/M000018.html delete mode 100644 doc/classes/CampaignMonitor.src/M000019.html delete mode 100644 doc/classes/CampaignMonitor.src/M000020.html delete mode 100644 doc/classes/CampaignMonitor.src/M000021.html delete mode 100644 doc/classes/CampaignMonitor.src/M000022.html delete mode 100644 doc/classes/CampaignMonitor.src/M000023.html delete mode 100644 doc/classes/CampaignMonitor.src/M000024.html delete mode 100644 doc/classes/CampaignMonitor.src/M000025.html delete mode 100644 doc/classes/CampaignMonitor.src/M000026.html delete mode 100644 doc/classes/CampaignMonitor.src/M000027.html delete mode 100644 doc/classes/CampaignMonitor.src/M000028.html delete mode 100644 doc/classes/CampaignMonitor.src/M000029.html delete mode 100644 doc/classes/CampaignMonitor.src/M000030.html delete mode 100644 doc/classes/CampaignMonitor.src/M000031.html delete mode 100644 doc/classes/CampaignMonitor.src/M000032.html delete mode 100644 doc/classes/CampaignMonitor.src/M000033.html delete mode 100644 doc/classes/CampaignMonitor.src/M000034.html delete mode 100644 doc/classes/CampaignMonitor.src/M000035.html delete mode 100644 doc/classes/CampaignMonitor/Campaign.html delete mode 100644 doc/classes/CampaignMonitor/Campaign.src/M000027.html delete mode 100644 doc/classes/CampaignMonitor/Campaign.src/M000028.html delete mode 100644 doc/classes/CampaignMonitor/Campaign.src/M000029.html delete mode 100644 doc/classes/CampaignMonitor/Campaign.src/M000030.html delete mode 100644 doc/classes/CampaignMonitor/Campaign.src/M000031.html delete mode 100644 doc/classes/CampaignMonitor/Campaign.src/M000032.html delete mode 100644 doc/classes/CampaignMonitor/Campaign.src/M000033.html delete mode 100644 doc/classes/CampaignMonitor/Campaign.src/M000034.html delete mode 100644 doc/classes/CampaignMonitor/Campaign.src/M000035.html delete mode 100644 doc/classes/CampaignMonitor/Campaign.src/M000036.html delete mode 100644 doc/classes/CampaignMonitor/Campaign.src/M000053.html delete mode 100644 doc/classes/CampaignMonitor/Campaign.src/M000054.html delete mode 100644 doc/classes/CampaignMonitor/Campaign.src/M000055.html delete mode 100644 doc/classes/CampaignMonitor/Campaign.src/M000056.html delete mode 100644 doc/classes/CampaignMonitor/Campaign.src/M000057.html delete mode 100644 doc/classes/CampaignMonitor/Campaign.src/M000058.html delete mode 100644 doc/classes/CampaignMonitor/Campaign.src/M000059.html delete mode 100644 doc/classes/CampaignMonitor/Campaign.src/M000060.html delete mode 100644 doc/classes/CampaignMonitor/Campaign.src/M000061.html delete mode 100644 doc/classes/CampaignMonitor/Campaign.src/M000062.html delete mode 100644 doc/classes/CampaignMonitor/Client.html delete mode 100644 doc/classes/CampaignMonitor/Client.src/M000016.html delete mode 100644 doc/classes/CampaignMonitor/Client.src/M000017.html delete mode 100644 doc/classes/CampaignMonitor/Client.src/M000018.html delete mode 100644 doc/classes/CampaignMonitor/Client.src/M000042.html delete mode 100644 doc/classes/CampaignMonitor/Client.src/M000043.html delete mode 100644 doc/classes/CampaignMonitor/Client.src/M000044.html delete mode 100644 doc/classes/CampaignMonitor/List.html delete mode 100644 doc/classes/CampaignMonitor/List.src/M000021.html delete mode 100644 doc/classes/CampaignMonitor/List.src/M000022.html delete mode 100644 doc/classes/CampaignMonitor/List.src/M000023.html delete mode 100644 doc/classes/CampaignMonitor/List.src/M000024.html delete mode 100644 doc/classes/CampaignMonitor/List.src/M000025.html delete mode 100644 doc/classes/CampaignMonitor/List.src/M000026.html delete mode 100644 doc/classes/CampaignMonitor/List.src/M000047.html delete mode 100644 doc/classes/CampaignMonitor/List.src/M000048.html delete mode 100644 doc/classes/CampaignMonitor/List.src/M000049.html delete mode 100644 doc/classes/CampaignMonitor/List.src/M000050.html delete mode 100644 doc/classes/CampaignMonitor/List.src/M000051.html delete mode 100644 doc/classes/CampaignMonitor/List.src/M000052.html delete mode 100644 doc/classes/CampaignMonitor/Result.html delete mode 100644 doc/classes/CampaignMonitor/Result.src/M000020.html delete mode 100644 doc/classes/CampaignMonitor/Result.src/M000046.html delete mode 100644 doc/classes/CampaignMonitor/Subscriber.html delete mode 100644 doc/classes/CampaignMonitor/Subscriber.src/M000012.html delete mode 100644 doc/classes/CampaignMonitor/Subscriber.src/M000013.html delete mode 100644 doc/classes/CampaignMonitor/Subscriber.src/M000014.html delete mode 100644 doc/classes/CampaignMonitor/Subscriber.src/M000038.html delete mode 100644 doc/classes/CampaignMonitor/Subscriber.src/M000039.html delete mode 100644 doc/classes/CampaignMonitor/Subscriber.src/M000040.html delete mode 100644 doc/classes/CampaignMonitor/SubscriberBounce.html delete mode 100644 doc/classes/CampaignMonitor/SubscriberBounce.src/M000019.html delete mode 100644 doc/classes/CampaignMonitor/SubscriberBounce.src/M000045.html delete mode 100644 doc/classes/CampaignMonitor/SubscriberClick.html delete mode 100644 doc/classes/CampaignMonitor/SubscriberClick.src/M000010.html delete mode 100644 doc/classes/CampaignMonitor/SubscriberClick.src/M000036.html delete mode 100644 doc/classes/CampaignMonitor/SubscriberOpen.html delete mode 100644 doc/classes/CampaignMonitor/SubscriberOpen.src/M000011.html delete mode 100644 doc/classes/CampaignMonitor/SubscriberOpen.src/M000037.html delete mode 100644 doc/classes/CampaignMonitor/SubscriberUnsubscribe.html delete mode 100644 doc/classes/CampaignMonitor/SubscriberUnsubscribe.src/M000015.html delete mode 100644 doc/classes/CampaignMonitor/SubscriberUnsubscribe.src/M000041.html delete mode 100644 doc/classes/Hash.html delete mode 100644 doc/classes/Hash.src/M000002.html delete mode 100644 doc/classes/Symbol.html delete mode 100644 doc/classes/Symbol.src/M000001.html delete mode 100644 doc/created.rid delete mode 100644 doc/files/campaign_monitor_old_rb.html delete mode 100644 doc/files/lib/campaign_monitor_rb.html delete mode 100644 doc/fr_class_index.html delete mode 100644 doc/fr_file_index.html delete mode 100644 doc/fr_method_index.html delete mode 100644 doc/index.html delete mode 100644 doc/rdoc-style.css 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 - - - - - - - - - - -
- - - - - - - - - - - - - - -
ClassCMCampaignSummary
In: - - campaign_monitor_old.rb - -
-
Parent: - Object -
-
- - -
- - - -
- - - -
- -
-

Methods

- -
- new   -
-
- -
- - - - -
- - - - - -
-

Attributes

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
bounced [RW] 
clicks [RW] 
recipients [RW] 
total_opened [RW] 
unsubscribed [RW] 
-
-
- - - - -
-

Public Class methods

- - - - -
- - -
- - -
-

[Validate]

-
- - - \ No newline at end of file diff --git a/doc/classes/CMCampaignSummary.src/M000003.html b/doc/classes/CMCampaignSummary.src/M000003.html deleted file mode 100644 index fcbf603..0000000 --- a/doc/classes/CMCampaignSummary.src/M000003.html +++ /dev/null @@ -1,22 +0,0 @@ - - - - - - new (CMCampaignSummary) - - - - - 
# 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 - - - - - - - - - - -
- - - - - - - - - - - - - - -
ClassCMClient
In: - - campaign_monitor_old.rb - -
-
Parent: - Object -
-
- - -
- - - -
- - - -
- - -
- - - - -
- - - - - - - - - - - -
- - -
-

[Validate]

-
- - - \ No newline at end of file diff --git a/doc/classes/CMResult.html b/doc/classes/CMResult.html deleted file mode 100644 index 4007b70..0000000 --- a/doc/classes/CMResult.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - Class: CMResult - - - - - - - - - - -
- - - - - - - - - - - - - - -
ClassCMResult
In: - - campaign_monitor_old.rb - -
-
Parent: - Object -
-
- - -
- - - -
- - - -
- -
-

Methods

- -
- new   -
-
- -
- - - - -
- - - - - -
-

Attributes

- -
- - - - - - - - - - - -
code [RW] 
message [RW] 
-
-
- - - - -
-

Public Class methods

- -
- - -
- - new(message, code) - -
- -
-
-
- - -
- - -
- - -
-

[Validate]

-
- - - \ No newline at end of file diff --git a/doc/classes/CMResult.src/M000004.html b/doc/classes/CMResult.src/M000004.html deleted file mode 100644 index 6f8953a..0000000 --- a/doc/classes/CMResult.src/M000004.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - - new (CMResult) - - - - - 
# 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 - - - - - - - - - - -
- - - - - - - - - - - - - - -
ClassCampaignMonitor
In: - - lib/campaign_monitor.rb - -
-
Parent: - Object -
-
- - -
- - - -
- - - -
- -
-

Methods

- -
- add_subscriber   - campaigns   - clients   - http_get   - lists   - method_missing   - new   - request   - request_url   -
-
- -
- - - - -
- - - - - - - - - - -
-

Public Class methods

- -
- - -
- - new(api_key=CAMPAIGN_MONITOR_API_KEY) - -
- -
-

-Replace this API key with your own (www.campaignmonitor.com/api/) -

-
-
- -

Public Instance methods

- -
- - -
- - add_subscriber(list_id, email, name) - -
- -
-

-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
-
-
-
- -
- - -
- - campaigns(client_id) - -
- -
-

-Returns an array of Campaign -objects associated with the specified Client ID -

-

-Example -

-
- @cm = CampaignMonitor.new()
- @campaigns = @cm.campaigns(12345)
-
- for campaign in @campaigns
-   puts campaign.subject
- end
-
-
-
- -
- - -
- - clients() - -
- -
-

-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
-
-
-
- -
- - -
- - http_get(url) - -
- -
-

-Does an HTTP GET on a given URL and returns the response body -

-
-
- -
- - -
- - lists(client_id) - -
- -
-

-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
-
-
-
- -
- - -
- - method_missing(method_id, *params) - -
- -
-

-By overriding the method_missing -method, it is possible to easily support all of the methods available in -the API -

-
-
- -
- - -
- - request(method, *params) - -
- -
-

-Takes a CampaignMonitor API method name -and set of parameters; returns an XmlSimple object with the response -

-
-
- -
- - -
- - request_url(method, *params) - -
- -
-

-Takes a CampaignMonitor API method name -and set of parameters; returns the correct URL for the REST API. -

-
-
- - -
- - -
- - -
-

[Validate]

-
- - - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor.src/M000001.html b/doc/classes/CampaignMonitor.src/M000001.html deleted file mode 100644 index d1f0bbe..0000000 --- a/doc/classes/CampaignMonitor.src/M000001.html +++ /dev/null @@ -1,20 +0,0 @@ - - - - - - new (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - new (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - request (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - request_url (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - http_get (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - method_missing (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - clients (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - campaigns (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - lists (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - add_subscriber (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - subscriber_unsubscribe (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - subscriber_get_active (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - subscriber_get_unsubscribed (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - subscriber_get_bounced (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - campaign_get_summary (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - campaign_get_opens (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - campaign_get_bounces (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - campaign_get_subscriber_clicks (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - campaign_get_unsubscribes (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - client_get_lists (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - client_get_campaigns (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - user_get_clients (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - user_get_system_date (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - request (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - record (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - records (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - new (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - request (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - request_url (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - http_get (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - method_missing (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - clients (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - campaigns (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - lists (CampaignMonitor) - - - - - 
# 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 @@ - - - - - - add_subscriber (CampaignMonitor) - - - - - 
# 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 - - - - - - - - - - -
- - - - - - - - - - - - - - -
ClassCampaignMonitor::Campaign
In: - - lib/campaign_monitor.rb - -
-
Parent: - Object -
-
- - -
- - - -
- -
-

-Provides access to the information about a campaign -

- -
- - -
- -
-

Methods

- -
- bounces   - clicks   - new   - number_bounced   - number_clicks   - number_opened   - number_recipients   - number_unsubscribed   - opens   - unsubscribes   -
-
- -
- - - - -
- - - - - -
-

Attributes

- -
- - - - - - - - - - - - - - - - - - - - - -
id [R] 
sent_date [R] 
subject [R] 
total_recipients [R] 
-
-
- - - - -
-

Public Class methods

- - - -

Public Instance methods

- -
- - -
- - bounces() - -
- -
-

-Example -

-
- @campaign = Campaign.new(12345)
- @subscriber_bounces = @campaign.bounces
-
- for subscriber in @subscriber_bounces
-   puts subscriber.email
- end
-
-
-
- -
- - -
- - clicks() - -
- -
-

-Example -

-
- @campaign = Campaign.new(12345)
- @subscriber_clicks = @campaign.clicks
-
- for subscriber in @subscriber_clicks
-   puts subscriber.email
- end
-
-
-
- -
- - -
- - number_bounced() - -
- -
-

-Example -

-
- @campaign = Campaign.new(12345)
- puts @campaign.number_bounced
-
-
-
- -
- - -
- - number_clicks() - -
- -
-

-Example -

-
- @campaign = Campaign.new(12345)
- puts @campaign.number_clicks
-
-
-
- -
- - -
- - number_opened() - -
- -
-

-Example -

-
- @campaign = Campaign.new(12345)
- puts @campaign.number_opened
-
-
-
- -
- - -
- - number_recipients() - -
- -
-

-Example -

-
- @campaign = Campaign.new(12345)
- puts @campaign.number_recipients
-
-
-
- -
- - -
- - number_unsubscribed() - -
- -
-

-Example -

-
- @campaign = Campaign.new(12345)
- puts @campaign.number_unsubscribed
-
-
-
- -
- - -
- - opens() - -
- -
-

-Example -

-
- @campaign = Campaign.new(12345)
- @subscriber_opens = @campaign.opens
-
- for subscriber in @subscriber_opens
-   puts subscriber.email
- end
-
-
-
- -
- - -
- - unsubscribes() - -
- -
-

-Example -

-
- @campaign = Campaign.new(12345)
- @subscriber_unsubscribes = @campaign.unsubscribes
-
- for subscriber in @subscriber_unsubscribes
-   puts subscriber.email
- end
-
-
-
- - -
- - -
- - -
-

[Validate]

-
- - - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Campaign.src/M000027.html b/doc/classes/CampaignMonitor/Campaign.src/M000027.html deleted file mode 100644 index e89d37d..0000000 --- a/doc/classes/CampaignMonitor/Campaign.src/M000027.html +++ /dev/null @@ -1,22 +0,0 @@ - - - - - - new (CampaignMonitor::Campaign) - - - - - 
# 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 @@ - - - - - - new (CampaignMonitor::Campaign) - - - - - 
# 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 @@ - - - - - - opens (CampaignMonitor::Campaign) - - - - - 
# 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 @@ - - - - - - bounces (CampaignMonitor::Campaign) - - - - - 
# 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 @@ - - - - - - clicks (CampaignMonitor::Campaign) - - - - - 
# 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 @@ - - - - - - unsubscribes (CampaignMonitor::Campaign) - - - - - 
# 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 @@ - - - - - - number_recipients (CampaignMonitor::Campaign) - - - - - 
# 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 @@ - - - - - - number_opened (CampaignMonitor::Campaign) - - - - - 
# 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 @@ - - - - - - number_clicks (CampaignMonitor::Campaign) - - - - - 
# 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 @@ - - - - - - number_unsubscribed (CampaignMonitor::Campaign) - - - - - 
# 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 @@ - - - - - - new (CampaignMonitor::Campaign) - - - - - 
# 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 @@ - - - - - - opens (CampaignMonitor::Campaign) - - - - - 
# 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 @@ - - - - - - bounces (CampaignMonitor::Campaign) - - - - - 
# 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 @@ - - - - - - clicks (CampaignMonitor::Campaign) - - - - - 
# 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 @@ - - - - - - unsubscribes (CampaignMonitor::Campaign) - - - - - 
# 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 @@ - - - - - - number_recipients (CampaignMonitor::Campaign) - - - - - 
# 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 @@ - - - - - - number_opened (CampaignMonitor::Campaign) - - - - - 
# 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 @@ - - - - - - number_clicks (CampaignMonitor::Campaign) - - - - - 
# 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 @@ - - - - - - number_unsubscribed (CampaignMonitor::Campaign) - - - - - 
# 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 @@ - - - - - - number_bounced (CampaignMonitor::Campaign) - - - - - 
# 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 - - - - - - - - - - -
- - - - - - - - - - - - - - -
ClassCampaignMonitor::Client
In: - - lib/campaign_monitor.rb - -
-
Parent: - Object -
-
- - -
- - - -
- -
-

-Provides access to the lists and campaigns associated with a client -

- -
- - -
- -
-

Methods

- -
- campaigns   - lists   - new   -
-
- -
- - - - -
- - - - - -
-

Attributes

- -
- - - - - - - - - - - - - - - - -
cm_client [R] 
id [R] 
name [R] 
-
-
- - - - -
-

Public Class methods

- -
- - -
- - new(id, name=nil) - -
- -
-

-Example -

-
- @client = new Client(12345)
-
-
-
- -

Public Instance methods

- -
- - -
- - campaigns() - -
- -
-

-Example -

-
- @client = new Client(12345)
- @campaigns = @client.campaigns
-
- for campaign in @campaigns
-   puts campaign.subject
- end
-
-
-
- -
- - -
- - lists() - -
- -
-

-Example -

-
- @client = new Client(12345)
- @lists = @client.lists
-
- for list in @lists
-   puts list.name
- end
-
-
-
- - -
- - -
- - -
-

[Validate]

-
- - - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Client.src/M000016.html b/doc/classes/CampaignMonitor/Client.src/M000016.html deleted file mode 100644 index 293e5bb..0000000 --- a/doc/classes/CampaignMonitor/Client.src/M000016.html +++ /dev/null @@ -1,20 +0,0 @@ - - - - - - new (CampaignMonitor::Client) - - - - - 
# 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 @@ - - - - - - new (CampaignMonitor::Client) - - - - - 
# 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 @@ - - - - - - lists (CampaignMonitor::Client) - - - - - 
# 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 @@ - - - - - - new (CampaignMonitor::Client) - - - - - 
# 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 @@ - - - - - - lists (CampaignMonitor::Client) - - - - - 
# 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 @@ - - - - - - campaigns (CampaignMonitor::Client) - - - - - 
# 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 - - - - - - - - - - -
- - - - - - - - - - - - - - -
ClassCampaignMonitor::List
In: - - lib/campaign_monitor.rb - -
-
Parent: - Object -
-
- - -
- - - -
- -
-

-Provides access to the subscribers and info about subscribers associated -with a Mailing List -

- -
- - -
- -
-

Methods

- -
- active_subscribers   - add_subscriber   - bounced   - new   - remove_subscriber   - unsubscribed   -
-
- -
- - - - -
- - - - - -
-

Attributes

- -
- - - - - - - - - - - - - - - - -
cm_client [R] 
id [R] 
name [R] 
-
-
- - - - -
-

Public Class methods

- -
- - -
- - new(id=nil, name=nil) - -
- -
-

-Example -

-
- @list = new List(12345)
-
-
-
- -

Public Instance methods

- -
- - -
- - active_subscribers(date) - -
- -
-

-Example -

-
- current_date = DateTime.new
- @list = new List(12345)
- @subscribers = @list.active_subscribers(current_date)
-
- for subscriber in @subscribers
-   puts subscriber.email
- end
-
-
-
- -
- - -
- - add_subscriber(email, name = nil) - -
- -
-

-Example -

-
- @list = new List(12345)
- result = @list.add_subscriber("ralph.wiggum@simpsons.net")
-
- if result.code == 0
-   puts "Added Subscriber"
- end
-
-
-
- -
- - -
- - bounced(date) - -
- -
-

-Example -

-
- current_date = DateTime.new
- @list = new List(12345)
- @subscribers = @list.bounced(current_date)
-
- for subscriber in @subscribers
-   puts subscriber.email
- end
-
-
-
- -
- - -
- - remove_subscriber(email) - -
- -
-

-Example -

-
- @list = new List(12345)
- result = @list.remove_subscriber("ralph.wiggum@simpsons.net")
-
- if result.code == 0
-   puts "Deleted Subscriber"
- end
-
-
-
- -
- - -
- - unsubscribed(date) - -
- -
-

-Example -

-
- current_date = DateTime.new
- @list = new List(12345)
- @subscribers = @list.unsubscribed(current_date)
-
- for subscriber in @subscribers
-   puts subscriber.email
- end
-
-
-
- - -
- - -
- - -
-

[Validate]

-
- - - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/List.src/M000021.html b/doc/classes/CampaignMonitor/List.src/M000021.html deleted file mode 100644 index e5367bd..0000000 --- a/doc/classes/CampaignMonitor/List.src/M000021.html +++ /dev/null @@ -1,20 +0,0 @@ - - - - - - new (CampaignMonitor::List) - - - - - 
# 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 @@ - - - - - - new (CampaignMonitor::List) - - - - - 
# 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 @@ - - - - - - add_subscriber (CampaignMonitor::List) - - - - - 
# 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 @@ - - - - - - remove_subscriber (CampaignMonitor::List) - - - - - 
# 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 @@ - - - - - - active_subscribers (CampaignMonitor::List) - - - - - 
# 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 @@ - - - - - - unsubscribed (CampaignMonitor::List) - - - - - 
# 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 @@ - - - - - - new (CampaignMonitor::List) - - - - - 
# 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 @@ - - - - - - add_subscriber (CampaignMonitor::List) - - - - - 
# 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 @@ - - - - - - remove_subscriber (CampaignMonitor::List) - - - - - 
# 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 @@ - - - - - - active_subscribers (CampaignMonitor::List) - - - - - 
# 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 @@ - - - - - - unsubscribed (CampaignMonitor::List) - - - - - 
# 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 @@ - - - - - - bounced (CampaignMonitor::List) - - - - - 
# 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 - - - - - - - - - - -
- - - - - - - - - - - - - - -
ClassCampaignMonitor::Result
In: - - lib/campaign_monitor.rb - -
-
Parent: - Object -
-
- - -
- - - -
- -
-

-Encapsulates the response received from the CampaignMonitor webservice. -

- -
- - -
- -
-

Methods

- -
- new   -
-
- -
- - - - -
- - - - - -
-

Attributes

- -
- - - - - - - - - - - -
code [R] 
message [R] 
-
-
- - - - -
-

Public Class methods

- -
- - -
- - new(message, code) - -
- -
-
-
- - -
- - -
- - -
-

[Validate]

-
- - - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Result.src/M000020.html b/doc/classes/CampaignMonitor/Result.src/M000020.html deleted file mode 100644 index 941987f..0000000 --- a/doc/classes/CampaignMonitor/Result.src/M000020.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - - new (CampaignMonitor::Result) - - - - - 
# 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 @@ - - - - - - new (CampaignMonitor::Result) - - - - - 
# 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 - - - - - - - - - - -
- - - - - - - - - - - - - - -
ClassCampaignMonitor::Subscriber
In: - - lib/campaign_monitor.rb - -
-
Parent: - Object -
-
- - -
- - - -
- -
-

-Provides the ability to add/remove subscribers from a list -

- -
- - -
- -
-

Methods

- -
- add   - new   - unsubscribe   -
-
- -
- - - - -
- - - - - -
-

Attributes

- -
- - - - - - - - - - - - - - - - -
date_subscribed [RW] 
email_address [RW] 
name [RW] 
-
-
- - - - -
-

Public Class methods

- - - -

Public Instance methods

- -
- - -
- - add(list_id) - -
- -
-

-Example -

-
- @subscriber = Subscriber.new("ralph.wiggum@simpsons.net")
- @subscriber.add(12345)
-
-
-
- -
- - -
- - unsubscribe(list_id) - -
- -
-

-Example -

-
- @subscriber = Subscriber.new("ralph.wiggum@simpsons.net")
- @subscriber.unsubscribe(12345)
-
-
-
- - -
- - -
- - -
-

[Validate]

-
- - - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/Subscriber.src/M000012.html b/doc/classes/CampaignMonitor/Subscriber.src/M000012.html deleted file mode 100644 index 1378f02..0000000 --- a/doc/classes/CampaignMonitor/Subscriber.src/M000012.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - new (CampaignMonitor::Subscriber) - - - - - 
# 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 @@ - - - - - - new (CampaignMonitor::Subscriber) - - - - - 
# 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 @@ - - - - - - add (CampaignMonitor::Subscriber) - - - - - 
# 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 @@ - - - - - - new (CampaignMonitor::Subscriber) - - - - - 
# 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 @@ - - - - - - add (CampaignMonitor::Subscriber) - - - - - 
# 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 @@ - - - - - - unsubscribe (CampaignMonitor::Subscriber) - - - - - 
# 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 - - - - - - - - - - -
- - - - - - - - - - - - - - -
ClassCampaignMonitor::SubscriberBounce
In: - - lib/campaign_monitor.rb - -
-
Parent: - Object -
-
- - -
- - - -
- -
-

-Encapsulates -

- -
- - -
- -
-

Methods

- -
- new   -
-
- -
- - - - -
- - - - - -
-

Attributes

- -
- - - - - - - - - - - - - - - - -
bounce_type [R] 
email_address [R] 
list_id [R] 
-
-
- - - - -
-

Public Class methods

- - - - -
- - -
- - -
-

[Validate]

-
- - - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/SubscriberBounce.src/M000019.html b/doc/classes/CampaignMonitor/SubscriberBounce.src/M000019.html deleted file mode 100644 index e74b65b..0000000 --- a/doc/classes/CampaignMonitor/SubscriberBounce.src/M000019.html +++ /dev/null @@ -1,20 +0,0 @@ - - - - - - new (CampaignMonitor::SubscriberBounce) - - - - - 
# 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 @@ - - - - - - new (CampaignMonitor::SubscriberBounce) - - - - - 
# 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 - - - - - - - - - - -
- - - - - - - - - - - - - - -
ClassCampaignMonitor::SubscriberClick
In: - - lib/campaign_monitor.rb - -
-
Parent: - Object -
-
- - -
- - - -
- -
-

-Encapsulates -

- -
- - -
- -
-

Methods

- -
- new   -
-
- -
- - - - -
- - - - - -
-

Attributes

- -
- - - - - - - - - - - - - - - - -
clicked_links [R] 
email_address [R] 
list_id [R] 
-
-
- - - - -
-

Public Class methods

- - - - -
- - -
- - -
-

[Validate]

-
- - - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/SubscriberClick.src/M000010.html b/doc/classes/CampaignMonitor/SubscriberClick.src/M000010.html deleted file mode 100644 index 56c72e9..0000000 --- a/doc/classes/CampaignMonitor/SubscriberClick.src/M000010.html +++ /dev/null @@ -1,20 +0,0 @@ - - - - - - new (CampaignMonitor::SubscriberClick) - - - - - 
# 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 @@ - - - - - - new (CampaignMonitor::SubscriberClick) - - - - - 
# 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 - - - - - - - - - - -
- - - - - - - - - - - - - - -
ClassCampaignMonitor::SubscriberOpen
In: - - lib/campaign_monitor.rb - -
-
Parent: - Object -
-
- - -
- - - -
- -
-

-Encapsulates -

- -
- - -
- -
-

Methods

- -
- new   -
-
- -
- - - - -
- - - - - -
-

Attributes

- -
- - - - - - - - - - - - - - - - -
email_address [R] 
list_id [R] 
opens [R] 
-
-
- - - - -
-

Public Class methods

- - - - -
- - -
- - -
-

[Validate]

-
- - - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/SubscriberOpen.src/M000011.html b/doc/classes/CampaignMonitor/SubscriberOpen.src/M000011.html deleted file mode 100644 index b778e77..0000000 --- a/doc/classes/CampaignMonitor/SubscriberOpen.src/M000011.html +++ /dev/null @@ -1,20 +0,0 @@ - - - - - - new (CampaignMonitor::SubscriberOpen) - - - - - 
# 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 @@ - - - - - - new (CampaignMonitor::SubscriberOpen) - - - - - 
# 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 - - - - - - - - - - -
- - - - - - - - - - - - - - -
ClassCampaignMonitor::SubscriberUnsubscribe
In: - - lib/campaign_monitor.rb - -
-
Parent: - Object -
-
- - -
- - - -
- -
-

-Encapsulates -

- -
- - -
- -
-

Methods

- -
- new   -
-
- -
- - - - -
- - - - - -
-

Attributes

- -
- - - - - - - - - - - -
email_address [R] 
list_id [R] 
-
-
- - - - -
-

Public Class methods

- - - - -
- - -
- - -
-

[Validate]

-
- - - \ No newline at end of file diff --git a/doc/classes/CampaignMonitor/SubscriberUnsubscribe.src/M000015.html b/doc/classes/CampaignMonitor/SubscriberUnsubscribe.src/M000015.html deleted file mode 100644 index 6d2d0e7..0000000 --- a/doc/classes/CampaignMonitor/SubscriberUnsubscribe.src/M000015.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - - new (CampaignMonitor::SubscriberUnsubscribe) - - - - - 
# 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 @@ - - - - - - new (CampaignMonitor::SubscriberUnsubscribe) - - - - - 
# 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 - - - - - - - - - - -
- - - - - - - - - - - - - - -
ClassHash
In: - - campaign_monitor_old.rb - -
-
Parent: - Object -
-
- - -
- - - -
- - - -
- -
-

Methods

- -
- to_xml   -
-
- -
- - - - -
- - - - - - - - - -
-

Public Instance methods

- -
- - -
- - to_xml() - -
- -
-
-
- - -
- - -
- - -
-

[Validate]

-
- - - \ No newline at end of file diff --git a/doc/classes/Hash.src/M000002.html b/doc/classes/Hash.src/M000002.html deleted file mode 100644 index aab4c9d..0000000 --- a/doc/classes/Hash.src/M000002.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - to_xml (Hash) - - - - - 
# 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 - - - - - - - - - - -
- - - - - - - - - - - - - - -
ClassSymbol
In: - - campaign_monitor_old.rb - -
-
Parent: - Object -
-
- - -
- - - -
- -
-

-A minor hack to let Xml-Simple serialize symbolic keys in hashes -

- -
- - -
- -
-

Methods

- -
- []   -
-
- -
- - - - -
- - - - - - - - - -
-

Public Instance methods

- -
- - -
- - [](*args) - -
- -
-
-
- - -
- - -
- - -
-

[Validate]

-
- - - \ No newline at end of file diff --git a/doc/classes/Symbol.src/M000001.html b/doc/classes/Symbol.src/M000001.html deleted file mode 100644 index 5a1885f..0000000 --- a/doc/classes/Symbol.src/M000001.html +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - [] (Symbol) - - - - - 
# 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 @@ - - - - - - File: campaign_monitor_old.rb - - - - - - - - - - -
-

campaign_monitor_old.rb

- - - - - - - - - -
Path:campaign_monitor_old.rb -
Last Update:Thu May 04 14:05:37 WST 2006
-
- - -
- - - -
- -
-

-the following are all standard ruby libraries -

- -
- -
-

Required files

- -
- net/https   - yaml   - date   - time   - xmlsimple   - rubygems   -
-
- -
- - -
- - - - -
- - - - - - - - - - - -
- - -
-

[Validate]

-
- - - \ No newline at end of file diff --git a/doc/files/lib/campaign_monitor_rb.html b/doc/files/lib/campaign_monitor_rb.html deleted file mode 100644 index c8bf920..0000000 --- a/doc/files/lib/campaign_monitor_rb.html +++ /dev/null @@ -1,184 +0,0 @@ - - - - - - File: campaign_monitor.rb - - - - - - - - - - -
-

campaign_monitor.rb

- - - - - - - - - -
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
-
- -
- -
-

Required files

- -
- cgi   - net/http   -
-
- -
- - -
- - - - -
- - - - - - - - - - - -
- - -
-

[Validate]

-
- - - \ No newline at end of file diff --git a/doc/fr_class_index.html b/doc/fr_class_index.html deleted file mode 100644 index 8e128e8..0000000 --- a/doc/fr_class_index.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - Classes - - - - - -
-

Classes

- -
- - \ No newline at end of file diff --git a/doc/fr_file_index.html b/doc/fr_file_index.html deleted file mode 100644 index 224342c..0000000 --- a/doc/fr_file_index.html +++ /dev/null @@ -1,30 +0,0 @@ - - - - - - - - Files - - - - - -
-

Files

- -
- - \ No newline at end of file diff --git a/doc/fr_method_index.html b/doc/fr_method_index.html deleted file mode 100644 index 06cb39b..0000000 --- a/doc/fr_method_index.html +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - Methods - - - - - -
-

Methods

- -
- - \ No newline at end of file diff --git a/doc/index.html b/doc/index.html deleted file mode 100644 index e144b5b..0000000 --- a/doc/index.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - - RDoc Documentation - - - - - - - - - - - \ No newline at end of file diff --git a/doc/rdoc-style.css b/doc/rdoc-style.css deleted file mode 100644 index 44c7b3d..0000000 --- a/doc/rdoc-style.css +++ /dev/null @@ -1,208 +0,0 @@ - -body { - font-family: Verdana,Arial,Helvetica,sans-serif; - font-size: 90%; - margin: 0; - margin-left: 40px; - padding: 0; - background: white; -} - -h1,h2,h3,h4 { margin: 0; color: #efefef; background: transparent; } -h1 { font-size: 150%; } -h2,h3,h4 { margin-top: 1em; } - -a { background: #eef; color: #039; text-decoration: none; } -a:hover { background: #039; color: #eef; } - -/* Override the base stylesheet's Anchor inside a table cell */ -td > a { - background: transparent; - color: #039; - text-decoration: none; -} - -/* and inside a section title */ -.section-title > a { - background: transparent; - color: #eee; - text-decoration: none; -} - -/* === Structural elements =================================== */ - -div#index { - margin: 0; - margin-left: -40px; - padding: 0; - font-size: 90%; -} - - -div#index a { - margin-left: 0.7em; -} - -div#index .section-bar { - margin-left: 0px; - padding-left: 0.7em; - background: #ccc; - font-size: small; -} - - -div#classHeader, div#fileHeader { - width: auto; - color: white; - padding: 0.5em 1.5em 0.5em 1.5em; - margin: 0; - margin-left: -40px; - border-bottom: 3px solid #006; -} - -div#classHeader a, div#fileHeader a { - background: inherit; - color: white; -} - -div#classHeader td, div#fileHeader td { - background: inherit; - color: white; -} - - -div#fileHeader { - background: #057; -} - -div#classHeader { - background: #048; -} - - -.class-name-in-header { - font-size: 180%; - font-weight: bold; -} - - -div#bodyContent { - padding: 0 1.5em 0 1.5em; -} - -div#description { - padding: 0.5em 1.5em; - background: #efefef; - border: 1px dotted #999; -} - -div#description h1,h2,h3,h4,h5,h6 { - color: #125;; - background: transparent; -} - -div#validator-badges { - text-align: center; -} -div#validator-badges img { border: 0; } - -div#copyright { - color: #333; - background: #efefef; - font: 0.75em sans-serif; - margin-top: 5em; - margin-bottom: 0; - padding: 0.5em 2em; -} - - -/* === Classes =================================== */ - -table.header-table { - color: white; - font-size: small; -} - -.type-note { - font-size: small; - color: #DEDEDE; -} - -.xxsection-bar { - background: #eee; - color: #333; - padding: 3px; -} - -.section-bar { - color: #333; - border-bottom: 1px solid #999; - margin-left: -20px; -} - - -.section-title { - background: #79a; - color: #eee; - padding: 3px; - margin-top: 2em; - margin-left: -30px; - border: 1px solid #999; -} - -.top-aligned-row { vertical-align: top } -.bottom-aligned-row { vertical-align: bottom } - -/* --- Context section classes ----------------------- */ - -.context-row { } -.context-item-name { font-family: monospace; font-weight: bold; color: black; } -.context-item-value { font-size: small; color: #448; } -.context-item-desc { color: #333; padding-left: 2em; } - -/* --- Method classes -------------------------- */ -.method-detail { - background: #efefef; - padding: 0; - margin-top: 0.5em; - margin-bottom: 1em; - border: 1px dotted #ccc; -} -.method-heading { - color: black; - background: #ccc; - border-bottom: 1px solid #666; - padding: 0.2em 0.5em 0 0.5em; -} -.method-signature { color: black; background: inherit; } -.method-name { font-weight: bold; } -.method-args { font-style: italic; } -.method-description { padding: 0 0.5em 0 0.5em; } - -/* --- Source code sections -------------------- */ - -a.source-toggle { font-size: 90%; } -div.method-source-code { - background: #262626; - color: #ffdead; - margin: 1em; - padding: 0.5em; - border: 1px dashed #999; - overflow: hidden; -} - -div.method-source-code pre { color: #ffdead; overflow: hidden; } - -/* --- Ruby keyword styles --------------------- */ - -.standalone-code { background: #221111; color: #ffdead; overflow: hidden; } - -.ruby-constant { color: #7fffd4; background: transparent; } -.ruby-keyword { color: #00ffff; background: transparent; } -.ruby-ivar { color: #eedd82; background: transparent; } -.ruby-operator { color: #00ffee; background: transparent; } -.ruby-identifier { color: #ffdead; background: transparent; } -.ruby-node { color: #ffa07a; background: transparent; } -.ruby-comment { color: #b22222; font-weight: bold; background: transparent; } -.ruby-regexp { color: #ffa07a; background: transparent; } -.ruby-value { color: #7fffd4; background: transparent; } \ No newline at end of file