rbet 1.0.0

data/README.rdoc

@@ -0,0 +1,39 @@
+== Ruby Library for ExactTarget
+
+  This is an attempt to make integrating easier with ExactTarget.  ExactTarget is 
+  an email newsletter system designed to make it easy to setup timely newsletters.
+  
+  Exact Target: http://www.exacttarget.com/
+  
+  Exact Target API:
+  http://developers.exacttarget.com/Web/help/Overview/Introduction_to_ExactTarget_API_Help.htm
+
+== Adding rbet to a Rails Project
+  
+  If you are using Git to manage your rails project and would like to add rbet as a submodule:
+  
+    git submodule add git://github.com/sbraford/rbet.git vendor/rbet
+    
+  Then in the bottom of your environment.rb, or in an initializer, add:
+
+    require File.join(RAILS_ROOT, 'vendor', 'rbet', 'lib', 'et.rb')
+
+== Development Notes
+  
+  Original development work was performed by Todd A. Fisher.
+  
+  Forking development to GitHub + minor development additions/changes by Shanti A. Braford.
+  
+== Contributing
+
+  If you'd like to contribute, fork a copy of the repo on GitHub.
+  
+  When you have patch(es) ready, contact me at:shantibraford@gmail.com
+
+== Notes
+
+  2000 character limit for each attribute
+
+== Win32 Notes
+
+  This has not been tested on Windows.  May the force be with you, young win32 jedi =)

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'lib/rbet/version'
+
+spec = Gem::Specification.new do |s|
+  s.name             = 'rbet'
+  s.version          = RBET::Version.to_s
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w(README.rdoc)
+  s.rdoc_options     = %w(--main README.rdoc)
+  s.summary          = "A ruby wrapper for the Exact Target API"
+  s.author           = 'See Contributing Section'
+  s.email            = 'kevin@conceptsahead.com'
+  s.homepage         = 'http://github.com/n3bulous/rbet'
+  s.files            = %w(README.rdoc Rakefile) + Dir.glob("{lib,test}/**/*")
+  # s.executables    = ['rbet']
+
+  # s.add_dependency('gem_name', '~> 0.0.1')
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList["test/*_test.rb"]
+  t.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+
+  Rcov::RcovTask.new(:coverage) do |t|
+    t.libs       = ['test']
+    t.test_files = FileList["test/*_test.rb"]
+    t.verbose    = true
+    t.rcov_opts  = ['--text-report', "-x #{Gem.path}", '-x /Library/Ruby', '-x /usr/lib/ruby']
+  end
+
+  task :default => :coverage
+
+rescue LoadError
+  warn "\n**** Install rcov (sudo gem install relevance-rcov) to get coverage stats ****\n"
+  task :default => :test
+end
+
+
+desc 'Generate the gemspec to serve this Gem from Github'
+task :github do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, 'w') {|f| f << spec.to_ruby }
+  puts "Created gemspec: #{file}"
+end

data/lib/rbet.rb

@@ -0,0 +1,31 @@
+#
+# Copyright (c) 2007 Todd A. Fisher
+#
+# 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.
+#
+
+require 'rubygems'
+gem 'activesupport'
+require 'active_support'
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/rbet"))
+%w(renderable error client subscriber list tracker triggered_send).each do |lib|
+  require lib
+end

data/lib/rbet/auth.rxml

@@ -0,0 +1,8 @@
+<?xml version="1.0" ?>
+<exacttarget>
+  <authorization>
+    <username><%= @username %></username>
+    <password><%= @password %></password>
+  </authorization>
+  <%= @system %>
+</exacttarget>

data/lib/rbet/client.rb

