fuelsdk 0.1.6 → 0.1.7

data/spec/soap/get_spec.rb

@@ -71,29 +71,32 @@ describe FuelSDK::Soap do
 
   describe '#normalize_filter' do
     it 'returns complex filter part when filter contains LogicalOperator key' do
-      expect(subject.normalize_filter({'LogicalOperator' => 'AND'}))
+      expect(subject.normalize_filter({'LogicalOperator' => 'AND', 'LeftOperand' => {}, 'RightOperand' => {}}))
         .to eq(
           {
             'Filter' => {
               'LogicalOperator' => 'AND',
-              :attributes! => {
-                'LeftOperand' => { 'xsi:type' => 'tns:SimpleFilterPart' },
-                'RightOperand' => { 'xsi:type' => 'tns:SimpleFilterPart' }
-              },
-            },
-            :attributes! => { 'Filter' => { 'xsi:type' => 'tns:ComplexFilterPart' }}
+              '@xsi:type'       => 'tns:ComplexFilterPart',
+              'LeftOperand'     => { '@xsi:type' => 'tns:SimpleFilterPart' },
+              'RightOperand'    => { '@xsi:type' => 'tns:SimpleFilterPart' }
+            }
           }
         )
     end
 
+    it 'raises error when missing left or right operand' do
+      expect{subject.normalize_filter({'LogicalOperator' => 'AND'})}
+        .to raise_error /Missing SimpleFilterParts/
+    end
+
     it 'returns simple filter part by default' do
       expect(subject.normalize_filter({'SimpleOperator' => 'equals'}))
         .to eq(
           {
             'Filter' => {
               'SimpleOperator' => 'equals',
-            },
-            :attributes! => { 'Filter' => { 'xsi:type' => 'tns:SimpleFilterPart' }}
+              '@xsi:type'      => 'tns:SimpleFilterPart',
+            }
           }
         )
     end

data/spec/soap/perform_spec.rb

@@ -14,12 +14,12 @@ describe FuelSDK::Soap do
       expect(subject.create_action_message('Definitions', 'QueryDefinition', [{'ObjectID' => 1}], 'start'))
         .to eq(
         {
-          'Action' => 'start',
+          'Action'      => 'start',
           'Definitions' => {
-            'Definition' => [{'ObjectID' => 1}],
-            :attributes! => {
-              'Definition' => { 'xsi:type' => 'tns:QueryDefinition'}
-            }
+            'Definition' => [{
+              'ObjectID'  => 1,
+              '@xsi:type' => 'tns:QueryDefinition'
+            }]
           }
         }
       )
@@ -29,12 +29,12 @@ describe FuelSDK::Soap do
       expect(subject.create_action_message('Definitions', 'QueryDefinition', {'ObjectID' => 1}, 'start'))
         .to eq(
         {
-          'Action' => 'start',
+          'Action'      => 'start',
           'Definitions' => {
-            'Definition' => [{'ObjectID' => 1}],
-            :attributes! => {
-              'Definition' => { 'xsi:type' => 'tns:QueryDefinition'}
-            }
+            'Definition' => [{
+              'ObjectID'  => 1,
+              '@xsi:type' => 'tns:QueryDefinition'
+            }]
           }
         }
       )

data/spec/soap/soap_spec.rb

@@ -35,9 +35,9 @@ describe FuelSDK::Soap do
       client.internal_token = 'innerspace'
       expect(client.header).to eq(
         {
-          'oAuth' => { 'oAuthToken' => 'innerspace' },
-          :attributes! => {
-            'oAuth' => { 'xmlns' => 'http://exacttarget.com' }
+          'oAuth' => {
+            'oAuthToken' => 'innerspace',
+            '@xmlns' => 'http://exacttarget.com'
           }
         }
       )
@@ -69,16 +69,23 @@ describe FuelSDK::Soap do
       it 'formats soap :create message for single object' do
         expect(subject.soap_post 'Subscriber', 'EmailAddress' => 'test@fuelsdk.com' ).to eq([:create,
           {
-            'Objects' => [{'EmailAddress' => 'test@fuelsdk.com'}],
-            :attributes! => {'Objects' => {'xsi:type' => ('tns:Subscriber')}}
+            'Objects' => [{
+              'EmailAddress' => 'test@fuelsdk.com',
+              '@xsi:type'    => 'tns:Subscriber'
+            }]
           }])
       end
 
       it 'formats soap :create message for multiple objects' do
         expect(subject.soap_post 'Subscriber', [{'EmailAddress' => 'first@fuelsdk.com'}, {'EmailAddress' => 'second@fuelsdk.com'}] ).to eq([:create,
           {
-            'Objects' => [{'EmailAddress' => 'first@fuelsdk.com'}, {'EmailAddress' => 'second@fuelsdk.com'}],
-            :attributes! => {'Objects' => {'xsi:type' => ('tns:Subscriber')}}
+            'Objects' => [{
+              'EmailAddress' => 'first@fuelsdk.com',
+              '@xsi:type'    => 'tns:Subscriber'
+            }, {
+              'EmailAddress' => 'second@fuelsdk.com',
+              '@xsi:type'    => 'tns:Subscriber'
+            }]
           }])
       end
 
@@ -88,9 +95,9 @@ describe FuelSDK::Soap do
           {
             'Objects' => [{
               'EmailAddress' => 'test@fuelsdk.com',
-              'Attributes' => [{'Name' => 'First Name', 'Value' => 'first'}],
-            }],
-            :attributes! => {'Objects' => {'xsi:type' => ('tns:Subscriber')}}
+              'Attributes'   => [{'Name' => 'First Name', 'Value' => 'first'}],
+              '@xsi:type'    => 'tns:Subscriber'
+            }]
           }])
       end
 
