fuelsdk 0.0.3 → 0.0.4

data/samples/sample-openevent.rb

@@ -2,14 +2,14 @@ require 'fuelsdk'
 require_relative 'sample_helper'
 
 begin
-	stubObj = FuelSDK::ET_Client.new auth
+	stubObj = FuelSDK::Client.new auth
 
 	## Modify the date below to reduce the number of results returned from the request
 	## Setting this too far in the past could result in a very large response size
 	retrieveDate = '2013-01-15T13:00:00.000'
 
 	p '>>> Retrieve Filtered OpenEvents with GetMoreResults'
-	getOpenEvent = FuelSDK::ET_OpenEvent.new()
+	getOpenEvent = FuelSDK::OpenEvent.new()
 	getOpenEvent.authStub = stubObj
 	getOpenEvent.props = ["SendID","SubscriberKey","EventDate","Client.ID","EventType","BatchID","TriggeredSendDefinitionObjectID","PartnerKey"]
 	getOpenEvent.filter = {'Property' => 'EventDate','SimpleOperator' => 'greaterThan','DateValue' => retrieveDate}
@@ -38,7 +38,7 @@ begin
 	#  The following request could potentially bring back large amounts of data if run against a production account
 =begin
 	p '>>> Retrieve All OpenEvents with GetMoreResults'
-	getOpenEvent = FuelSDK::ET_OpenEvent.new()
+	getOpenEvent = FuelSDK::OpenEvent.new()
 	getOpenEvent.authStub = stubObj
 	getOpenEvent.props = ["SendID","SubscriberKey","EventDate","Client.ID","EventType","BatchID","TriggeredSendDefinitionObjectID","PartnerKey"]
 	getResponse = getOpenEvent.get

data/samples/sample-sentevent.rb

@@ -2,14 +2,14 @@ require 'fuelsdk'
 require_relative 'sample_helper'
 
 begin
-	stubObj = FuelSDK::ET_Client.new auth
+	stubObj = FuelSDK::Client.new auth
 
 	## Modify the date below to reduce the number of results returned from the request
 	## Setting this too far in the past could result in a very large response size
 	retrieveDate = '2013-01-15T13:00:00.000'
 
 	p '>>> Retrieve Filtered SentEvents with GetMoreResults'
-	getSentEvent = FuelSDK::ET_SentEvent.new()
+	getSentEvent = FuelSDK::SentEvent.new()
 	getSentEvent.authStub = stubObj
 	getSentEvent.props = ["SendID","SubscriberKey","EventDate","Client.ID","EventType","BatchID","TriggeredSendDefinitionObjectID","ListID","PartnerKey","SubscriberID"]
 	getSentEvent.filter = {'Property' => 'EventDate','SimpleOperator' => 'greaterThan','DateValue' => retrieveDate}
@@ -38,7 +38,7 @@ begin
 	#  The following request could potentially bring back large amounts of data if run against a production account
 =begin
 	p '>>> Retrieve All SentEvents with GetMoreResults'
-	getSentEvent = FuelSDK::ET_SentEvent.new()
+	getSentEvent = FuelSDK::SentEvent.new()
 	getSentEvent.authStub = stubObj
 	getSentEvent.props = ["SendID","SubscriberKey","EventDate","Client.ID","EventType","BatchID","TriggeredSendDefinitionObjectID","ListID","PartnerKey","SubscriberID"]
 	getResponse = getSentEvent.get

data/samples/sample-subscriber.rb

@@ -2,7 +2,7 @@ require 'fuelsdk'
 require_relative 'sample_helper' # contains auth with credentials
 
 begin
-  stubObj = FuelSDK::ET_Client.new auth
+  stubObj = FuelSDK::Client.new auth
 
   # NOTE: These examples only work in accounts where the SubscriberKey functionality is not enabled
   #       SubscriberKey will need to be included in the props if that feature is enabled
@@ -11,7 +11,7 @@ begin
 
   # Create Subscriber
   p '>>> Create Subscriber'
-  postSub = FuelSDK::ET_Subscriber.new
+  postSub = FuelSDK::Subscriber.new
   postSub.authStub = stubObj
   postSub.props = {"EmailAddress" => SubscriberTestEmail}
   p '>>> Posting'
@@ -26,7 +26,7 @@ begin
 
   # Retrieve newly created Subscriber
   p '>>> Retrieve newly created Subscriber'
-  getSub = FuelSDK::ET_Subscriber.new()
+  getSub = FuelSDK::Subscriber.new()
   getSub.authStub = stubObj
   getSub.props = ["SubscriberKey", "EmailAddress", "Status"]
   getSub.filter = {'Property' => 'SubscriberKey', 'SimpleOperator' => 'equals', 'Value' => SubscriberTestEmail}
@@ -42,7 +42,7 @@ begin
 
   # Update Subscriber
   p '>>> Update Subscriber'
-  patchSub = FuelSDK::ET_Subscriber.new
+  patchSub = FuelSDK::Subscriber.new
   patchSub.authStub = stubObj
   patchSub.props = {"EmailAddress" => SubscriberTestEmail, "Status" => "Unsubscribed"}
   patchResponse = patchSub.patch
@@ -56,7 +56,7 @@ begin
 
   # Retrieve Subscriber that should have status unsubscribed now
   p '>>> Retrieve Subscriber that should have status unsubscribed now'
-  getSub = FuelSDK::ET_Subscriber.new()
+  getSub = FuelSDK::Subscriber.new()
   getSub.authStub = stubObj
   getSub.props = ["SubscriberKey", "EmailAddress", "Status"]
   getSub.filter = {'Property' => 'SubscriberKey','SimpleOperator' => 'equals','Value' => SubscriberTestEmail};
@@ -72,7 +72,7 @@ begin
 
   # Delete Subscriber
   p '>>> Delete Subscriber'
-  deleteSub = FuelSDK::ET_Subscriber.new()
+  deleteSub = FuelSDK::Subscriber.new()
   deleteSub.authStub = stubObj
   deleteSub.props = {"EmailAddress" => SubscriberTestEmail}
   deleteResponse = deleteSub.delete
@@ -86,7 +86,7 @@ begin
 
   # Retrieve Subscriber to confirm deletion
   p '>>> Retrieve Subscriber to confirm deletion'
-  getSub = FuelSDK::ET_Subscriber.new()
+  getSub = FuelSDK::Subscriber.new()
   getSub.authStub = stubObj
   getSub.props = ["SubscriberKey", "EmailAddress", "Status"]
   getSub.filter = {'Property' => 'SubscriberKey','SimpleOperator' => 'equals','Value' => SubscriberTestEmail};
@@ -105,7 +105,7 @@ begin
 
   # Retrieve All Subcribers with GetMoreResults
   p '>>> Retrieve All Subcribers with GetMoreResults'
-  getSub = FuelSDK::ET_Subscriber.new()
+  getSub = FuelSDK::Subscriber.new()
   getSub.authStub = stubObj
   getSub.props = ["SubscriberKey", "EmailAddress", "Status"]
   getResponse = getSub.get

data/samples/sample-triggeredsend.rb

@@ -3,11 +3,11 @@ require 'securerandom'
 require_relative 'sample_helper'
 
 begin
-	stubObj = FuelSDK::ET_Client.new auth
+	stubObj = FuelSDK::Client.new auth
 
 	# Get all TriggeredSendDefinitions
 	p '>>> Get all TriggeredSendDefinitions'
-	getTS = FuelSDK::ET_TriggeredSend.new
+	getTS = FuelSDK::TriggeredSend.new
 	getTS.authStub = stubObj
 	getTS.props = ["CustomerKey", "Name", "TriggeredSendStatus"]
 	getResponse = getTS.get
@@ -24,7 +24,7 @@ begin
 
 	# Create a TriggeredSend Definition
 	p '>>> Create a TriggeredSend Definition'
-	postTrig = FuelSDK::ET_TriggeredSend.new
+	postTrig = FuelSDK::TriggeredSend.new
 	postTrig.authStub = stubObj
 	postTrig.props = {'CustomerKey' => TSNameForCreateThenDelete,'Name' => TSNameForCreateThenDelete, 'Email' => {"ID"=>"3113962"}, "SendClassification"=> {"CustomerKey"=> "2240"}}
 	postResponse = postTrig.post
@@ -42,7 +42,7 @@ begin
 
 	# Pause a TriggeredSend
 	p '>>> Pause a TriggeredSend'
-	patchTrig = FuelSDK::ET_TriggeredSend.new
+	patchTrig = FuelSDK::TriggeredSend.new
 	patchTrig.authStub = stubObj
 	patchTrig.props = {"CustomerKey" => NameOfTestTS, "TriggeredSendStatus" =>"Inactive"}
 	patchResponse = patchTrig.patch
