sfmc-fuelsdk-ruby 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a05834436829d49ca8336cd49946a56bed5f003f709a512a1ecb9637cec3031
-  data.tar.gz: 8f00eed0dd3e176c72042cf404b0fb7e06b71820f69df8417581c51a90e68869
+  metadata.gz: c6d1e7835b46241d74415cfc71fcf04898d24c36b4d7e02ecc2c79c0b4b43851
+  data.tar.gz: 6e49a53e6a97bda143d6cae5fb335f50dc793ea0da967c4236f69874137e7f17
 SHA512:
-  metadata.gz: a8ee8667e093661ebed4f9433f3de2010079117db931f917ddda8cefb5eef8e511a8857bd457731cb0cb217d46212a0f0b9b71cb41010ea6f3670aafadc50267
-  data.tar.gz: db4f4acc5d67666bef2a109460fdc018be30f438751968cb235d64663f73b5ec34cb1d8acc18cbd8574760ac3c5205dfe3105a819cade0030527609f51c38007
+  metadata.gz: c7f5558179e22d3acf72b562b6ea219f1ffea55946ccab4bd2108e2e471f35102131113c6e4e58ad69801281e24d02a5e174006193ba018d26a14df79c60ec2a
+  data.tar.gz: aef480e9c3218532d934d69b9204b71822e7d2ee6c4a2eece74211bf8442196caa241328b43229a6e241b6baabd7130ca7104ace67d9fdd14632f7367deeeca1

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,39 @@
+---
+name: Bug report
+about: Describe the issue you found
+title: "[BUG]"
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Code snippet**
+A code snippet that demonstrates the issue or a link to a code repository the developers can easily pull down to recreate the issue locally.
+
+Note: Because the developers need to copy and paste the code snippet, including a code snippet as a media file (e.g. gif) is not sufficient.
+
+
+**Environment**
+- SDK Version [e.g. 1.2.0]
+- Ruby version
+
+**The bug has the severity**
+- [ ] Critical: The defect affects critical functionality or critical data. It does not have a workaround.
+- [ ] Major: The defect affects major functionality or major data. It has a workaround but is not obvious and is difficult.
+- [ ] Minor: The defect affects minor functionality or non-critical data. It has an easy workaround.
+- [ ] Trivial: The defect does not affect functionality or data. It does not even need a workaround. It does not impact productivity or efficiency. It is merely an inconvenience.
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[Enhancement]"
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe**
+A clear and concise description of what the problem is. 
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.gitignore

@@ -8,6 +8,7 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
+spec/public_or_web_integration_credentials.rb
 test/tmp
 test/version_tmp
 tmp

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sfmc-fuelsdk-ruby (1.2.0)
+    sfmc-fuelsdk-ruby (1.3.0)
       json (~> 1.8, >= 1.8.1)
       jwt (~> 1.0, >= 1.0.0)
       savon (= 2.2.0)

data/README.md

@@ -6,6 +6,34 @@ ExactTarget Fuel SDK / SalesforceMarektingCloudSDK for Ruby
 ## Overview ##
 The Fuel SDK for Ruby provides easy access to ExactTarget's Fuel API Family services, including a collection of REST APIs and a SOAP API. These APIs provide access to ExactTarget functionality via common collection types such as array/hash.
 
+## New Features in Version 1.3.0 ##
+- **Added Refresh Token support for OAuth2 authentication**
+- **Added Web/Public App support for OAuth2 authentication**
+
+    More details on Access Tokens for Web/Public Apps can be found [here](https://developer.salesforce.com/docs/atlas.en-us.mc-app-development.meta/mc-app-development/access-token-app.htm)
+
+    Example of instantiating the Client class:
+        
+    ```
+    myclient = MarketingCloudSDK::Client.new({
+        'client' => {
+            'id' => '<CLIENT_ID>',
+            'secret' => '<CLIENT_SECRET>',
+            'request_token_url' => '<AUTH TENANT SPECIFIC ENDPOINT>',
+            'soap_endpoint' => '<SOAP TENANT SPECIFIC ENDPOINT>',
+            'base_api_url' => '<REST TENANT SPECIFIC ENDPOINT>',
+            'use_oAuth2_authentication' => true,
+            'account_id' => <TARGET_ACCOUNT_ID>,
+            'scope' => '<PERMISSION_LIST>',
+            'application_type' => '<APPLICATION_TYPE>',
+            'redirect_URI' => '<REDIRECT_URI_FOR_PUBLIC/WEB_APP>',
+            'authorization_code' => '<AUTHORIZATION_CODE_FOR_PUBLIC/WEB_APP>'
+            }
+        })
+    ```
+
+ * application_type can have one of the following values: `server`, `public`, `web`. The default value of application_type is `server`.
+
 
 ## New Features in Version 1.2.0 ##
 - **OAuth2 authentication support** - [More Details](https://developer.salesforce.com/docs/atlas.en-us.mc-app-development.meta/mc-app-development/integration-considerations.htm)
@@ -65,7 +93,7 @@ gem build marketingcloudsdk.gemspec
 Install the newly built gem
 
 ```ruby
-gem install marketingcloudsdk-1.2.0.gem
+gem install marketingcloudsdk-1.3.0.gem
 ```
 
 If you have not registered your application or you need to lookup your Application Key or Application Signature values, please go to App Center at [Code@: ExactTarget's Developer Community](http://code.exacttarget.com/appcenter "Code@ App Center").

data/lib/marketingcloudsdk/client.rb

@@ -78,7 +78,7 @@ module MarketingCloudSDK
 	class Client
 	attr_accessor :debug, :access_token, :auth_token, :internal_token, :refresh_token,
 		:id, :secret, :signature, :base_api_url, :package_name, :package_folders, :parent_folders, :auth_token_expiration,
-		:request_token_url, :soap_endpoint, :use_oAuth2_authentication, :account_id, :scope
+		:request_token_url, :soap_endpoint, :use_oAuth2_authentication, :account_id, :scope, :application_type, :authorization_code, :redirect_URI
 
 	include MarketingCloudSDK::Soap
 	include MarketingCloudSDK::Rest
@@ -86,12 +86,13 @@ module MarketingCloudSDK
 		def jwt= encoded_jwt
 			raise 'Require app signature to decode JWT' unless self.signature
 			decoded_jwt = JWT.decode(encoded_jwt, self.signature, true)
+			decoded_jwt_first = decoded_jwt.first
 
-			self.auth_token = decoded_jwt['request']['user']['oauthToken']
-			self.internal_token = decoded_jwt['request']['user']['internalOauthToken']
-			self.refresh_token = decoded_jwt['request']['user']['refreshToken']
-			self.auth_token_expiration = Time.new + decoded_jwt['request']['user']['expiresIn']
-			self.package_name = decoded_jwt['request']['application']['package']
+			self.auth_token = decoded_jwt_first['request']['user']['oauthToken']
+			self.internal_token = decoded_jwt_first['request']['user']['internalOauthToken']
+			self.refresh_token = decoded_jwt_first['request']['user']['refreshToken']
+			self.auth_token_expiration = Time.new + decoded_jwt_first['request']['user']['expiresIn']
+			self.package_name = decoded_jwt_first['request']['application']['package']
 		end
 
 		def initialize(params={}, debug=false)
@@ -108,6 +109,9 @@ module MarketingCloudSDK
 				self.use_oAuth2_authentication = client_config["use_oAuth2_authentication"]
 				self.account_id = client_config["account_id"]
 				self.scope = client_config["scope"]
+				self.application_type = client_config["application_type"]
+				self.authorization_code = client_config["authorization_code"]
+				self.redirect_URI = client_config["redirect_URI"]
 			end
 
 			# Set a default value in case no 'client' params is sent
@@ -123,6 +127,26 @@ module MarketingCloudSDK
 				end
 			end
 
+			if application_type.to_s.strip.empty?
+				self.application_type = 'server'
+			end
+
+			if ['web', 'public'].include? application_type
+				if authorization_code.to_s.strip.empty? or redirect_URI.to_s.strip.empty?
+					raise 'authorization_code or redirect_URI is null: For Public/Web Apps, the authorization_code and redirect_URI must be passed when instantiating Client'
+				end
+			end
+
+			if application_type == 'public'
+				if id.to_s.strip.empty?
+					raise 'id is null: id must be passed when instantiating Client'
+				end
+			else
+				if id.to_s.strip.empty? or secret.to_s.strip.empty?
+					raise 'id and secret must pe passed when instantiating Client'
+				end
+			end
+
 			self.jwt = params['jwt'] if params['jwt']
 			self.refresh_token = params['refresh_token'] if params['refresh_token']
 
@@ -133,7 +157,6 @@ module MarketingCloudSDK
 
 		def refresh force=false
 			@refresh_mutex.synchronize do
-				raise 'Require Client Id and Client Secret to refresh tokens' unless (id && secret)
 
 				if (self.use_oAuth2_authentication == true)
 					self.refreshWithOAuth2(force)
@@ -169,43 +192,67 @@ module MarketingCloudSDK
 		end
 
 	def refreshWithOAuth2 force=false
-		raise 'Require Client Id and Client Secret to refresh tokens' unless (id && secret)
 		#If we don't already have a token or the token expires within 5 min(300 seconds)
 		if (self.access_token.nil? || Time.new + 300 > self.auth_token_expiration || force) then
-			payload = Hash.new.tap do |h|
-				h['client_id']= id
-				h['client_secret'] = secret
-				h['grant_type'] = 'client_credentials'
-
-				if (not self.account_id.to_s.strip.empty?)then
-					h['account_id'] = account_id
-				end
 
-				if (not self.scope.to_s.strip.empty?)then
-					h['scope'] = scope
-				end
-			end
+			payload = createPayload
 
 			options = Hash.new.tap do |h|
 				h['data'] = payload
 				h['content_type'] = 'application/json'
 			end
 
-			self.request_token_url += '/v2/token'
+			auth_endpoint = request_token_url + '/v2/token'
 
-			response = post(request_token_url, options)
+			response = post(auth_endpoint, options)
 			raise "Unable to refresh token: #{response['message']}" unless response.has_key?('access_token')
 
 			self.access_token = response['access_token']
 			self.auth_token_expiration = Time.new + response['expires_in']
 			self.soap_endpoint = response['soap_instance_url'] + 'service.asmx'
 			self.base_api_url = response['rest_instance_url']
+
+			if response.has_key?('refresh_token')
+				self.refresh_token = response['refresh_token']
+			end
+
 			return true
 		else
 			return false
 		end
 	end
 
+	def createPayload
+		payload = Hash.new.tap do |h|
+			h['client_id'] = id
+
+			if application_type != 'public'
+				h['client_secret'] = secret
+			end
+
+			if !refresh_token.to_s.strip.empty?
+				h['grant_type'] = 'refresh_token'
+				h['refresh_token'] = refresh_token
+			elsif ['web', 'public'].include? application_type
+				h['grant_type'] = 'authorization_code'
+				h['code'] = authorization_code
+				h['redirect_uri'] = redirect_URI
+			else
+				h['grant_type'] = 'client_credentials'
+			end
+
+			unless account_id.to_s.strip.empty?
+				h['account_id'] = account_id
+			end
+
+			unless scope.to_s.strip.empty?
+				h['scope'] = scope
+			end
+		end
+
+		payload
+	end
+
 		def refresh!
 			refresh true
 		end

data/lib/marketingcloudsdk/version.rb

@@ -35,5 +35,5 @@ USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 =end
 
 module MarketingCloudSDK
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/spec/client_spec.rb

@@ -1,94 +1,208 @@
 require 'spec_helper.rb'
+require 'public_or_web_integration_credentials'
+
+def get_test_stub
+  {'client' => {
+      'use_oAuth2_authentication' => true,
+      'id' => 'id',
+      'secret' => 'secret',
+      'request_token_url' => 'request_token_url',
+      'account_id' => 'account_id',
+      'authorization_code' => 'authorization_code',
+      'redirect_URI' => 'redirect_URI'
+  }}
+end
 
-describe MarketingCloudSDK::Client do
+describe(MarketingCloudSDK::Client) do
 
   context 'initialized' do
 
+    before(:each) do
+      allow_any_instance_of(MarketingCloudSDK::Client).to receive(:refresh).and_return(true)
+    end
+
     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'
+      test_stub = get_test_stub
+
+      client = MarketingCloudSDK::Client.new(test_stub)
+
+      expect(client.use_oAuth2_authentication).to be test_stub['client']['use_oAuth2_authentication']
+      expect(client.id).to eq test_stub['client']['id']
+      expect(client.secret).to eq test_stub['client']['secret']
+      expect(client.account_id).to eq test_stub['client']['account_id']
+      expect(client.request_token_url).to eq test_stub['client']['request_token_url']
     end
 
     it 'with debug=true' do
-      client = MarketingCloudSDK::Client.new({}, true)
+      client = MarketingCloudSDK::Client.new(get_test_stub, true)
+
       expect(client.debug).to be true
     end
 
     it 'with debug=false' do
-      client = MarketingCloudSDK::Client.new({}, false)
+      client = MarketingCloudSDK::Client.new(get_test_stub, 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 'with base_api_url set to default value if base_api_url is not set' do
+      client = MarketingCloudSDK::Client.new(get_test_stub)
 
-    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'
+    it 'with null/blank/empty request_token_url and use_oAuth2_authentication=true should raise exception' do
+      expected_exception = 'request_token_url (Auth TSE) is mandatory when using OAuth2 authentication'
+
+      test_stub = get_test_stub
+
+      [nil, '   ', ''].each do |exception_raiser|
+        test_stub['client']['request_token_url'] = exception_raiser
+        expect { MarketingCloudSDK::Client.new(test_stub) }.to raise_error(expected_exception)
+      end
     end
 
-    it 'creates SoapClient' do
-      client = MarketingCloudSDK::Client.new
+    it 'with SoapClient' do
+      client = MarketingCloudSDK::Client.new(get_test_stub)
+
       expect(client).to be_kind_of MarketingCloudSDK::Soap
     end
 
-    it '#wsdl defaults to https://webservice.exacttarget.com/etframework.wsdl' do
-      client = MarketingCloudSDK::Client.new
+    it 'with RestClient' do
+      client = MarketingCloudSDK::Client.new(get_test_stub)
+
+      expect(client).to be_kind_of MarketingCloudSDK::Rest
+    end
+
+    it 'with wsdl set to default value if  not set in params' do
+      client = MarketingCloudSDK::Client.new(get_test_stub)
+
       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
+    it 'with application_type set to \'server\' if application_type is not set in params' do
+      client = MarketingCloudSDK::Client.new(get_test_stub)
+
+      expect(client.application_type).to eq 'server'
+    end
+
+    describe 'with web/public app and null/blank/empty authorization_code or redirect_URI should raise exception' do
+      expected_exception = 'authorization_code or redirect_URI is null: For Public/Web Apps, the authorization_code and redirect_URI must be passed when instantiating Client'
+
+      exception_raisers = Hash.new.tap do |h|
+        h[nil] = 'nil'
+        h['   '] = 'blank string'
+        h[''] = 'empty string'
+      end
+
+      test_stub = get_test_stub
+
+      ['web', 'public'].each do |app_type|
+        [nil, '   ', ''].each do |exception_raiser|
+          ['authorization_code', 'redirect_URI'].each do |under_test_prop|
+
+            it "#{app_type} app with #{exception_raisers[exception_raiser]} #{under_test_prop} raises an exception" do
+
+              test_stub['client']['application_type'] = app_type
+              test_stub['client'][under_test_prop] = exception_raiser
+
+              expect { MarketingCloudSDK::Client.new(test_stub) }.to raise_error(expected_exception)
+            end
+          end
+        end
+      end
+    end
+
+    it 'with public app and null/blank/empty id should raise exception' do
+      expected_exception = 'id is null: id must be passed when instantiating Client'
+
+      test_stub = get_test_stub
+      test_stub['client']['application_type'] = 'public'
+      test_stub['client']['authorization_code'] = 'authorization_code'
+      test_stub['client']['redirect_URI'] = 'redirect_URI'
+
+      [nil, '   ', ''].each do |exception_raiser|
+        test_stub['client']['id'] = exception_raiser
+
+        expect { MarketingCloudSDK::Client.new(test_stub) }.to raise_error(expected_exception)
+      end
+    end
+
+    describe 'with web/server app and null/blank/empty id or secret should raise exception' do
+      expected_exception = 'id and secret must pe passed when instantiating Client'
+
+      exception_raisers = Hash.new.tap do |h|
+        h[nil] = 'nil'
+        h['   '] = 'blank string'
+        h[''] = 'empty string'
+      end
+
+      test_stub = get_test_stub
+      test_stub['client']['authorization_code'] = 'authorization_code'
+      test_stub['client']['redirect_URI'] = 'redirect_URI'
+
+      ['web', 'server'].each do |app_type|
+        [nil, '   ', ''].each do |exception_raiser|
+          ['id', 'secret'].each do |under_test_prop|
+
+            it "#{app_type} app with #{exception_raisers[exception_raiser]} #{under_test_prop} raises an exception" do
+
+            test_stub['client']['application_type'] = app_type
+            test_stub['client'][under_test_prop] = exception_raiser
+
+            expect { MarketingCloudSDK::Client.new(test_stub) }.to raise_error(expected_exception)
+            end
+          end
+        end
+      end
     end
 
     describe 'with a wsdl' do
 
-      let(:client) { MarketingCloudSDK::Client.new 'defaultwsdl' => 'somewsdl' }
+      test_stub = get_test_stub
+
+      let(:client) { MarketingCloudSDK::Client.new test_stub }
 
       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'
+        expect(client.wsdl).to eq 'https://webservice.exacttarget.com/etframework.wsdl'
       end
     end
   end
 
   context 'instance can set' do
 
-    let(:client) { MarketingCloudSDK::Client.new }
+    before(:each) do
+      allow_any_instance_of(MarketingCloudSDK::Client).to receive(:refresh).and_return(true)
+    end
+
+    let(:client) { MarketingCloudSDK::Client.new (get_test_stub)}
 
     it 'client id' do
-      client.id = 123
-      expect(client.id).to eq 123
+      client.id = 'some_id'
+
+      expect(client.id).to eq 'some_id'
     end
 
     it 'client secret' do
-      client.secret = 'sssh'
-      expect(client.secret).to eq 'sssh'
+      client.secret = 'some_secret'
+
+      expect(client.secret).to eq 'some_secret'
     end
 
     it 'refresh token' do
-      client.refresh_token = 'refresh'
-      expect(client.refresh_token).to eq 'refresh'
+      client.refresh_token = 'some_refresh_token'
+
+      expect(client.refresh_token).to eq 'some_refresh_token'
     end
 
     it 'debug' do
+      client.debug = false
       expect(client.debug).to be false
+
       client.debug = true
       expect(client.debug).to be true
     end
@@ -97,23 +211,23 @@ describe MarketingCloudSDK::Client do
   describe '#jwt=' do
 
     let(:payload) {
-     {
-      'request' => {
-        'user'=> {
-          'oauthToken' => 123456789,
-          'expiresIn' => 3600,
-          'internalOauthToken' => 987654321,
-          'refreshToken' => 101010101010
-        },
-        'application'=> {
-          'package' => 'JustTesting'
-        }
+      {
+          'request' => {
+              'user'=> {
+                  'oauthToken' => 'oAuthToken',
+                  'expiresIn' => 3600,
+                  'internalOauthToken' => 'internalOauthToken',
+                  'refreshToken' => 'refreshToken'
+              },
+              'application'=> {
+                  'package' => 'JustTesting'
+              }
+          }
       }
-     }
     }
 
     let(:sig){
-      sig = 'hanckock'
+      sig = 'signature'
     }
 
     let(:encoded) {
@@ -121,13 +235,20 @@ describe MarketingCloudSDK::Client do
     }
 
     it 'raises an exception when signature is missing' do
-      expect { MarketingCloudSDK::Client.new.jwt = encoded }.to raise_exception 'Require app signature to decode JWT'
+      test_stub = get_test_stub
+      test_stub['jwt'] = encoded
+
+      expect { MarketingCloudSDK::Client.new test_stub }.to raise_exception 'Require app signature to decode JWT'
     end
 
     describe 'decodes JWT' do
 
+      before(:each) do
+        allow_any_instance_of(MarketingCloudSDK::Client).to receive(:refresh).and_return(true)
+      end
+
       let(:sig){
-        sig = 'hanckock'
+        sig = 'signature'
       }
 
       let(:encoded) {
@@ -135,84 +256,161 @@ describe MarketingCloudSDK::Client do
       }
 
       let(:client) {
-        MarketingCloudSDK::Client.new 'client' => { 'id' => '1234', 'secret' => 'ssssh', 'signature' => sig }
+        test_stub = get_test_stub
+        test_stub['client']['signature'] = sig
+        test_stub['jwt'] = encoded
+
+        MarketingCloudSDK::Client.new test_stub
       }
 
       it 'making auth token available to client' do
-        client.jwt = encoded
-        expect(client.auth_token).to eq 123456789
+        expect(client.auth_token).to eq payload['request']['user']['oauthToken']
       end
 
       it 'making internal token available to client' do
-        client.jwt = encoded
-        expect(client.internal_token).to eq 987654321
+        expect(client.internal_token).to eq payload['request']['user']['internalOauthToken']
       end
 
       it 'making refresh token available to client' do
-        client.jwt = encoded
-        expect(client.refresh_token).to eq 101010101010
+        expect(client.refresh_token).to eq payload['request']['user']['refreshToken']
       end
     end
   end
 
   describe '#refresh_token' do
-    let(:client) { MarketingCloudSDK::Client.new }
+
+    before(:each) do
+      allow_any_instance_of(MarketingCloudSDK::Client).to receive(:refresh).and_return(true)
+    end
+
+    let(:client) { MarketingCloudSDK::Client.new get_test_stub }
 
     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'
+      client.refresh_token = 'refresh_token'
+      expect(client.refresh_token).to eq 'refresh_token'
     end
   end
 
-  describe '#refresh' do
+  context 'authentication payload' do
+
+    before(:each) do
+      allow_any_instance_of(MarketingCloudSDK::Client).to receive(:refresh).and_return(true)
+    end
 
-    let(:client) { MarketingCloudSDK::Client.new }
+    it 'should have public app attributes' do
+      test_stub = get_test_stub
+      test_stub['client']['application_type'] = 'public'
 
-    context 'raises an exception' do
+      client = MarketingCloudSDK::Client.new(test_stub)
 
-      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
+      payload = client.createPayload
 
-      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
+      expect(client.id).to eq payload['client_id']
+      expect(client.redirect_URI).to eq payload['redirect_uri']
+      expect(client.authorization_code).to eq payload['code']
+      expect('authorization_code').to eq payload['grant_type']
+    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
+    it 'should not have client secret for public app' do
+      test_stub = get_test_stub
+      test_stub['client']['application_type'] = 'public'
+
+      client = MarketingCloudSDK::Client.new(test_stub)
+
+      payload = client.createPayload
+
+      expect(payload.key?('client_secret')).to be false
+    end
+
+    it 'should have web app attributes' do
+      test_stub = get_test_stub
+      test_stub['client']['application_type'] = 'web'
+
+      client = MarketingCloudSDK::Client.new(test_stub)
+
+      payload = client.createPayload
+
+      expect('authorization_code').to eq payload['grant_type']
+      expect(client.id).to eq payload['client_id']
+      expect(client.secret).to eq payload['client_secret']
+      expect(client.redirect_URI).to eq payload['redirect_uri']
+      expect(client.authorization_code).to eq payload['code']
+    end
+
+    it 'should have server attributes' do
+      test_stub = get_test_stub
+      test_stub['client']['application_type'] = 'server'
+
+      client = MarketingCloudSDK::Client.new(test_stub)
+
+      payload = client.createPayload
+
+      expect('client_credentials').to eq payload['grant_type']
+      expect(client.id).to eq payload['client_id']
+      expect(client.secret).to eq payload['client_secret']
+    end
+
+    it 'should not have code and redirect_uri for server app' do
+      test_stub = get_test_stub
+      test_stub['client']['application_type'] = 'server'
+
+      client = MarketingCloudSDK::Client.new(test_stub)
+
+      payload = client.createPayload
+
+      expect(payload.key?('code')).to be false
+      expect(payload.key?('redirect_uri')).to be false
+    end
+
+    it 'should have refresh_token attribute when refresh_token is not null/blank/empty on client' do
+      test_stub = get_test_stub
+      test_stub['refresh_token'] = 'refresh_token'
+      test_stub['client']['application_type'] = 'public'
+
+      client = MarketingCloudSDK::Client.new(test_stub)
+
+      payload = client.createPayload
+
+      expect('refresh_token').to eq payload['grant_type']
+      expect(client.refresh_token).to eq payload['refresh_token']
     end
+  end
+
+  context 'for public and web integrations, access_token and refresh_token' do
+  # Test expects a Public/Web App integration config in spec/public_or_web_integration_credentials.rb
+    it 'should differ if refresh token is enforced' do
 
-    #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
+      client = MarketingCloudSDK::Client.new(auth)
 
-    #context 'updates' do
-    #  let(:client) { MarketingCloudSDK::Client.new 'client' => { 'id' => 123, 'secret' => 'sssh'} }
+      auth_token1 = client.access_token
+      refresh_token1 = client.refresh_token
 
-    #  it 'access_token' do
-    #    #client.stub(:post).
-    #  end
-    #end
+      client.refreshWithOAuth2(true)
+
+      auth_token2 = client.access_token
+      refresh_token2 = client.refresh_token
+
+      expect(auth_token1).not_to eq(auth_token2)
+      expect(refresh_token1).not_to eq(refresh_token2)
+    end
   end
 
   describe 'includes HTTPRequest' do
 
-    subject { MarketingCloudSDK::Client.new }
+    before(:each) do
+      allow_any_instance_of(MarketingCloudSDK::Client).to receive(:refresh).and_return(true)
+    end
+
+    subject { MarketingCloudSDK::Client.new get_test_stub}
 
     it { should respond_to(:get) }
     it { should respond_to(:post) }
     it { should respond_to(:patch) }
     it { should respond_to(:delete) }
+
   end
 end

data/spec/public_or_web_integration_credentials.rb.template

@@ -0,0 +1,12 @@
+def auth
+  {
+      'client' => {
+          'id' => '<CLIENT_ID>',
+          'request_token_url' => '<AUTH TENANT SPECIFIC ENDPOINT>',
+          'use_oAuth2_authentication' => true,
+          'application_type' => '<APPLICATION_TYPE>',
+          'redirect_URI' => '<REDIRECT_URI_FOR_PUBLIC/WEB_APP>',
+          'authorization_code' => '<AUTHORIZATION_CODE_FOR_PUBLIC/WEB_APP>'
+      }
+  }
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sfmc-fuelsdk-ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Salesforce
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-21 00:00:00.000000000 Z
+date: 2019-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -118,22 +118,22 @@ dependencies:
   name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: API wrapper for SOAP and REST API with Salesforce Marketing Cloud (ExactTarget)
 email:
 - mcsdkadmin@salesforce.com
@@ -141,6 +141,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".gitignore"
 - Gemfile
 - Gemfile.lock
@@ -193,6 +195,7 @@ files:
 - spec/http_request_spec.rb
 - spec/objects_helper_spec.rb
 - spec/objects_spec.rb
+- spec/public_or_web_integration_credentials.rb.template
 - spec/rest_spec.rb
 - spec/soap_spec.rb
 - spec/spec_helper.rb
@@ -217,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: Fuel Client Library for Ruby
@@ -256,6 +259,7 @@ test_files:
 - spec/http_request_spec.rb
 - spec/objects_helper_spec.rb
 - spec/objects_spec.rb
+- spec/public_or_web_integration_credentials.rb.template
 - spec/rest_spec.rb
 - spec/soap_spec.rb
 - spec/spec_helper.rb