@@ -0,0 +1,87 @@
+#
+# Copyright (c) 2007 Todd A. Fisher
+#
+# Portions Copyright (c) 2008 Shanti A. Braford
+#
+# 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.
+#
+require 'net/https'
+require 'uri'
+require 'erb'
+
+module RBET
+  class Client
+    attr_reader :username, :password, :headers
+    include RBET::Renderable
+
+    #  Initializes a new ET::Client object
+    #
+    #   Usaage:
+    #
+    #     client = ET::Client.new('tester','tester11', {:service_url => 'http://127.0.0.1:99999/test/', :use_ssl => false})
+    #     client.status
+    #     => "Running"
+    #     client.live?
+    #      => true
+    #
+    def initialize(username,password,options={})
+      @username = username
+      @password = password
+      service_url = options[:service_url] ? options[:service_url] : 'https://www.exacttarget.com/api/integrate.asp?qf=xml'
+      @uri = URI.parse(service_url)
+      @url = Net::HTTP.new(@uri.host, @uri.port)
+      @url.use_ssl = options.key?(:use_ssl) ? options[:use_ssl] : true
+      @url.set_debug_output options.key?(:debug_output) ? options[:debug_output] : nil
+      @headers = {
+        'Content-Type' => 'application/x-www-form-urlencoded'
+      }
+    end
+
+    # Boolean value of whether the service is running or not currently
+    def live?
+      @current_status ||= status
+      @current_status == 'Running'
+    end
+
+    # Returns the string value from the ExactTarget API ping method. ("Running" when the system is operational)
+    def status
+      response = send do|io|
+        io << render_template('ping')
+      end
+      Error.check_response_error(response)
+      doc = Hpricot.XML( response.read_body )
+      @current_status = doc.at("Ping").inner_html
+    end
+
+    # usage:
+    #   send do|io|
+    #     io << 'more xml'
+    #   end
+    def send
+      @system = ""
+      yield @system
+
+      result = 'qf=xml&xml=' + render_template( 'auth' )
+
+      @url.post( @uri.path, result, @headers.merge('Content-length' => result.length.to_s) )
+    end
+
+  end
+end

data/lib/rbet/error.rb

@@ -0,0 +1,50 @@
+#
+# Copyright (c) 2007 Todd A. Fisher
+#
+# Portions Copyright (c) 2008 Shanti A. Braford
+#
+# 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.
+#
+module RBET
+  class Error < RuntimeError
+    attr_reader :code, :message
+    def initialize(error_code,error_msg)
+      @code = error_code
+      @message = error_msg
+    end
+
+    def to_s
+      "Code: #{@code}.  Message: #{@message}"
+    end
+
+    # raise a new error object from an HTTP response if it contains an error
+    def self.check_response_error(response)
+      if response.class != Net::HTTPOK
+        raise Error.new(-1,'Network error')
+      end
+      doc = Hpricot.XML(response.body)
+      error_code = doc.at("error")
+      error_msg = doc.at("error_description")
+      if( error_code and error_msg )
+        raise Error.new(error_code.inner_html.to_i,error_msg.inner_html)
+      end
+    end
+  end
+end

data/lib/rbet/list.rb

