Giter Club home page Giter Club logo

dropboxsimpleoauth's Introduction

DropboxSimpleOAuth Bitrise Cocoapod Version Carthage Compatible Cocoapod Platform License

A quick and simple way to authenticate a Dropbox user in your iPhone or iPad app.

iPhone 7 Screenshot iPad Pro 9.7 Screenshot

Adding DropboxSimpleOAuth to your project

CocoaPods

CocoaPods is the recommended way to add DropboxSimpleOAuth to your project.

  1. Add DropboxSimpleOAuth to your Podfile pod 'DropboxSimpleOAuth'.
  2. Install the pod(s) by running pod install.
  3. Add DropboxSimpleOAuth to your files with #import <DropboxSimpleOAuth/DropboxSimpleOAuth.h>.

Carthage

  1. Add github "rbaumbach/DropboxSimpleOAuth" to your Cartfile.
  2. Follow the directions to add the dynamic framework to your target.

Clone from Github

  1. Clone repository from github and copy files directly, or add it as a git submodule.
  2. Add all files from 'Source' directory to your project.

How To

  • Create an instance of DropboxSimpleOAuthViewController and pass in an Dropbox app key, app secret, client callback URL and completion block to be executed with DropboxLoginResponse and NSError arguments.
  • Once the instance of DropboxSimpleOAuthViewController is 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, DropboxLoginResponse, contains an accessToken and other login information for the authenticated user provided by Dropbox 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 shouldShowErrorAlert to NO.
  • Note: Even though an instance of the view controller itself can be initalized without app key, app 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:

DropboxSimpleOAuthViewController
    *viewController = [[DropboxSimpleOAuthViewController alloc] initWithAppKey:@"123I_am_a_client_id_567890"
                                                                     appSecret:@"shhhhhh, I'm a secret"
                                                                   callbackURL:[NSURL URLWithString:@"http://your.fancy.site"]
                                                                    completion:^(DropboxLoginResponse *response, NSError *error) {
                                                                        NSLog(@"My Access Token is: %@", response.accessToken);
                                                                    }];
[self.navigationController pushViewController:viewController
                                     animated:YES];

// Disable error UIAlertViews Example:

DropboxSimpleOAuthViewController
    *viewController = [[DropboxSimpleOAuthViewController alloc] initWithAppKey:@"123I_am_a_client_id_567890"
                                                                     appSecret:@"shhhhhh, I'm a secret"
                                                                   callbackURL:[NSURL URLWithString:@"http://your.fancy.site"]
                                                                    completion:^(DropboxLoginResponse *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 specs.

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 DropboxSimpleOAuth for your in-app Dropbox authentication. Any feedback can be can be sent to: [email protected].

dropboxsimpleoauth's People

Contributors

rbaumbach avatar readmecritic avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.