responsys-client 0.0.2

data/responsys-client.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = 'responsys-client'
+  s.version = '0.0.2'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'Ruby SOAP Client For Responsys API'
+  s.description = 'Ruby SOAP Client For Responsys API'
+
+  s.authors = ['Christopher Sun', 'Leo Romanovsky']
+  s.email = 'leoromanovsky@gmail.com'
+  s.homepage = 'http://github.com/leoromanovsky/responsys-client'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.require_paths = ['lib']
+
+  s.add_dependency('mumboe-soap4r', '~> 1.5.8.5')
+  s.add_dependency('fastercsv', '~> 1.5.4')
+  s.add_dependency('mocha', '~> 0.9.12')
+end

data/test/config.yml.sample

@@ -0,0 +1,4 @@
+# Enter your username and password for testing from Responsys
+# Rename this file to config.yml to run tests
+username: "USERNAME"
+password: "PASSWORD"

data/test/feedback.csv

@@ -0,0 +1,4 @@
+REASON,CUSTOMER_ID_,EMAIL_ADDRESS_,EMAIL_PERMISSION_STATUS_,USER_TYPE,LAST_NAME,HOW_HEARD,ACCOUNT_CREATION_DATE,AFFILIATE,FIRST_NAME,GENDER,DATE_OF_BIRTH,COUNTRY_,POSTAL_CODE_,BUSINESS_TYPE
+INVALID FORMAT FOR EMAIL ADDRESS,253,hahahaha%40gmail.com+a618bb@animoto.com,OPTIN,,Korhonen,,2009-01-27,N,Christopher,M,1982-04-05,United States,10005,
+INVALID FORMAT FOR EMAIL ADDRESS,324,ewrewrewrwer@s.cdsdf,OPTIN,,sdfsd,,2009-02-12,N,dsfs,M,1983-11-05,United States,sdfsdf,
+INVALID FORMAT FOR EMAIL ADDRESS,878,chris.sun%40animoto.com+d169ae@animoto.com,OPTOUT,business,Sun,Magazine,2009-10-15,Y,Christopher,M,1975-06-06,United States,10069,other

data/test/import.txt

@@ -0,0 +1,4 @@
+"EVENT_TYPE_ID","ACCOUNT_ID","LIST_ID","RIID","CUSTOMER_ID","EVENT_CAPTURED_DT","EVENT_STORED_DT","CAMPAIGN_ID","LAUNCH_ID","EMAIL_FORMAT","SOURCE","REASON","EMAIL","CONTACT_INFO"
+"7","50209","1012","1407280","855006","15-Jul-2011 04:42:32","15-Jul-2011 04:42:47","1345","1387","M","Unsubscribe Page/Link","Unsubscribe Page","leigh.walters@united.com","leigh.walters@united.com"
+"7","50209","1012","1438565","886389","15-Jul-2011 04:45:47","15-Jul-2011 04:46:02","1345","1387","M","Unsubscribe Page/Link","Unsubscribe Page","gcandido@cox.net","gcandido@cox.net"
+"7","50209","1012","4477551","3052672","15-Jul-2011 06:02:15","15-Jul-2011 06:02:30","0","","N","Exchange - Webservice","WS:MERGE","deleteduser@delete.animoto.com","deleteduser@delete.animoto.com"

data/test/member_test.rb