@@ -0,0 +1,149 @@
+#
+# Copyright (c) 2007 Todd A. Fisher
+#
+# Portions Copyright (c) 2008 Shanti A. Braford
+#
+# 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.
+#
+module RBET
+  #
+  # Subscriber list
+  # usage:
+  #
+  #   # create a new subscriber list
+  #   super_list = List.add 'Super list', :type => :public
+  #   => ET::List
+  #
+  #   # retrieve the list by name
+  #   basic_list = List.retrieve_by_name('My Super List')
+  #   => ET::List
+  #
+  #   # retrieve by id
+  #   basic_list = List.retrieve_by_id(12322)
+  #   => ET::List
+  #
+  #   # send an email to a list
+  #   list_id = 147000
+  #   email_template_id = 9999123
+  #   list = ET::List.new('username', 'password')
+  #   list.send_email(list_id, email_template_id, {:first_name => 'John', :last_name => 'Wayne'})
+  #
+  class List < Client
+    attr_reader :attributes
+
+    def initialize(username,password,options={})
+      super
+      @attributes = {}
+    end
+
+    # get all the lists
+    def all
+      response = send do|io|
+        io << render_template('list_list_all')
+      end
+      Error.check_response_error(response)
+      doc = Hpricot.XML( response.read_body )
+      listids = []
+      (doc/"listid").each do|listid|
+        listids << listid.inner_html.to_i
+      end
+      listids
+    end
+
+    # returns a new list object by id
+    def retrieve_by_id( id )
+      @search_type = "listid"
+      @search_value = id
+      response = send do|io|
+        io << render_template('list_retrieve')
+      end
+      Error.check_response_error(response)
+      load_list( response.read_body )
+    end
+
+    # returns a new list object by list name
+    def retrieve_by_name( name )
+      @search_type = "listname"
+      @search_value = name
+      response = send do|io|
+        io << render_template('list_retrieve')
+      end
+      Error.check_response_error(response)
+      load_list( response.read_body )
+    end
+
+    # defaults type to private if not private or public
+    # returns the new list id
+    def add(name, type='private')
+      @list_name = name
+      @list_type = type
+      @list_type = 'private' if type != 'public' or type != 'private'
+      response = send do|io|
+        io << render_template('list_add')
+      end
+      Error.check_response_error(response)
+      doc = Hpricot.XML( response.read_body )
+      doc.at("list_description").inner_html.to_i
+    end
+
+    def subscriber_emails(list_id)
+      @list_id = list_id
+      response = send do|io|
+        io << render_template('list_retrieve_subscribers')
+      end
+      Error.check_response_error(response)
+      body = response.read_body
+      doc = Hpricot.XML( body )
+      emails = []
+      (doc/"Email__Address").each do |row|
+        emails << row.inner_html
+      end
+      emails
+    end
+
+    # Sends an email to the list specified
+    def send_email(list_id, email_id, attrs = {})
+      defaults = {:from_name => '', :from_email => '', :additional => '',
+                  :multipart_mime => true, :track_links => true, :send_date => 'immediate', :send_time => ''}
+      @list_id, @email_id = list_id, email_id
+      @extra_attrs = defaults.merge(attrs)
+      response = send do|io|
+        io << render_template('list_send_email')
+      end
+      Error.check_response_error(response)
+      #puts "Response Body: #{response.read_body} \n"
+      doc = Hpricot.XML( response.read_body )
+      doc.at("job_description").inner_html.to_i rescue nil
+    end
+
+    private
+
+    def load_list( body )
+      doc = Hpricot.XML( body )
+      doc.at("list").each_child do|child|
+        if child.respond_to?(:name) and child.respond_to?(:inner_html)
+          @attributes[child.name] = child.inner_html
+        end
+      end
+      self
+    end
+
+  end
+end

data/lib/rbet/list_add.rxml

@@ -0,0 +1,8 @@
+<system>
+  <system_name>list</system_name>
+  <action>add</action>
+  <search_type></search_type>
+  <search_value></search_value>
+  <list_type><%= @list_type %></list_type>
+  <list_name><%= @list_name %></list_name>
+</system>

data/lib/rbet/list_list_all.rxml

@@ -0,0 +1,6 @@
+<system>
+  <system_name>list</system_name>
+  <action>retrieve</action>
+  <search_type>listname</search_type>
+  <search_value></search_value>
+</system>

data/lib/rbet/list_retrieve.rxml

@@ -0,0 +1,6 @@
+<system>
+  <system_name>list</system_name>
+  <action>retrieve</action>
+  <search_type><%= @search_type %></search_type>
+  <search_value><%= @search_value %></search_value>
+</system>

data/lib/rbet/list_retrieve_subscribers.rxml

@@ -0,0 +1,6 @@
+<system>
+  <system_name>list</system_name>
+  <action>retrieve_sub</action>
+  <search_type>listid</search_type>
+  <search_value><%= @list_id %></search_value>
+</system>

data/lib/rbet/list_send_email.rxml

@@ -0,0 +1,12 @@
+<system>
+  <system_name>job</system_name>
+  <action>send</action>
+  <search_type>emailid</search_type>
+  <search_value><%= @email_id %></search_value>
+  <% @extra_attrs.each do|name, value| %>
+    <<%= name.to_s %>><%= value.to_s %></<%= name %>>
+  <% end %>
+  <lists>                        
+    <list><%= @list_id %></list>
+  </lists>
+</system>

data/lib/rbet/ping.rxml

@@ -0,0 +1,4 @@
+<system>
+  <system_name>diagnostics</system_name>
+  <action>Ping</action>
+</system>

data/lib/rbet/renderable.rb

@@ -0,0 +1,41 @@
+#
+# Copyright (c) 2007 Todd A. Fisher
+#
+# Portions Copyright (c) 2008 Shanti A. Braford
+#
+# 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.
+#
+module RBET
+  module Renderable
+    def set_template_path(path)
+      @template_path = path
+    end
+
+    def template_path(name)
+      File.join( (@template_path || File.dirname(__FILE__)), "#{name}.rxml")
+    end
+
+    def render_template( name )
+      erb = ERB.new( File.open( template_path(name) ,"r").read, 0, "<>")
+      erb.result( binding )
+    end
+
+  end
+end

data/lib/rbet/subscriber.rb

@@ -0,0 +1,137 @@
+#
+# Copyright (c) 2007 Todd A. Fisher
+#
+# Portions Copyright (c) 2008 Shanti A. Braford
+#
+# 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.
+
+require 'rubygems'
+require 'hpricot'
+
+module RBET
+
+  #
+  # usage:
+  #
+  #   # get an existing subscriber
+  #   subscriber = Subscriber.load!('user@example.com')
+  #   => ET::Subscriber
+  #
+  #   # subscribe a new user to an existing list
+  #   subscriber = Subscriber.add('user@example.com',list)
+  #   => ET::Subscriber
+  #
+  class Subscriber < Client
+    attr_accessor :attrs
+    attr_reader :email, :status
+
+    def initialize(username,password,options={})
+      super
+      @attrs = {}
+    end
+
+    def load!(email)
+      @email = email
+      response = send do|io|
+        io << render_template('subscriber_retrieve')
+      end
+      Error.check_response_error(response)
+      load_response(response.read_body)
+    end
+
+    def load_response(body)
+      doc = Hpricot.XML(body)
+      subscriber = doc.at(:subscriber)
+      # load elements into the attrs hash
+      @attrs = {}
+      subscriber.each_child do|attr_element|
+        if attr_element.elem?
+          name = attr_element.name.gsub(/__/,' ')
+          value = attr_element.inner_html
+          @attrs[name] = value
+          if name == 'Email Address'
+            @email = value
+          elsif name == 'Status'
+            @status = value
+          end
+        end
+      end
+    end
+    private :load_response
+
+    # desc:
+    #   add this user as a new subscriber to the list, with a set of attributes
+    # params:
+    #   listid: id of the e-mail list to subscribe this user to
+    #   email: E-mail address of subscriber
+    def add( email, listid, attributes ={} )
+      @email = email
+      @subscriber_listid = listid
+      @attributes = attributes
+      response = send do|io|
+        io << render_template('subscriber_add')
+      end
+      Error.check_response_error(response)
+      doc = Hpricot.XML(response.read_body)
+      doc.at("subscriber_description").inner_html.to_i
+    end
+
+    # desc:
+    #   update this a subscriber
+    # params:
+    #   listid: id of the e-mail list to subscribe this user to
+    #   email: E-mail address of subscriber
+    #   subscriberid: id for the subscriber to update
+    def update(subscriberid, email, listid, attributes ={} )
+      @email = email
+      @listid = listid
+      @subscriberid = subscriberid
+      @attributes = attributes
+      response = send do|io|
+        io << render_template('subscriber_update')
+      end
+      Error.check_response_error(response)
+      doc = Hpricot.XML(response.read_body)
+      doc.at("subscriber_description").inner_html.to_i
+    end
+
+    # desc:
+    #   delete this user as a new subscriber to the list, or completely from ET
+    # params:
+    #   listid: id of the e-mail list to unsubscribe this user from
+    #   email: E-mail address of subscriber
+    #   subscriberid: id for the subscriber to delete COMPLETELY
+    def delete(subscriberid, email, listid, attributes ={} )
+      @email = email
+      @subscriber_listid = listid
+      @subscriberid = subscriberid
+
+      puts render_template('subscriber_delete')
+      response = send do|io|
+        io << render_template('subscriber_delete')
+      end
+      Error.check_response_error(response)
+      doc = Hpricot.XML(response.read_body)
+      doc.at("subscriber_info").inner_html
+    end
+
+
+  end
+end

data/lib/rbet/subscriber_add.rxml

@@ -0,0 +1,15 @@
+<system>
+  <system_name>subscriber</system_name>
+  <action>add</action>
+  <search_type>listid</search_type>
+  <search_value><%= @subscriber_listid %></search_value>
+  <search_value2></search_value2>
+  <values>
+    <Email__Address><%= @email %></Email__Address>
+    <status>active</status>
+    <% @attributes.each do|name,value| %>
+      <<%= name %>><%= (value.is_a?(Array)) ? value.join(',') : value %></<%= name %>>
+    <% end %>
+  </values>
+  <update>true</update>
+</system>

data/lib/rbet/subscriber_delete.rxml

@@ -0,0 +1,7 @@
+<system>
+  <system_name>subscriber</system_name>
+  <action>delete</action>
+  <search_type><%= @subscriberid.nil? ? "listid" : "subid" %></search_type>
+  <search_value><%= @subscriberid.nil? ? @subscriber_listid : @subscriberid %></search_value>
+  <search_value2><%= @email if @subscriberid.nil? %></search_value2>
+</system>

data/lib/rbet/subscriber_retrieve.rxml

@@ -0,0 +1,8 @@
+<system>
+  <system_name>subscriber</system_name>
+  <action>retrieve</action>
+  <search_type>listid</search_type>
+  <search_value><%= @list_id %></search_value>
+  <search_value2><%= @email %></search_value2>
+  <showChannelID></showChannelID>
+</system>

data/lib/rbet/subscriber_retrieve_by_id.rxml

@@ -0,0 +1,8 @@
+<system>
+  <system_name>subscriber</system_name>
+  <action>retrieve</action>
+  <search_type>subid</search_type>
+  <search_value><%= @subid %></search_value>
+  <search_value2></search_value2>
+  <showChannelID></showChannelID>
+</system>

data/lib/rbet/subscriber_update.rxml

@@ -0,0 +1,17 @@
+<system>
+  <system_name>subscriber</system_name>
+  <action>edit</action>
+  <search_type><%= @subscriberid.nil? ? "listid" : "subid" %></search_type>
+  <search_value><%= @subscriberid.nil? ? @listid : @subscriberid %></search_value>
+  <search_value2><%= @email unless @subscriberid.nil? %></search_value2>
+  <values>
+    <Email__Address><%= @email %></Email__Address>
+    <% unless @listid.nil? %>
+      <status>active</status>
+    <% end %>
+    <% @attributes.each do|name,value| %>
+      <<%= name %>><%= (value.is_a?(Array)) ? value.join(',') : value %></<%= name %>>
+    <% end %>
+  </values>
+  <update>true</update>
+</system>

data/lib/rbet/tracker.rb

@@ -0,0 +1,57 @@
+#
+# Copyright (c) 2008 Shanti A. Braford
+#
+# 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.
+
+require 'rubygems'
+require 'hpricot'
+
+module RBET
+
+  #
+  # usage:
+  #
+  #   # First load the Tracker client
+  #   tracker_client = ET::Tracker.new('username', 'password')
+  #
+  #   # get job summary
+  #   summary = job_client.retrieve_summary(12345) # pass a job_id
+  #   => {'sentCount' => 163, 'deliveredCount' => 159, ... }
+  #
+  #
+  class Tracker < Client
+
+    def initialize(username,password,options={})
+      super
+    end
+
+    # retrieves tracking information for a particular job id
+    def retrieve_summary( job_id )
+      @job_id = job_id
+      response = send do|io|
+        io << render_template('tracker_retrieve_summary')
+      end
+      Error.check_response_error(response)
+      h = Hash.from_xml(response.read_body)
+      h['exacttarget']['system']['tracking']['emailSummary']
+    end
+
+  end
+end

data/lib/rbet/tracker_retrieve_summary.rxml

@@ -0,0 +1,8 @@
+<system>
+  <system_name>tracking</system_name>
+  <action>retrieve</action>
+  <sub_action>summary</sub_action>
+  <search_type>jobID</search_type>
+  <search_value><%= @job_id %></search_value>
+  <search_value2></search_value2>
+</system>

