exact_target_sdk 0.0.0

data/CHANGELOG.rdoc

@@ -0,0 +1,6 @@
+= ExactTarget SDK
+
+== Version 0.0.0
+* Initial release
+* Supports Create method
+* Supports Subscriber and TriggeredSend objects, allowing subscribers to be created and triggered emails to be sent to them

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2012 RevPAR Collective, Inc.
+
+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/README.rdoc

@@ -0,0 +1,36 @@
+= ExactTarget SDK
+
+An object-oriented wrapper for the ExactTarget SOAP API.
+
+The ExactTarget web service guide can be viewed here:
+http://docs.code.exacttarget.com/020_Web_Service_Guide
+
+With few exceptions, ruby conventions for capitalization are ignored and those
+outlined in the guide linked above are used. This is done in an attempt to be
+as transparent as possible, so that the API may be used by referring only to
+the guide linked above.
+
+Note this SDK is currently very incomplete, allowing you only to create
+subscribers and trigger sends. The framework is in place, however, to very
+easily implement new objects by simply declaring their properties.
+
+== Synopsis:
+
+ ExactTargetSDK.config(:username => 'foo', :password => 'mypass')
+
+ client = ExactTargetSDK::Client.new
+ definition = TriggeredSendDefinition.new('CustomerKey' => 'my_triggered_send')
+ subscriber = Subscriber.new('EmailAddress' => 'me@example.com')
+ triggered_send = TriggeredSend.new('TriggeredSendDefinition' => definition)
+ triggered_send.subscribers << subscriber
+
+ # Creates subscriber record, then executes the "my_triggered_send" trigger to
+ # that subscriber.
+ response = client.Create(subscriber, triggered_send)
+
+ puts "response status: #{response.OverallStatus}"
+ response.Results.each do |result|
+   puts "result..."
+   puts "  result code: #{result.StatusCode}"
+   puts "  result message: #{result.StatusMessage}"
+ end

data/lib/exact_target_sdk.rb

@@ -0,0 +1,14 @@
+require 'exact_target_sdk/config'
+require 'exact_target_sdk/errors'
+
+module ExactTargetSDK
+
+  autoload :APIObject, 'exact_target_sdk/api_object'
+  autoload :Client, 'exact_target_sdk/client'
+  autoload :CreateResponse, 'exact_target_sdk/create_response'
+  autoload :CreateResult, 'exact_target_sdk/create_result'
+  autoload :Subscriber, 'exact_target_sdk/subscriber'
+  autoload :TriggeredSend, 'exact_target_sdk/triggered_send'
+  autoload :TriggeredSendDefinition, 'exact_target_sdk/triggered_send_definition'
+
+end

data/lib/exact_target_sdk/api_object.rb

