cupid 0.1.2 → 0.2.0

data/README.md

@@ -28,21 +28,48 @@ folders = et_translator.retrieve_email_folders
 # Retrieving email copies for not default account (your_account_id can be nil - default account on ET)
 copies = et_translator.retrieve_email_copies(name)
 
+# Retrieving emails from list for not default account (your_account_id can be nil - default account on ET)
+copies = et_translator.retrieve_emails_from_list(list_id)
+
 # Creating new folder
 # not required fields for folder: description, content_type, is_active, is_editable, allow_children
 new_folder_id = et_translator.create_folder('title', :parent => parent_directory_id)
 
+# Creating folders
+# not required fields for folders: description, content_type, is_active, is_editable, allow_children
+new_folder_ids = et_translator.create_folders(['title', 'title2'], :parent => parent_directory_id)
+
 # Creating new email
 # not required fields for email: email_type, is_html_paste, character_set, name, description, category_id
 new_email_id = et_translator.create_email('subject', 'body')
 
+# Creating emails
+# not required fields for emails: email_type, is_html_paste, character_set, name, description, category_id
+new_email_ids = et_translator.create_emails({'subject' => 'body', 'subject2' => 'body2'})
+
+# User object:
+{
+  :email => 'email@email.com',
+  :lists => [list_id1, list_id2...],
+  :first_name => 'Name',
+  :last_name => 'Lastname'
+}
+
 # Creating new subscriber
 # not required fields for subscriber: first_name, last_name, client_id
-new_subscriber_id = et_translator.create_subscriber('email@email.com')
+new_subscriber_id = et_translator.create_subscriber(user_object)
+
+# Creating subscribers
+# not required fields for subscriber: first_name, last_name, client_id
+new_subscriber_ids = et_translator.create_subscribers([user_object1, user_object2...])
 
 # Send email to list
 # not required fields for send: account
 send_tracking_id = et_translator.send_email_to_list(email_id, list_id)
+
+# Send emails to lists
+# not required fields for send: account
+send_tracking_ids = et_translator.send_emails_to_lists({'email_id' => 'list_id','email_id' => 'list_id'...})
 ```
 
 ## Installation
@@ -50,13 +77,13 @@ send_tracking_id = et_translator.send_email_to_list(email_id, list_id)
 Puts this line into `Gemfile` then run `$ bundle`:
 
 ``` ruby
-gem 'cupid', '0.1.2'
+gem 'cupid', '0.2.0'
 ```
 
 Or if you are old-school Rails 2 developer put this into `config/environment.rb` and run `$ rake gems:install`:
 
 ``` ruby
