sfmc-fuelsdk-ruby 1.1.0

data/spec/client_spec.rb

@@ -0,0 +1,218 @@
+require 'spec_helper.rb'
+
+describe MarketingCloudSDK::Client do
+
+  context 'initialized' do
+
+    it 'with client parameters' do
+      client = MarketingCloudSDK::Client.new 'client' => {'id' => '1234', 'secret' => 'ssssh', 'signature' => 'hancock',
+                                                          'base_api_url' => 'http://getapis', 'request_token_url' => 'http://authapi'}
+      expect(client.secret).to eq 'ssssh'
+      expect(client.id).to eq '1234'
+      expect(client.signature).to eq 'hancock'
+      expect(client.base_api_url).to eq 'http://getapis'
+      expect(client.request_token_url).to eq 'http://authapi'
+    end
+
+    it 'with debug=true' do
+      client = MarketingCloudSDK::Client.new({}, true)
+      expect(client.debug).to be true
+    end
+
+    it 'with debug=false' do
+      client = MarketingCloudSDK::Client.new({}, false)
+      expect(client.debug).to be false
+    end
+
+    it 'sets the request_token url to parameter if it exists' do
+      client = MarketingCloudSDK::Client.new({'request_token_url' => 'fake/url'}, false)
+      expect(client.request_token_url).to eq 'fake/url'
+    end
+
+    it 'sets the base_api_url url to a default if it does not exist' do
+      client = MarketingCloudSDK::Client.new({}, false)
+      expect(client.base_api_url).to eq 'https://www.exacttargetapis.com'
+    end
+
+    it 'sets the request_token url to a default if it does not exist' do
+      client = MarketingCloudSDK::Client.new({}, false)
+      expect(client.request_token_url).to eq 'https://auth.exacttargetapis.com/v1/requestToken'
+    end
+
+    it 'creates SoapClient' do
+      client = MarketingCloudSDK::Client.new
+      expect(client).to be_kind_of MarketingCloudSDK::Soap
+    end
+
+    it '#wsdl defaults to https://webservice.exacttarget.com/etframework.wsdl' do
+      client = MarketingCloudSDK::Client.new
+      expect(client.wsdl).to eq 'https://webservice.exacttarget.com/etframework.wsdl'
+    end
+
+    it 'creates RestClient' do
+      client = MarketingCloudSDK::Client.new
+      expect(client).to be_kind_of MarketingCloudSDK::Rest
+    end
+
+    describe 'with a wsdl' do
+
+      let(:client) { MarketingCloudSDK::Client.new 'defaultwsdl' => 'somewsdl' }
+
+      it'creates a SoapClient' do
+        expect(client).to be_kind_of MarketingCloudSDK::Soap
+      end
+
+      it'#wsdl returns default wsdl' do
+        expect(client.wsdl).to eq 'somewsdl'
+      end
+    end
+  end
+
+  context 'instance can set' do
+
+    let(:client) { MarketingCloudSDK::Client.new }
+
+    it 'client id' do
+      client.id = 123
+      expect(client.id).to eq 123
+    end
+
+    it 'client secret' do
+      client.secret = 'sssh'
+      expect(client.secret).to eq 'sssh'
+    end
+
+    it 'refresh token' do
+      client.refresh_token = 'refresh'
+      expect(client.refresh_token).to eq 'refresh'
+    end
+
+    it 'debug' do
+      expect(client.debug).to be false
+      client.debug = true
+      expect(client.debug).to be true
+    end
+  end
+
+  describe '#jwt=' do
+
+    let(:payload) {
+     {
+      'request' => {
+        'user'=> {
+          'oauthToken' => 123456789,
+          'expiresIn' => 3600,
+          'internalOauthToken' => 987654321,
+          'refreshToken' => 101010101010
+        },
+        'application'=> {
+          'package' => 'JustTesting'
+        }
+      }
+     }
+    }
+
+    let(:sig){
+      sig = 'hanckock'
+    }
+
+    let(:encoded) {
+      JWT.encode(payload, sig)
+    }
+
+    it 'raises an exception when signature is missing' do
+      expect { MarketingCloudSDK::Client.new.jwt = encoded }.to raise_exception 'Require app signature to decode JWT'
+    end
+
+    describe 'decodes JWT' do
+
+      let(:sig){
+        sig = 'hanckock'
+      }
+
+      let(:encoded) {
+        JWT.encode(payload, sig)
+      }
+
+      let(:client) {
+        MarketingCloudSDK::Client.new 'client' => { 'id' => '1234', 'secret' => 'ssssh', 'signature' => sig }
+      }
+
+      it 'making auth token available to client' do
+        client.jwt = encoded
+        expect(client.auth_token).to eq 123456789
+      end
+
+      it 'making internal token available to client' do
+        client.jwt = encoded
+        expect(client.internal_token).to eq 987654321
+      end
+
+      it 'making refresh token available to client' do
+        client.jwt = encoded
+        expect(client.refresh_token).to eq 101010101010
+      end
+    end
+  end
+
+  describe '#refresh_token' do
+    let(:client) { MarketingCloudSDK::Client.new }
+
+    it 'defaults to nil' do
+      expect(client.refresh_token).to be_nil
+    end
+
+    it 'can be accessed' do
+      client.refresh_token = '1234567890'
+      expect(client.refresh_token).to eq '1234567890'
+    end
+  end
+
+  describe '#refresh' do
+
+    let(:client) { MarketingCloudSDK::Client.new }
+
+    context 'raises an exception' do
+
+      it 'when client id and secret are missing' do
+        expect { client.refresh }.to raise_exception 'Require Client Id and Client Secret to refresh tokens'
+      end
+
+      it 'when client id is missing' do
+        client.secret = 1234
+        expect { client.refresh }.to raise_exception 'Require Client Id and Client Secret to refresh tokens'
+      end
+
+      it 'when client secret is missing' do
+        client.id = 1234
+        expect { client.refresh }.to raise_exception 'Require Client Id and Client Secret to refresh tokens'
+      end
+    end
+
+    #context 'posts' do
+    #  let(:client) { MarketingCloudSDK::Client.new 'client' => { 'id' => 123, 'secret' => 'sssh'} }
+    #  it 'accessType=offline' do
+    #  client.stub(:post)
+    #    .with({'clientId' => 123, 'secret' => 'ssh', 'accessType' => 'offline'})
+    #    .and_return()
+    #end
+
+    #context 'updates' do
+    #  let(:client) { MarketingCloudSDK::Client.new 'client' => { 'id' => 123, 'secret' => 'sssh'} }
+
+    #  it 'access_token' do
+    #    #client.stub(:post).
+    #  end
+    #end
+  end
+
+  describe 'includes HTTPRequest' do
+
+    subject { MarketingCloudSDK::Client.new }
+
+    it { should respond_to(:get) }
+    it { should respond_to(:post) }
+    it { should respond_to(:patch) }
+    it { should respond_to(:delete) }
+  end
+end

