gnumarcelo-campaigning 0.12.1 → 0.14.0

data/lib/campaigning/template.rb

@@ -0,0 +1,124 @@
+# Template is defined in soap/default.rb which is automatically generated.
+# In this file we add additional methods to the Template class.
+require File.expand_path(File.dirname(__FILE__)) + '/module_mixin'
+
+
+module Campaigning
+  class Template
+    include ModuleMixin
+    attr_accessor :templateID
+    attr_accessor :name
+    attr_accessor :previewURL
+    attr_accessor :screenshotURL
+    
+    def initialize(templateID = nil, name = nil, previewURL = nil, screenshotURL = nil, opts = {})
+      @apiKey = opts[:apiKey] || CAMPAIGN_MONITOR_API_KEY
+      @templateID = templateID
+      @name = name
+      @previewURL = previewURL
+      @screenshotURL = screenshotURL
+    end
+    
+    #Creates a new template for a client.
+    #
+    #Available _params_ argument are:
+    #   * :clientID - The ID of the client who will owner of the list.
+    #   * :templateName - The name of the template. Maximum of 30 characters (will be truncated to 30 characters if longer).
+    #   * :htmlPageURL - The URL of the HTML page you have created for the template.
+    #   * :zipFileURL - Optional URL of a zip file containing any other files required by the template.
+    #   * :screenshotURL - Optional URL of a screenshot of the template. Must be in jpeg format and at least 218 pixels wide.
+    #   * :apiKey - optional API key to use to make request. Will use CAMPAIGN_MONITOR_API_KEY if not set.
+    #*Return*:
+    #
+    #*Success*: Upon a successful call, this method will return a Campaigning::Template object representing the newly created
+    #template. The object returned isn't filled with previewURL and screenShotURL once the CampaignMonitor API generate a new
+    #value for that and doesn't return it on te create! method. In order to get a complete filled object call the Template.details
+    #method.
+    #
+    #*Error*: An Exception containing the cause of the error will be raised.
+    def self.create!(params)
+      response = @@soap.createTemplate(
+        :apiKey => params[:apiKey] || CAMPAIGN_MONITOR_API_KEY,
+        :clientID => params[:clientID],
+        :templateName => params[:templateName],
+        :hTMLPageURL => params[:htmlPageURL],
+        :zipFileURL => params[:zipFileURL],
+        :screenshotURL => params[:screenshotURL]    
+      )
+      Template.new( handle_response(response.template_CreateResult), params[:templateName], nil, nil, :apiKey=> params[:apiKey] )
+    end
+    
+    #Gets the details of a template.
+    #
+    #*Return*:
+    #
+    #*Success*: Upon a successful call, this method will return a Template object, which consists of the template ID,
+    #the template name, a preview URL and a screenshot URL.
+    #
+    #*Error*: An Exception containing the cause of the error will be raised.
+    def details
+      response = @@soap.getTemplateDetail(:apiKey => @apiKey, :templateID => @templateID)
+      handle_response response.template_GetDetailResult
+    end
+
+    #Updates an existing template.
+    #
+    #Available _params_ argument are:
+    #   * :templateID - The ID of the template to be updated.  
+    #   * :templateName - The name of the template. Maximum of 30 characters (will be truncated to 30 characters if longer).
+    #   * :htmlPageURL - The URL of the HTML page you have created for the template.
+    #   * :zipFileURL - Optional URL of a zip file containing any other files required by the template.
+    #   * :screenshotURL - Optional URL of a screenshot of the template. Must be in jpeg format and at least 218 pixels wide.
+    #   * :apiKey - optional API key to use to make request. Will use CAMPAIGN_MONITOR_API_KEY if not set.
+    #*Return*:
+    #
+    #*Success*: Upon a successful call, this method will return a Campaigning::Result object wich consists of a +code+ and +message+ fields
+    #containing a successful message.
+    #
+    #*Error*: An Exception containing the cause of the error will be raised.
+    def update!(params)
+      response = @@soap.updateTemplate(
+        :apiKey => params[:apiKey] || CAMPAIGN_MONITOR_API_KEY,
+        :templateID => @templateID,
+        :templateName =>  params[:templateName],
+        :hTMLPageURL => params[:htmlPageURL],
+        :zipFileURL => params[:zipFileURL],
+        :screenshotURL => params[:screenshotURL]
+      )
+      handle_response response.template_UpdateResult
+    end
+    
+    
+    #Deletes a template.
+    #
+    #*Return*:
+    #
+    #*Success*: Upon a successful call, this method will return a Campaigning::Result object wich consists of a +code+ and +message+ fields
+    #containing a successful message.
+    #
+    #*Error*: An Exception containing the cause of the error will be raised.
+    def delete!
+      response = Template.delete!(@templateID, :apiKey=> @apiKey)
+      self.templateID, self.name  = nil, nil
+      response
+    end
+    
+
+    #Deletes a template.
+    #
+    #Aviable _opts_ arguments are:
+    #   * :apiKey - optional API key to use to make request. Will use CAMPAIGN_MONITOR_API_KEY if not set.
+    #
+    #*Return*:
+    #
+    #*Success*: Upon a successful call, this method will return a Campaigning::Result object wich consists of a +code+ and +message+ fields
+    #containing a successful message.
+    #
+    #*Error*: An Exception containing the cause of the error will be raised.
+    def self.delete!(template_id, opts={})
+      response = @@soap.deleteTemplate(:apiKey => opts[:apiKey] || CAMPAIGN_MONITOR_API_KEY, :templateID => template_id)
+      handle_response response.template_DeleteResult
+    end
+    
+  end
+end

data/test/campaigning_test.rb

@@ -25,12 +25,6 @@ class CampaigningTest < Test::Unit::TestCase
     assert !countries.nil?
   end
   
-  def test_client_get_all_clients
-    clients = Campaigning::Client.get_all_clients
-    assert clients.length > 0
-    #clients.each{ |c| puts c.clientID + " - " + c.name }
-  end
-  
   def test_client_lists
     client = Campaigning::Client.find_by_name("Client One Company")    
     assert client.lists.length > 0

data/test/client_test.rb

@@ -3,14 +3,27 @@ require 'test_helper'
 # Replace this API key with your own (http://www.campaignmonitor.com/api/)
 CAMPAIGN_MONITOR_API_KEY  = '__PUT_YOUR_API_KEY_HERE__'
 
+
 class ClientTest < Test::Unit::TestCase
 
 
   def setup
     #Campaigning.set_endpoint_url "http://127.0.0.1:8088/mockapiSoap"
-    Campaigning.set_debug_mode(:on)
+    #Campaigning.set_debug_mode(:on)
+  end
+
+  def test_client_get_templates
+    client = Campaigning::Client.get_all_clients.first
+    puts "#{client.name} - #{client.clientID}"
+    puts "Templates: #{client.templates.inspect}"
   end
 
+  def test_client_get_all_clients
+    clients = Campaigning::Client.get_all_clients
+    assert clients.length > 0
+    #clients.each{ |c| puts c.clientID + " - " + c.name }
+  end
+  
   def test_client_create!
     client_created = Campaigning::Client.create!(
     :companyName => "My test clients22",
@@ -21,34 +34,34 @@ class ClientTest < Test::Unit::TestCase
     )
     assert !client_created.clientID.nil?
   end
-
+  
   def test_client_delete
     response = Campaigning::Client.delete!(client_created.clientID)  
     assert response.code == 0
   end
-
+  
   def test_client_delete_itself
     client = Campaigning::Client.find_by_name("Orange Company 7")
     client.delete!
   end
-
+  
   def test_client_segments
     client = Campaigning::Client.find_by_name("Client One Company")
     assert client.segments.length > 0
   end
-
-
+  
+  
   def test_find_client_by_name
     client = Campaigning::Client.find_by_name("Client One Company")
     assert !client.nil? && client.name == "Client One Company"
   end
-
-
+  
+  
   def test_get_client_campaigns
     client = Campaigning::Client.find_by_name("Client One Company")
     puts client.campaigns.inspect
   end
-
+  
   def test_get_client_details
     client = Campaigning::Client.find_by_name("Client One Company")
     # client_details = client.details
@@ -70,16 +83,16 @@ class ClientTest < Test::Unit::TestCase
     #       Cost per Recipient: #{access_and_billing_details.costPerRecipient} - \n
     #       Design and Span test Fee: #{access_and_billing_details.designAndSpamTestFee} - \n
     #       Access Level: #{access_and_billing_details.accessLevel}"
