RubyGems - exactish_target - Versions diffs - 0.2.2 - Mend

exactish_target 0.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (18) hide show

data/.rvmrc +1 -0
data/Gemfile +13 -0
data/Gemfile.lock +29 -0
data/LICENSE.txt +20 -0
data/README.md +29 -0
data/Rakefile +41 -0
data/VERSION +1 -0
data/exactish_target.gemspec +78 -0
data/lib/exactish_target.rb +83 -0
data/rdoc/ExactishTarget.html +450 -0
data/rdoc/created.rid +3 -0
data/rdoc/index.html +61 -0
data/rdoc/lib/exactish_target_rb.html +58 -0
data/rdoc/rdoc.css +706 -0
data/spec/exact_target_spec.rb +85 -0
data/spec/spec_helper.rb +8 -0
data/spec/support/fake_exactish_target/app.rb +128 -0
metadata +195 -0

data/spec/exact_target_spec.rb ADDED

@@ -0,0 +1,85 @@
+require 'spec_helper'
+require 'sham_rack'
+require 'fake_exactish_target/app'
+require 'exactish_target'
+describe ExactishTarget do
+  def fake_exactish_target
+    @fake_exactish_target ||= FakeExactishTarget::App.new
+  end
+  before do
+    ShamRack.mount(fake_exactish_target, "exact-target.com")
+  end
+  describe "#create_subscriber" do
+    it "should not raise an error if the subscription request was successful" do
+      fake_exactish_target.mode = :happy
+      lambda {
+        ExactishTarget.new("username", "password", "http://exact-target.com/Service.asmx").create_subscriber("email", "country", "source")
+      }.should_not raise_error
+    end
+    it "should raise an error if the subscription request failed" do
+      fake_exactish_target.mode = :sad
+      lambda {
+        ExactishTarget.new("username", "password", "http://exact-target.com/Service.asmx").create_subscriber("email", "country", "source")
+      }.should raise_error(StandardError, /^Subscription request for email: "email", country: "country", source: "source" failed. Newsletter subscription has not been created.\s+Exception: #<StandardError: Exact Target Error/)
+    end
+    it "should raise an error if an invalid response is received from ET" do
+      fake_exactish_target.mode = :invalid
+      lambda {
+        ExactishTarget.new("username", "password", "http://exact-target.com/Service.asmx").create_subscriber("email", "country", "source")
+      }.should raise_error(StandardError, /^Subscription request for email: "email", country: "country", source: "source" failed. Newsletter subscription has not been created.\s+Exception: #<StandardError: Invalid response from Exact Target/)
+    end
+  end
+  describe "#create_subscriber_request_xml" do
+    before do
+      @client = ExactishTarget.new("the username", "the password", "http://exact-target.com/Service.asmx")
+      @xml = @client.create_subscriber_request_xml("email@gmail.com", "a country", "the source")
+    end
+    it "should include the ET credentials" do
+      @xml.should include("<n1:UsernameToken><n1:Username>the username</n1:Username><n1:Password>the password</n1:Password></n1:UsernameToken>")
+    end
+    it "should include the subscriber's email address" do
+      @xml.should include("<n2:EmailAddress>email@gmail.com</n2:EmailAddress>")
+    end
+    it "should use the subscriber's email address as the customer key" do
+      @xml.should include("<n2:CustomerKey>email@gmail.com</n2:CustomerKey>")
+    end
+    it "should include the subscriber's country" do
+      @xml.should include("<n2:Attributes><n2:Name>Country</n2:Name><n2:Value>a country</n2:Value></n2:Attributes>")
+    end
+    it "should include the source of the subscription" do
+      @xml.should include("<n2:Attributes><n2:Name>Source</n2:Name><n2:Value>the source</n2:Value></n2:Attributes>")
+    end
+    it "should include the Lonely Planet Newsletters flag set to true" do
+      @xml.should include("<n2:Attributes><n2:Name>Lonely Planet Newsletters</n2:Name><n2:Value>true</n2:Value></n2:Attributes>")
+    end
+    it "should include the Lonely Planet Marketing flag set to true" do
+      @xml.should include("<n2:Attributes><n2:Name>Lonely Planet Marketing</n2:Name><n2:Value>true</n2:Value></n2:Attributes>")
+    end
+    it "should xml-escape field values" do
+      xml = @client.create_subscriber_request_xml("<email@gmail.com>", "a country & something", "the sour&ce")
+      xml.should include("&lt;email@gmail.com&gt;")
+      xml.should include("a country &amp; something")
+      xml.should include("sour&amp;ce")
+    end
+  end
+end

data/spec/spec_helper.rb ADDED

@@ -0,0 +1,8 @@
+require 'rr'
+require 'pp'
+$LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), "support"))
+Spec::Runner.configure do |config|
+  config.mock_with :rr
+end

data/spec/support/fake_exactish_target/app.rb ADDED

@@ -0,0 +1,128 @@
+require 'rubygems'
+require 'sinatra/base'
+require 'builder'
+module FakeExactishTarget
+  class App < Sinatra::Base
+    attr_accessor :mode
+    def initialize
+      @mode = :happy
+    end
+    post '/Service.asmx' do
+      send("#{mode}_response")
+    end
+    def happy_response
+      <<-XML.strip
+      <?xml version="1.0" encoding="utf-8"?>
+      <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
+        <soap:Header>
+          <wsa:Action>CreateResponse</wsa:Action>
+          <wsa:MessageID>urn:uuid:d97e2a9a-48a7-4f38-b2c5-7c30c0abf37c</wsa:MessageID>
+          <wsa:RelatesTo>urn:uuid:259526f3-cfea-4628-8bce-f49714556f45</wsa:RelatesTo>
+          <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>
+          <wsse:Security>
+            <wsu:Timestamp wsu:Id="Timestamp-507733bc-b23a-454d-837b-c173836d26e9">
+              <wsu:Created>2011-02-22T00:32:45Z</wsu:Created>
+              <wsu:Expires>2011-02-22T00:37:45Z</wsu:Expires>
+            </wsu:Timestamp>
+          </wsse:Security>
+        </soap:Header>
+        <soap:Body>
+          <CreateResponse xmlns="http://exacttarget.com/wsdl/partnerAPI">
+            <Results>
+              <StatusCode>OK</StatusCode>
+              <StatusMessage>Created Subscriber.</StatusMessage>
+              <OrdinalID>0</OrdinalID>
+              <NewID>921310</NewID>
+              <Object xsi:type="Subscriber">
+                <PartnerKey xsi:nil="true"/>
+                <ID>921310</ID>
+                <ObjectID xsi:nil="true"/>
+                <CustomerKey>api-test-13@bh.exacttarget.com</CustomerKey>
+                <EmailAddress>api-test-13@bh.exacttarget.com</EmailAddress>
+                <Attributes>
+                  <Name>Country</Name>
+                  <Value>Australia</Value>
+                </Attributes>
+                <Attributes>
+                  <Name>Source</Name>
+                  <Value>Over the rainbow</Value>
+                </Attributes>
+              </Object>
+            </Results>
+            <RequestID>dd6710a8-5d74-48fb-a8db-c10622860a68</RequestID>
+            <OverallStatus>OK</OverallStatus>
+          </CreateResponse>
+        </soap:Body>
+      </soap:Envelope>
+      XML
+    end
+    def sad_response
+      <<-XML.strip
+      <?xml version="1.0" encoding="utf-8"?>
+      <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
+        <soap:Header>
+          <wsa:Action>CreateResponse</wsa:Action>
+          <wsa:MessageID>urn:uuid:5ebdc5c1-dc28-499e-85d6-76a45eb33fc5</wsa:MessageID>
+          <wsa:RelatesTo>urn:uuid:59f069b9-293a-41cd-a836-fd46a6f95343</wsa:RelatesTo>
+          <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>
+          <wsse:Security>
+            <wsu:Timestamp wsu:Id="Timestamp-d0da59eb-829d-46d9-a45c-bd5e062be276">
+              <wsu:Created>2011-02-22T00:37:18Z</wsu:Created>
+              <wsu:Expires>2011-02-22T00:42:18Z</wsu:Expires>
+            </wsu:Timestamp>
+          </wsse:Security>
+        </soap:Header>
+        <soap:Body>
+          <CreateResponse xmlns="http://exacttarget.com/wsdl/partnerAPI">
+            <Results>
+              <StatusCode>Error</StatusCode>
+              <StatusMessage>The subscriber is already on the list</StatusMessage>
+              <OrdinalID>0</OrdinalID>
+              <ErrorCode>12014</ErrorCode>
+              <NewID>0</NewID>
+              <Object xsi:type="Subscriber">
+                <PartnerKey xsi:nil="true"/>
+                <ObjectID xsi:nil="true"/>
+                <CustomerKey>api-test-13@bh.exacttarget.com</CustomerKey>
+                <EmailAddress>api-test-13@bh.exacttarget.com</EmailAddress>
+                <Attributes>
+                  <Name>Country</Name>
+                  <Value>Australia</Value>
+                </Attributes>
+                <Attributes>
+                  <Name>Source</Name>
+                  <Value>Over the rainbow</Value>
+                </Attributes>
+              </Object>
+            </Results>
+            <RequestID>beb6f073-5a3a-4a09-a167-7410e2957b14</RequestID>
+            <OverallStatus>Error</OverallStatus>
+          </CreateResponse>
+        </soap:Body>
+      </soap:Envelope>
+      XML
+    end
+    def invalid_response
+      <<-XML.strip
+      <?xml version="1.0" encoding="utf-8"?>
+      <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+        xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"
+        xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
+        xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
+      </soap:Envelope>
+      XML
+    end
+  end
+end

metadata ADDED

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: exactish_target
+version: !ruby/object:Gem::Version
+  hash: 19
+  prerelease:
+  segments:
+  - 0
+  - 2
+  - 2
+  version: 0.2.2
+platform: ruby
+authors:
+- Lonely Planet
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2011-07-12 00:00:00 +10:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  name: builder
+  prerelease: false
+  version_requirements: &id001 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - "="
+      - !ruby/object:Gem::Version
+        hash: 7
+        segments:
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  requirement: *id001
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: shoulda
+  prerelease: false
+  version_requirements: &id002 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 3
+        segments:
+        - 0
+        version: "0"
+  requirement: *id002
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: rspec
+  prerelease: false
+  version_requirements: &id003 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 27
+        segments:
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  requirement: *id003
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: rr
+  prerelease: false
+  version_requirements: &id004 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 33
+        segments:
+        - 0
+        - 10
+        - 11
+        version: 0.10.11
+  requirement: *id004
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: sham_rack
+  prerelease: false
+  version_requirements: &id005 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 27
+        segments:
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  requirement: *id005
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: sinatra
+  prerelease: false
+  version_requirements: &id006 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 51
+        segments:
+        - 0
+        - 9
+        - 4
+        version: 0.9.4
+  requirement: *id006
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: jeweler
+  prerelease: false
+  version_requirements: &id007 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 7
+        segments:
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  requirement: *id007
+description: Very simple Exact Target SOAP client. Only supports subscriber creation at this point
+email: daniel.vydra@lonelyplanet.com.au
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- exactish_target.gemspec
+- lib/exactish_target.rb
+- rdoc/ExactishTarget.html
+- rdoc/created.rid
+- rdoc/index.html
+- rdoc/lib/exactish_target_rb.html
+- rdoc/rdoc.css
+- spec/exact_target_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_exactish_target/app.rb
+has_rdoc: true
+homepage: https://github.com/lonelyplanet/exactish_target
+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:
+rubygems_version: 1.4.2
+signing_key:
+specification_version: 3
+summary: Exact Target client
+test_files:
+- spec/exact_target_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_exactish_target/app.rb