Github OAuth Client Library - Android

The Github_OAuth library helps to easily add a Github's OAuth implementation flow to your Android application.

It will open a new Dialog Fragment with webview and user token will be returned on callback.

Find more about GitHub's OAuth implementation

Let’s go through a sample application that authenticate using Github. complete source code of this library and sample application is available on Github.

Setup

Using Gradle

The Github-OAuth library is pushed to jcenter, so you need to add the following dependency to your app's build.gradle.

	dependencies {
	implementation 'com.github.rahul:github-oauth:1.0'
	implementation 'com.squareup.okhttp3:okhttp:3.8.0'
	}

view raw build.gradle hosted with ❤ by GitHub

As a module

If you can't include it as gradle dependency, you can also download this GitHub repo and copy the library folder to your project.

Usage

Obtaining GithubAuthenticator instance

	val githubAuthenticatorBuilder = GithubAuthenticator.builder(this)
	.clientId(GITHUB_ID)
	.clientSecret(GITHUB_SECRET)
	.onSuccess(object : SuccessCallback {
	override fun onSuccess(result: String) {
	runOnUiThread {
	Toast.makeText(this@MainActivity, result,
	Toast.LENGTH_LONG).show()
	}
	}
	})
	.onError(object : ErrorCallback {
	override fun onError(error: Exception) {
	runOnUiThread {
	Toast.makeText(this@MainActivity, error.message,
	Toast.LENGTH_LONG).show()
	}
	}
	})
	val githubAuthenticator = githubAuthenticatorBuilder.build()

view raw MainActivity.kt hosted with ❤ by GitHub

Obtaining an access token via the GithubAuthenticator

githubAuthenticator.authenticate()

view raw MainActivity.kt hosted with ❤ by GitHub

Authenticate will open a new Dialog Fragment with webview and user token will be returned on callback

Enable logs

githubAuthenticatorBuilder.debug(true)

view raw MainActivity.kt hosted with ❤ by GitHub

Scope can also be defined (optional)

githubAuthenticatorBuilder.scopeList(arrayListOf("scope1", "scope2"))

view raw MainActivity.kt hosted with ❤ by GitHub

Available scopes are from developer page