Skip to content

Commit

Permalink
Merge pull request #29 from tinkoff-mobile-tech/MC-9610
Browse files Browse the repository at this point in the history 
MС-9610 improve webveiew auth flow
  • Loading branch information
@mrkiriss
mrkiriss authored Jul 26, 2023
2 parents 611521a + d45c07c commit 5e6a253
Show file tree
Hide file tree
Showing 5 changed files with 71 additions and 28 deletions.
30 changes: 28 additions & 2 deletions MIGRATION.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,32 @@

## 1.0.6 -> 1.1.0

Переименованы методы класса `TinkoffIdAuth`:
В связи с добавлением альтернативного способа авторизации через веб Тинькофф с помощью WebView,
переработана логика метода `createTinkoffAuthIntent(callbackUrl: Uri): Intent`. Теперь внутри него, на основе значения
`isTinkoffAppAuthAvailable(): Boolean`, происходит создание Intent для открытия или приложения Тинькофф,
или `TinkoffWebViewAuthActivity` (для прохождения авторизации в вебе).

Рекомендуется использовать `createTinkoffAuthIntent(callbackUrl: Uri): Intent`, чтобы пользователю в любом случае была
доступна авторизации через Тинькофф:

**Before**:

```kotlin
if (tinkoffPartnerAuth.isTinkoffAuthAvailable()) {
val intent = tinkoffPartnerAuth.createTinkoffAuthIntent(callbackUrl)
startActivity(intent)
} else {
// The logic of disabling authorization via Tinkoff
}
```

**After**:

```kotlin
val intent = tinkoffPartnerAuth.createTinkoffAuthIntent(callbackUrl)
startActivity(intent)
```

Изменения в методах класса `TinkoffIdAuth`:
- `createTinkoffAuthIntent(callbackUrl: Uri): Intent` -> `createTinkoffAppAuthIntent(callbackUrl: Uri): Intent`
- `isTinkoffAuthAvailable(): Boolean ` -> `isTinkoffAppAuthAvailable(): Boolean `
- `isTinkoffAuthAvailable(): Boolean` -> `isTinkoffAppAuthAvailable(): Boolean`
43 changes: 23 additions & 20 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,26 +46,28 @@ implementation "ru.tinkoff.core.tinkoffauth:tinkoff-id:${version}"
### Начало

Все необходимое взаимодействие в библиотеке идет только через класс `TinkoffIdAuth`.

Чтобы начать авторизациию через Тинькофф, создайте Intent с помощью `tinkoffIdAuth.createTinkoffAuthIntent(callbackUrl)` и запустите его.
Внутри этого метода автоматически происходит создание Intent для открытия приложения Тинькофф, если оно доступно, иначе создается Intent
для открытия `TinkoffWebViewAuthActivity`, в котором возможно прохождение авторизации через веб Тинькофф.

Вы также сами можете выбирать, какой способ авторизации использовать.
Сперва проверьте, есть ли возможность пройти авторизацию через приложение Тинькофф.
Для этого используйте `tinkoffIdAuth.isTinkoffAppAuthAvailable()`.
Когда флаг `isTinkoffAppAuthAvailable == true`, значит у пользователя установлено приложение Тинькофф,
через которое можно осуществить вход, используя `tinkoffPartnerAuth.createTinkoffAppAuthIntent(callbackUrl)`.
Иначе можно запустить сценарий авторизации через WebView, использую `tinkoffPartnerAuth.createTinkoffWebViewAuthIntent(callbackUrl)`.
Если флаг `isTinkoffAppAuthAvailable == true`, значит у пользователя установлено приложение Тинькофф,
через которое можно осуществить вход, используя `tinkoffIdAuth.createTinkoffAppAuthIntent(callbackUrl)`.
Иначе можно запустить сценарий авторизации через WebView, используя `tinkoffIdAuth.createTinkoffWebViewAuthIntent(callbackUrl)`.

### Выполнение авторизации