data/lib/rbet/triggered_send.rb

@@ -0,0 +1,60 @@
+#
+# Copyright (c) 2008 Shanti A. Braford
+#
+# 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.
+
+require 'rubygems'
+require 'hpricot'
+
+module RBET
+
+  #
+  # usage:
+  #
+  #   # First load the Trigger client
+  #   trigger = ET::TriggeredSend.new('username', 'password')
+  #
+  #   # send message
+  #   summary = trigger.deliver("someone@domain.org", "message-key", {:first_name => 'John', :last_name => 'Wayne'})
+  #   => 0 # success
+  #
+  #
+  class TriggeredSend < Client
+
+    def initialize(username, password, options={})
+      super
+    end
+
+    # deliver triggered email
+    def deliver(email, external_key, attributes={} )
+      @email = email
+      @external_key = external_key
+      @attributes = attributes
+      raise "external_key can't be nil" unless @external_key
+      response = send do|io|
+        io << render_template('triggered_send')
+      end
+      Error.check_response_error(response)
+      doc = Hpricot.XML(response.read_body)
+      doc.at("triggered_send_description").inner_html.to_i
+    end
+
+  end
+end

data/lib/rbet/triggered_send.rxml

@@ -0,0 +1,21 @@
+<system> 
+  <system_name>triggeredsend</system_name> 
+  <action>add</action> 
+  <TriggeredSend xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' 
+xmlns:xsd='http://www.w3.org/2001/XMLSchema' 
+xmlns='http://exacttarget.com/wsdl/partnerAPI'> 
+    <TriggeredSendDefinition> 
+      <CustomerKey><%= @external_key %></CustomerKey> 
+    </TriggeredSendDefinition> 
+    <Subscribers> 
+      <SubscriberKey><%= @email %></SubscriberKey> 
+      <EmailAddress><%= @email %></EmailAddress>
+      <% @attributes.each do |key, value| %>
+        <Attributes> 
+          <Name><%= key %></Name> 
+          <Value><%= value %></Value> 
+        </Attributes> 
+      <% end %>
+    </Subscribers> 
+  </TriggeredSend> 
+</system> 

data/lib/rbet/version.rb

@@ -0,0 +1,13 @@
+module RBET
+  module Version
+
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 0
+
+    def self.to_s # :nodoc:
+      [MAJOR, MINOR, TINY].join('.')
+    end
+
+  end
+end

data/test/client_test.rb

@@ -0,0 +1,18 @@
+require File.join(File.dirname(__FILE__),"help.rb")
+
+class TestClient  < Test::Unit::TestCase
+  include RBET::TestCase
+
+  def test_client_send_ping
+    client = RBET::Client.new('tester','tester11', {:service_url => 'http://127.0.0.1:9999/test/', :use_ssl => false})
+    result = client.send do|io|
+      io << %q(<system>
+                <system_name>diagnostics</system_name>
+                <action>Ping</action>
+               </system>)
+    end
+    assert_equal Net::HTTPOK, result.class
+    assert_match /<Ping>Running<\/Ping>/, result.body
+  end
+
+end

data/test/help.rb