-
+  
     assert !client.details.nil?
-
+  
   end 
-
+  
   def test_get_client_suppression_list
     client = Campaigning::Client.find_by_name("Client One Company")
     puts client.suppression_list.inspect
   end
-
+  
   def test_client_update_access_and_billing!
     client = Campaigning::Client.find_by_name("Client One Company")
     response = client.update_access_and_billing!(
@@ -106,11 +119,11 @@ class ClientTest < Test::Unit::TestCase
     )
     assert response.code == 0
   end
-
+  
   def test_client_find_list_by_name
     client = Campaigning::Client.find_by_name("Client One Company")
     list = client.find_list_by_name "My Friends"
     assert list.nil? == false
   end
-
+  
 end

data/test/template_test.rb

@@ -0,0 +1,62 @@
+require 'test_helper'
+
+# Replace this API key with your own (http://www.campaignmonitor.com/api/)
+CAMPAIGN_MONITOR_API_KEY  = '__PUT_YOUR_API_KEY_HERE__'
+HTML_PAGE_URL = "http://s4ve.as:80/pages/download/17767/template-with-editor-tags.html"
+ZIP_FILE_URL = "http://s4ve.as:80/pages/download/17766/Archive.zip"
+SCREENSHOT_URL = "http://s4ve.as:80/pages/download/17768/screenshot.png"
+
+class TemplateTest < Test::Unit::TestCase
+
+
+  def setup
+    #Campaigning.set_endpoint_url "http://127.0.0.1:8088/mockapiSoap"
+    Campaigning.set_debug_mode(:on)
+  end
+
+  def test_create!
+    client = Campaigning::Client.get_all_clients.first
+    template_created = Campaigning::Template.create!(
+      :clientID => client.clientID,
+      :templateName => "template_BY_API",
+      :htmlPageURL => HTML_PAGE_URL,
+      :zipFileURL => ZIP_FILE_URL,
+      :screenshotURL => SCREENSHOT_URL
+    )
+    puts template_created.details
+    puts "\n INSPECT: #{template_created.inspect} \n"
+    assert !template_created.nil?
+  end
+  
+  # #Should I return a new Template object?
+  # def test_details
+  #   client = Campaigning::Client.get_all_clients.first
+  #   template = client.templates.first
+  #   assert !template.details.nil?
+  # end
+  # 
+  # def test_update!
+  #   client = Campaigning::Client.get_all_clients.first
+  #   template = client.templates.first
+  #   result = template.update!(
+  #     :templateName => "template_BY_API-updt",
+  #     :htmlPageURL => HTML_PAGE_URL,
+  #     :zipFileURL => ZIP_FILE_URL,
+  #     :screenshotURL => SCREENSHOT_URL
+  #   )
+  #   assert result.code == 0
+  # end
+  # 
+  # def test_delete!
+  #   client = Campaigning::Client.get_all_clients.first
+  #   template = client.templates.last
+  #   result = template.delete!
+  #   assert result.code == 0
+  #   assert template.templateID == nil
+  #   
+  #   #deleting template by templateID
+  #   result = Campaigning::Template.delete!("d0814103dcee1073ef84516dd96a12c4")
+  #   assert result.code == 0
+  # end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gnumarcelo-campaigning
 version: !ruby/object:Gem::Version 
-  version: 0.12.1
+  version: 0.14.0
 platform: ruby
 authors: 
 - Marcelo Menezes
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-04 00:00:00 -07:00
+date: 2009-09-11 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,11 +46,13 @@ files:
 - lib/campaigning/soap/generated/defaultDriver.rb
 - lib/campaigning/soap/generated/defaultMappingRegistry.rb
 - lib/campaigning/subscriber.rb
+- lib/campaigning/template.rb
 - test/campaign_test.rb
 - test/campaigning_test.rb
 - test/client_test.rb
 - test/list_test.rb
 - test/subscriber_test.rb
+- test/template_test.rb
 - test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/gnumarcelo/campaigning
@@ -84,4 +86,5 @@ test_files:
 - test/client_test.rb
 - test/list_test.rb
 - test/subscriber_test.rb
+- test/template_test.rb
 - test/test_helper.rb