Feature/expose scopes (#233)

kadikraman · web-flow · commit 68560cae2757 · 2019-02-01T12:07:20.000Z
* Expose scopes in iOS

* Expose scopes in Android

* Add scopes to the example app

* Add scopes to the readme

* Add scopes type definition to typescript
diff --git a/Example/AndroidExample/.eslintrc b/Example/AndroidExample/.eslintrc
@@ -0,0 +1,20 @@
+---
+extends:
+  - formidable/configurations/es6-react
+plugins:
+  - jest
+env:
+  jest/globals: true
+  browser: true
+rules:
+  quotes:
+    - error
+    - double
+  no-unsafe-negation:
+    - off
+  max-nested-callbacks:
+    - off
+  arrow-parens:
+    - off
+  filenames/match-regex:
+    - off
diff --git a/Example/AndroidExample/.prettierrc b/Example/AndroidExample/.prettierrc
@@ -0,0 +1,4 @@
+{
+    "printWidth": 100,
+    "singleQuote": true
+}
diff --git a/Example/AndroidExample/App.js b/Example/AndroidExample/App.js
@@ -53,7 +53,8 @@ export default class App extends Component<{}, State> {
           hasLoggedInOnce: true,
           accessToken: authState.accessToken,
           accessTokenExpirationDate: authState.accessTokenExpirationDate,
-          refreshToken: authState.refreshToken
+          refreshToken: authState.refreshToken,
+          scopes: authState.scopes
         },
         500
       );
@@ -107,6 +108,8 @@ export default class App extends Component<{}, State> {
             <Form.Value>{state.accessTokenExpirationDate}</Form.Value>
             <Form.Label>refreshToken</Form.Label>
             <Form.Value>{state.refreshToken}</Form.Value>
+            <Form.Label>Scopes</Form.Label>
+            <Form.Value>{state.scopes.join(', ')}</Form.Value>
           </Form>
         ) : (
           <Heading>{state.hasLoggedInOnce ? 'Goodbye.' : 'Hello, stranger.'}</Heading>
diff --git a/Example/Latest/App.js b/Example/Latest/App.js
@@ -53,7 +53,8 @@ export default class App extends Component<{}, State> {
           hasLoggedInOnce: true,
           accessToken: authState.accessToken,
           accessTokenExpirationDate: authState.accessTokenExpirationDate,
-          refreshToken: authState.refreshToken
+          refreshToken: authState.refreshToken,
+          scopes: authState.scopes
         },
         500
       );