@@ -100,12 +107,12 @@ describe FuelSDK::Soap do
           {
             'Objects' => [{
               'EmailAddress' => 'test@fuelsdk.com',
-              'Attributes' => [
+              'Attributes'   => [
                 {'Name' => 'First Name', 'Value' => 'first'},
                 {'Name' => 'Last Name', 'Value' => 'subscriber'},
               ],
-            }],
-            :attributes! => {'Objects' => {'xsi:type' => ('tns:Subscriber')}}
+              '@xsi:type'    => 'tns:Subscriber'
+            }]
           }])
       end
 
@@ -115,18 +122,19 @@ describe FuelSDK::Soap do
           {
             'Objects' => [
               {'EmailAddress' => 'first@fuelsdk.com',
-                'Attributes' => [
+                'Attributes'  => [
                   {'Name' => 'First Name', 'Value' => 'first'},
                   {'Name' => 'Last Name', 'Value' => 'subscriber'},
-                ]
+                ],
+                '@xsi:type'    => 'tns:Subscriber'
               },
               {'EmailAddress' => 'second@fuelsdk.com',
                 'Attributes' => [
                   {'Name' => 'First Name', 'Value' => 'second'},
                   {'Name' => 'Last Name', 'Value' => 'subscriber'},
-                ]
-              }],
-            :attributes! => {'Objects' => {'xsi:type' => ('tns:Subscriber')}}
+                ],
+                '@xsi:type'    => 'tns:Subscriber'
+              }]
           }])
       end
     end

data/spec/spec_helper.rb

@@ -1,16 +1,32 @@
+require 'coveralls'
+Coveralls.wear!
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'fuelsdk'
+require 'pry'
+require 'webmock/rspec'
+require "savon/mock/spec_helper"
 
 RSpec.configure do |config|
   config.mock_with :rspec
+  config.include Savon::SpecHelper
 
   # Use color in STDOUT
   config.color_enabled = true
 
   # Use the specified formatter
   config.formatter = :documentation
+
+  config.before(:all) do
+    savon.mock!
+  end
+
+  config.after(:all) do
+    savon.unmock!
+  end
+
 end
 
 shared_examples_for 'Response Object' do

data/spec/subscriber_spec.rb