@@ -0,0 +1,121 @@
+require 'test/unit'
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'rbet'
+require 'webrick'
+require 'thread'
+require 'rubygems'
+gem 'hpricot'
+require 'hpricot'
+
+# shut up, webrick :-)
+class ::WEBrick::HTTPServer
+  def access_log(config, req, res)
+    # nop
+  end
+end
+class ::WEBrick::BasicLog
+  def log(level, data)
+    # nop
+  end
+end
+
+class RBETService
+  include RBET::Renderable
+  def initialize
+    set_template_path( File.join(File.dirname(__FILE__), "templates") )
+  end
+end
+
+class DiagnosticsService < RBETService
+  def ping(params)
+    render_template("diagnostics_ping_success")
+  end
+end
+
+class ListService < RBETService
+  def add(params)
+    list_type = params['list_type']
+    if list_type != 'private' and list_type != 'public'
+      render_template("list_add_failure")
+    else
+      render_template("list_add_success")
+    end
+  end
+
+  def retrieve(params)
+    render_template("list_retrieve_all_success")
+  end
+end
+
+class SubscriberService < RBETService
+
+  def retrieve(params)
+    if params['search_value2']
+      @email = params['search_value2']
+      render_template("subscriber_retrieve_success")
+    else
+      render_template("subscriber_retrieve_failed")
+    end
+  end
+
+end
+
+# list for subscriber requests and respond like ET would
+class SubscriberRBETService < ::WEBrick::HTTPServlet::AbstractServlet
+
+  def do_POST(req, res)
+
+    xml_body = String.new(req.body)
+    xml_body.gsub!(/qf=xml&xml=/,'')
+    doc = Hpricot.XML(xml_body)
+    system = doc.at(:system)
+    system_name = system.at(:system_name).inner_html.strip.downcase
+    action = system.at(:action).inner_html.strip.downcase
+
+    params = {}
+    # load all the system parameters into a hash
+    system.each_child do|element|
+      next unless element.elem?
+      params[element.name] = element.inner_html.strip
+    end
+
+    response = service_for(system_name).send(action, params)
+
+    res.body = %Q(<?xml version="1.0" ?>
+<exacttarget>
+#{response}
+</exacttarget>)
+
+    res['Content-Type'] = "text/xml"
+  end
+
+private
+  def service_for(system_name)
+    eval("#{system_name.capitalize}Service.new")  #render_template("#{system_name}_#{action}_success")
+  end
+
+end
+
+module RBET
+  module TestCase
+
+    def setup
+      # create the server
+      @server = WEBrick::HTTPServer.new({:BindAddress => "localhost", :Port => 9999})
+
+      # setup test server (simulates exact target)
+      @server.mount("/test/", SubscriberRBETService)
+
+      # start up the server in a background thread
+      @thread = Thread.new(@server) do|server|
+        server.start
+      end
+    end
+
+    def teardown
+      @server.shutdown
+      #@thread.join
+    end
+
+  end
+end

data/test/list_test.rb

@@ -0,0 +1,18 @@
+require File.join(File.dirname(__FILE__),"help.rb")
+
+class ListClient  < Test::Unit::TestCase
+  include RBET::TestCase
+  def setup
+    super
+    @client = RBET::List.new('tester','tester11', :service_url => 'http://127.0.0.1:9999/test/', :use_ssl => false, :debug_output => $stderr)
+  end
+
+  def test_list_all
+    @client.all
+  end
+
+  def test_list_add
+    @client.add('sample list')
+  end
+
+end

data/test/subscriber_test.rb

@@ -0,0 +1,18 @@
+require File.join(File.dirname(__FILE__),"help.rb")
+
+class SubscriberClient  < Test::Unit::TestCase
+  include RBET::TestCase
+
+  def test_subscriber_load
+    client = RBET::Subscriber.new('tester', 'tester11', :service_url => 'http://127.0.0.1:9999/test/', :use_ssl => false)
+    client.load!('jdoe@email.com')
+    assert_equal 'jdoe@email.com', client.attrs['Email Address']
+    assert_equal 'John', client.attrs['First Name']
+    assert_equal 'Doe', client.attrs['Last Name']
+    assert_equal "", client.attrs['Title']
+    assert_equal nil, client.attrs['Not Event Defined']
+    assert_equal 'jdoe@email.com', client.email
+    assert_equal 'Active', client.status
+  end
+
+end

data/test/templates/diagnostics_ping_success.rxml

@@ -0,0 +1,5 @@
+<system>
+  <diagnostics>
+    <Ping>Running</Ping>
+  </diagnostics>
+</system>)

data/test/templates/list_add_failure.rxml

@@ -0,0 +1,6 @@
+<?xml version='1.0'?>
+<exacttarget>
+<system>
+  <list><error>93</error><error_description>You did not specify a valid list type.</error_description></list>
+</system>
+</exacttarget>

data/test/templates/list_add_success.rxml

@@ -0,0 +1,9 @@
+<?xml version="1.0" ?>
+<exacttarget>
+  <system>
+    <list>
+      <list_info>List was added successfully</list_info>
+      <list_description>80080</list_description>
+    </list>
+  </system>
+</exacttarget>