@@ -55,7 +55,7 @@ begin
 
 	# Retrieve Single TriggeredSend
 	p '>>> Retrieve Single TriggeredSend'
-	getTS = FuelSDK::ET_TriggeredSend.new
+	getTS = FuelSDK::TriggeredSend.new
 	getTS.authStub = stubObj
 	getTS.props = ["CustomerKey", "Name", "TriggeredSendStatus"]
 	getTS.filter = {'Property' => 'CustomerKey','SimpleOperator' => 'equals','Value' => NameOfTestTS}
@@ -70,7 +70,7 @@ begin
 
 	# Start a TriggeredSend by setting to Active
 	p '>>> Start a TriggeredSend by setting to Active'
-	patchTrig = FuelSDK::ET_TriggeredSend.new
+	patchTrig = FuelSDK::TriggeredSend.new
 	patchTrig.authStub = stubObj
 	patchTrig.props = {"CustomerKey" => NameOfTestTS, "TriggeredSendStatus" =>"Active"}
 	patchResponse = patchTrig.patch
@@ -83,7 +83,7 @@ begin
 
 	# Retrieve Single TriggeredSend After setting back to active
 	p '>>> Retrieve Single TriggeredSend After setting back to active'
-	getTS = FuelSDK::ET_TriggeredSend.new
+	getTS = FuelSDK::TriggeredSend.new
 	getTS.authStub = stubObj
 	getTS.props = ["CustomerKey", "Name", "TriggeredSendStatus"]
 	getTS.filter = {'Property' => 'CustomerKey','SimpleOperator' => 'equals','Value' => NameOfTestTS}
@@ -98,7 +98,7 @@ begin
 
 	# Send an email with TriggeredSend
 	p '>>> Send an email with TriggeredSend'
-	sendTrig = FuelSDK::ET_TriggeredSend.new
+	sendTrig = FuelSDK::TriggeredSend.new
 	sendTrig.authStub = stubObj
 	sendTrig.props = {"CustomerKey" => NameOfTestTS}
 	sendTrig.subscribers = [{"EmailAddress"=>"testing@bh.exacttarget.com", "SubscriberKey" => "testing@bh.exacttarget.com"}]
@@ -113,7 +113,7 @@ begin
 
 	# Delete a TriggeredSend Definition
 	p '>>> Delete a TriggeredSend Definition '
-	deleteTrig = FuelSDK::ET_TriggeredSend.new
+	deleteTrig = FuelSDK::TriggeredSend.new
 	deleteTrig.authStub = stubObj
 	deleteTrig.props = {'CustomerKey' => TSNameForCreateThenDelete}
 	deleteResponse = deleteTrig.delete

data/samples/sample-unsubevent.rb

@@ -2,14 +2,14 @@ require 'fuelsdk'
 require_relative 'sample_helper'
 
 begin
-	stubObj = FuelSDK::ET_Client.new auth
+	stubObj = FuelSDK::Client.new auth
 
 	## Modify the date below to reduce the number of results returned from the request
 	## Setting this too far in the past could result in a very large response size
 	retrieveDate = '2013-01-15T13:00:00.000'
 
 	p '>>> Retrieve Filtered UnsubEvents with GetMoreResults'
-	getUnsubEvent = FuelSDK::ET_UnsubEvent.new()
+	getUnsubEvent = FuelSDK::UnsubEvent.new()
 	getUnsubEvent.authStub = stubObj
 	getUnsubEvent.props = ["SendID","SubscriberKey","EventDate",
   "Client.ID","EventType","BatchID","TriggeredSendDefinitionObjectID","PartnerKey"]
@@ -40,7 +40,7 @@ begin
 	#  The following request could potentially bring back large amounts of data if run against a production account
 =begin
 	p '>>> Retrieve All UnsubEvents with GetMoreResults'
-	getUnsubEvent = FuelSDK::ET_UnsubEvent.new()
+	getUnsubEvent = FuelSDK::UnsubEvent.new()
 	getUnsubEvent.authStub = stubObj
 	getUnsubEvent.props = ["SendID","SubscriberKey","EventDate","Client.ID","EventType","BatchID","TriggeredSendDefinitionObjectID","PartnerKey"]
 	getResponse = getUnsubEvent.get

data/spec/{fuelsdk_spec.rb → client_spec.rb}

@@ -1,44 +1,44 @@
 require 'spec_helper.rb'
 
-describe FuelSDK::ET_Client do
+describe FuelSDK::Client do
 
   context 'initialized' do
 
     it 'with client parameters' do