-config.gem 'cupid', :version => '0.1.2'
+config.gem 'cupid', :version => '0.2.0'
 ```
 
 Or manually install cupid gem: `$ gem install cupid`

data/lib/cupid/methods/email.rb

@@ -30,19 +30,23 @@ module Cupid
       all_copies = response.css('Results').map{|f| {f.css('Name').to_a.map(&:text).join('/') => f.css('ID')[0].text}}
     end
 
-    def create_email(subject, body, *args)
-      options = args.extract_options!
-      options[:subject] = CGI.escapeHTML subject.to_s
-      options[:body] = CGI.escapeHTML body.to_s
-      options[:client_id] ||= @account
+    def retrieve_emails_from_folder(folder, account=nil, properties=nil)
+      account ||= @account
+      properties ||= ['ID', 'Name']
+      filters = '<Filter xsi:type="SimpleFilterPart">' +
+                  '<Property>CategoryID</Property>' +
+                  '<SimpleOperator>equals</SimpleOperator>' +
+                  '<Value>' + folder + '</Value>' +
+                '</Filter>'
 
-      options[:email_type] ||= 'HTML'
-      options[:is_html_paste] ||= 'true' # ??
-      options[:character_set] ||= 'utf-8'
+      soap_body = build_retrieve(account.to_s, 'Email', properties, filters)
+      response = build_request('Retrieve', 'RetrieveRequestMsg', soap_body)
+      response = Nokogiri::XML(response.http.body).remove_namespaces!
+      all_copies = response.css('Results').map{|f| {f.css('Name').to_a.map(&:text).join('/') => f.css('ID')[0].text}}
+    end
 
-      soap_body = '<Objects xsi:type="Email">' +
-                    create_email_object(options) +
-                  '</Objects>'
+    def create_email(subject, body, *args)
+      soap_body = prepare_email(subject, body, args)
 
       response = build_request('Create', 'CreateRequest', soap_body)
       response = Nokogiri::XML(response.http.body).remove_namespaces!
@@ -50,19 +54,7 @@ module Cupid
     end
 
     def create_folder(title, *args)
-      options = args.extract_options!
-      options[:title] = CGI.escapeHTML title.to_s
-      options[:description] ||= 'description'
-      options[:client_id] ||= @account
-
-      options[:content_type] ||= 'email'
-      options[:is_active] ||= 'true'
-      options[:is_editable] ||= 'true'
-      options[:allow_children] ||= 'true'
-
-      soap_body = '<Objects xsi:type="DataFolder">' +
-                    create_folder_object(options) +
-                  '</Objects>'
+      soap_body = prepare_folder(title, args)
 
       response = build_request('Create', 'CreateRequest', soap_body)
       response = Nokogiri::XML(response.http.body).remove_namespaces!
@@ -70,27 +62,72 @@ module Cupid
     end
 
     def send_email_to_list(email_id, list_id, account=nil)
-      account ||= @account
-      soap_body = '<Objects xsi:type="Send">' +
-                    create_send_object(email_id, list_id, account) +
-                  '</Objects>'
+      soap_body = prepare_send_object(email_id, list_id, account)
 
       response = build_request('Create', 'CreateRequest', soap_body)
       response = Nokogiri::XML(response.http.body).remove_namespaces!
       created_send_id = response.css('NewID').text
     end
 
-    def email_link(email_id)
-      "https://members.s4.exacttarget.com/Content/Email/EmailEdit.aspx?eid=" + email_id.to_s
+    def create_emails(subject_bodies, *args)
+      soap_body = ''
+      subject_bodies.each{ |subject, body| soap_body += prepare_email(subject, body, args) }
+
+      response = build_request('Create', 'CreateRequest', soap_body)
+      response = Nokogiri::XML(response.http.body).remove_namespaces!
+      response.css('Results').map{ |f| f.css('NewID').text }
+    end
+
+    def create_folders(titles, *args)
+      soap_body = titles.map{ |title| prepare_folder(title, args) }.join('')
+
+      response = build_request('Create', 'CreateRequest', soap_body)
+      response = Nokogiri::XML(response.http.body).remove_namespaces!
+      response.css('Results').map{ |f| f.css('NewID').text }
+    end
+
+    def send_emails_to_lists(emails_lists, account=nil)
+      soap_body = ''
+      emails_lists.each{ |email_id, list_id| soap_body += prepare_send(email_id, list_id, account) }
+
+      response = build_request('Create', 'CreateRequest', soap_body)
+      response = Nokogiri::XML(response.http.body).remove_namespaces!
+      response.css('Results').map{ |f| f.css('NewID').text }
+    end
+
+    def delete_email(email_id, account=nil)
+      soap_body = prepare_delete_email(email_id, account)
+
+      response = build_request('Delete', 'DeleteRequest', soap_body)
+      response = Nokogiri::XML(response.http.body).remove_namespaces!
+      response.css('Results').css('StatusCode').text == 'OK'
     end
 
-    def create_emails(*args)
-      raise NoMethodError.new "I will implement this method soon"
+    def delete_emails(emails, account=nil)
+      soap_body = emails.map{ |email_id| prepare_delete_email(email_id, account) }.join('')
+
+      response = build_request('Delete', 'DeleteRequest', soap_body)
+      response = Nokogiri::XML(response.http.body).remove_namespaces!
+      response.css('Results').map{ |f| f.css('StatusCode').text == 'OK' }
     end
 
     private
+
+    def prepare_email(subject, body, *args)
+      options = args.extract_options!
+      options[:subject] = CGI.escapeHTML subject.to_s
+      options[:body] = CGI.escapeHTML body.to_s
+      options[:client_id] ||= @account
+
+      options[:email_type] ||= 'HTML'
+      options[:is_html_paste] ||= 'true' # ??
+      options[:character_set] ||= 'utf-8'
+
+      create_email_object(options)
+    end
+
     def create_email_object(options)
-      email_object =   '<ObjectID xsi:nil="true"/>'
+      email_object =   '<Objects xsi:type="Email"><ObjectID xsi:nil="true"/>'
       email_object +=  '<Client><ID>' + options[:client_id].to_s + '</ID></Client>' if options[:client_id]
       email_object +=  '<CategoryID>' + options[:category_id].to_s + '</CategoryID>' if options[:category_id]
       email_object +=  '<Name>' + options[:name].to_s + '</Name>' if options[:name]
@@ -99,11 +136,25 @@ module Cupid
                        '<HTMLBody>' + options[:body] + '</HTMLBody>' +
                        '<EmailType>' + options[:email_type] + '</EmailType>' +
                        '<IsHTMLPaste>' + options[:is_html_paste] + '</IsHTMLPaste>' +
-                       '<CharacterSet>' + options[:character_set] + '</CharacterSet>'
+                       '<CharacterSet>' + options[:character_set] + '</CharacterSet></Objects>'
+    end
+
+    def prepare_folder(title, *args)
+      options = args.extract_options!
+      options[:title] = CGI.escapeHTML title.to_s
+      options[:description] ||= 'description'
+      options[:client_id] ||= @account
+
+      options[:content_type] ||= 'email'
+      options[:is_active] ||= 'true'
+      options[:is_editable] ||= 'true'
+      options[:allow_children] ||= 'true'
+
+      create_folder_object(options)
     end
 
     def create_folder_object(options)
-      folder_object =   '<ObjectID xsi:nil="true"/>'
+      folder_object =   '<Objects xsi:type="DataFolder"><ObjectID xsi:nil="true"/>'
       folder_object +=  '<Client><ID>' + options[:client_id].to_s + '</ID></Client>' if options[:client_id]
       folder_object +=  '<CustomerKey>' + options[:title].to_s + '</CustomerKey>' if options[:title]
       folder_object +=  '<Name>' + options[:title].to_s + '</Name>' +
@@ -121,22 +172,44 @@ module Cupid
                               <ObjectID xsi:nil="true"/>
                            </ParentFolder>'
       end
+      folder_object += '</Objects>'
+    end
+
+    def prepare_send(email_id, list_id, account=nil)
+      account ||= @account
+      create_send_object(email_id, list_id, account)
     end
 
     def create_send_object(email_id, list_id, account)
-      send_object = '<PartnerKey xsi:nil="true"/>' +
-                     '<ObjectID xsi:nil="true"/>' +
-                     '<Client><ID>' + account.to_s + '</ID></Client>' +
-                     '<Email>' +
-                       '<PartnerKey xsi:nil="true"/>' +
-                       '<ID>' + email_id.to_s + '</ID>' +
-                       '<ObjectID xsi:nil="true"/>' +
-                     '</Email>' +
-                     '<List>' +
-                       '<PartnerKey xsi:nil="true"/>' +
-                       '<ObjectID xsi:nil="true"/>' +
-                       '<ID>' + list_id.to_s + '</ID>' +
-                     '</List>'
+      '<Objects xsi:type="Send"><PartnerKey xsi:nil="true"/>' +
+       '<ObjectID xsi:nil="true"/>' +
+       '<Client><ID>' + account.to_s + '</ID></Client>' +
+       '<Email>' +
+         '<PartnerKey xsi:nil="true"/>' +
+         '<ID>' + email_id.to_s + '</ID>' +
+         '<ObjectID xsi:nil="true"/>' +
+       '</Email>' +
+       '<List>' +
+         '<PartnerKey xsi:nil="true"/>' +
+         '<ObjectID xsi:nil="true"/>' +
+         '<ID>' + list_id.to_s + '</ID>' +
+       '</List>' +
+      '</Objects>'
+    end
+
+    def prepare_delete_email(email_id, account=nil)
+      account ||= @account
+      create_delete_email_object(email_id, account)
+    end
+
+    def create_delete_email_object(email_id, account)
+      '<Objects xsi:type="Email">' +
+        '<Client>' +
+          '<ID>' + account + '</ID>' +
+        '</Client>' +
+        '<ID>' + email_id + '</ID>' +
+        '<ObjectID xsi:nil="true"/>' +
+      '</Objects>'
     end
   end
 end

data/lib/cupid/methods/subscriber.rb

@@ -1,38 +1,57 @@
 module Cupid
   class Session
-    def create_subscriber(email, *args)
-      options = args.extract_options!
-      options[:email] = email.to_s
-      options[:client_id] ||= @account
+    # User object:
+    # {
+    #   :email => 'email@email.com',
+    #   :lists => [list_id1, list_id2...],
+    #   :first_name => 'Name',
+    #   :last_name => 'Lastname'
+    # }
+    def create_subscriber(user, account=nil)
+      soap_body = prepare_subscriber(user, account)
 
-      soap_body = '<Objects xsi:type="Subscriber">' +
-                    create_subscriber_object(options) +
-                  '</Objects>'
-
-      build_request('Create', 'CreateRequest', soap_body)
+      response = build_request('Create', 'CreateRequest', soap_body)
+      response = Nokogiri::XML(response.http.body).remove_namespaces!
+      created_user_id = response.css('NewID').text
     end
 
-    def create_subscribers(*args)
-      raise NoMethodError.new "I will implement this method soon"
+    def create_subscribers(users, account=nil)
+      soap_body = users.map{ |user| prepare_subscriber(user, account) }
+
+      response = build_request('Create', 'CreateRequest', soap_body)
+      response = Nokogiri::XML(response.http.body).remove_namespaces!
+      created_user_id = response.css('NewID').text
     end
 
     private
-      def create_subscriber_object(options)
-        subscriber_object =   '<ObjectID xsi:nil="true"/>'
-        subscriber_object +=  '<PartnerKey xsi:nil="true" />'
-        subscriber_object +=  '<Client><ID>' + options[:client_id].to_s + '</ID></Client>' if options[:client_id]
-        subscriber_object +=  '<Lists>' + options[:lists].map(&:list_object).join('') + '</Lists>' if options[:lists]
-        subscriber_object +=  '<FirstName>' + options[:first_name].to_s + '</FirstName>' if options[:first_name]
-        subscriber_object +=  '<LastName>' + options[:last_name].to_s + '</LastName>' if options[:last_name]
-        subscriber_object +=  '<EmailAddress>' + options[:email] + '</EmailAddress>'
-      end
-      
-      def list_object(list_id)
-        '<PartnerKey xsi:nil="true">
+
+    def prepare_subscriber(user, account=nil)
+      user[:lists].map!{ |list| list_object(list) }
+      account ||= @account
+
+      create_subscriber_object(user, account)
+    end
+
+    def create_subscriber_object(user, account)
+      subscriber_object =   '<Objects xsi:type="Subscriber"><ObjectID xsi:nil="true"/>'
+      subscriber_object +=  '<PartnerKey xsi:nil="true" />'
+      subscriber_object +=  '<Client><ID>' + account.to_s + '</ID></Client>' if account
+      subscriber_object +=  user[:lists].join('') if user[:lists]
+      subscriber_object +=  '<FirstName>' + user[:first_name].to_s + '</FirstName>' if user[:first_name]
+      subscriber_object +=  '<LastName>' + user[:last_name].to_s + '</LastName>' if user[:last_name]
+      subscriber_object +=  '<EmailAddress>' + user[:email] + '</EmailAddress>'
+    end
+    
+    def list_object(list_id)
+      '<Lists>
+        <PartnerKey xsi:nil="true">
         </PartnerKey>
         <ID>' + list_id.to_s + '</ID>
         <ObjectID xsi:nil="true">
-        </ObjectID>'
-      end
+        </ObjectID>
+      </Lists>'
+    end
+
+    subscriber_object += '</Objects>'
   end
 end

data/lib/cupid/version.rb

@@ -1,3 +1,3 @@
 module Cupid
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/tmp/dancing_with_ET.rb

@@ -38,7 +38,7 @@ body = {
 }
 
 header = {
-  'a:Action' => 'Create',
+  'a:Action' => 'Delete',
   'a:MessageID' => 'urn:uuid:99e6822c-5436-4fec-a243-3126c14924f6',
   'a:ReplyTo' => {
       'a:Address' => 'http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous'
@@ -129,7 +129,7 @@ body = '<Objects xsi:type="Send">
 <List>
 <PartnerKey xsi:nil="true"/>
 <ObjectID xsi:nil="true"/>
-<ID>57</ID>
+<ID>354</ID>
 </List>
 </Objects>'
 # 
@@ -170,13 +170,39 @@ body = '<RetrieveRequest>
 </Filter>
 </RetrieveRequest>'
 
-html = CGI.escapeHTML('<center><h2>Way Cool Email</h2></center>')
+body = '<RetrieveRequest>
+<ClientIDs>
+<ID>1058484</ID>
+</ClientIDs>
+<ObjectType>Email</ObjectType>
+<Properties>ID</Properties>
+<Properties>Name</Properties>
+<Properties>Folder</Properties>
+<Properties>CategoryID</Properties>
+<Filter xsi:type="SimpleFilterPart">
+<Property>Name</Property>
+<SimpleOperator>like</SimpleOperator>
+<Value>120911_piter_follow_up_side</Value>
+</Filter>
+</RetrieveRequest>'
 
+body = '
+<Objects xsi:type="Email">
+<Client>
+<ID>1058484</ID>
+</Client>
+<ID>1724</ID>
+<ObjectID xsi:nil="true"/>
+</Objects>
+'
+
+html = CGI.escapeHTML('<center><h2>Way Cool Email</h2></center>')
+# 
 # body = '
 #     <Objects xsi:type="Email">  
 #        <ObjectID xsi:nil="true"/>
 #        <Client><ID>1058484</ID></Client>
-#        <CategoryID>277</CategoryID>
+#        <CategoryID>354</CategoryID>
 #        <HTMLBody>'+html+'</HTMLBody>  
 #        <Subject>Test Subject111</Subject>  
 #        <EmailType>HTML</EmailType>  
@@ -193,7 +219,7 @@ namespaces = {
 }
 # 
 response = client.request :retrieve do |soap|
-  soap.input = ['RetrieveRequestMsg', { 'xmlns'=>"http://exacttarget.com/wsdl/partnerAPI"}]
+  soap.input = ['DeleteRequest', { 'xmlns'=>"http://exacttarget.com/wsdl/partnerAPI"}]
   soap.header = header
   soap.env_namespace = :s
   soap.namespaces = namespaces

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cupid
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - gazay