@@ -0,0 +1,147 @@
+require 'active_model'
+
+module ExactTargetSDK
+
+# Parent class of all ExactTarget API objects (listed here:
+# http://docs.code.exacttarget.com/020_Web_Service_Guide/Objects). Provides
+# class-level declarations, validation, and rendering that makes modeling
+# each object easy.
+class APIObject
+
+  include ::ActiveModel::Validations
+
+  class << self
+
+    # Declares a property of this object, optionally requiring it upon
+    # validation.
+    #
+    # Provides a getter and setter for this property, keeping track of
+    # whether or not it has been set and registering it for rendering.
+    def property(name, required = false)
+      name = name.to_s
+      attr_reader name.to_sym
+      class_eval <<-__EOF__
+        def #{name}=(value)
+          @_set_#{name} = true
+          @#{name} = value
+        end
+      __EOF__
+      if required
+        validates name.to_sym, :presence => true
+      end
+      register_property!(name)
+    end
+
+    # Declares a property as an array of values.
+    #
+    # Provides a getter and setter for this property. The getter will
+    # always return an array (not null), so the client may simply append
+    # to this property.
+    #
+    # Note that once the property has been either read or written to, it
+    # will be rendered.
+    def array_property(name)
+      # TODO: type validation would be nice
+      name = name.to_s
+      class_eval <<-__EOF__
+        def #{name}
+          @_set_#{name} = true
+          @#{name} ||= []
+        end
+        def #{name}=(value)
+          @_set_#{name} = true
+          @#{name} = value
+        end
+      __EOF__
+      register_property!(name)
+    end
+
+    # Same as #property, adding validation the the provided value is an
+    # integer.
+    def int_property(name, required = false)
+      property(name, required)
+      validates name.to_sym, :numericality => { :allow_nil => true, :only_integer => true }
+    end
+
+    # Takes one or more method names as symbols, and executes them in order
+    # before validation occurs on this object.
+    def before_validation(*args)
+      before_validation_methods.concat(args)
+    end
+
+    # Returns an array of all registered properties.
+    def properties
+      @properties || []
+    end
+
+    private
+
+    # Returns the method names declared using #before_validation.
+    def before_validation_methods
+      @before_validation_methods ||= []
+    end
+
+    # Stores the given property name to be used at render time.
+    def register_property!(name)
+      @properties ||= []
+      @properties << name
+      @properties.uniq!
+    end
+
+  end
+
+  # By default, any properties may be passed and set.
+  #
+  # May be overridden.
+  def initialize(properties = {})
+    properties.each do |key, value|
+      self.send "#{key}=", value
+    end
+  end
+
+  # By default, returns the name of the class.
+  #
+  # May be overridden.
+  def type_name
+    self.class.name.split('::').last
+  end
+
+  # By default, runs validation and executes #render_properties!.
+  #
+  # If overridden, the child class should execute the before_validation
+  # methods, check wehter or not the object is valid, and then render
+  # the object.
+  def render!(xml)
+    self.class.before_validation_methods.each { |method| self.send(method) }
+    raise(InvalidAPIObject, self) if invalid?
+    render_properties!(xml)
+  end
+
+  # By default, loops through all registered properties, and renders
+  # each that has been explicitly set.
+  #
+  # May be overridden.
+  def render_properties!(xml)
+    self.class.properties.each do |property|
+      next unless instance_variable_get("@_set_#{property}")
+
+      property_value = self.send(property)
+
+      if property_value.is_a?(APIObject)
+        xml.__send__(property) do
+          property_value.render!(xml)
+        end
+      elsif property_value.is_a?(Array)
+        property_value.each do |current|
+          xml.__send__(property) do
+            current.render!(xml)
+          end
+        end
+      else
+        xml.__send__(property, property_value)
+      end
+    end
+  end
+
+end
+end

data/lib/exact_target_sdk/client.rb

@@ -0,0 +1,140 @@
+require 'guid'
+require 'savon'
+require 'timeout'
+
+module ExactTargetSDK
+
+# Provides an object-oriented API to ExactTarget's Web Service API
+# (http://docs.code.exacttarget.com/020_Web_Service_Guide)
+#
+# With few exceptions, ruby conventions for capitalization are ignored and those
+# outlined in the guide linked above are used. This is done in an attempt to be
+# as transparent as possible, so that the API may be used by referring only to
+# the guide linked above.
+class Client
+
+  # Constructs a client.
+  #
+  # Any of the options documented in ExactTargetSDK#config may be overridden
+  # using the options parameter.
+  #
+  # Since ExactTarget's API is stateless, constructing a client object will not
+  # make any remote calls.
+  def initialize(options = {})
+    self.config = {
+    }.merge!(ExactTargetSDK.config).merge!(options)
+
+    Savon.configure do |c|
+      c.logger = config[:logger]
+      c.raise_errors = false
+    end
+
+    initialize_client!
+  end
+
+  # Invokes the Create method.
+  #
+  # The provided arguments should each be sub-classes of APIObject, and each
+  # provided object will be created in order.
+  #
+  # Possible exceptions are:
+  #   HTTPError         if an HTTP error (such as a timeout) occurs
+  #   SOAPFault         if a SOAP fault occurs
+  #   Timeout           if there is a timeout waiting for the response
+  #   InvalidAPIObject  if any of the provided objects don't pass validation
+  #
+  # Returns a CreateResponse object.
+  def Create(*args)
+    # TODO: implement and accept CreateOptions
+
+    api_objects = args
+
+    response = execute_request 'Create' do |xml|
+      xml.CreateRequest do
+        xml.Options  # TODO: support CreateOptions
+
+        api_objects.each do |api_object|
+          xml.Objects "xsi:type" => api_object.type_name do
+            api_object.render!(xml)
+          end
+        end
+      end
+    end
+
+    CreateResponse.new(response)
+  end
+
+  private
+
+  attr_accessor :config, :client
+  
+  # Constructs and saves the savon client using provided config.
+  def initialize_client!
+    self.client = ::Savon::Client.new do
+      wsdl.endpoint = config[:endpoint]
+      wsdl.namespace = config[:namespace]
+      http.open_timeout = config[:open_timeout]
+      http.read_timeout = config[:read_timeout]
+    end
+  end
+
+  # Builds the SOAP request for the given method, delegating body
+  # rendering to the provided block.
+  #
+  # Handles errors and re-raises with appropriate sub-class of
+  # ExactTargetSDK::Error.
+  #
+  # Returns the raw savon response.
+  def execute_request(method)
+    begin
+      response = client.request(method) do
+        soap.xml do |xml|
+          xml.s :Envelope,
+              "xmlns" => config[:namespace],
+              "xmlns:xsd" => "http://www.w3.org/2001/XMLSchema",
+              "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance",
+              "xmlns:s" => "http://www.w3.org/2003/05/soap-envelope",
+              "xmlns:a" => "http://schemas.xmlsoap.org/ws/2004/08/addressing",
+              "xmlns:o" => "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" do
+
+            xml.s :Header do
+              xml.a :Action, method, "s:mustUnderstand" => "1"
+              xml.a :MessageID, "uuid:#{Guid.new.to_s}"
+              xml.a :ReplyTo do
+                xml.a :Address, "http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous"
+              end
+              xml.a :To, config[:endpoint], "s:mustUnderstand" => "1"
+              xml.o :Security, "s:mustUnderstand" => "1" do
+                xml.o :UsernameToken, "o:Id" => "test" do
+                  xml.o :Username, config[:username]
+                  xml.o :Password, config[:password]
+                end
+              end
+            end
+
+            xml.s :Body do
+              yield(xml)
+            end
+          end
+        end
+      end
+
+      if response.http_error?
+        raise HTTPError, response.http_error.to_s
+      end
+
+      if response.soap_fault?
+        raise SOAPFault, response.soap_fault.to_s
+      end
+
+      response
+    rescue Timeout::Error => e
+      timeout = ::ExactTargetSDK::Timeout.new("#{e.message}; open_timeout: #{config[:open_timeout]}; read_timeout: #{config[:read_timeout]}")
+      timeout.set_backtrace(e.backtrace)
+      raise timeout
+    end
+  end
+
+end
+
+end

data/lib/exact_target_sdk/config.rb

@@ -0,0 +1,61 @@
+require 'logger'
+
+module ExactTargetSDK
+
+  DEFAULT_TIMEOUT = 15
+  DEFAULT_ENDPOINT = 'https://webservice.s4.exacttarget.com/Service.asmx'
+  DEFAULT_NAMESPACE = 'http://exacttarget.com/wsdl/partnerAPI'
+
+  # Globally configures and retrieves configuration for the ExactTarget SDK.
+  #
+  # == Environment Variables
+  #
+  # For convenience in a command-line environment, configuration may be skipped
+  # by setting the EXACT_TARGET_SDK_USERNAME and EXACT_TARGET_SDK_PASSWORD
+  # environment variables, which are self-explanatory.
+  #
+  # == Rails
+  #
+  # If running in a rails environment, this configuration will automatically use
+  # the global Rails.logger instance. This behavior may be overridden by passing
+  # in a :logger option.
+  #
+  # @param [Hash] options
+  # @option options [String] :username (nil) ExactTarget account username
+  # @option options [String] :password (nil) ExactTarget account password
+  # @option options [Logger] :logger (Rails.logger) Logger to use
+  # @option options [Numeric] :open_timeout (ExactTargetSDK::DEFAULT_TIMEOUT)
+  #   Number of seconds to wait for the connection to open
+  #   (see Net::HTTP#open_timeout)
+  # @option options [Numeric] :read_timeout (ExactTargetSDK::DEFAULT_TIMEOUT)
+  #   Number of seconds to wait for one block to be read
+  #   (see Net::HTTP#read_timeout)
+  def self.config(options = nil)
+    @config ||= {
+      :username => ENV['EXACT_TARGET_SDK_USERNAME'],
+      :password => ENV['EXACT_TARGET_SDK_PASSWORD'],
+      :logger => default_logger,
+      :open_timeout => DEFAULT_TIMEOUT,
+      :read_timeout => DEFAULT_TIMEOUT,
+      :endpoint => DEFAULT_ENDPOINT,
+      :namespace => DEFAULT_NAMESPACE,
+    }
+    
+    @config.merge!(options) if options
+
+    @config
+  end
+
+  private
+
+  def self.default_logger
+    if defined?(::Rails)
+      ::Rails.logger
+    else
+      logger = ::Logger.new(STDERR)
+      logger.level = ::Logger::INFO
+      logger
+    end
+  end
+
+end

data/lib/exact_target_sdk/create_response.rb

@@ -0,0 +1,17 @@
+module ExactTargetSDK
+class CreateResponse
+
+  attr_reader :OverallStatus, :RequestID, :Results
+
+  def initialize(response)
+    response = response.to_hash[:create_response]
+    @OverallStatus = response[:overall_status]
+    @RequestID = response[:request_id]
+    @Results = []
+    (response[:results] || []).each do |result|
+      @Results << CreateResult.new(result)
+    end
+  end
+
+end
+end