data/spec/default_values_fallback_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe MarketingCloudSDK::Client do
+
+  context 'Empty string REST endpoint, no Auth attribute' do
+
+    client1 = MarketingCloudSDK::Client.new 'client' => {'id' => '1234', 'secret' => 'ssssh',
+                                                        'base_api_url' => ''}
+
+    it 'Should use REST endpoint default value if base_api_url endpoint is an empty string in config' do
+      expect(client1.base_api_url).to eq 'https://www.exacttargetapis.com'
+    end
+
+    it 'Should use Auth endpoint default value if request_token_url attribute is not in config' do
+      expect(client1.request_token_url).to eq 'https://auth.exacttargetapis.com/v1/requestToken'
+    end
+  end
+
+  context 'Blank string REST endpoint' do
+
+    client2 = MarketingCloudSDK::Client.new 'client' => {'id' => '1234', 'secret' => 'ssssh',
+                                                         'base_api_url' => '   '}
+
+    it 'Should use REST endpoint default value if REST endpoint is a blank string in config' do
+      expect(client2.base_api_url).to eq 'https://www.exacttargetapis.com'
+    end
+
+  end
+
+end

data/spec/helper_funcs_spec.rb

@@ -0,0 +1,11 @@
+#require 'spec_helper'
+#
+#describe 'indifferent_access' do
+#
+#  it 'returns value when symbol is used to access a string key' do
+#    expect( indifferent_access :key, 'key' => true).to be_true
+#  end
+#  it 'returns value when string is used to access a symbol key' do
+#    expect( indifferent_access 'key', :key => true).to be_true
+#  end
+#end

