mtodd-silverpop_mailer 0.0.1

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rake'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+require 'fileutils'
+include FileUtils
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ["--color"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+require 'rubygems/specification'
+spec_def = File.read('silverpop-mailer.gemspec')
+spec = nil
+Thread.new { spec = eval("$SAFE = 3\n#{spec_def}") }.join
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.need_zip = true
+  p.need_tar = true
+end
+
+desc "Package and Install halcyon"
+task :install do
+  name = "#{project[:name]}-#{project[:version]}.gem"
+  sh %{rake package}
+  sh %{sudo gem install pkg/#{name}}
+end
+
+desc "Uninstall the halcyon gem"
+task :uninstall => [:clean] do
+  sh %{sudo gem uninstall #{project[:name]}}
+end
+
+desc "Generate RDoc documentation"
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.options << '--line-numbers' << '--inline-source' <<
+    '--main' << 'README' <<
+    '--title' << 'Halcyon Documentation' <<
+    '--charset' << 'utf-8'
+  rdoc.rdoc_dir = "doc"
+  rdoc.rdoc_files.include 'README'
+  rdoc.rdoc_files.include('lib/halcyon.rb')
+  rdoc.rdoc_files.include('lib/halcyon/*.rb')
+  rdoc.rdoc_files.include('lib/halcyon/*/*.rb')
+end
+
+task :default => Rake::Task['spec']

data/init.rb

@@ -0,0 +1,3 @@
+# Integrate the SilverPop Mailer into ActionMailer
+require 'silverpop'
+ActionMailer::Base.send :include, Silverpop::ActionMailer

data/lib/silverpop/action_mailer.rb

@@ -0,0 +1,29 @@
+module Silverpop
+  
+  module ActionMailer
+    
+    def perform_delivery_silverpop(mail)
+      @mailer ||= Silverpop::Mailer.new(self.class.options)
+      response = @mailer.mail(self.class.options[:campaign_id], mail, self.class.options)
+      raise response.errors.first[:message] unless response.errors.empty?
+    end
+    
+    def self.included(target) # :nodoc:
+      target.extend ClassMethods
+    end
+    
+    module ClassMethods
+      
+      def set_silverpop_delivery_options(options = {})
+        cattr_accessor :options
+        self.options = options
+        
+        raise ArgumentError.new("Missing required option :server") unless self.options[:server]
+        raise ArgumentError.new("Missing required option :campaign_id") unless self.options[:campaign_id]
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/silverpop/mailer.rb

@@ -0,0 +1,33 @@
+module Silverpop
+  
+  class Mailer
+    
+    attr_accessor :config, :request, :response
+    
+    def initialize(options = {})
+      # config
+      self.config = options
+      
+      # logger
+      Silverpop.logger.level = self.config[:log_level] || Logger::ERROR
+      
+      # logging
+      Silverpop.logger.debug "Mailer init: #{self.config[:server]}"
+    end
+    
+    def mail(campaign_id, email, options = {})
+      self.request = Silverpop::Request.new(campaign_id, email, options)
+      self.response = Silverpop::Response.new(self.send(self.request.generate))
+    end
+    
+    # Submits the request.
+    # 
+    def send(request)
+      # TODO: implement into Silverpop::Transact
+      res = Net::HTTP.post_form(URI.parse(self.config[:server]), :xml => request)
+      res.body
+    end
+    
+  end
+  
+end

data/lib/silverpop/request.rb

@@ -0,0 +1,99 @@
+module Silverpop
+  
+  class Request
+    
+    attr_accessor :campaign_id, :email, :options
+    
+    def initialize(campaign_id, email, options = {})
+      self.campaign_id = campaign_id
+      self.email = email
+      self.options = options
+    end
+    
+    def generate
+      result = ""
+      builder = Builder::XmlMarkup.new(:target => result, :indent => 2)
+      builder.XTMAILING do |xml|
+        xml.CAMPAIGN_ID(self.campaign_id)
+        xml.TRANSACTION_ID(self.options[:transaction_id]) if self.options[:transaction_id]
+        self.email.to.each do |recipient|
+          xml.RECIPIENT do |rec|
+            rec.EMAIL(recipient)
+            rec.BODY_TYPE("HTML")
+            rec.PERSONALIZATION do |per|
+              per.TAG_NAME("HTML_BODY")
+              per.VALUE do |per_val|
+                per_val.cdata! self.email.body
+              end
+            end
+          end
+        end
+      end
+      Silverpop.logger.debug "*** REQUEST:\n#{result}\n"
+      result
+    end
+    
+  end
+  
+end
+
+# Sample Request
+# 
+# <?xml version="1.0"?>
+# <XTMAILING>
+#   <CAMPAIGN_ID>300401</CAMPAIGN_ID>
+#   <TRANSACTION_ID>trans-1234</TRANSACTION_ID>
+#   <SHOW_ALL_SEND_DETAIL>false</SHOW_ALL_SEND_DETAIL>
+#   <SEND_AS_BATCH>false</SEND_AS_BATCH>
+#   <NO_RETRY_ON_FAILURE>false</NO_RETRY_ON_FAILURE>
+#   <SAVE_COLUMNS>
+#     <COLUMN_NAME>NAME</COLUMN_NAME>
+#     <COLUMN_NAME>ADDRESS</COLUMN_NAME>
+#   </SAVE_COLUMNS>
+#   <RECIPIENT>
+#     <EMAIL>person@domain.com</EMAIL>
+#     <BODY_TYPE>HTML</BODY_TYPE>
+#     <PERSONALIZATION>
+#       <TAG_NAME>FLIGHT-NUMBER</TAG_NAME>
+#       <VALUE>Flight 807 </VALUE>
+#     </PERSONALIZATION>
+#     <PERSONALIZATION>
+#       <TAG_NAME>FLIGHT-INFORMATION</TAG_NAME>
+#       <VALUE><![CDATA[ 
+# <HTML><span style="color:#000000;”>No meals on this flight</span></HTML> 
+# ]]></VALUE>
+#     </PERSONALIZATION>
+#   </RECIPIENT>
+# </XTMAILING>
+
+# Another example, specificying TRANSACT_MAIL_BODY
+# 
+# <?xml version="1.0"?>
+# <XTMAILING>
+#   <CAMPAIGN_ID>numeric campaign id</CAMPAIGN_ID>
+#   <TRANSACTION_ID>TRANS-1234</TRANSACTION_ID>
+#   <SHOW_ALL_SEND_DETAIL>false</SHOW_ALL_SEND_DETAIL>
+#   <SEND_AS_BATCH>false</SEND_AS_BATCH>
+#   <NO_RETRY_ON_FAILURE>false</NO_RETRY_ON_FAILURE>
+#   <SAVE_COLUMNS>
+#     <COLUMN_NAME>ACCOUNT_ID</COLUMN_NAME>
+#   </SAVE_COLUMNS>
+#   <RECIPIENT>
+#     <EMAIL>person@domain.com</EMAIL>
+#     <BODY_TYPE>HTML</BODY_TYPE>
+#     <PERSONALIZATION>
+#       <TAG_NAME>ACCOUNT_ID</TAG_NAME>
+#       <VALUE>807</VALUE>
+#     </PERSONALIZATION>
+#     <PERSONALIZATION>
+#       <TAG_NAME>TRANSACT_MAIL_BODY</TAG_NAME>
+#       <VALUE><![CDATA[ 
+# <p>Here is a link, click it: <a 
+# href="http://recp.mkt32.net/ctt?m=%%MAILING_ID%%&r=%%RECIPIENT_ID%%&b=0&j=%%JOB_ID%%&k 
+# =The_Only_Link&kt=12&kd=http://www.spopdemo.com%3FAccountID%3D%25%25Account_ID%25%25"> 
+# link</a><p> 
+# ]]></VALUE>
+#     </PERSONALIZATION>
+#   </RECIPIENT>
+# </XTMAILING>
+

data/lib/silverpop/response.rb

@@ -0,0 +1,44 @@
+module Silverpop
+  
+  class Response
+    
+    attr_accessor :body, :status, :response, :errors
+    
+    def initialize(response)
+      self.parse(response)
+    end
+    
+    def parse(response)
+      Silverpop.logger.debug "*** RESPONSE:\n#{response}\n"
+      self.body = REXML::Document.new(response)
+      self.response = {
+        :status => self.body.root.elements['STATUS'][0].value,
+        :error_code => (self.body.root.elements['ERROR_CODE'][0].value rescue nil),
+        :error_string => (self.body.root.elements['ERROR_STRING'][0].value rescue nil)
+      }
+      self.status = self.response[:status].to_i
+      self.errors ||= []
+      self.errors << {:code => self.response[:error_code], :message => self.response[:error_string]}
+    end
+    
+    def inspect
+      "#<Silverpop::Response status:#{self.status} response=#{self.response.inspect}>"
+    end
+    
+  end
+  
+end
+
+# Sample Response Document
+# 
+# <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+# <XTMAILING_RESPONSE>
+#     <CAMPAIGN_ID>0</CAMPAIGN_ID>
+#     <TRANSACTION_ID>unknown</TRANSACTION_ID>
+#     <RECIPIENTS_RECEIVED>0</RECIPIENTS_RECEIVED>
+#     <EMAILS_SENT>0</EMAILS_SENT>
+#     <NUMBER_ERRORS>0</NUMBER_ERRORS>
+#     <STATUS>2</STATUS>
+#     <ERROR_CODE>5</ERROR_CODE>
+#     <ERROR_STRING>Access not allowed to application for this ip 208.52.141.138</ERROR_STRING>
+# </XTMAILING_RESPONSE>

data/lib/silverpop/transact.rb

@@ -0,0 +1,9 @@
+module Silverpop
+  
+  class Transact
+    
+    # ...
+    
+  end
+  
+end

data/lib/silverpop.rb

@@ -0,0 +1,28 @@
+%w(rubygems builder tmail rexml/document uri net/http net/https logger).each{|dep|require dep}
+
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__))))
+
+module Silverpop
+  
+  VERSION = [0,0,1]
+  
+  autoload :Mailer, "silverpop/mailer"
+  autoload :Transact, "silverpop/transact"
+  autoload :Request, "silverpop/request"
+  autoload :Response, "silverpop/response"
+
+  autoload :ActionMailer, "silverpop/action_mailer"
+  
+  class << self
+    
+    def logger
+      @logger ||= Logger.new(STDOUT)
+    end
+    
+    def version
+      VERSION.join('.')
+    end
+    
+  end
+  
+end

data/silverpop_mailer.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name     = "silverpop_mailer"
+  s.version  = "0.0.1"
+  s.date     = "2008-08-27"
+  s.summary  = "SilverPOP Mailer Gem/Plugin for ActionMailer"
+  s.email    = "mtodd@highgroove.com"
+  s.homepage = "http://github.com/mtodd/silverpop_mailer"
+  s.description = "A SilverPOP Mailer Gem/Plugin for sending emails with the ability to override ActionMailer"
+  s.has_rdoc = true
+  s.authors  = ["Matt Todd"]
+  s.files    = ["init.rb",
+    "README",
+		"Rakefile",
+		"silverpop_mailer.gemspec",
+		"lib/silverpop/action_mailer.rb",
+		"lib/silverpop/mailer.rb",
+		"lib/silverpop/request.rb",
+		"lib/silverpop/response.rb",
+		"lib/silverpop/transact.rb",
+		"lib/silverpop.rb"]
+  s.rdoc_options = ["--main", "README"]
+  s.add_dependency("action_mailer", [">= 2.0.0"])
+  s.add_dependency("builder", [">= 2.1.2"])
+  s.add_dependency("tmail", [">= 1.2.3.1"])
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: mtodd-silverpop_mailer
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Matt Todd
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-27 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: action_mailer
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: tmail
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3.1
+    version: 
+description: A SilverPOP Mailer Gem/Plugin for sending emails with the ability to override ActionMailer
+email: mtodd@highgroove.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- init.rb
+- README
+- Rakefile
+- silverpop_mailer.gemspec
+- lib/silverpop/action_mailer.rb
+- lib/silverpop/mailer.rb
+- lib/silverpop/request.rb
+- lib/silverpop/response.rb
+- lib/silverpop/transact.rb
+- lib/silverpop.rb
+has_rdoc: true
+homepage: http://github.com/mtodd/silverpop_mailer
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+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.2.0
+signing_key: 
+specification_version: 2
+summary: SilverPOP Mailer Gem/Plugin for ActionMailer
+test_files: []
+