GAuth-SDK-Kotlin

KO | EN

gitlite — search

#python #java #android #nodejs #php #docker #hacktoberfest #ruby #spark #elixir #erlang #search-engine

GAuth-SDK-Kotlin

★ 17 Open GitHub ↗

GAuth Software Development Kit in Kotlin

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# GAuth SDK Kotlin

## Dependency

### Gradle
repositories
```gradle
// build.gradle
maven { url 'https://jitpack.io' }

// or

// build.gradle.kts
maven { url = uri("https://jitpack.io") }
```

dependencies
```gradle
// build.gradle
implementation 'com.github.GSM-MSG:GAuth-SDK-Kotlin:v1.0.1'

// or

// build.gradle.kt
implementation("com.github.GSM-MSG:GAuth-SDK-Kotlin:v1.0.1")
```

### Maven
repositories
```html
<repository>
 <id>jitpack.io</id>
 <url>https://jitpack.io</url>
</repository>
```

dependencies
```html
<dependency>
	 <groupId>com.github.GSM-MSG</groupId>
	 <artifactId>GAuth-SDK-Kotlin</artifactId>
	 <version>v1.0.1</version>
</dependency>
```

## Configuration

### Bean 
```java
@Bean
public GAuth gauth() {
	return new GAuthImpl();
}
```

### DI
```java
@Component
public class Component{
	private GAuth gAuth;

public Component(GAuth gAuth){
		this.gAuth = gAuth;
	}
}
```

## Code
해당 메서드를 통해 발급 가능
```java
gAuth.generateCode(email, password);
```

```java
public class GAuthCode {
    private String code;
}
```

코드 발급후 해당 객체를 리턴한다.

## Token

```java
gAuth.generateToken(email, password, clientId, clientSecret, redirectUri);

gAuth.generateToken(code, clientId, clientSecret, redirectUri);
```
이메일, 패스워드, 클라이언트 아이디, 클라이언트 시크릿, 리다이렉트 uri를 사용해서 토큰을 발급할 수도 있고,
  
코드, 클라이언트 아이디, 클라이언트 시크릿, 리다이렉트 uri를 사용해서 발급할 수도 있다.

```java
public class GAuthToken {
    private String accessToken;
    private String refreshToken;
}
```
토큰 발급 후 해당 객체를 리턴한다.

## Refresh Token

refreshToken을 통해서 토큰을 발급할 수 있다.

```java
gAuth.refresh(refreshToken);
```

```java
public class GAuthToken {
    private String accessToken;
    private String refreshToken;
}
```
토큰 발급 후 해당 객체를 리턴한다.

## User Info

```java
gAuth.getUserInfo(accessToken);
```

accessToken을 사용해 유저 정보를 가져올 수 있다.

```java
public class GAuthUserInfo {
    private String email;
    private String name;
    private Integer grade;
    private Integer classNum;
    private Integer num;
    private String gender; // MALE | FEMALE
    private String profileUrl;
    private String role; // ROLE_STUDENT | ROLE_TEACHER
}
```

유저 정보를 해당 객체에 담아서 리턴한다.
  
> grade, classNum, num, number, gender, profileUrl은 nullable로  
> GAuth SDK Java는 Type!를 반환하지만(문제는 없음) GAuth SDK Kotlin은 Type?를 반환한다.

### Exception
응답코드가 200이 아니면 예외코드를 담은 GAuthException을 throw한다.

GAuth-SDK-Kotlin

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README