Merge pull request #28 from exeDog/ANA-3170

Add an optional account uuid field in raw info

Author: splittingred

README.md

@@ -1,7 +1,7 @@
 # OmniAuth Bigcommerce Strategy
 [![Build Status](https://travis-ci.org/bigcommerce/omniauth-bigcommerce.png?branch=master)](https://travis-ci.org/bigcommerce/omniauth-bigcommerce)
 
-This gem provides a dead simple way to authenticate to Bigcommerce using OmniAuth.
+This gem provides a simple way to authenticate to Bigcommerce using OmniAuth.
 
 ## Installation
 
@@ -42,22 +42,23 @@ It defaults to https://login.bigcommerce.com if the env variable is not defined.
 
 ## Auth Hash Schema
 
-The following information is provided back to you for this provider:
+The following response format is provided back to you for this provider:
 
 ```
 {
   uid: '12345',
   info: {
-    name: 'Philip Muir',
-    email: 'philip.muir@example.com'
+    name: 'John Doe',
+    email: 'john.doe@example.com'
   },
   credentials: {
     token: 'xyz123abc'
   },
   extra: {
     raw_info: {},
     scopes: 'requested_scopes store_v2_settings'
-    context: 'store/xyz123'
+    context: 'store/xyz123',
+    account_uuid: 'fooBar'
   }
 }
 ```

lib/omniauth/strategies/bigcommerce.rb

@@ -25,7 +25,7 @@ class BigCommerce < OmniAuth::Strategies::OAuth2
       option :provider_ignores_state, true
       option :scope, 'users_basic_information'
       option :authorize_options, [:scope, :context]
-      option :token_options, [:scope, :context]
+      option :token_options, [:scope, :context, :account_uuid]
       option :client_options,
              site: ENV.fetch('BC_AUTH_SERVICE', 'https://login.bigcommerce.com'),
              authorize_url: '/oauth2/authorize',
@@ -51,7 +51,8 @@ class BigCommerce < OmniAuth::Strategies::OAuth2
         {
           raw_info: raw_info,
           scopes: raw_info['scope'],
-          context: raw_info['context']
+          context: raw_info['context'],
+          account_uuid: raw_info.fetch('account_uuid', '')
         }
       end
 

spec/omniauth/strategies/bigcommerce_spec.rb

@@ -4,7 +4,8 @@
   let(:store_hash) { 'abcdefg' }
   let(:context) { "stores/#{store_hash}" }
   let(:scope) { 'store_v2_products' }
-  let(:request) { double('Request', :params => { 'context' => context, 'scope' => scope }, :cookies => {}, :env => {}) }
+  let(:account_uuid) { 'foobar' }
+  let(:request) { double('Request', params: { 'context' => context, 'scope' => scope, 'account_uuid' => account_uuid }, cookies: {}, env: {}) }
 
   before do
     OmniAuth.config.test_mode = true
@@ -71,6 +72,7 @@
     it 'should set the context and scope parameters in the token request' do
       expect(subject.token_params['context']).to eq(context)
       expect(subject.token_params['scope']).to eq(scope)
+      expect(subject.token_params['account_uuid']).to eq(account_uuid)
     end
   end
 end