cupid 0.0.6 → 0.0.7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cupid (0.0.2)
+    cupid (0.0.6)
       builder (>= 2.1.2)
       nokogiri (>= 1.4.1)
       savon (>= 0.9.0)
@@ -18,7 +18,7 @@ GEM
       rack
     nokogiri (1.5.0)
     nori (1.0.2)
-    rack (1.3.2)
+    rack (1.3.3)
     savon (0.9.7)
       akami (~> 1.0)
       builder (>= 2.1.2)

data/README.md

@@ -6,7 +6,36 @@ Sponsored by Evil Martians <http://evilmartians.com>
 
 ## Usage
 
+Add cupid initializer to your config/initializers and now there only two parameters to configure:
 
+``` ruby
+Cupid.configure do |config|
+  config.username = 'username'
+  config.password = 'password'
+end
+```
+
+After that you can create Cupid::Session object and do some stuff through it:
+
+``` ruby
+# Creating session
+et_translator = Cupid::Session.new
+
+# Retrieving folders for not default account (your_account_id can be nil - default account on ET)
+folders = et_translator.retrieve_email_folders(your_account_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, :client_id => your_account_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', :client_id => your_account_id, :category_id => new_folder_id)
+
+# Creating new subscriber
+# not required fields for subscriber: first_name, last_name, client_id
+new_subscriber_id = et_translator.create_subscriber('email@email.com')
+```
 
 ## Installation
 

data/lib/cupid/configuration.rb

@@ -12,7 +12,8 @@ module Cupid
     attr_accessor(
       :username,
       # :api_type, #now it's only soap s4. But i want MOAR
-      :password
+      :password,
+      :account
     )
   end
 end

data/lib/cupid/methods/email.rb

@@ -1,22 +1,15 @@
 module Cupid
   class Session
-    def retrieve_email_folders(account)
-      soap_body = '<RetrieveRequest>
-                    <ClientIDs>
-                    <ID>' + account.to_s + '</ID>
-                    </ClientIDs>
-                    <ObjectType>DataFolder</ObjectType>
-                    <Properties>ID</Properties>
-                    <Properties>Name</Properties>
-                    <Properties>ParentFolder.ID</Properties>
-                    <Properties>ParentFolder.Name</Properties>
-                    <Filter xsi:type="SimpleFilterPart">
-                      <Property>ContentType</Property>
-                      <SimpleOperator>like</SimpleOperator>
-                      <Value>email</Value>
-                    </Filter>
-                   </RetrieveRequest>'
+    def retrieve_email_folders(account=nil, properties=nil)
+      account ||= @account
+      properties ||= ['ID', 'Name', 'ParentFolder.ID', 'ParentFolder.Name']
+      filters = 'Filter xsi:type="SimpleFilterPart"' => {
+                  'Property' => 'ContentType',
+                  'SimpleOperator' => 'like',
+                  'Value' => 'email'
+                }
 
+      soap_body = build_retrieve(account.to_s, 'DataFolder', properties, filters)
       response = build_request('Retrieve', 'RetrieveRequestMsg', soap_body)
       response = Nokogiri::XML(response.http.body).remove_namespaces!
       all_folders = response.css('Results').map{|f| {f.css('Name').to_a.map(&:text).join('/') => f.css('ID')[0].text}}
@@ -26,7 +19,8 @@ module Cupid
       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'
@@ -44,6 +38,7 @@ module Cupid
       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'
@@ -59,6 +54,17 @@ module Cupid
       created_folder_id = response.css('NewID').text
     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>'
+
+      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
     end
@@ -101,5 +107,22 @@ module Cupid
                            </ParentFolder>'
       end
     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 + '</CustomerKey>' +
+                     '</List>' +
+                     '</Objects>'
+    end
   end
 end

data/lib/cupid/methods/list.rb

@@ -0,0 +1,13 @@
+module Cupid
+  class Session
+    def retrieve_lists(account=nil, properties=nil)
+      account ||= @account
+      properties ||= ['ID', 'CustomerKey']
+      
+      soap_body = build_retrieve(account.to_s, 'List', properties)
+      response = build_request('Retrieve', 'RetrieveRequestMsg', soap_body)
+      response = Nokogiri::XML(response.http.body).remove_namespaces!
+      all_lists = response.css('Results').map{|f| {f.css('CustomerKey').to_a.map(&:text).join('/') => f.css('ID')[0].text}}
+    end
+  end
+end

data/lib/cupid/methods/subscriber.rb

@@ -3,6 +3,7 @@ module Cupid
     def create_subscriber(email, *args)
       options = args.extract_options!
       options[:email] = email.to_s
+      options[:client_id] ||= @account
 
       soap_body = '<Objects xsi:type="Subscriber">' +
                     create_subscriber_object(options) +

data/lib/cupid/session.rb

@@ -12,6 +12,7 @@ module Cupid
       options     = args.extract_options!
       @username   = options[:username]    ||= Cupid.username
       @password   = options[:password]    ||= Cupid.password
+      @account    = options[:account]     ||= Cupid.account
       @headers    = {"Content-Type" => "application/x-www-form-urlencoded", "Connection" => "close"}
 
       @api_uri = @api_wsdl = DEFAULTS[:soap_s4_url]
@@ -23,39 +24,54 @@ module Cupid
     end
 
     private
-      def build_request(type, method, body)
-        client = Savon::Client.new(@api_wsdl)
-        client.wsse.username = @username
-        client.wsse.password = @password
-        client.wsse.created_at = Time.now.utc
-        client.wsse.expires_at = (Time.now + 120).utc
-
-        header = {
-          'a:Action' => type,
-          'a:MessageID' => 'urn:uuid:99e6822c-5436-4fec-a243-3126c14924f6',
-          'a:ReplyTo' => {
-              'a:Address' => 'http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous'
-            },
-          'VsDebuggerCausalityData' => 'uIDPo5GdUXRQCEBNrqnw0gOEloMAAAAAIAi4IHpPlUiMs1MZ2raBIhJnF/jqJLlAgZIny03R+tgACQAA',
-          'a:To' => @wsa_soap_s4_to
-        }
-
-        namespaces = {
-          'xmlns:s'=>"http://schemas.xmlsoap.org/soap/envelope/",
-          'xmlns:a'=>"http://schemas.xmlsoap.org/ws/2004/08/addressing",
-          'xmlns:u'=>"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd",
-          'xmlns:xsi'=>"http://www.w3.org/2001/XMLSchema-instance",
-          'xmlns:xsd'=>"http://www.w3.org/2001/XMLSchema",
-          'xmlns:o'=>"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
-        }
-
-        response = client.request type.downcase.to_sym do |soap|
-          soap.input = [method, { 'xmlns'=>"http://exacttarget.com/wsdl/partnerAPI"}]
-          soap.header = header
-          soap.env_namespace = :s
-          soap.namespaces = namespaces
-          soap.body = body
-        end
+
+    def build_request(type, method, body)
+      client = Savon::Client.new(@api_wsdl)
+      client.wsse.username = @username
+      client.wsse.password = @password
+      client.wsse.created_at = Time.now.utc
+      client.wsse.expires_at = (Time.now + 120).utc
+
+      header = {
+        'a:Action' => type,
+        'a:MessageID' => 'urn:uuid:99e6822c-5436-4fec-a243-3126c14924f6',
+        'a:ReplyTo' => {
+            'a:Address' => 'http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous'
+          },
+        'VsDebuggerCausalityData' => 'uIDPo5GdUXRQCEBNrqnw0gOEloMAAAAAIAi4IHpPlUiMs1MZ2raBIhJnF/jqJLlAgZIny03R+tgACQAA',
+        'a:To' => @wsa_soap_s4_to
+      }
+
+      namespaces = {
+        'xmlns:s'=>"http://schemas.xmlsoap.org/soap/envelope/",
+        'xmlns:a'=>"http://schemas.xmlsoap.org/ws/2004/08/addressing",
+        'xmlns:u'=>"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd",
+        'xmlns:xsi'=>"http://www.w3.org/2001/XMLSchema-instance",
+        'xmlns:xsd'=>"http://www.w3.org/2001/XMLSchema",
+        'xmlns:o'=>"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
+      }
+
+      response = client.request type.downcase.to_sym do |soap|
+        soap.input = [method, { 'xmlns'=>"http://exacttarget.com/wsdl/partnerAPI"}]
+        soap.header = header
+        soap.env_namespace = :s
+        soap.namespaces = namespaces
+        soap.body = body
       end
+    end
+
+    def build_retrieve(id, object_type, properties, filters=nil)
+      body = {'RetrieveRequest' => {
+                'ClientIDs' => {
+                  'ID' => id
+                },
+                'ObjectType' => object_type,
+                'Properties' => properties
+              }
+             }
+      body['RetrieveRequest'].merge! filters if filters
+
+      body
+    end
   end
 end

data/lib/cupid/version.rb

@@ -1,3 +1,3 @@
 module Cupid
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

data/tmp/dancing_with_ET.rb

@@ -1,5 +1,6 @@
 require 'rubygems'
 # require 'ruby-debug'
+require 'nokogiri'
 require 'savon'
 require 'cgi'
 
@@ -37,7 +38,7 @@ body = {
 }
 
 header = {
-  'a:Action' => 'Retrieve',
+  'a:Action' => 'Create',
   'a:MessageID' => 'urn:uuid:99e6822c-5436-4fec-a243-3126c14924f6',
   'a:ReplyTo' => {
       'a:Address' => 'http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous'
@@ -91,17 +92,52 @@ body = '<RetrieveRequest>
 <ClientIDs>
 <ID>1058484</ID>
 </ClientIDs>
-<ObjectType>DataFolder</ObjectType>
+<ObjectType>List</ObjectType>
+<Properties>CustomerKey</Properties>
 <Properties>ID</Properties>
-<Properties>Name</Properties>
-<Properties>ParentFolder.ID</Properties>
-<Properties>ParentFolder.Name</Properties>
-<Filter xsi:type="SimpleFilterPart">
-<Property>ContentType</Property>
-<SimpleOperator>like</SimpleOperator>
-<Value>email</Value>
-</Filter>
 </RetrieveRequest>'
+
+body = {
+  'RetrieveRequest' => {
+    'ClientIDs' => {
+      'ID' => '1058484'
+    },
+    'ObjectType' => 'List',
+    'Properties' => ['CustomerKey', 'ID']
+  }
+}
+body_noko = Nokogiri::XML::Builder.new do |xml|
+  xml.retrieve_request {
+    xml.client_ids {
+      xml.id "1058484"
+    }
+    xml.object_type "List"
+    xml.properties "CustomerKey"
+    xml.properties "ID"
+  }
+end
+
+body = '<Objects xsi:type="Send">
+<PartnerKey xsi:nil="true"/>
+<Client><ID>1058484</ID></Client>
+<ObjectID xsi:nil="true"/>
+<Email>
+<PartnerKey xsi:nil="true"/>
+<ID>565</ID>
+<ObjectID xsi:nil="true"/>
+</Email>
+<List>
+<PartnerKey xsi:nil="true"/>
+<ObjectID xsi:nil="true"/>
+<ID>57</ID>
+</List>
+</Objects>'
+# 
+# puts body
+# 
+# puts '-============-'
+# 
+# puts body_noko.text
                       
 # body = '<RetrieveRequest>
 # <ClientIDs>
@@ -142,7 +178,7 @@ namespaces = {
 }
 # 
 response = client.request :retrieve do |soap|
-  soap.input = ['RetrieveRequestMsg', { 'xmlns'=>"http://exacttarget.com/wsdl/partnerAPI"}]
+  soap.input = ['CreateRequest', { 'xmlns'=>"http://exacttarget.com/wsdl/partnerAPI"}]
   soap.header = header
   soap.env_namespace = :s
   soap.namespaces = namespaces

metadata

@@ -1,80 +1,58 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: cupid
-version: !ruby/object:Gem::Version 
-  hash: 19
+version: !ruby/object:Gem::Version
+  version: 0.0.7
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 6
-  version: 0.0.6
 platform: ruby
-authors: 
+authors:
 - gazay
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-05 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-09-22 00:00:00.000000000 %:z
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: builder
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2153805140 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 2
-        - 1
-        - 2
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.1.2
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: nokogiri
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2153805140
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &2153804440 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 1
-        - 4
-        - 1
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.4.1
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: savon
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2153804440
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: &2153803980 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 59
-        segments: 
-        - 0
-        - 9
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.9.0
   type: :runtime
-  version_requirements: *id003
-description: Send love, not war. This version of cupid can only work with ET SOAP API with s4.
-email: 
+  prerelease: false
+  version_requirements: *2153803980
+description: Send love, not war. This version of cupid can only work with ET SOAP
+  API with s4.
+email:
 - gazay@evilmartians.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -84,43 +62,36 @@ files:
 - lib/cupid/configuration.rb
 - lib/cupid/methods.rb
 - lib/cupid/methods/email.rb
+- lib/cupid/methods/list.rb
 - lib/cupid/methods/subscriber.rb
 - lib/cupid/session.rb
 - lib/cupid/version.rb
 - spec/cupid/cupid_spec.rb
 - tmp/dancing_with_ET.rb
-homepage: ""
+has_rdoc: true
+homepage: ''
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: cupid
-rubygems_version: 1.8.6
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Create, organize and send emails through Exact Target SOAP API
-test_files: 
+test_files:
 - spec/cupid/cupid_spec.rb