@@ -0,0 +1,322 @@
+require 'spec_helper'
+
+describe 'Subscriber' do
+
+  let(:base) { 'spec/fixtures/webmock/subscriber' }
+
+  let(:auth) do
+    {
+      'client' => {
+        'id'     => 'kevy_id',
+        'secret' => 'kevy_secret'
+      }
+    }
+  end
+
+  let!(:stub_wsdl_request) do
+    stub_request(:get, "https://webservice.exacttarget.com/etframework.wsdl").
+      to_return(File.new("spec/fixtures/webmock/client/wsdl.txt"))
+  end
+
+  let!(:stub_determine_endpoint) do
+    stub_request(:get, "https://www.exacttargetapis.com/platform/v1/endpoints/soap").
+      with(:query => { 'access_token' => 'access' }).
+      to_return(File.new("spec/fixtures/webmock/client/endpoint.txt"))
+  end
+
+  let!(:stub_refresh_tokens) do
+    stub_request(:post, "https://auth.exacttargetapis.com/v1/requestToken").
+      with(:query => { 'legacy' => 1 },
+        :body      => {
+          'clientId'     => 'kevy_id',
+          'clientSecret' => 'kevy_secret',
+          'accessType'   => 'offline',
+        }).
+      to_return(File.new("spec/fixtures/webmock/client/tokens.txt"))
+  end
+
+  let(:client) { FuelSDK::Client.new(auth) }
+
+  let(:stub_describes) do
+    savon.expects(:describe).
+      with(:message => {
+        'DescribeRequests' => {
+          'ObjectDefinitionRequest' => {
+            'ObjectType' => 'Subscriber'
+          }
+        }
+      }).
+      returns(File.read("#{base}/description.xml"))
+  end
+
+  it 'describes' do
+    stub_describes
+
+    rsp = client.describe('Subscriber')
+    expect(rsp.retrievable).to include(
+      'EmailAddress'
+    )
+    expect(rsp.editable).to include(
+      'Gender'
+    )
+    expect(rsp.editable).not_to include(
+      'ModifiedDate'
+    )
+  end
+  it 'reads specified properties' do
+    savon.expects(:retrieve).
+      with(:message => {
+        'RetrieveRequest' => {
+          'ObjectType' => 'Subscriber',
+          'Properties' => [
+            "ID",
+            "EmailAddress",
+          ]
+        }
+      }).
+      returns(File.read("#{base}/subscribers.xml"))
+
+    rsp = client.soap_get('Subscriber', ['ID', 'EmailAddress'])
+
+    expect(rsp.success).to be_true
+    expect(rsp.results.count).to eq 2
+
+    expect(rsp.results.first[:id]).to eq '16234076'
+    expect(rsp.results.first[:attributes]).to include(
+      {:name=>"Available Weekends", :value=>"False"}
+    )
+
+    expect(rsp.results.last[:id]).to eq '16234077'
+    expect(rsp.results.last[:attributes]).to include(
+      {:name=>"Available Weekends", :value=>"True"}
+    )
+  end
+  it 'reads all properties' do
+    stub_describes
+    savon.expects(:retrieve).
+      with(:message => {
+        'RetrieveRequest' => {
+          'ObjectType' => 'Subscriber',
+          'Properties' => [
+            "ID",
+            "PartnerKey",
+            "CreatedDate",
+            "Client.ID",
+            "Client.PartnerClientKey",
+            "EmailAddress",
+            "SubscriberKey",
+            "UnsubscribedDate",
+            "Status",
+            "EmailTypePreference",
+          ]
+        }
+      }).
+      returns(File.read("#{base}/subscribers_with_all_properties.xml"))
+
+    rsp = client.soap_get('Subscriber')
+
+    expect(rsp.success).to be_true
+    expect(rsp.results.count).to eq 2
+
+    expect(rsp.results.first[:id]).to eq '16234076'
+    expect(rsp.results.first[:status]).to eq 'Active'
+    expect(rsp.results.first[:attributes]).to include(
+      {:name=>"Available Weekends", :value=>"False"}
+    )
+
+    expect(rsp.results.last[:id]).to eq '16234077'
+    expect(rsp.results.last[:status]).to eq 'Unsubscribed'
+    expect(rsp.results.last[:attributes]).to include(
+      {:name=>"Available Weekends", :value=>"True"}
+    )
+  end
+  it 'reads with a simple filter' do
+    stub_describes
+    savon.expects(:retrieve).
+      with(:message => {
+        'RetrieveRequest' => {
+          'ObjectType' => 'Subscriber',
+          'Properties' => [
+            "ID",
+            "PartnerKey",
+            "CreatedDate",
+            "Client.ID",
+            "Client.PartnerClientKey",
+            "EmailAddress",
+            "SubscriberKey",
+            "UnsubscribedDate",
+            "Status",
+            "EmailTypePreference",
+          ],
+          'Filter' => {
+            'Property'       => 'ID',
+            'SimpleOperator' => 'equals',
+            'Value'          => '16234076',
+            '@xsi:type'      => 'tns:SimpleFilterPart'
+          }
+        }
+      }).
+      returns(File.read("#{base}/subscriber.xml"))
+
+    rsp = client.soap_get('Subscriber', nil,
+      'Property'       => 'ID',
+      'SimpleOperator' => 'equals',
+      'Value'          => '16234076'
+    )
+
+    expect(rsp.success).to be_true
+    expect(rsp.results.count).to eq 1
+
+    expect(rsp.results.first[:id]).to eq '16234076'
+    expect(rsp.results.first[:status]).to eq 'Active'
+    expect(rsp.results.first[:attributes]).to include(
+      {:name=>"Available Weekends", :value=>"False"}
+    )
+  end
+  it 'reads with a complex filter' do
+    stub_describes
+    savon.expects(:retrieve).
+      with(:message => {
+        'RetrieveRequest' => {
+          'ObjectType' => 'Subscriber',
+          'Properties' => [
+            "ID",
+            "PartnerKey",
+            "CreatedDate",
+            "Client.ID",
+            "Client.PartnerClientKey",
+            "EmailAddress",
+            "SubscriberKey",
+            "UnsubscribedDate",
+            "Status",
+            "EmailTypePreference",
+          ],
+          'Filter' => {
+            'LeftOperand'     => {
+              'Property'       => 'ID',
+              'SimpleOperator' => 'equals',
+              'Value'          => '16234076',
+              '@xsi:type'      => 'tns:SimpleFilterPart'
+            },
+            'RightOperand'    => {
+              'Property'       => 'ID',
+              'SimpleOperator' => 'equals',
+              'Value'          => '16234077',
+              '@xsi:type'      => 'tns:SimpleFilterPart'
+            },
+            'LogicalOperator' => 'OR',
+            '@xsi:type'       => 'tns:ComplexFilterPart'
+          }
+        }
+      }).
+      returns(File.read("#{base}/subscriber.xml"))
+
+    rsp = client.soap_get('Subscriber', nil, {
+      'LeftOperand' => {
+        'Property'       => 'ID',
+        'SimpleOperator' => 'equals',
+        'Value'          => '16234076'
+      },
+      'RightOperand' => {
+        'Property'       => 'ID',
+        'SimpleOperator' => 'equals',
+        'Value'          => '16234077'
+      },
+      'LogicalOperator' => 'OR'
+    })
+
+    expect(rsp.success).to be_true
+    expect(rsp.results.count).to eq 1
+
+    expect(rsp.results.first[:id]).to eq '16234076'
+    expect(rsp.results.first[:status]).to eq 'Active'
+    expect(rsp.results.first[:attributes]).to include(
+      {:name=>"Available Weekends", :value=>"False"}
+    )
+  end
+  it 'creates' do
+    stub_describes
+    savon.expects(:create).
+      with(:message => {
+        'Objects' => [{
+          'EmailAddress'       => 'fuelsdk@exacttarget.com',
+          'Attributes' => [{
+            'Name'  => 'Gender',
+            'Value' => 'M'
+          },{
+            'Name'  => 'Available Weekends',
+            'Value' => true
+          }],
+          '@xsi:type'          => 'tns:Subscriber'
+        }]}).
+      returns(File.read("#{base}/created.xml"))
+
+    rsp = client.soap_post('Subscriber',
+      'EmailAddress'       => 'fuelsdk@exacttarget.com',
+      'Gender'             => 'M',
+      'Available Weekends' => true
+    )
+    expect(rsp.success).to be_true
+    expect(rsp.results.first[:new_id]).to eq '37576181'
+  end
+  it 'updates' do
+    stub_describes
+    savon.expects(:update).
+      with(:message => {
+        'Objects' => [{
+          'EmailAddress'       => 'fuelsdk@exacttarget.com',
+          'Attributes' => [{
+            'Name'  => 'Gender',
+            'Value' => 'M'
+          },{
+            'Name'  => 'Available Weekends',
+            'Value' => true
+          }],
+          '@xsi:type'          => 'tns:Subscriber'
+        }]}).
+      returns(File.read("#{base}/updated.xml"))
+
+    rsp = client.soap_put('Subscriber',
+      'EmailAddress'       => 'fuelsdk@exacttarget.com',
+      'Gender'             => 'M',
+      'Available Weekends' => true
+    )
+    expect(rsp.success).to be_true
+    expect(rsp.results.first).to include(
+      :status_code    => "OK",
+      :status_message => "Updated Subscriber."
+    )
+    expect(rsp.results.first[:object][:id]).to eq '16234076'
+    expect(rsp.results.first[:object][:attributes]).to include(
+      {:name => "Available Weekends", :value => true}
+    )
+  end
+  it 'deletes' do
+    stub_describes
+    savon.expects(:delete).
+      with(:message => {
+        'Objects' => [{
+          'EmailAddress'       => 'fuelsdk@exacttarget.com',
+          'Attributes' => [{
+            'Name'  => 'Gender',
+            'Value' => 'M'
+          },{
+            'Name'  => 'Available Weekends',
+            'Value' => true
+          }],
+          '@xsi:type'          => 'tns:Subscriber'
+        }]}).
+      returns(File.read("#{base}/deleted.xml"))
+
+    rsp = client.soap_delete('Subscriber',
+      'EmailAddress'       => 'fuelsdk@exacttarget.com',
+      'Gender'             => 'M',
+      'Available Weekends' => true
+    )
+    expect(rsp.success).to be_true
+    expect(rsp.results.first).to include(
+      :status_code    => "OK",
+      :status_message => "Subscriber deleted"
+    )
+  end
+end