-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Restructuring * Moved servererror package * Moved all service packages to services sub directory * Moved all service packages to services sub directory * Moved generated OpenAPI code to generated/ sub directory * Renamed email link service to email magic link service and email code service to email OTP service * Renamed SDK getter methods for email magic links and email OTPs * Renamed integration tests * Added SmsOTP service! * New README * Added error handling section to README * Fixed code examples in README * Tabs vs. spaces * Tabs vs. spaces * Run GitHub action on every branch push * Set version to 1.0.0 * Updated test email and test phone number, added more Go versions to GitHub matrix * Some cleanup, added email OTP and SMS OTP validate integration tests * Bugfix in GitHub workflow * Renamed some GitHub workflow jobs * More renames * Implemented user delete method, added more integration tests to user API * Added error stacks * Update ci_unittests.yml * Update ci_integrationtests.yml * Update ci_unittests.yml * Update ci_integrationtests.yml * Update ci_integrationtests.yml * Update ci_unittests.yml * Bugfix * PR feedback * Update README.md * Changed SDK header (added more infos) * Refactoring config handling and added validation, added session stdlib example, some other minor changes * Removed unused config variable * Renamed NewConfigEnv() to NewConfigFromEnv() * Polished session stdlib example * Extended session stdlib example * Moved internal packages to internal/ * Added missing directory * Moved entities to pkg/ * move logger from internal to pkg * Update README.md * Update README.md * Update README.md --------- Co-authored-by: Corbadovych <[email protected]>
- Loading branch information
1 parent
0793136
commit 93655ad
Showing
60 changed files
with
1,393 additions
and
538 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,44 +1,156 @@ | ||
| # Corbado Go SDK | ||
| <img width="1070" alt="GitHub Repo Cover" src="https://github.com/corbado/corbado-php/assets/18458907/aa4f9df6-980b-4b24-bb2f-d71c0f480971"> | ||
|
|
||
| Go SDK for Corbado Backend API | ||
| # Corbado Go SDK | ||
|
|
||
| [](https://pkg.go.dev/github.com/corbado/corbado-go) | ||
| [](https://packagist.org/packages/corbado/php-sdk) | ||
| [](https://github.com/corbado/corbado-go/actions?query=workflow%3Atests) | ||
| [](https://api.corbado.com/docs/api/) | ||
| [](https://goreportcard.com/report/github.com/corbado/corbado-go) | ||
| [](https://api.corbado.com/docs/api/) | ||
| [](https://join.slack.com/t/corbado/shared_invite/zt-1b7867yz8-V~Xr~ngmSGbt7IA~g16ZsQ) | ||
|
|
||
| ## Requirements | ||
| The [Corbado](https://www.corbado.com) Go SDK provides convenient access to the [Corbado Backend API](https://api.corbado.com/docs/api/) from applications written in the Go language. | ||
|
|
||
| The SDK supports Go version 1.18 and above. | ||
| :warning: The Corbado Go SDK is commonly referred to as a private client, specifically designed for usage within closed backend applications. This particular SDK should exclusively be utilized in such environments, as it is crucial to ensure that the API secret remains strictly confidential and is never shared. | ||
|
|
||
| ## Usage | ||
| :rocket: [Getting started](#rocket-getting-started) | :hammer_and_wrench: [Services](#hammer_and_wrench-services) | :books: [Advanced](#books-advanced) | :speech_balloon: [Support & Feedback](#speech_balloon-support--feedback) | ||
|
|
||
| ## :rocket: Getting started | ||
|
|
||
| ### Requirements | ||
|
|
||
| - Go 1.18 or later | ||
|
|
||
| ### Installation | ||
|
|
||
| Use the following command to install the Corbado Go SDK: | ||
|
|
||
| ```bash | ||
| go get github.com/corbado/[email protected] | ||
| ``` | ||
| $ go get github.com/corbado/[email protected] | ||
| ``` | ||
|
|
||
| Import SDK in your Go files: | ||
| ### Usage | ||
|
|
||
| To create a Corbado Go SDK instance you need to provide your `Project ID` and `API secret` which can be found at the [Developer Panel](https://app.corbado.com). | ||
|
|
||
| ```Go | ||
| package main | ||
|
|
||
| ```go | ||
| import "github.com/corbado/corbado-go" | ||
| import ( | ||
| "github.com/corbado/corbado-go" | ||
| ) | ||
|
|
||
| func main() { | ||
| config, err := corbado.NewConfig("<Project ID>", "<API secret>") | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| sdk, err := corbado.NewSDK(config) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| Now create a new SDK client: | ||
| ### Examples | ||
|
|
||
| A list of examples can be found in the [examples](/examples) directory. [Integration tests](tests/integration) are good examples as well. | ||
|
|
||
| ```go | ||
| config := corbado.MustNewConfig("pro-12345678", "yoursecret") | ||
| sdk, err := corbado.NewSDK(config) | ||
| ## :hammer_and_wrench: Services | ||
|
|
||
| The Corbado Go SDK provides the following services: | ||
|
|
||
| - `AuthTokens` for managing authentication tokens needed for own session management ([examples](tests/integration/authtoken)) | ||
| - `EmailMagicLinks` for managing email magic links ([examples](tests/integration/emailmagiclink)) | ||
| - `EmailOTPs` for managing email OTPs ([examples](tests/integration/emailotp)) | ||
| - `Sessions` for managing sessions ([examples](examples/sessionstdlib)) | ||
| - `SmsOTPs` for managing SMS OTPs ([examples](tests/integration/smsotp)) | ||
| - `Users` for managing users ([examples](tests/integration/user)) | ||
| - `Validations` for validating email addresses and phone numbers ([examples](tests/integration/validation)) | ||
|
|
||
| To use a specific service, such as `Users`, invoke it as shown below: | ||
|
|
||
| ```Go | ||
| users, err := sdk.Users().List(context.Background(), nil) | ||
| if err != nil { | ||
| // handle error | ||
| panic(err) | ||
| } | ||
| ``` | ||
|
|
||
| // list all users | ||
| users, err := sdk.Users().List(context.TODO(), nil) | ||
| if err != nil { | ||
| if serverErr := corbado.AsServerError(err); serverErr != nil { | ||
| // handle server error | ||
| ## :books: Advanced | ||
|
|
||
| ### Error handling | ||
|
|
||
| The Corbado Go SDK uses Go standard error handling (error interface). If the Backend API returns a HTTP status code other than 200, the Corbado Go SDK returns a `ServerError` error (which implements the error interface): | ||
|
|
||
| ```Go | ||
| package main | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
|
|
||
| "github.com/corbado/corbado-go" | ||
| ) | ||
|
|
||
| func main() { | ||
| config, err := corbado.NewConfig("<Project ID>", "<API secret>") | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| sdk, err := corbado.NewSDK(config) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| // Try to get non-existing user with ID 'usr-123456789' | ||
| user, err := sdk.Users().Get(context.Background(), "usr-123456789", nil) | ||
| if err != nil { | ||
| if serverErr := corbado.AsServerError(err); serverErr != nil { | ||
| // Show HTTP status code (404 in this case) | ||
| fmt.Println(serverErr.HTTPStatusCode) | ||
|
|
||
| // Show request ID (can be used in developer panel to look up the full request | ||
| // and response, see https://app.corbado.com/app/logs/requests) | ||
| fmt.Println(serverErr.RequestData.RequestID) | ||
|
|
||
| // Show runtime of request in seconds (server side) | ||
| fmt.Println(serverErr.Runtime) | ||
|
|
||
| // Show validation error messages (server side validation in case of HTTP | ||
| // status code 400 (Bad Request)) | ||
| fmt.Printf("%+v\n", serverErr.Validation) | ||
| } else { | ||
| // Handle other errors | ||
| panic(err) | ||
| } | ||
|
|
||
| return | ||
| } | ||
|
|
||
| fmt.Println(user.Data.ID) | ||
| } | ||
|
|
||
| ``` | ||
|
|
||
| See [examples](https://github.com/corbado/corbado-go/tree/main/examples) for some real example code | ||
| ## :speech_balloon: Support & Feedback | ||
|
|
||
| ### Report an issue | ||
|
|
||
| If you encounter any bugs or have suggestions, please [open an issue](https://github.com/corbado/corbado-go/issues/new). | ||
|
|
||
| ### Slack channel | ||
|
|
||
| Join our Slack channel to discuss questions or ideas with the Corbado team and other developers. | ||
|
|
||
| [](https://join.slack.com/t/corbado/shared_invite/zt-1b7867yz8-V~Xr~ngmSGbt7IA~g16ZsQ) | ||
|
|
||
|
|
||
| You can also reach out to us via email at [email protected]. | ||
|
|
||
| ### Vulnerability reporting | ||
|
|
||
| Please report suspected security vulnerabilities in private to [email protected]. Please do NOT create publicly viewable issues for suspected security vulnerabilities. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.