data/spec/http_request_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+require 'marketingcloudsdk/version'
+
+describe MarketingCloudSDK::HTTPRequest do
+  let(:client) { Class.new.new.extend MarketingCloudSDK::HTTPRequest }
+  subject { client }
+  it { should respond_to(:get) }
+  it { should respond_to(:post) }
+  it { should respond_to(:patch) }
+  it { should respond_to(:delete) }
+  it { should respond_to(:request) }
+
+  describe '#get' do
+    it 'makes and Net::HTTP::Get request' do
+      client.stub(:request).with(Net::HTTP::Get, 'http://some_url', {}).and_return({'success' => 'get'})
+      expect(client.get('http://some_url')).to eq 'success' => 'get'
+    end
+  end
+
+  describe '#post' do
+    describe 'makes and Net::HTTP::Post request' do
+
+      it 'with only url' do
+        Net::HTTP.any_instance.stub(:request)
+        client.stub(:request).with(Net::HTTP::Post, 'http://some_url', {}).and_return({'success' => 'post'})
+        expect(client.post('http://some_url')).to eq 'success' => 'post'
+      end
+
+      it 'with params' do
+        client.stub(:request)
+          .with(Net::HTTP::Post, 'http://some_url', {'params' => {'legacy' => 1}})
+          .and_return({'success' => 'post'})
+        expect(client.post('http://some_url', {'params' => {'legacy' => 1}})).to eq 'success' => 'post'
+      end
+    end
+  end
+
+  describe '#request' do
+    it 'should set Authorization header' do
+      params = {'access_token' => 'token'}
+      Net::HTTP.any_instance.stub(:request)
+      get = double("get")
+      get.should_receive(:add_field).with('User-Agent', 'FuelSDK-Ruby-v' + MarketingCloudSDK::VERSION)
+      get.should_receive(:add_field).with('Authorization', 'Bearer ' + params['access_token'])
+      net = double(Net::HTTP::Get)
+      net.stub(:new).with(any_args()).and_return(get)
+      client.request(net, 'http://some_url', params)
+    end
+
+    it 'should skip setting Authorization header' do
+      params = {}
+      Net::HTTP.any_instance.stub(:request)
+      get = double("get")
+      get.should_receive(:add_field).with('User-Agent', 'FuelSDK-Ruby-v' + MarketingCloudSDK::VERSION)
+      get.should_not_receive(:add_field).with('Authorization', any_args())
+      net = double(Net::HTTP::Get)
+      net.stub(:new).with(any_args()).and_return(get)
+      client.request(net, 'http://some_url', params)
+    end
+  end
+end

data/spec/objects_helper_spec.rb

@@ -0,0 +1,32 @@
+
+# Everything will be readable so test for shared from Read behavior
+shared_examples_for 'Soap Read Object' do
+  # begin backwards compat
+  it { should respond_to :props= }
+  it { should respond_to :authStub= }
+  # end
+  it { should respond_to :id }
+  it { should respond_to :properties }
+  it { should respond_to :client }
+  it { should respond_to :filter }
+  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_behaves_like 'Soap Read Object'
+  it_behaves_like 'Soap CUD Object'
+end
+
+shared_examples_for 'Soap Read Only Object' do
+  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