react-native-social-auth

React Native module provides auth methods via social networks using native APIs

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
react-native-social-auth
2.0.07 years ago8 years agoMinified + gzip package size for react-native-social-auth in KB

Readme

React Native Social Auth

React Native module provides auth methods via social networks using native APIs.

Very important! The module doesn't provide full stack communication with social networks API, it made just for auth.

preview

Table of contents

- Common - iOS - Android - Facebook - Twitter

Dependencies

  • React Native >= 0.40.0 (use 0.5 branch that works with previous versions of RN)

What using

  • facebook
- FacebookSDK
  • twitter
- __Accounts.framework and reverse auth (iOS)__

Example

here

Installation

Common

  1. Install package via npm:

```javascript
npm install react-native-social-auth
```
  1. Inside your code include JS part by adding

```javascript import SocialAuth from 'react-native-social-auth'; ```
Perform platform specific setup
- [iOS](ios#readme)
- [Android](android#readme)

Usage

Facebook

Constants

- SocialAuth.facebookPermissionsType.read - SocialAuth.facebookPermissionsType.write

setFacebookApp({id, name})

SocialAuth.setFacebookApp({id: 'APP_ID', name: 'DISPLAY_NAME'});

getFacebookCredentials(permissions, permissionsType)

- permissions (Array of strings) - permissionsType (one of facebookPermissionsType)
returns a promise
- resolved with credentials (object contains accessToken, userId, hasWritePermissions) - rejected with error (object contains code and message)
SocialAuth.getFacebookCredentials(["email", "user_friends"], SocialAuth.facebookPermissionsType.read)
.then((credentials) => console.log(credentials));
.catch((error) => console.log(error))

Twitter

getTwitterSystemAccounts()

returns a promise
- resolved with accounts (array of objects like {username: "userName"}) - rejected with error (object contains code and message)
SocialAuth.getTwitterSystemAccounts()
.then((accounts) => console.log(accounts))
.catch((error) => console.log(error));

getTwitterCredentials(username, reverseAuthResponse)

- username (Twitter account user name without @) - reverseAuthResponse (is a string that returns by twitter's api when we do the first part of reverse auth)
- __you can define `key` and `secret` of your twitter app in [RNSocialAuthManager.m](ios/RNSocialAuthManager.m)__
```
#define twitterAppConsumerKey @"..."
#define twitterAppConsumerSecret @"..."
```
#### But this way is not SAFE!

- other option is that your server can perform the first part of reverse auth and send you back response of it.
  It looks like this
  ```
  OAuth oauth_timestamp="...", oauth_signature="...", oauth_consumer_key="...", oauth_nonce="...", oauth_token="...", oauth_signature_method="HMAC-SHA1", oauth_version="1.0"
  ```
  Then you just pass it to the function as a second parameter
returns a promise
- resolved with credentials (object contains oauthToken, oauthTokenSecret, userName) - rejected with error (object contains code and message)
SocialAuth.getTwitterCredentials("dimkol")
.then((credentials) => console.log(credentials))
.catch((error) => console.log(error));

Contributing

Just submit a pull request!

Copyright and license

Code and documentation copyright 2015 Dmitriy Kolesnikov. Code released under the MIT license.