-      client = FuelSDK::ET_Client.new 'client' => { 'id' => '1234', 'secret' => 'ssssh', 'signature' => 'hancock' }
+      client = FuelSDK::Client.new 'client' => { 'id' => '1234', 'secret' => 'ssssh', 'signature' => 'hancock' }
       expect(client.secret).to eq 'ssssh'
       expect(client.id).to eq '1234'
       expect(client.signature).to eq 'hancock'
     end
 
     it 'with debug=true' do
-      client = FuelSDK::ET_Client.new({}, true)
+      client = FuelSDK::Client.new({}, true)
       expect(client.debug).to be_true
     end
 
     it 'with debug=false' do
-      client = FuelSDK::ET_Client.new({}, false)
+      client = FuelSDK::Client.new({}, false)
       expect(client.debug).to be_false
     end
 
     it 'creates SoapClient' do
-      client = FuelSDK::ET_Client.new
+      client = FuelSDK::Client.new
       expect(client).to be_kind_of FuelSDK::Soap
     end
 
     it '#wsdl defaults to https://webservice.exacttarget.com/etframework.wsdl' do
-      client = FuelSDK::ET_Client.new
+      client = FuelSDK::Client.new
       expect(client.wsdl).to eq 'https://webservice.exacttarget.com/etframework.wsdl'
     end
 
     it 'creates RestClient' do
-      client = FuelSDK::ET_Client.new
+      client = FuelSDK::Client.new
       expect(client).to be_kind_of FuelSDK::Rest
     end
 
     describe 'with a wsdl' do
 
-      let(:client) { FuelSDK::ET_Client.new 'defaultwsdl' => 'somewsdl' }
+      let(:client) { FuelSDK::Client.new 'defaultwsdl' => 'somewsdl' }
 
       it'creates a SoapClient' do
         expect(client).to be_kind_of FuelSDK::Soap
@@ -52,7 +52,7 @@ describe FuelSDK::ET_Client do
 
   context 'instance can set' do
 
-    let(:client) { FuelSDK::ET_Client.new }
+    let(:client) { FuelSDK::Client.new }
 
     it 'client id' do
       client.id = 123
@@ -100,7 +100,7 @@ describe FuelSDK::ET_Client do
     }
 
     it 'raises an exception when signature is missing' do
-      expect { FuelSDK::ET_Client.new.jwt = encoded }.to raise_exception 'Require app signature to decode JWT'
+      expect { FuelSDK::Client.new.jwt = encoded }.to raise_exception 'Require app signature to decode JWT'
     end
 
     describe 'decodes JWT' do
@@ -114,7 +114,7 @@ describe FuelSDK::ET_Client do
       }
 
       let(:client) {
-        FuelSDK::ET_Client.new 'client' => { 'id' => '1234', 'secret' => 'ssssh', 'signature' => sig }
+        FuelSDK::Client.new 'client' => { 'id' => '1234', 'secret' => 'ssssh', 'signature' => sig }
       }
 
       it 'making auth token available to client' do
@@ -135,7 +135,7 @@ describe FuelSDK::ET_Client do
   end
 
   describe '#refresh_token' do
-    let(:client) { FuelSDK::ET_Client.new }
+    let(:client) { FuelSDK::Client.new }
 
     it 'defaults to nil' do
       expect(client.refresh_token).to be_nil
@@ -149,7 +149,7 @@ describe FuelSDK::ET_Client do
 
   describe '#refresh' do
 
-    let(:client) { FuelSDK::ET_Client.new }
+    let(:client) { FuelSDK::Client.new }
 
     context 'raises an exception' do
 
@@ -169,7 +169,7 @@ describe FuelSDK::ET_Client do
     end
 
     #context 'posts' do
-    #  let(:client) { FuelSDK::ET_Client.new 'client' => { 'id' => 123, 'secret' => 'sssh'} }
+    #  let(:client) { FuelSDK::Client.new 'client' => { 'id' => 123, 'secret' => 'sssh'} }
     #  it 'accessType=offline' do
     #  client.stub(:post)
     #    .with({'clientId' => 123, 'secret' => 'ssh', 'accessType' => 'offline'})
@@ -177,7 +177,7 @@ describe FuelSDK::ET_Client do
     #end
 
     #context 'updates' do