data/test/templates/list_retrieve_all_success.rxml

@@ -0,0 +1,12 @@
+<?xml version="1.0" ?>
+<exacttarget>
+  <system>
+    <list>
+      <listid>12345</listid>
+      <listid>67890</listid>
+      <listid>80080</listid>
+      <listid>80081</listid>
+      <listid>80082</listid>
+    </list>
+  </system>
+</exacttarget>

data/test/templates/list_retrieve_bylistid_success.rxml

@@ -0,0 +1,15 @@
+<?xml version="1.0" ?>
+<exacttarget>
+  <system>
+    <list>
+      <list_name>API-API Test List</list_name>
+      <list_type>Public</list_type>
+      <modified>8/18/2003 10:11:59 AM</modified>
+      <subscriber_count>129</subscriber_count>
+      <active_total>126</active_total>
+      <held_count>1</held_count>
+      <bounce_count>2</bounce_count>
+      <unsub_count>0</unsub_count>
+    </list>
+  </system>
+</exacttarget>

data/test/templates/subscriber_add_success.rxml

@@ -0,0 +1,6 @@
+<system>
+  <subscriber>
+    <subscriber_info>Subscriber was added/updated successfully</subscriber_info>
+    <subscriber_description>12334566</subscriber_description>
+  </subscriber>
+</system>

data/test/templates/subscriber_retrieve_failed.rxml

@@ -0,0 +1,9 @@
+<?xml version='1.0'?>
+<exacttarget>
+<system>
+  <subscriber>
+    <error>1</error>
+    <error_description>Subscriber not found with ListID = <%= @listid %> Email Address = <%= @email %></error_description>
+  </subscriber>
+</system>
+</exacttarget>

data/test/templates/subscriber_retrieve_success.rxml

@@ -0,0 +1,15 @@
+<system>
+  <subscriber>
+    <subid>125704849</subid>
+    <listid>63718</listid>
+    <list_name>Newsletter List</list_name>
+    <Email__Address><%= @email %></Email__Address>
+    <Status>Active</Status>
+    <Email__Type>HTML</Email__Type>
+    <First__Name>John</First__Name>
+    <Last__Name>Doe</Last__Name>
+    <Title />
+    <Region />
+    <showChannelID>123456</showChannelID>
+  </subscriber>
+</system>

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: rbet
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- See Contributing Section
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-30 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: kevin@conceptsahead.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- lib/rbet/auth.rxml
+- lib/rbet/client.rb
+- lib/rbet/error.rb
+- lib/rbet/list.rb
+- lib/rbet/list_add.rxml
+- lib/rbet/list_list_all.rxml
+- lib/rbet/list_retrieve.rxml
+- lib/rbet/list_retrieve_subscribers.rxml
+- lib/rbet/list_send_email.rxml
+- lib/rbet/ping.rxml
+- lib/rbet/renderable.rb
+- lib/rbet/subscriber.rb
+- lib/rbet/subscriber_add.rxml
+- lib/rbet/subscriber_delete.rxml
+- lib/rbet/subscriber_retrieve.rxml
+- lib/rbet/subscriber_retrieve_by_id.rxml
+- lib/rbet/subscriber_update.rxml
+- lib/rbet/tracker.rb
+- lib/rbet/tracker_retrieve_summary.rxml
+- lib/rbet/triggered_send.rb
+- lib/rbet/triggered_send.rxml
+- lib/rbet/version.rb
+- lib/rbet.rb
+- test/client_test.rb
+- test/help.rb
+- test/list_test.rb
+- test/subscriber_test.rb
+- test/templates/diagnostics_ping_success.rxml
+- test/templates/list_add_failure.rxml
+- test/templates/list_add_success.rxml
+- test/templates/list_retrieve_all_success.rxml
+- test/templates/list_retrieve_bylistid_success.rxml
+- test/templates/subscriber_add_success.rxml
+- test/templates/subscriber_retrieve_failed.rxml
+- test/templates/subscriber_retrieve_success.rxml
+has_rdoc: true
+homepage: http://github.com/n3bulous/rbet
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A ruby wrapper for the Exact Target API
+test_files: []
+