@@ -0,0 +1,145 @@
+require 'test_helper'
+require 'member'
+
+class MemberTest < Test::Unit::TestCase 
+  
+  def setup
+     SunDawg::Responsys::Member.clear_fields!
+  end
+
+  def test_parse_feedback_csv
+    SunDawg::Responsys::Member.add_field :customer_id, true
+    SunDawg::Responsys::Member.add_field :email_address, true
+    results = SunDawg::Responsys::Member.parse_feedback_csv("#{File.dirname(__FILE__)}/feedback.csv")
+    assert_equal 3, results.size
+    results.values.each do |reason|
+      assert_equal "INVALID FORMAT FOR EMAIL ADDRESS", reason
+    end
+    results.keys.each do |member|
+      assert member.instance_of?(SunDawg::Responsys::Member)
+      assert member.customer_id
+      assert member.email_address
+    end
+  end
+
+  def test_parse_import_file
+    SunDawg::Responsys::Member.add_field :customer_id, true
+    SunDawg::Responsys::Member.add_field :email, true
+    results = SunDawg::Responsys::Member.import_file("#{File.dirname(__FILE__)}/import.txt")
+    assert_equal 3, results.size
+    results.each do |member|
+      assert member.instance_of?(SunDawg::Responsys::Member)
+    end
+    [["855006", "leigh.walters@united.com"],
+     ["886389", "gcandido@cox.net"],
+     ["3052672", "deleteduser@delete.animoto.com"]].each do |expected|
+      actual = results.shift
+      assert_equal expected[0], actual.customer_id
+      assert_equal expected[1], actual.email
+    end
+  end
+
+  def test_attribute_methods
+    SunDawg::Responsys::Member.add_field :foo
+    member = SunDawg::Responsys::Member.new
+    member.foo = "bar"
+    assert_equal "bar", member.foo
+    assert_equal "bar", member.FOO
+  end
+
+  def test_fields
+    SunDawg::Responsys::Member.add_field :foo
+    SunDawg::Responsys::Member.add_field :bar
+    SunDawg::Responsys::Member.add_field :hello, true
+    # Fields should be unique and defined the first time
+    SunDawg::Responsys::Member.add_field :bar
+    SunDawg::Responsys::Member.add_field :hello
+    assert_equal [:foo, :bar, :hello], SunDawg::Responsys::Member.fields
+    assert_equal ["FOO", "BAR", "HELLO_"], SunDawg::Responsys::Member.responsys_fields
+  end
+
+  def test_has_field
+    SunDawg::Responsys::Member.add_field :foo
+    SunDawg::Responsys::Member.add_field :bar, true
+    assert SunDawg::Responsys::Member.has_field?(:foo)
+    assert SunDawg::Responsys::Member.has_field?(:bar)
+    assert !SunDawg::Responsys::Member.has_system_field?(:foo)
+    assert SunDawg::Responsys::Member.has_system_field?(:bar)
+  end
+
+  def test_responsys_fields
+    SunDawg::Responsys::Member.add_field :foo
+    SunDawg::Responsys::Member.add_field :bar
+    assert_equal ["FOO", "BAR"], SunDawg::Responsys::Member.responsys_fields
+  end
+
+  def test_from_responsys_field
+    assert_equal "foo", SunDawg::Responsys::Member.send(:from_responsys_field, "FOO")
+    assert_equal "foo_bar", SunDawg::Responsys::Member.send(:from_responsys_field, "FOO_BAR")
+    SunDawg::Responsys::Member.add_field :tweet, true
+    assert_equal "tweet", SunDawg::Responsys::Member.send(:from_responsys_field, "TWEET_")
+  end
+
+  def test_responsys_system_fields
+    SunDawg::Responsys::Member.add_field :foo, true
+    SunDawg::Responsys::Member.add_field :bar, true
+    SunDawg::Responsys::Member.add_field :woot
+    assert_equal ["FOO_", "BAR_", "WOOT"], SunDawg::Responsys::Member.responsys_fields
+    member = SunDawg::Responsys::Member.new
+    member.foo = "value_1"
+    member.bar = "value_2"
+    member.woot = 123 
+    assert_equal ["value_1", "value_2", 123], member.values
+  end
+
+  def test_values
+    SunDawg::Responsys::Member.add_field :foo
+    SunDawg::Responsys::Member.add_field :bar
+    SunDawg::Responsys::Member.add_field :nernt
+    member = SunDawg::Responsys::Member.new
+    member.foo = "value_1"
+    member.bar = "value_2"
+    member.nernt = 123 
+    assert_equal ["value_1", "value_2", 123], member.values
+  end
+
+  def test_attributes
+    SunDawg::Responsys::Member.add_field :foo
+    SunDawg::Responsys::Member.add_field :bar
+    member = SunDawg::Responsys::Member.new
+    member.attributes = {:foo => "value_1", :bar => "value_2"}
+    assert_equal "value_1", member.foo
+    assert_equal "value_2", member.bar
+  end
+
+  def test_to_csv_splitted_files
+    SunDawg::Responsys::Member.add_field :customer_id
+    SunDawg::Responsys::Member.add_field :foo
+    SunDawg::Responsys::Member.add_field :bar
+    SunDawg::Responsys::Member.extension_fields = {:file_a => [:foo], :file_b => [:bar]}
+    member = SunDawg::Responsys::Member.new
+    member.attributes = {:foo => "value_1", :bar => "value_2", :customer_id => 123}
+    SunDawg::Responsys::Member.expects(:build_csv_file).times(3)
+    SunDawg::Responsys::Member.to_csv_extension_files([member], "/tmp", :headers => true, :access => "w")
+  end
+
+  def test_member_fields
+    SunDawg::Responsys::Member.add_field :customer_id
+    SunDawg::Responsys::Member.add_field :foo
+    SunDawg::Responsys::Member.add_field :bar
+    SunDawg::Responsys::Member.add_field :chooch
+    SunDawg::Responsys::Member.add_field :nooch
+    SunDawg::Responsys::Member.extension_fields = {:file_a => [:foo], :file_b => [:bar]}
+    assert_equal [:customer_id, :chooch, :nooch], SunDawg::Responsys::Member.member_fields
+  end
+
+  def test_profile_fields
+    SunDawg::Responsys::Member.extension_fields = {
+      :file_a => [:foo],
+      :file_b => [:bar]
+    }
+    [:file_a, :file_b].each do |i|
+      SunDawg::Responsys::Member.extension_fields.keys.include?(i)
+    end
+  end
+end