Для авторизации:
1. Необходимо создать объект `TinkoffIdAuth(applicationContext, clientId, redirectUri)` - это основной класс для работы с библиотекой.
2. На основе значения `tinkoffIdAuth.isTinkoffAppAuthAvailable()` выбрать способ авторизации. Запустить партнерскую авторизацию, передав в качестве аргумента `callbackUrl` ваш AppLink/DeepLink (по данному uri приложение группы Тинькофф вернется обратно после процесса авторизации)
2. Создать Intent для выбранного способа авторизации, передав в качестве аргумента `callbackUrl` - ваш AppLink/DeepLink (по данному uri приложение группы Тинькофф вернется обратно после процесса авторизации), запустить его
```kotlin
val intent = if (tinkoffPartnerAuth.isTinkoffAppAuthAvailable()) {
tinkoffPartnerAuth.createTinkoffAppAuthIntent(callbackUrl)
} else {
tinkoffPartnerAuth.createTinkoffWebViewAuthIntent(callbackUrl)
}
val intent = tinkoffIdAuth.createTinkoffAuthIntent(callbackUrl)
startActivity(intent)
```
3. После прохождения пользователем авторизации в приложении Тинькофф, произойдет переход в ваше приложение на основе `callbackUrl`. В `intent.data` будет храниться информация по авторизации.
3. После прохождения пользователем авторизации через Тинькофф, произойдет переход в ваше приложение на основе `callbackUrl`. В `intent.data` будет храниться информация по авторизации.

### Завершение авторизации
Успешность авторизации можно проверить методом - `tinkoffIdAuth.getStatusCode(uriFromIntentData)`. Метод вернет статус `SUCCESS` или `CANCELLED_BY_USER`
Expand Down Expand Up @@ -139,16 +141,17 @@ implementation "ru.tinkoff.core.tinkoffauth:tinkoff-id:${version}"

Базовый класс для работы c авторизацией

| Функция | Описание |
| ---------------------------- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `isTinkoffAppAuthAvailable(): Boolean` | Выполняет проверку возможна ли авторизация через приложения группы Тинькофф на данном устройстве |
| `createTinkoffAppAuthIntent(callbackUrl: Uri): Intent` | Создает Intent для открытия приложения группы Тинькофф для прохождения авторизации. На вход принимает Uri для создания AppLink/DeepLink, по которому будет осуществлен переход после окончания процесса авторизации |
| `createTinkoffWebViewAuthIntent(callbackUrl: Uri): Intent` | Создает Intent для открытия `TinkoffWebViewAuthActivity` для прохождения авторизации в вебе. На вход принимает Uri для создания AppLink/DeepLink, по которому будет осуществлен переход после окончания процесса авторизации |
| `getTinkoffTokenPayload(uri: Uri): TinkoffCall<TinkoffTokenPayload>` | Возвращает объект, который позволяет получить синхронно информацию о токене, которая придет к вам в `intent.data` после авторизации в Тинькофф |
| `getStatusCode(uri: Uri): TinkoffIdStatusCode?` | Позволяет получить статус выполнения авторизации из `intent.data` пришедшего к вам |
| `obtainTokenPayload(refreshToken: String): TinkoffCall<TinkoffTokenPayload>` | Возвращает объект, который позволяет синхронно обновить токен по рефреш токену полученному ранее |
| `signOutByAccessToken(accessToken: String): TinkoffCall<Unit>` | Возвращает объект, который позволяет синхронно разлогинить по accessToken |
| `signOutByRefreshToken(refreshToken: String): TinkoffCall<Unit>` | Возвращает объект, который позволяет синхронно разлогинить по refreshToken |
| Функция | Описание |
| ---------------------------- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `createTinkoffAuthIntent(callbackUrl: Uri): Intent` | Создает Intent для открытия приложения группы Тинькофф, если оно доступно, иначе для `TinkoffWebViewAuthActivity`, чтобы авторизоваться через веб Тинькофф. На вход принимает Uri для создания AppLink/DeepLink, по которому будет осуществлен переход после окончания процесса авторизации |
| `isTinkoffAppAuthAvailable(): Boolean` | Выполняет проверку возможна ли авторизация через приложения группы Тинькофф на данном устройстве |
| `createTinkoffAppAuthIntent(callbackUrl: Uri): Intent` | Создает Intent для открытия приложения группы Тинькофф для прохождения авторизации. На вход принимает Uri для создания AppLink/DeepLink, по которому будет осуществлен переход после окончания процесса авторизации |
| `createTinkoffWebViewAuthIntent(callbackUrl: Uri): Intent` | Создает Intent для открытия `TinkoffWebViewAuthActivity` для прохождения авторизации в вебе. На вход принимает Uri для создания AppLink/DeepLink, по которому будет осуществлен переход после окончания процесса авторизации |
| `getTinkoffTokenPayload(uri: Uri): TinkoffCall<TinkoffTokenPayload>` | Возвращает объект, который позволяет получить синхронно информацию о токене, которая придет к вам в `intent.data` после авторизации в Тинькофф |
| `getStatusCode(uri: Uri): TinkoffIdStatusCode?` | Позволяет получить статус выполнения авторизации из `intent.data` пришедшего к вам |
| `obtainTokenPayload(refreshToken: String): TinkoffCall<TinkoffTokenPayload>` | Возвращает объект, который позволяет синхронно обновить токен по рефреш токену полученному ранее |
| `signOutByAccessToken(accessToken: String): TinkoffCall<Unit>` | Возвращает объект, который позволяет синхронно разлогинить по accessToken |
| `signOutByRefreshToken(refreshToken: String): TinkoffCall<Unit>` | Возвращает объект, который позволяет синхронно разлогинить по refreshToken |

