Skip to content

Commit

Permalink
PSG-3120: openAPI codegen (#34)
Browse files Browse the repository at this point in the history 
* feat: use codegen for API requests

* chore: bump version
  • Loading branch information
@bertrmz
bertrmz authored Nov 1, 2023
1 parent d1efa46 commit 13c749f
Show file tree
Hide file tree
Showing 8 changed files with 3,001 additions and 417 deletions.
187 changes: 54 additions & 133 deletions app.go
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
package passage

import (
"fmt"
"net/http"
"context"

jwkLibrary "github.com/lestrrat-go/jwx/jwk"
)
Expand All @@ -16,19 +15,29 @@ type App struct {
ID string
JWKS jwkLibrary.Set
Config *Config
client *ClientWithResponses
}

func New(appID string, config *Config) (*App, error) {
if config == nil {
config = &Config{}
}

client, err := NewClientWithResponses(
"https://api.passage.id/v1/",
withPassageVersion,
withAPIKey(config.APIKey),
)
if err != nil {
return nil, err
}

app := App{
ID: appID,
Config: config,
client: client,
}

var err error
app.JWKS, err = app.fetchJWKS()
if err != nil {
return nil, err
Expand All @@ -39,152 +48,64 @@ func New(appID string, config *Config) (*App, error) {

var jwkCache map[string]jwkLibrary.Set = make(map[string]jwkLibrary.Set)

type ChannelType string

const (
EmailChannel ChannelType = "email"
PhoneChannel ChannelType = "phone"
)

type MagicLinkType string

const (
LoginType MagicLinkType = "login"
VerifyIdentifierType MagicLinkType = "verify_identifier"
)

type CreateMagicLinkBody struct {
UserID string `json:"user_id"`
Email string `json:"email"`
Phone string `json:"phone"`
Channel ChannelType `json:"channel"`
Send bool `json:"send"`
MagicLinkPath string `json:"magic_link_path"`
RedirectURL string `json:"redirect_url"`
TTL int `json:"ttl"`
Language string `json:"language"`
Type MagicLinkType `json:"type,omitempty"`
}

type MagicLink struct {
ID string `json:"id"`
Secret string `json:"secret"`
Activated bool `json:"activated"`
UserID string `json:"user_id"`
AppID string `json:"app_id"`
Identifier string `json:"identifier"`
Type string `json:"type"`
RedirectURL string `json:"redirect_url"`
TTL int `json:"ttl"`
URL string `json:"url"`
}
type AppInfo struct {
Name string `json:"name"` // The name of the App
ID string `json:"id"` // The appID of the App
AuthOrigin string `json:"auth_origin"` // The url being used for the App's authentication
RedirectURL string `json:"redirect_url"` // Where users should be redirected on successful authentication
LoginURL string `json:"login_url"` // Where users should attempt to log in
PublicKey string `json:"rsa_public_key"` // The PublicKey associated with the app.
AllowedIdentifier string `json:"allowed_identifier"` // Which identifier(s) are allowed for this app (email, phone, both)
RequireIdentifierVerification bool `json:"require_identifier_verification"` // Whether this app requires identifier verification
SessionTimeoutLength int `json:"session_timeout_length"` // How long a JWT will last for the app when a user logs in
RefreshEnabled bool `json:"refresh_enabled"` // Whether this app has refresh tokens enabled
RefreshAbsoluteLifetime int `json:"refresh_absolute_lifetime"` // The absolute lifetime of a refresh token in seconds
RefreshInactivityLifetime int `json:"refresh_inactivity_lifetime"` // The inactivity lifetime of a refresh token in seconds
UserMetadataSchemaResponse []UserMetadataField `json:"user_metadata_schema"` // The schema for user_metadata that will be stored about users
Layouts Layouts `json:"layouts"` // The layouts of user_metadata on the register/profile element
DefaultLanguage string `json:"default_language"` // The default_language to be used by the app
AuthFallbackMethod string `json:"auth_fallback_method"` // The fallback method to be used by the app
AuthFallbackMethodTTL int `json:"auth_fallback_method_ttl"` // The fallback method ttl to be used by the app
}
type UserMetadataField struct {
Handle string `json:"id"` // Unique id for the user metadata field
FieldName string `json:"field_name"` // The name that will be used in user requests to create/update user_metadata
FieldType UserMetadataFieldType `json:"type"` // The type of data stored in this field
FriendlyName string `json:"friendly_name"` // The human readable name for this field
Registration bool `json:"registration"` // Whether or not this field will be accepted on user registration
Profile bool `json:"profile"` // Whether or not this field can be updated via the passage-profile
}

type UserMetadataFieldType string

const (
StringMD UserMetadataFieldType = "string"
BooleanMD UserMetadataFieldType = "boolean"
NumberMD UserMetadataFieldType = "integer"
DateMD UserMetadataFieldType = "date"
PhoneMD UserMetadataFieldType = "phone"
EmailMD UserMetadataFieldType = "email"
)

type Layouts struct {
Registration []LayoutConfig `json:"registration"` // The UI layout for user_metadata in the passage-register/passage-auth element
Profile []LayoutConfig `json:"profile"` // The UI layout for user_metadata in the passage-profile element
}

type LayoutConfig struct {
ID string `json:"id"`
X uint `json:"x"`
Y uint `json:"y"`
W uint `json:"w"`
H uint `json:"h"`
}

// GetApp gets information about an app
// returns App on success, error on failure
func (a *App) GetApp() (*AppInfo, error) {
type respAppInfo struct {
App AppInfo `json:"app"`
}
var appResp respAppInfo
var errorResponse HTTPError

response, err := newRequest().
SetResult(&appResp).
SetError(&errorResponse).
Get(fmt.Sprintf("https://api.passage.id/v1/apps/%v", a.ID))
res, err := a.client.GetAppWithResponse(context.Background(), a.ID)
if err != nil {
return nil, Error{Message: "network error: failed to get Passage App Info"}
}
if response.StatusCode() != http.StatusOK {
return nil, Error{
Message: "failed to get Passage App Info",
StatusCode: response.StatusCode(),
StatusText: http.StatusText(response.StatusCode()),
ErrorText: errorResponse.ErrorText,
}

if res.JSON200 != nil {
return &res.JSON200.App, nil
}

return &appResp.App, nil
var errorText string
switch {
case res.JSON401 != nil:
errorText = res.JSON401.Error
case res.JSON404 != nil:
errorText = res.JSON404.Error
case res.JSON500 != nil:
errorText = res.JSON500.Error
}

return nil, Error{
Message: "failed to get Passage App Info",
StatusCode: res.StatusCode(),
StatusText: res.Status(),
ErrorText: errorText,
}
}

// CreateMagicLink receives a CreateMagicLinkBody struct, creating a magic link with provided values
// returns MagicLink on success, error on failure
func (a *App) CreateMagicLink(createMagicLinkBody CreateMagicLinkBody) (*MagicLink, error) {

type respMagicLink struct {
MagicLink MagicLink `json:"magic_link"`
}
var magicLinkResp respMagicLink
var errorResponse HTTPError

response, err := newRequest().
SetResult(&magicLinkResp).
SetError(&errorResponse).
SetBody(&createMagicLinkBody).
SetAuthToken(a.Config.APIKey).
Post(fmt.Sprintf("https://api.passage.id/v1/apps/%v/magic-links/", a.ID))
res, err := a.client.CreateMagicLinkWithResponse(context.Background(), a.ID, createMagicLinkBody)
if err != nil {
return nil, Error{Message: "network error: failed to create Passage Magic Link"}
}
if response.StatusCode() != http.StatusCreated {
return nil, Error{
Message: "failed to create Passage Magic Link",
StatusCode: response.StatusCode(),
StatusText: http.StatusText(response.StatusCode()),
ErrorText: errorResponse.ErrorText,
}

if res.JSON201 != nil {
return &res.JSON201.MagicLink, nil
}

var errorText string
switch {
case res.JSON400 != nil:
errorText = res.JSON400.Error
case res.JSON401 != nil:
errorText = res.JSON401.Error
case res.JSON404 != nil:
errorText = res.JSON404.Error
case res.JSON500 != nil:
errorText = res.JSON500.Error
}

return &magicLinkResp.MagicLink, nil
return nil, Error{
Message: "failed to create Passage Magic Link",
StatusCode: res.StatusCode(),
StatusText: res.Status(),
ErrorText: errorText,
}
}
71 changes: 71 additions & 0 deletions generate.sh
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# #!/bin/bash
set -euo pipefail

output_file="passage.gen.go"

# Skip pointer on optional fields
fields="\
.components.schemas.CreateUserRequest.properties.email \
.components.schemas.CreateUserRequest.properties.phone \
.components.schemas.CreateUserRequest.properties.user_metadata \
.components.schemas.UpdateUserRequest.properties.email \
.components.schemas.UpdateUserRequest.properties.phone \
.components.schemas.UpdateUserRequest.properties.user_metadata \
.components.schemas.CreateMagicLinkRequest.properties.language \
.components.schemas.MagicLinkType \
.components.schemas.UserInfo.properties.user_metadata \
.components.schemas.UserInfo.properties.webauthn_types"
for field in $fields; do
jq "$field |= . + {\"x-go-type-skip-optional-pointer\": true}" openapi.json > tmp.json && mv tmp.json openapi.json
done

# JSON string of key-value pairs
transforms='{
"Active": "StatusActive",
"CreateMagicLinkRequest": "CreateMagicLinkBody",
"CreateUserRequest": "CreateUserBody",
"Inactive": "StatusInactive",
"Login": "LoginType",
"MagicLinkChannel": "ChannelType",
"MagicLinkChannelEmail": "EmailChannel",
"MagicLinkChannelPhone": "PhoneChannel",
"Pending": "StatusPending",
"UpdateUserRequest": "UpdateBody",
"UserInfo": "User",
"UserMetadataFieldTypeBoolean": "BooleanMD",
"UserMetadataFieldTypeDate": "DateMD",
"UserMetadataFieldTypeEmail": "EmailMD",
"UserMetadataFieldTypeInteger": "IntegerMD",
"UserMetadataFieldTypePhone": "PhoneMD",
"UserMetadataFieldTypeString": "StringMD",
"VerifyIdentifier": "VerifyIdentifierType"
}'

# Function to perform replacements
command -v gorename &> /dev/null || go install golang.org/x/tools/cmd/gorename@latest
replace() {
local in=$1 out=$2
gorename -from "\"github.com/passageidentity/passage-go\".$in" -to "$out" -force
}

# Un-apply transforms
echo "$transforms" | jq -r 'to_entries[] | "\(.key) \(.value)"' | while read -r key value; do
replace "$value" "$key"
done

# Run codegen
go run github.com/deepmap/oapi-codegen/cmd/oapi-codegen@v1.16.2 \
-generate types,client \
-package passage \
-o "$output_file" \
-initialism-overrides \
openapi.json

# Replace initialisms with uppercase versions
perl -pe 's/(Url|Uri|Ttl|Id|Rsa|Ip)(s?)(?=\b|[A-Z])/\U$1\E$2/g' "$output_file" > tmp.txt && mv tmp.txt "$output_file"

# Apply transforms
echo "$transforms" | jq -r 'to_entries[] | "\(.key) \(.value)"' | while read -r key value; do
replace "$key" "$value"
done

2 changes: 1 addition & 1 deletion go.mod
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ require (
github.com/golang-jwt/jwt v3.2.2+incompatible
github.com/joho/godotenv v1.4.0
github.com/lestrrat-go/jwx v1.2.26
github.com/oapi-codegen/runtime v1.0.0
github.com/stretchr/testify v1.8.4
gopkg.in/resty.v1 v1.12.0
)
Loading

0 comments on commit 13c749f

Please sign in to comment.