@@ -107,6 +108,8 @@ export default class App extends Component<{}, State> {
             <Form.Value>{state.accessTokenExpirationDate}</Form.Value>
             <Form.Label>refreshToken</Form.Label>
             <Form.Value>{state.refreshToken}</Form.Value>
+            <Form.Label>scopes</Form.Label>
+            <Form.Value>{state.scopes.join(', ')}</Form.Value>
           </Form>
         ) : (
           <Heading>{state.hasLoggedInOnce ? 'Goodbye.' : 'Hello, stranger.'}</Heading>
diff --git a/Example/Latest/android/app/build.gradle b/Example/Latest/android/app/build.gradle
@@ -95,7 +95,7 @@ def enableProguardInReleaseBuilds = false
 
 android {
     compileSdkVersion rootProject.ext.compileSdkVersion
-    buildToolsVersion rootProject.ext.buildToolsVersion
+    buildToolsVersion '28.0.2'
 
     defaultConfig {
         applicationId "com.appauthexample"
diff --git a/Example/Latest/android/build.gradle b/Example/Latest/android/build.gradle
@@ -13,7 +13,7 @@ buildscript {
         google()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:3.1.4'
+        classpath 'com.android.tools.build:gradle:3.2.0'
 
         // NOTE: Do not place your application dependencies here; they belong
         // in the individual module build.gradle files
diff --git a/Example/Latest/android/gradle/wrapper/gradle-wrapper.properties b/Example/Latest/android/gradle/wrapper/gradle-wrapper.properties
@@ -1,5 +1,6 @@
+#Thu Jan 31 15:34:58 GMT 2019
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-4.4-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-4.6-all.zip
diff --git a/Example/iOSCarthageExample/.eslintrc b/Example/iOSCarthageExample/.eslintrc
@@ -0,0 +1,20 @@
+---
+extends:
+  - formidable/configurations/es6-react
+plugins:
+  - jest
+env:
+  jest/globals: true
+  browser: true
+rules:
+  quotes:
+    - error
+    - double
+  no-unsafe-negation:
+    - off
+  max-nested-callbacks:
+    - off
+  arrow-parens:
+    - off
+  filenames/match-regex:
+    - off
diff --git a/Example/iOSCarthageExample/.prettierrc b/Example/iOSCarthageExample/.prettierrc
@@ -0,0 +1,4 @@
+{
+  "printWidth": 100,
+  "singleQuote": true
+}
diff --git a/Example/iOSCarthageExample/App.js b/Example/iOSCarthageExample/App.js
@@ -53,7 +53,8 @@ export default class App extends Component<{}, State> {
           hasLoggedInOnce: true,
           accessToken: authState.accessToken,
           accessTokenExpirationDate: authState.accessTokenExpirationDate,
-          refreshToken: authState.refreshToken
+          refreshToken: authState.refreshToken,
+          scopes: authState.scopes
         },
         500
       );
@@ -107,6 +108,8 @@ export default class App extends Component<{}, State> {
             <Form.Value>{state.accessTokenExpirationDate}</Form.Value>
             <Form.Label>refreshToken</Form.Label>
             <Form.Value>{state.refreshToken}</Form.Value>
+            <Form.Label>Scopes</Form.Label>
+            <Form.Value>{state.scopes.join(', ')}</Form.Value>
           </Form>
         ) : (
           <Heading>{state.hasLoggedInOnce ? 'Goodbye.' : 'Hello, stranger.'}</Heading>
diff --git a/Example/iOSPodsExample/.eslintrc b/Example/iOSPodsExample/.eslintrc
@@ -0,0 +1,20 @@
+---
+extends:
+  - formidable/configurations/es6-react
+plugins:
+  - jest
+env:
+  jest/globals: true
+  browser: true
+rules:
+  quotes:
+    - error
+    - double
+  no-unsafe-negation:
+    - off
+  max-nested-callbacks:
+    - off
+  arrow-parens:
+    - off
+  filenames/match-regex:
+    - off
diff --git a/Example/iOSPodsExample/.prettierrc b/Example/iOSPodsExample/.prettierrc
@@ -0,0 +1,4 @@
+{
+  "printWidth": 100,
+  "singleQuote": true
+}
diff --git a/Example/iOSPodsExample/App.js b/Example/iOSPodsExample/App.js
@@ -53,7 +53,8 @@ export default class App extends Component<{}, State> {
           hasLoggedInOnce: true,
           accessToken: authState.accessToken,
           accessTokenExpirationDate: authState.accessTokenExpirationDate,
-          refreshToken: authState.refreshToken
+          refreshToken: authState.refreshToken,
+          scopes: authState.scopes
         },
         500
       );
@@ -107,6 +108,8 @@ export default class App extends Component<{}, State> {
             <Form.Value>{state.accessTokenExpirationDate}</Form.Value>
             <Form.Label>refreshToken</Form.Label>
             <Form.Value>{state.refreshToken}</Form.Value>
+            <Form.Label>Scopes</Form.Label>
+            <Form.Value>{state.scopes.join(', ')}</Form.Value>
           </Form>
         ) : (
           <Heading>{state.hasLoggedInOnce ? 'Goodbye.' : 'Hello, stranger.'}</Heading>
diff --git a/README.md b/README.md
@@ -108,6 +108,7 @@ This is the result from the auth server
 * **idToken** - (`string`) the id token
 * **refreshToken** - (`string`) the refresh token
 * **tokenType** - (`string`) the token type, e.g. Bearer
+* **scopes** - ([`string`]) the scopes the user has agreed to be granted
 
 ### `refresh`
 
diff --git a/android/build.gradle b/android/build.gradle
@@ -5,15 +5,15 @@ buildscript {
     }
 
     dependencies {
-        classpath 'com.android.tools.build:gradle:1.3.1'
+        classpath 'com.android.tools.build:gradle:2.3.2'
     }
 }
 
 apply plugin: 'com.android.library'
 
 android {
     compileSdkVersion 27
-    buildToolsVersion '27.0.2'
+    buildToolsVersion '28.0.2'
 
     defaultConfig {
         minSdkVersion 16
diff --git a/android/gradle/wrapper/gradle-wrapper.properties b/android/gradle/wrapper/gradle-wrapper.properties
@@ -1,6 +1,6 @@
-#Wed Nov 15 16:01:20 GMT 2017
+#Thu Jan 31 18:04:04 GMT 2019
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-4.1-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-3.3-all.zip
diff --git a/android/src/main/java/com/rnappauth/RNAppAuthModule.java b/android/src/main/java/com/rnappauth/RNAppAuthModule.java
@@ -15,6 +15,7 @@
 import com.facebook.react.bridge.Promise;
 import com.facebook.react.bridge.ReadableArray;
 import com.facebook.react.bridge.ReadableMap;
+import com.facebook.react.bridge.WritableArray;
 import com.facebook.react.bridge.WritableMap;
 import com.rnappauth.utils.MapUtils;
 import com.rnappauth.utils.UnsafeConnectionBuilder;
@@ -229,7 +230,7 @@ public void onActivityResult(Activity activity, int requestCode, int resultCode,
                 public void onTokenRequestCompleted(
                         TokenResponse resp, AuthorizationException ex) {
                     if (resp != null) {
-                        WritableMap map = tokenResponseToMap(resp, response.additionalParameters);
+                        WritableMap map = tokenResponseToMap(resp, response);
                         authorizePromise.resolve(map);
                     } else {
                         promise.reject("RNAppAuth Error", "Failed exchange token", ex);
@@ -394,7 +395,7 @@ private String arrayToString(ReadableArray array) {
         return strBuilder.toString();
     }
 
-/*
+    /*
      * Read raw token response into a React Native map to be passed down the bridge
      */
     private WritableMap tokenResponseToMap(TokenResponse response) {
@@ -433,7 +434,7 @@ private WritableMap tokenResponseToMap(TokenResponse response) {
     /*
      * Read raw token response into a React Native map to be passed down the bridge
      */
-    private WritableMap tokenResponseToMap(TokenResponse response, Map<String, String> responseAdditionalParameters) {
+    private WritableMap tokenResponseToMap(TokenResponse response, AuthorizationResponse authResponse) {
         WritableMap map = Arguments.createMap();
 
         map.putString("accessToken", response.accessToken);
@@ -448,13 +449,13 @@ private WritableMap tokenResponseToMap(TokenResponse response, Map<String, Strin
 
         WritableMap additionalParametersMap = Arguments.createMap();
 
-        if (!responseAdditionalParameters.isEmpty()) {
+        if (!authResponse.additionalParameters.isEmpty()) {
 
-            Iterator<String> iterator = responseAdditionalParameters.keySet().iterator();
+            Iterator<String> iterator = authResponse.additionalParameters.keySet().iterator();
 
             while(iterator.hasNext()) {
                 String key = iterator.next();
-                additionalParametersMap.putString(key, responseAdditionalParameters.get(key));
+                additionalParametersMap.putString(key, authResponse.additionalParameters.get(key));
             }
         }
 
@@ -473,6 +474,18 @@ private WritableMap tokenResponseToMap(TokenResponse response, Map<String, Strin
         map.putString("refreshToken", response.refreshToken);
         map.putString("tokenType", response.tokenType);
 
+        if (!authResponse.scope.isEmpty()) {
+            WritableArray scopes = Arguments.createArray();
+            String[] scopesArray = authResponse.scope.split(" ");
+
+            for( int i = 0; i < scopesArray.length - 1; i++)
+            {
+                scopes.pushString(scopesArray[i]);
+            }
+
+            map.putArray("scopes", scopes);
+        }
+
         return map;
     }
 
diff --git a/index.d.ts b/index.d.ts
@@ -18,9 +18,9 @@ export type BaseAuthConfiguration =
     };
 
 interface BuiltInParameters {
-  display?: "page" | "popup" | "touch" | "wap";
+  display?: 'page' | 'popup' | 'touch' | 'wap';
   login_prompt?: string;
-  prompt?: "consent" |"login" | "none" | "select_account";
+  prompt?: 'consent' | 'login' | 'none' | 'select_account';
 }
 
 export type AuthConfiguration = BaseAuthConfiguration & {
@@ -39,6 +39,7 @@ export interface AuthorizeResult {
   idToken: string;
   refreshToken: string;
   tokenType: string;
+  scopes: [string];
 }
 
 export interface RevokeConfiguration {
diff --git a/ios/RNAppAuth.m b/ios/RNAppAuth.m
@@ -205,7 +205,7 @@ - (void)authorizeWithConfiguration: (OIDServiceConfiguration *) configuration
                                                        strongSelf->_currentSession = nil;
                                                        if (authState) {
                                                            resolve([self formatResponse:authState.lastTokenResponse
-                                                               withAdditionalParameters:authState.lastAuthorizationResponse.additionalParameters]);
+                                                               withAuthResponse:authState.lastAuthorizationResponse]);
                                                        } else {
                                                            reject(@"RNAppAuth Error", [error localizedDescription], error);
                                                        }
@@ -272,18 +272,19 @@ - (NSDictionary*)formatResponse: (OIDTokenResponse*) response {
  *  and turn them into an extended token response format to pass to JavaScript caller
  */
 - (NSDictionary*)formatResponse: (OIDTokenResponse*) response
-       withAdditionalParameters:(NSDictionary*) params{
+       withAuthResponse:(OIDAuthorizationResponse*) authResponse {
     NSDateFormatter *dateFormat = [[NSDateFormatter alloc] init];
     dateFormat.timeZone = [NSTimeZone timeZoneWithAbbreviation: @"UTC"];
     [dateFormat setLocale:[NSLocale localeWithLocaleIdentifier:@"en_US_POSIX"]];
     [dateFormat setDateFormat:@"yyyy-MM-dd'T'HH:mm:ss'Z'"];
 
     return @{@"accessToken": response.accessToken ? response.accessToken : @"",
              @"accessTokenExpirationDate": response.accessTokenExpirationDate ? [dateFormat stringFromDate:response.accessTokenExpirationDate] : @"",
-             @"additionalParameters": params,
+             @"additionalParameters": authResponse.additionalParameters,
              @"idToken": response.idToken ? response.idToken : @"",
              @"refreshToken": response.refreshToken ? response.refreshToken : @"",
              @"tokenType": response.tokenType ? response.tokenType : @"",
+             @"scopes": authResponse.scope ? [authResponse.scope componentsSeparatedByString:@" "] : [NSArray new],
              };
 }
 

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +    "printWidth": 100,
 +    "singleQuote": true
 +}
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ buildscript {`
`13`	`13`	`google()`
`14`	`14`	`}`
`15`	`15`	`dependencies {`
`16`		`- classpath 'com.android.tools.build:gradle:3.1.4'`
	`16`	`+ classpath 'com.android.tools.build:gradle:3.2.0'`
`17`	`17`
`18`	`18`	`// NOTE: Do not place your application dependencies here; they belong`
`19`	`19`	`// in the individual module build.gradle files`