### TinkoffCall`<T>`

Expand Down
6 changes: 1 addition & 5 deletions app-demo/src/main/java/ru/tinkoff/core/app_demo_partner/PartnerActivity.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,7 @@ class PartnerActivity : AppCompatActivity() {
val clickListener = View.OnClickListener {
if (isDataCorrect()) {
initTinkoffIdAuth()
val intent = if (tinkoffPartnerAuth.isTinkoffAppAuthAvailable()) {
tinkoffPartnerAuth.createTinkoffAppAuthIntent(callbackUrl)
} else {
tinkoffPartnerAuth.createTinkoffWebViewAuthIntent(callbackUrl)
}
val intent = tinkoffPartnerAuth.createTinkoffAuthIntent(callbackUrl)
startActivity(intent)
}
}
Expand Down
19 changes: 18 additions & 1 deletion tinkoff-id/src/main/java/ru/tinkoff/core/tinkoffId/TinkoffIdAuth.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,24 @@ public class TinkoffIdAuth(
}

/**
* Creates an intent to open Tinkoff App and later return authorization data.
* Creates an intent to open Tinkoff App or WebView Activity for authorization via Tinkoff web
* based on the results of the method [isTinkoffAppAuthAvailable()][isTinkoffAppAuthAvailable]
* and later return authorization data.
*
* @param callbackUrl AppLink/DeepLink that will be opened when authorization process finishes
* @return intent for authorization via Tinkoff
*/
@RequiresApi(Build.VERSION_CODES.M)
public fun createTinkoffAuthIntent(callbackUrl: Uri): Intent {
return if (isTinkoffAppAuthAvailable()) {
createTinkoffAppAuthIntent(callbackUrl)
} else {
createTinkoffWebViewAuthIntent(callbackUrl)
}
}

/**
* Creates an intent to open Tinkoff App and later returns authorization data.
*
* @param callbackUrl AppLink/DeepLink that will be opened when authorization process finishes
* @return implicit Intent to open Tinkoff App
Expand Down
1 change: 1 addition & 0 deletions tinkoff-id/src/main/java/ru/tinkoff/core/tinkoffId/ui/webView/TinkoffWebViewAuthActivity.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ internal class TinkoffWebViewAuthActivity : AppCompatActivity() {
}

private fun finish(intent: Intent) {
intent.setPackage(packageName)
startActivity(intent)
finish()
}
Expand Down

0 comments on commit 5e6a253

Please sign in to comment.