data/lib/exact_target_sdk/create_result.rb

@@ -0,0 +1,12 @@
+module ExactTargetSDK
+class CreateResult
+
+  attr_reader :StatusCode, :StatusMessage
+
+  def initialize(hash)
+    @StatusCode = hash[:status_code]
+    @StatusMessage = hash[:status_message]
+  end
+
+end
+end

data/lib/exact_target_sdk/errors.rb

@@ -0,0 +1,35 @@
+module ExactTargetSDK
+
+# Parent of all errors raised by this SDK
+class Error < ::StandardError
+end
+
+# Indicates an "HTTP error" as defined by savon
+class HTTPError < Error
+end
+
+# Indicates a "SOAP fault" as defined by savon
+class SOAPFault < Error
+end
+
+# Indicates the open or read timeouts were reached
+class Timeout < Error
+end
+
+# Indicates validation failed on an APIObject, which is referenced
+# in the exception.
+class InvalidAPIObject < Error
+
+  attr_reader :api_object
+
+  def initialize(api_object)
+    @api_object = api_object
+  end
+
+  def message
+    "#{api_object.type_name} object is invalid: #{api_object.errors.full_messages.join('; ')}"
+  end
+
+end
+
+end

data/lib/exact_target_sdk/subscriber.rb

@@ -0,0 +1,31 @@
+module ExactTargetSDK
+
+# Assumes that the "SubscriberKey feature" is not enabled on your account, and
+# thus explicitly sets the SubscriberKey to be the same as the EmailAddress
+# (and vice-versa). This allows all methods to be used without ever needing to 
+# refer to the SubscriberKey (just use EmailAddress).
+#
+# If the SubscriberKey is explicitly set, it will be left alone (in case you do
+# have the SubscriberKey feature enabled).
+#
+# When updating, the email address may be updated by setting the SubscriberKey
+# property to the current email address, and the EmailAddress property to the
+# new email address.
+class Subscriber < APIObject
+
+  property 'SubscriberKey', true
+  property 'EmailAddress', true
+  array_property 'Attributes'
+
+  before_validation :sync_subscriber_key_and_email_address
+
+  private
+
+  def sync_subscriber_key_and_email_address
+    self.SubscriberKey = self.EmailAddress if self.SubscriberKey.nil?
+    self.EmailAddress = self.SubscriberKey if self.EmailAddress.nil?
+  end
+
+end
+
+end

data/lib/exact_target_sdk/triggered_send.rb

@@ -0,0 +1,8 @@
+module ExactTargetSDK
+class TriggeredSend < APIObject
+
+  property 'TriggeredSendDefinition', true
+  array_property 'Subscribers'
+
+end
+end

data/lib/exact_target_sdk/triggered_send_definition.rb

@@ -0,0 +1,7 @@
+module ExactTargetSDK
+class TriggeredSendDefinition < APIObject
+
+  property 'CustomerKey', true
+
+end
+end

data/lib/exact_target_sdk/version.rb

@@ -0,0 +1,3 @@
+module ExactTargetSDK
+  VERSION = '0.0.0'
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification 
+name: exact_target_sdk
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- David Dawson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-30 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 3
+        - 1
+        version: "3.1"
+  version_requirements: *id001
+  name: activemodel
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 0
+        - 1
+        version: "0.1"
+  version_requirements: *id002
+  name: guid
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
+  version_requirements: *id003
+  name: savon
+  prerelease: false
+  type: :runtime
+description: Provides an easy-to-use ruby interface into the ExactTarget SOAP API, using the Savon client.
+email: daws23@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- CHANGELOG.rdoc
+- LICENSE.txt
+files: 
+- lib/exact_target_sdk/api_object.rb
+- lib/exact_target_sdk/client.rb
+- lib/exact_target_sdk/config.rb
+- lib/exact_target_sdk/create_response.rb
+- lib/exact_target_sdk/create_result.rb
+- lib/exact_target_sdk/errors.rb
+- lib/exact_target_sdk/subscriber.rb
+- lib/exact_target_sdk/triggered_send.rb
+- lib/exact_target_sdk/triggered_send_definition.rb
+- lib/exact_target_sdk/version.rb
+- lib/exact_target_sdk.rb
+- README.rdoc
+- CHANGELOG.rdoc
+- LICENSE.txt
+homepage: https://github.com/daws/exact_target_sdk
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+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: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A simple wrapper for the ExactTarget SOAP API.
+test_files: []
+