MOB-415: Add access to access token and save it in the keychain (#11)

MOB-415: Add access to access token and save it in the keychain

Fixes #6

* Handle several scopes and their associated access tokens
* Separate the callback block for profile and token results.
* Throw appropriate errors when there is no valid token

Cartfile

@@ -0,0 +1 @@
+github "soffes/SAMKeychain" ~> 1.5.2

Cartfile.resolved

@@ -0,0 +1 @@
+github "soffes/SAMKeychain" "v1.5.2"

ID.me WebVerify SDK/IDmeWebVerify.h

@@ -13,7 +13,8 @@
 
 @interface IDmeWebVerify : NSObject
 
-typedef void (^IDmeVerifyWebVerifyResults)(NSDictionary  * _Nullable userProfile, NSError  * _Nullable error, NSString *  _Nullable accessToken);
+typedef void (^IDmeVerifyWebVerifyProfileResults)(NSDictionary  * _Nullable userProfile, NSError  * _Nullable error);
+typedef void (^IDmeVerifyWebVerifyTokenResults)(NSString *  _Nullable accessToken, NSError  * _Nullable error);
 
 /// This typedef differentiates errors that may occur when authentication a user
 typedef NS_ENUM(NSUInteger, IDmeWebVerifyErrorCode)
@@ -28,37 +29,64 @@ typedef NS_ENUM(NSUInteger, IDmeWebVerifyErrorCode)
     IDmeWebVerifyErrorCodeVerificationWasDeniedByUser,
 
     /// Error occurs if user exits modal navigation controller before OAuth flow could complete.
-    IDmeWebVerifyErrorCodeVerificationWasCanceledByUser
+    IDmeWebVerifyErrorCodeVerificationWasCanceledByUser,
+
+    /// Error occurs if getUserProfileWithScope:result: or getAccessTokenWithScope:forceRefreshing:result: are called with a scope that has no access token associated.
+    IDmeWebVerifyErrorCodeNoSuchScope,
+
+    /// Error thrown when there is no valid token or when a response status code is 401.
+    IDmeWebVerifyErrorCodeNotAuthorized,
+
+    /// Error thrown for not implemented features like token refreshing.
+    IDmeWebVerifyErrorCodeNotImplemented
 };
 
 /// THe ID.me WebVerify Singleton method
 + (IDmeWebVerify * _Nonnull)sharedInstance;
 
 /**
- @param externalViewController The viewController which will present the modal navigationController
  @param clientID The clientID provided by ID.me when registering the app at @b http://developer.id.me
  @param redierectURI The redirectURI provided to ID.me when registering your app at @b http://developer.id.me
- @param affiliationType The type of group verficiation that should be presented. Check the @c IDmeVerifyAffiliationType typedef for more details
+ */
++ (void)initializeWithClientID:(NSString * _Nonnull)clientID redirectURI:(NSString * _Nonnull)redirectURI;
+
+/**
+ @param externalViewController The viewController which will present the modal navigationController
+ @param scope The type of group verification that should be presented.
  @param webVerificationResults A block that returns an NSDictionary object and an NSError object. The verified user's profile is stored in an @c NSDictionary object as @c JSON data. If no data was returned, or an error occured, @c NSDictionary is @c nil and @c NSError returns an error code and localized description of the specific error that occured.
  */
 - (void)verifyUserInViewController:(UIViewController * _Nonnull)externalViewController
-                      withClientID:(NSString * _Nonnull)clientID
-                       redirectURI:(NSString * _Nonnull)redirectURI
                              scope:(NSString * _Nonnull)scope
-                       withResults:(IDmeVerifyWebVerifyResults _Nonnull)webVerificationResults;
+                       withResults:(IDmeVerifyWebVerifyProfileResults _Nonnull)webVerificationResults;
 
 /**
  @param externalViewController The viewController which will present the modal navigationController
- @param clientID The clientID provided by ID.me when registering the app at @b http://developer.id.me
- @param redierectURI The redirectURI provided to ID.me when registering your app at @b http://developer.id.me
- @param affiliationType The type of group verficiation that should be presented. Check the @c IDmeVerifyAffiliationType typedef for more details
+ @param scope The type of group verification that should be presented.
  @param webVerificationResults A block that returns an NSString object representing a valid access token or an NSError object.
  */
 
 - (void)verifyUserInViewController:(UIViewController * _Nonnull)externalViewController
-                      withClientID:(NSString * _Nonnull)clientID
-                       redirectURI:(NSString * _Nonnull)redirectURI
                              scope:(NSString * _Nonnull)scope
-                   withTokenResult:(IDmeVerifyWebVerifyResults _Nonnull)webVerificationResults;
+                   withTokenResult:(IDmeVerifyWebVerifyTokenResults _Nonnull)webVerificationResults;
+
+/**
+ Returns the User profile with the stored access token. 
+ @param scope The type of token to be used. If nil then the last token will be used
+ @param webVerificationResults A block that returns an NSDictionary object and an NSError object. The verified user's profile is stored in an @c NSDictionary object as @c JSON data. If no data was returned, or an error occured, @c NSDictionary is @c nil and @c NSError returns an error code and localized description of the specific error that occured.
+ */
+- (void)getUserProfileWithScope:(NSString* _Nullable)scope result:(IDmeVerifyWebVerifyProfileResults _Nonnull)webVerificationResults;
+
+/**
+ Returns a valid access token. If the currently saved access token is valid it will be returned. If not, then it will be refreshed.
+ @param scope The type of token to be used. If nil then the last token will be used
+ @param forceRefreshing Force the SDK to refresh the token and do not use the current one.
+ @param callback A block that returns an NSString object representing a valid access token or an NSError object.
+ */
+- (void)getAccessTokenWithScope:(NSString* _Nullable)scope forceRefreshing:(BOOL)force result:(IDmeVerifyWebVerifyTokenResults _Nonnull)callback;
+
+/**
+ Invalidates and deletes all tokens stored by the SDK.
+ */
+- (void)logout;
 
 @end