data/test/responsys_client_integration_test.rb

@@ -0,0 +1,166 @@
+require 'test_helper'
+require 'responsys_client'
+
+class ResponsysClientIntegrationTest < Test::Unit::TestCase 
+  FOLDER_NAME = "Test_Gem"
+  CAMPAIGN_NAME = "GemCampaignEmail"
+  CAMPAIGN_TRANSACTION_NAME = "GemTransactionalEmail"
+  LIST_NAME = "GemList"
+  EMAIL = "gem.test@responsys.client.gem.com"
+
+  def setup
+    config = YAML.load_file("test/config.yml")
+    @username = config["username"]
+    @password = config["password"]
+    @client = SunDawg::ResponsysClient.new(@username, @password) #, :wiredump_dev => STDOUT)
+    SunDawg::Responsys::Member.clear_fields!
+  end
+
+  class << self
+    def with_integration
+      return unless INTEGRATION
+      yield
+    end
+  end
+
+  def test_client
+    assert @client
+  end
+
+  with_integration do
+    def test_invalid_login
+      error = assert_raise AccountFault do
+        SunDawg::ResponsysClient.new("foo", "bar").login
+      end
+      assert_equal ExceptionCode::INVALID_USER_NAME, error.exception_code
+    end
+
+    def test_login
+      assert_nothing_raised do
+        @client.login
+        assert @client.session_id
+      end
+    end
+
+    def test_list_folders
+      results = @client.list_folders
+      assert results.size
+      results.each do |result|
+        assert result.name
+      end
+    end
+
+    def test_create_folder
+      folder_name = "test_folder_#{Time.now.to_i}"
+      @client.keep_alive = true
+      response = @client.create_folder folder_name
+      assert response.result
+      results = @client.list_folders
+      assert results.map { |i| i.name }.include? folder_name
+    end
+
+    def test_save_members
+      SunDawg::Responsys::Member.add_field :customer_id, true
+      SunDawg::Responsys::Member.add_field :email_address, true
+      SunDawg::Responsys::Member.add_field :email_permission_status, true
+      SunDawg::Responsys::Member.add_field :city, true
+      SunDawg::Responsys::Member.add_field :state, true
+      member = SunDawg::Responsys::Member.new
+      member.customer_id = Time.now.to_i 
+      member.email_address = "sundawg.#{Time.now.to_i}@sundawg.net"
+      member.email_permission_status = "I"
+      member.city = "San Francisco"
+      member.state = "CA"
+      response = @client.save_members FOLDER_NAME, LIST_NAME, [member] 
+      assert response.result
+    end
+
+    def test_save_members_with_attributes
+      SunDawg::Responsys::Member.add_field :customer_id, true
+      SunDawg::Responsys::Member.add_field :email_address, true
+      SunDawg::Responsys::Member.add_field :email_permission_status, true
+      SunDawg::Responsys::Member.add_field :city, true
+      SunDawg::Responsys::Member.add_field :state, true
+      member = SunDawg::Responsys::Member.new
+      member.customer_id = Time.now.to_i 
+      member.email_address = "lol.cats.sundawg.#{Time.now.to_i}@sundawg.net"
+      member.email_permission_status = PermissionStatus::OPTIN
+      member.city = "San Francisco"
+      member.state = "CA"
+      member.expects(:state).never
+      response = @client.save_members FOLDER_NAME, LIST_NAME, [member], [:customer_id, :email_address, :city]
+      assert response.result
+    end
+
+
+    def test_keep_session
+      SunDawg::Responsys::Member.add_field :customer_id, true
+      SunDawg::Responsys::Member.add_field :email_address, true
+      SunDawg::Responsys::Member.add_field :email_permission_status, true
+      SunDawg::Responsys::Member.add_field :city, true
+      SunDawg::Responsys::Member.add_field :state, true
+
+      member = SunDawg::Responsys::Member.new
+      member.customer_id = Time.now.to_i 
+      member.email_address = "sundawg-montgomery@sundawg.net"
+      member.email_permission_status = PermissionStatus::OPTIN
+      member.city = "Montgomery"
+      member.state = "AL"
+
+      # When the keep_alive option has not been set (default) then the client 
+      # must reconnect for every request or a FaultError will be raised on 
+      # multiple requests
+      response = @client.save_members FOLDER_NAME, LIST_NAME, [member] 
+      assert response.result
+      error = assert_raise SOAP::FaultError do
+        @client.save_members FOLDER_NAME, LIST_NAME, [member] 
+      end
+
+      # When the keep_alive option has been set then the client does not need
+      # to reconnect for every request
+      @client = SunDawg::ResponsysClient.new(@username, @password, :keep_alive => true)
+      response = @client.save_members FOLDER_NAME, LIST_NAME, [member] 
+      assert response.result
+      response = @client.save_members FOLDER_NAME, LIST_NAME, [member] 
+      assert response.result
+
+      # When the keep_alive option has not been set (default) then the client 
+      # does not need to reconnect for every request if keep_alive is set
+      @client = SunDawg::ResponsysClient.new(@username, @password)
+      @client.keep_alive = true
+      response = @client.save_members FOLDER_NAME, LIST_NAME, [member] 
+      assert response.result
+      response = @client.save_members FOLDER_NAME, LIST_NAME, [member] 
+      assert response.result
+    end
+
+    def test_launch_campaign
+      begin
+        response = @client.launch_campaign FOLDER_NAME, CAMPAIGN_NAME
+        assert response.result 
+      rescue CampaignFault => e
+        # Responsys does not allow campaigns to be launched less than 15 minute attempts
+        assert_equal "Launch attempt failed: A campaign cannot be launched more than once per 15 minutes.", e.exception_message
+      end
+    end
+
+    def test_trigger_campaign_with_optional_data
+      response = @client.trigger_campaign(
+        FOLDER_NAME, 
+        CAMPAIGN_TRANSACTION_NAME, 
+        EMAIL,
+        {:name => "Fred"}
+      )
+      assert response.first.success
+    end
+
+    def test_trigger_campaign_without_optional_data
+      response = @client.trigger_campaign(
+        FOLDER_NAME,
+        CAMPAIGN_TRANSACTION_NAME,
+        EMAIL
+      )
+      assert response.first.success
+    end
+  end
+end

