BoxSimpleOAuth 
A quick and simple way to authenticate a Box user in your iPhone or iPad app.
Adding BoxSimpleOAuth to your project
CocoaPods
CocoaPods is the recommended way to add BoxSimpleOAuth to your project.
- Add BoxSimpleOAuth to your Podfile
pod 'BoxSimpleOAuth'. - Install the pod(s) by running
pod install. - Add BoxSimpleOAuth to your files with
#import <BoxSimpleOAuth/BoxSimpleOAuth.h>.
Carthage
- Add
github "rbaumbach/BoxSimpleOAuth"to your Cartfile. - Follow the directions to add the dynamic framework to your target.
Clone from Github
- Clone repository from github and copy files directly, or add it as a git submodule.
- Add all files from 'Source' directory to your project.
How To
- Create an instance of
BoxSimpleOAuthViewControllerand pass in an Box client ID, client secret, client callback URL and completion block to be executed withBoxLoginResponseandNSErrorarguments. - Once the instance of
BoxSimpleOAuthViewControlleris presented (either as a modal or pushed on the navigation stack), it will allow the user to login. After the user logs in, the completion block given in the initialization of the view controller will be executed. The argument in the completion block,BoxLoginResponse, contains an accessToken and other login information for the authenticated user provided by Box API Response. If there is an issue attempting to authenticate, an error will be given instead. - By default, if there are issues with authentication, an UIAlertView will be given to the user. To disable this, and rely on the NSError directly, set the property
shouldShowErrorAlertto NO. - An access_token can be refreshed using the underlying BoxAuthenticationManager.
- Note: Even though an instance of the view controller itself can be initialized without client ID, client secret, client callback and completion block (to help with testing), this data must be set using the view controller's properties before it is presented to the user.
Example Usage
// Simplest Example:
BoxSimpleOAuthViewController
*viewController = [[BoxSimpleOAuthViewController alloc] initWithClientID:@"panchos_client_id"
clientSecret:@"shhhhhh, I'm a secret"
callbackURL:[NSURL URLWithString:@"http://chihuahuas.dog"]
completion:^(BoxLoginResponse *response, NSError *error) {
NSLog(@"My Access Token is: %@", response.accessToken);
}];
[self.navigationController pushViewController:viewController
animated:YES];
// Disable error UIAlertViews Example:
BoxSimpleOAuthViewController
*viewController = [[BoxSimpleOAuthViewController alloc] initWithClientID:@"pancho_jrs_client_id"
clientSecret:@"shhhhhh, I'm a secret"
callbackURL:[NSURL URLWithString:@"http://your.fancy.site"]
completion:^(BoxLoginResponse *response, NSError *error) {
NSLog(@"My OAuth Token is: %@", response.accessToken);
}];
viewController.shouldShowErrorAlert = NO;
[self.navigationController pushViewController:viewController
animated:YES];
Testing
This project has been setup to use fastlane to run the tests.
First, run the setup.sh script to bundle required gems and CocoaPods when in the project directory:
$ ./setup.sh
And then use fastlane to run all the specs on the command line:
$ bundle exec fastlane specs
Version History
Version history can be found on releases page.
Suggestions, requests, and feedback
Thanks for checking out BoxSimpleOAuth for your in-app Box Authentication. Any feedback can be can be sent to: [email protected].
477 Oct 15, 2022
516 Nov 24, 2022
68 May 13, 2022
256 Dec 14, 2022
0 Oct 23, 2021
1.1k Jan 2, 2023
3.1k Jan 3, 2023
2 Aug 22, 2022
90 Aug 20, 2022
212 Dec 30, 2022
196 Dec 22, 2022
167 Mar 13, 2022
67 Aug 20, 2022
0 Nov 20, 2021
0 Jan 23, 2022
89 Oct 27, 2022
40 Nov 24, 2022
12 Jul 29, 2022
42 Dec 29, 2021
67 Aug 20, 2022
653 Dec 17, 2022
681 Dec 18, 2022
0 Oct 18, 2021
0 Dec 2, 2021
34 Sep 1, 2022
3 Dec 8, 2022
250 Dec 5, 2022
332 Nov 5, 2022