-    #  let(:client) { FuelSDK::ET_Client.new 'client' => { 'id' => 123, 'secret' => 'sssh'} }
+    #  let(:client) { FuelSDK::Client.new 'client' => { 'id' => 123, 'secret' => 'sssh'} }
 
     #  it 'access_token' do
     #    #client.stub(:post).
@@ -187,7 +187,7 @@ describe FuelSDK::ET_Client do
 
   describe 'includes HTTPRequest' do
 
-    subject { FuelSDK::ET_Client.new }
+    subject { FuelSDK::Client.new }
 
     it { should respond_to(:get) }
     it { should respond_to(:post) }

data/spec/objects_helper_spec.rb

@@ -0,0 +1,25 @@
+
+shared_examples_for 'Soap Read Object' do
+  it { should respond_to(:info) }
+  it { should respond_to(:get) }
+end
+
+shared_examples_for 'Soap CUD Object' do
+  it { should respond_to(:post) }
+  it { should respond_to(:patch) }
+  it { should respond_to(:delete) }
+end
+
+shared_examples_for 'Soap Object' do
+  it { should respond_to(:id) }
+  it_behaves_like 'Soap Read Object'
+  it_behaves_like 'Soap CUD Object'
+end
+
+shared_examples_for 'Soap Read Only Object' do
+  it { should respond_to(:id) }
+  it_behaves_like 'Soap Read Object'
+  it { should_not respond_to(:post) }
+  it { should_not respond_to(:patch) }
+  it { should_not respond_to(:delete) }
+end

data/spec/objects_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper.rb'
+require 'objects_helper_spec.rb'
+
+describe FuelSDK::BounceEvent do
+
+  let(:object) { FuelSDK::BounceEvent.new }
+  subject{ object }
+
+  it_behaves_like 'Soap Read Only Object'
+  its(:id){ should eq 'BounceEvent' }
+end
+
+describe FuelSDK::ClickEvent do
+
+  let(:object) { FuelSDK::ClickEvent.new }
+  subject{ object }
+
+  it_behaves_like 'Soap Read Only Object'
+  its(:id){ should eq 'ClickEvent' }
+end
+
+describe FuelSDK::ContentArea do
+
+  let(:object) { FuelSDK::ContentArea.new }
+  subject{ object }
+
+  it_behaves_like 'Soap Object'
+  its(:id){ should eq 'ContentArea' }
+end
+
+describe FuelSDK::DataFolder do
+
+  let(:object) { FuelSDK::DataFolder.new }
+  subject{ object }
+
+  it_behaves_like 'Soap Object'
+  its(:id){ should eq 'DataFolder' }
+end
+
+describe FuelSDK::Folder do
+
+  let(:object) { FuelSDK::Folder.new }
+  subject{ object }
+
+  it_behaves_like 'Soap Object'
+  its(:id){ should eq 'DataFolder' }
+end
+
+describe FuelSDK::Email do
+
+  let(:object) { FuelSDK::Email.new }
+  subject{ object }
+
+  it_behaves_like 'Soap Object'
+  its(:id){ should eq 'Email' }
+end
+
+describe FuelSDK::List do
+
+  let(:object) { FuelSDK::List.new }
+  subject{ object }
+
+  it_behaves_like 'Soap Object'
+  its(:id){ should eq 'List' }
+end
+
+describe FuelSDK::List::Subscriber do
+
+  let(:object) { FuelSDK::List::Subscriber.new }
+  subject{ object }
+
+  it_behaves_like 'Soap Read Only Object'
+  its(:id){ should eq 'ListSubscriber' }
+end
+
+describe FuelSDK::OpenEvent do
+
+  let(:object) { FuelSDK::OpenEvent.new }
+  subject{ object }
+
+  it_behaves_like 'Soap Read Only Object'
+  its(:id){ should eq 'OpenEvent' }
+end
+
+describe FuelSDK::SentEvent do
+
+  let(:object) { FuelSDK::SentEvent.new }
+  subject{ object }
+
+  it_behaves_like 'Soap Read Only Object'
+  its(:id){ should eq 'SentEvent' }
+end
+
+describe FuelSDK::Subscriber do
+
+  let(:object) { FuelSDK::Subscriber.new }
+  subject{ object }
+
+  it_behaves_like 'Soap Object'
+  its(:id){ should eq 'Subscriber' }
+end
+
+# verify backward compats
+describe ET_Subscriber do
+
+  let(:object) { ET_Subscriber.new }
+  subject{ object }
+
+  it_behaves_like 'Soap Object'
+  its(:id){ should eq 'Subscriber' }
+end