data/test/responsys_client_test.rb

@@ -0,0 +1,46 @@
+require 'test_helper'
+require 'responsys_client'
+
+class ResponsysClientTest < Test::Unit::TestCase 
+  def setup
+     SunDawg::Responsys::Member.clear_fields!
+  end
+
+  def test_instantiation
+    assert SunDawg::ResponsysClient.new("foo", "bar")
+  end
+
+  def test_instantiation_with_options
+    assert SunDawg::ResponsysClient.new("foo", "bar", :wiredump_dev => STDOUT)
+  end
+
+  def test_save_members_throws_too_many_members_error 
+    SunDawg::Responsys::Member.add_field :customer_id
+    SunDawg::Responsys::Member.add_field :email_address
+    SunDawg::Responsys::Member.add_field :email_permission_status
+    members = []
+    (SunDawg::ResponsysClient::MAX_MEMBERS + 1).times do 
+      members << SunDawg::Responsys::Member.new 
+    end
+    assert_raises SunDawg::ResponsysClient::TooManyMembersError do
+      SunDawg::ResponsysClient.new("foo", "bar").save_members("folder", "list", members)
+    end
+  end
+
+  def test_save_members_throws_methods_not_supported_error_with_no_email_address
+    SunDawg::Responsys::Member.add_field :email_address
+    member = SunDawg::Responsys::Member.new
+    assert_raises SunDawg::ResponsysClient::MethodsNotSupportedError do
+      SunDawg::ResponsysClient.new("foo", "bar").save_members("folder", "list", [member])
+    end
+  end
+
+  def test_save_members_throws_methods_not_supported_error_with_no_email_permission_status
+    SunDawg::Responsys::Member.add_field :email_permission_status
+    member = SunDawg::Responsys::Member.new
+    assert_raises SunDawg::ResponsysClient::MethodsNotSupportedError do
+      SunDawg::ResponsysClient.new("foo", "bar").save_members("folder", "list", [member])
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'test/unit'
+require 'rubygems'
+require 'mocha'
+
+INTEGRATION = false unless defined?(INTEGRATION)

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: responsys-client
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Christopher Sun
+- Leo Romanovsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mumboe-soap4r
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.8.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.8.5
+- !ruby/object:Gem::Dependency
+  name: fastercsv
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.4
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+description: Ruby SOAP Client For Responsys API
+email: leoromanovsky@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- README.rdoc
+- Rakefile
+- lib/member.rb
+- lib/responsys_client.rb
+- lib/stub/ResponsysWSServiceClient.rb
+- lib/stub/default.rb
+- lib/stub/defaultDriver.rb
+- lib/stub/defaultMappingRegistry.rb
+- lib/wsdl/wsdl_4_11_2011.wsdl
+- responsys-client.gemspec
+- test/config.yml.sample
+- test/feedback.csv
+- test/import.txt
+- test/member_test.rb
+- test/responsys_client_integration_test.rb
+- test/responsys_client_test.rb
+- test/test_helper.rb
+homepage: http://github.com/leoromanovsky/responsys-client
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby SOAP Client For Responsys API
+test_files:
+- test/config.yml.sample
+- test/feedback.csv
+- test/import.txt
+- test/member_test.rb
+- test/responsys_client_integration_test.rb
+- test/responsys_client_test.rb
+- test/test_helper.rb
+has_rdoc: