cupid 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in cupid.gemspec
+gemspec

data/README.md

@@ -0,0 +1,39 @@
+# Cupid gem — Create, organize and send emails through Exact Target
+
+Send love, not war. This version of cupid can only work with ET SOAP API with s4.
+
+## Usage
+
+
+
+## Installation
+
+Puts this line into `Gemfile` then run `$ bundle`:
+
+``` ruby
+gem 'cupid', '0.0.1'
+```
+
+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.0.1'
+```
+
+Or manually install cupid gem: `$ gem install cupid`
+
+## Contributors
+
+* @gazay
+
+## License
+
+The MIT License
+
+Copyright (c) 2011 gazay
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'rake'
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/cupid.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "cupid/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cupid"
+  s.version     = Cupid::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['gazay']
+  s.email       = ['gazay@evilmartians.com']
+  s.homepage    = ""
+  s.summary     = %q{Create, organize and send emails through Exact Target SOAP API}
+  s.description = %q{Send love, not war. This version of cupid can only work with ET SOAP API with s4.}
+
+  s.rubyforge_project = "cupid"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/cupid.rb

@@ -0,0 +1,10 @@
+require("cupid/configuration")
+
+module Cupid
+  extend Configuration
+
+  def self.configure
+    yield self if block_given?
+  end
+
+end

data/lib/cupid/configuration.rb

@@ -0,0 +1,20 @@
+require 'erb'
+require 'uri'
+require 'savon'
+require 'logger'
+require 'builder'
+require 'net/https'
+require 'nokogiri'
+require 'cupid/session'
+
+include(ERB::Util)
+
+module Cupid
+  module Configuration
+    attr_accessor(
+      :username,
+      # :api_type, #now it's only soap s4. But i want MOAR
+      :password
+    )
+  end
+end

data/lib/cupid/methods.rb

@@ -0,0 +1,2 @@
+require("cupid/methods/email")
+require("cupid/methods/subscriber")

data/lib/cupid/methods/email.rb

@@ -0,0 +1,63 @@
+module Cupid
+  class Session
+    def retreive_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>'
+
+      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}}
+    end
+
+    def create_email(subject, body, *args)
+      options = args.extract_options!
+      options[:subject] = subject.to_s
+      options[:body] = CGI.escapeHTML body.to_s
+      
+      options[:email_type] = 'HTML'
+      options[:is_html_paste] = 'true' # ??
+
+      soap_body = '<Objects xsi:type="Email">' +
+                    create_email_object(options) +
+                  '</Objects>'
+
+      response = build_request('Create', 'CreateRequest', soap_body)
+      response = Nokogiri::XML(response.http.body).remove_namespaces!
+      created_email_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
+
+    def create_emails(*args)
+      raise NoMethodError.new "I will implement this method soon"
+    end
+
+    private
+      def create_email_object(options)
+        email_object =   '<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]
+        email_object +=  '<Description>' + options[:description].to_s + '</Description>' if options[:description]
+        email_object +=  '<Subject>' + options[:subject] + '</Subject>' +
+                         '<HTMLBody>' + options[:body] + '</HTMLBody>' +
+                         '<EmailType>' + options[:email_type] + '</EmailType>' +
+                         '<IsHTMLPaste>' + options[:is_html_paste] + '</IsHTMLPaste>'
+      end
+  end
+end

data/lib/cupid/methods/subscriber.rb

@@ -0,0 +1,37 @@
+module Cupid
+  class Session
+    def create_subscriber(email, *args)
+      options = args.extract_options!
+      options[:email] = email.to_s
+
+      soap_body = '<Objects xsi:type="Subscriber">' +
+                    create_subscriber_object(options) +
+                  '</Objects>'
+
+      build_request('Create', 'CreateRequest', soap_body)
+    end
+
+    def create_subscribers(*args)
+      raise NoMethodError.new "I will implement this method soon"
+    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">
+        </PartnerKey>
+        <ID>' + list_id.to_s + '</ID>
+        <ObjectID xsi:nil="true">
+        </ObjectID>'
+      end
+  end
+end

data/lib/cupid/session.rb

@@ -0,0 +1,61 @@
+require("cupid/methods")
+
+module Cupid
+  class Session
+    DEFAULTS = {
+      :soap_s4_url          => "https://webservice.s4.exacttarget.com/etframework.wsdl",
+      :wsa_soap_s4_to       => "https://webservice.s4.exacttarget.com/Service.asmx",
+      :use_ssl              => true
+    }
+
+    def initialize(*args)
+      options     = args.extract_options!
+      @username   = options[:username]    ||= Cupid.username
+      @password   = options[:password]    ||= Cupid.password
+      @headers    = {"Content-Type" => "application/x-www-form-urlencoded", "Connection" => "close"}
+
+      @api_uri = @api_wsdl = DEFAULTS[:soap_s4_url]
+      @api_uri = URI.parse(@api_uri)
+      @api_url = Net::HTTP.new(@api_uri.host, @api_uri.port)
+
+      @api_url.use_ssl = DEFAULTS[:use_ssl]
+      @wsa_soap_s4_to = DEFAULTS[:wsa_soap_s4_to]
+    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
+      end
+  end
+end

data/lib/cupid/version.rb

@@ -0,0 +1,3 @@
+module Cupid
+  VERSION = '0.0.1'
+end

data/tmp/dancing_with_ET.rb

@@ -0,0 +1,158 @@
+require 'rubygems'
+require 'ruby-debug'
+require 'savon'
+require 'cgi'
+
+client = Savon::Client.new do
+  wsdl.document = "https://webservice.s4.exacttarget.com/etframework.wsdl"
+end
+
+client.wsse.credentials "username", "password"
+client.wsse.created_at = Time.now.utc
+client.wsse.expires_at = (Time.now + 60).utc
+client.http.headers["SOAPAction"] = '"urn:example#service"'
+
+# p client.wsdl.soap_actions
+
+# 1058396
+
+# [:create, :perform, :update, :schedule, :configure, :version_info, :execute, :extract, :get_system_status, :query, :delete, :retrieve, :describe]
+body = {
+  'wsdl:Objects' => {
+    'wsdl:EmailAddress' => 'wuuuuut@tester.com',
+    'wsdl:Attributes' => [
+        {"wsdl:Name" => "First Name", "wsdl:Value" => "Wuuuuut"},
+        {"wsdl:Name" => "Last Name", "wsdl:Value" => "Teeeester"},
+        {"wsdl:Name" => "Company", "wsdl:Value" => "Northern Trail Outfitters"}
+      ],
+    'wsdl:Lists' => {
+      'wsdl:ID' => '251',
+      'wsdl:Status' => 'Active'
+    },
+    :attributes! => {
+      'wsdl:Lists' => {'xsi:type' => 'wsdl:SubscriberList'}
+    }
+  
+  }
+}
+
+header = {
+  'a:Action' => 'Retrieve',
+  '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' => 'https://webservice.s4.exacttarget.com/Service.asmx'
+  }
+'
+<a:MessageID>urn:uuid:99e6822c-5436-4fec-a243-3126c14924f6</a:MessageID>
+<a:ReplyTo>
+  <a:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</a:Address>
+</a:ReplyTo>
+<VsDebuggerCausalityData xmlns="http://schemas.microsoft.com/vstudio/diagnostics/servicemodelsink">uIDPo5GdUXRQCEBNrqnw0gOEloMAAAAAIAi4IHpPlUiMs1MZ2raBIhJnF/jqJLlAgZIny03R+tgACQAA</VsDebuggerCausalityData>
+<a:To s:mustUnderstand="1">https://webservice.s4.exacttarget.com/Service.asmx</a:To>
+<o:Security s:mustUnderstand="1" xmlns:o="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
+  <u:Timestamp u:Id="_0">
+    <u:Created>2011-07-27T15:04:42.722Z</u:Created>
+    <u:Expires>2011-07-27T15:09:42.722Z</u:Expires>
+  </u:Timestamp>
+  <o:UsernameToken u:Id="uuid-8e2ca2bf-1581-4d7a-a981-bbdab4639bc3-1">
+    <o:Username>username</o:Username>
+    <o:Password>password</o:Password>
+  </o:UsernameToken>
+</o:Security>'
+# 
+body = '<RetrieveRequest>
+  <ObjectType>DataFolder</ObjectType>
+  <Properties>ID</Properties>
+  <Properties>Name</Properties>
+  <Properties>ParentFolder.ID</Properties>
+  <Properties>ParentFolder.Name</Properties>
+  <Filter xsi:type="SimpleFilterPart">
+    <Property>Account</Property>
+    <SimpleOperator>equals</SimpleOperator>
+    <Value>1058484</Value>
+  </Filter>
+</RetrieveRequest>'
+
+body = '<RetrieveRequest>  
+      <ObjectType>List</ObjectType>  
+      <Properties>ListName</Properties>  
+      <Properties>ID</Properties>  
+      <Filter xsi:type="SimpleFilterPart">  
+         <Property>ListName</Property>  
+         <SimpleOperator>equals</SimpleOperator>  
+         <Value>All Subscribers</Value>  
+      </Filter>  
+   </RetrieveRequest>'
+   
+body = '<RetrieveRequest>
+<ClientIDs>
+<ID>1058484</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>'
+                      
+# body = '<RetrieveRequest>
+# <ClientIDs>
+# <ID>1058396</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>'
+
+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>
+#        <HTMLBody>'+html+'</HTMLBody>  
+#        <Subject>Test Subject111</Subject>  
+#        <EmailType>HTML</EmailType>  
+#        <IsHTMLPaste>true</IsHTMLPaste>  
+#     </Objects>'
+
+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 :retrieve do |soap|
+  soap.input = ['RetrieveRequestMsg', { 'xmlns'=>"http://exacttarget.com/wsdl/partnerAPI"}]
+  soap.header = header
+  soap.env_namespace = :s
+  soap.namespaces = namespaces
+  soap.body = body
+end
+# 
+# response = client.request :create do |soap|
+#   soap.input = ['CreateRequest', { 'xmlns'=>"http://exacttarget.com/wsdl/partnerAPI"}]
+#   soap.header = header
+#   soap.env_namespace = :s
+#   soap.namespaces = namespaces
+#   soap.body = body
+# end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: cupid
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- gazay
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-01 00:00:00 Z
+dependencies: []
+
+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: 
+- Gemfile
+- README.md
+- Rakefile
+- cupid.gemspec
+- lib/cupid.rb
+- lib/cupid/configuration.rb
+- lib/cupid/methods.rb
+- lib/cupid/methods/email.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: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: cupid
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Create, organize and send emails through Exact Target SOAP API
+test_files: 
+- spec/cupid/cupid_spec.rb