Git Product home page Git Product logo

gauth-sdk-kotlin's Introduction

GAuth SDK Kotlin

Dependency

Gradle

repositories

// build.gradle
maven { url 'https://jitpack.io' }

// or

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

dependencies

// 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

<repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
</repository>

dependencies

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

Configuration

Bean

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

DI

@Component
public class Component{
	private GAuth gAuth;

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

Code

해당 메서드를 통해 발급 가능

gAuth.generateCode(email, password);
public class GAuthCode {
    private String code;
}

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


Token

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

gAuth.generateToken(code, clientId, clientSecret, redirectUri);

이메일, 패스워드, 클라이언트 아이디, 클라이언트 시크릿, 리다이렉트 uri를 사용해서 토큰을 발급할 수도 있고,

코드, 클라이언트 아이디, 클라이언트 시크릿, 리다이렉트 uri를 사용해서 발급할 수도 있다.

public class GAuthToken {
    private String accessToken;
    private String refreshToken;
}

토큰 발급 후 해당 객체를 리턴한다.


Refresh Token

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

gAuth.refresh(refreshToken);
public class GAuthToken {
    private String accessToken;
    private String refreshToken;
}

토큰 발급 후 해당 객체를 리턴한다.


User Info

gAuth.getUserInfo(accessToken);

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

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's People

Contributors

esperar avatar umjiseung avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

gauth-sdk-kotlin's Issues

변경된 url 수정

Describe

변경된 배포서버와 리소스 서버 url을 수정하겠습니다

Additional

No response

SDK Code 리팩토링

Describe

소프트웨이브에서 GAuth SDK Kotlin을 리뷰해주신 개발자분의 의견에 따라
전반적인 코드를 깔끔하게 리팩터링해보겠습니다.

Additional

No response

README 수정

Describe

릴리즈된 버전에 따른 리드미 수정

Additional

No response

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.