Compare commits

..

No commits in common. "main" and "v1.4.0" have entirely different histories.
main ... v1.4.0

7 changed files with 119 additions and 122 deletions

View file

@ -7,11 +7,12 @@
gleam add spacetraders_sdk@1 gleam add spacetraders_sdk@1
``` ```
```gleam ```gleam
import spacetraders_api import spacetraders_sdk
pub fn main() -> Nil { pub fn main() -> Nil {
let assert Ok(server_status) = spacetraders_api.get_server_status() let assert Ok(server_status) = get_server_status()
io.println(server_status.status) echo server_status
Nil
} }
``` ```

View file

@ -1,5 +1,5 @@
name = "spacetraders_sdk" name = "spacetraders_sdk"
version = "1.5.5" version = "1.4.0"
gleam = ">= 1.11.0" gleam = ">= 1.11.0"
description = "A Gleam SDK for the spacetraders.io game API" description = "A Gleam SDK for the spacetraders.io game API"
licences = ["MIT"] licences = ["MIT"]

View file

@ -56,11 +56,10 @@ import spacetraders_models/waypoint_modifier.{type WaypointModifier}
import spacetraders_models/waypoint_symbol.{type WaypointSymbol} import spacetraders_models/waypoint_symbol.{type WaypointSymbol}
import spacetraders_models/waypoint_trait_symbol.{type WaypointTraitSymbol} import spacetraders_models/waypoint_trait_symbol.{type WaypointTraitSymbol}
import spacetraders_models/waypoint_type.{type WaypointType} import spacetraders_models/waypoint_type.{type WaypointType}
import spacetraders_sdk.{ import spacetraders_sdk/internal/api.{
type AccountToken, type AgentToken, type ApiResponse, type PagedData, type AccountToken, type AgentToken, type ApiResponse, type PagedData,
AccountAuth, AgentAuth, NoAuth, AccountAuth, AgentAuth, NoAuth,
} }
import spacetraders_sdk/internal/api
import spacetraders_sdk/internal/time import spacetraders_sdk/internal/time
pub fn get_account(token: AgentToken) -> ApiResponse(Account) { pub fn get_account(token: AgentToken) -> ApiResponse(Account) {
@ -104,10 +103,7 @@ pub fn register_new_agent(
case response.status { case response.status {
201 -> 201 ->
api.parse_data_response(response, { api.parse_data_response(response, {
use token <- decode.field( use token <- decode.field("token", api.agent_token_decoder())
"token",
spacetraders_sdk.agent_token_decoder(),
)
use agent <- decode.field("agent", agent.decoder()) use agent <- decode.field("agent", agent.decoder())
use faction <- decode.field("faction", faction.decoder()) use faction <- decode.field("faction", faction.decoder())
use contract <- decode.field("contract", contract.decoder()) use contract <- decode.field("contract", contract.decoder())
@ -1673,7 +1669,6 @@ pub type ConstructionSiteSupplied {
} }
pub fn supply_construction_site( pub fn supply_construction_site(
token: AgentToken,
system_symbol: SystemSymbol, system_symbol: SystemSymbol,
waypoint_symbol: WaypointSymbol, waypoint_symbol: WaypointSymbol,
ship_symbol: ShipSymbol, ship_symbol: ShipSymbol,
@ -1682,7 +1677,7 @@ pub fn supply_construction_site(
) -> ApiResponse(ConstructionSiteSupplied) { ) -> ApiResponse(ConstructionSiteSupplied) {
let request = let request =
api.post_json( api.post_json(
AgentAuth(token), NoAuth,
"/systems/" "/systems/"
<> system_symbol.to_string(system_symbol) <> system_symbol.to_string(system_symbol)
<> "/waypoints/" <> "/waypoints/"

View file

@ -1,5 +1,4 @@
import gleam/dynamic/decode.{type Decoder} import gleam/dynamic/decode.{type Decoder}
import gleam/int
import gleam/json.{type Json} import gleam/json.{type Json}
pub opaque type ShipComponentCondition { pub opaque type ShipComponentCondition {
@ -18,11 +17,7 @@ pub fn parse(value: Float) -> Result(ShipComponentCondition, Nil) {
} }
pub fn decoder() -> Decoder(ShipComponentCondition) { pub fn decoder() -> Decoder(ShipComponentCondition) {
use value <- decode.then( use value <- decode.then(decode.float)
decode.one_of(decode.float, [
decode.then(decode.int, fn(i) { decode.success(int.to_float(i)) }),
]),
)
case parse(value) { case parse(value) {
Ok(ship_component_condition) -> decode.success(ship_component_condition) Ok(ship_component_condition) -> decode.success(ship_component_condition)
Error(Nil) -> Error(Nil) ->

View file

@ -1,5 +1,4 @@
import gleam/dynamic/decode.{type Decoder} import gleam/dynamic/decode.{type Decoder}
import gleam/int
import gleam/json.{type Json} import gleam/json.{type Json}
pub opaque type ShipComponentIntegrity { pub opaque type ShipComponentIntegrity {
@ -18,11 +17,7 @@ pub fn parse(value: Float) -> Result(ShipComponentIntegrity, Nil) {
} }
pub fn decoder() -> Decoder(ShipComponentIntegrity) { pub fn decoder() -> Decoder(ShipComponentIntegrity) {
use value <- decode.then( use value <- decode.then(decode.float)
decode.one_of(decode.float, [
decode.then(decode.int, fn(i) { decode.success(int.to_float(i)) }),
]),
)
case parse(value) { case parse(value) {
Ok(ship_component_integrity) -> decode.success(ship_component_integrity) Ok(ship_component_integrity) -> decode.success(ship_component_integrity)
Error(Nil) -> Error(Nil) ->

View file

@ -1,103 +1,33 @@
import gleam/dynamic.{type Dynamic} import spacetraders_sdk/internal/api
import gleam/dynamic/decode.{type Decoder}
import gleam/http/request.{type Request}
import gleam/httpc.{type HttpError}
import gleam/json.{type DecodeError}
import gleam/option.{type Option}
import gleam/result
import spacetraders_models/meta.{type Meta}
import spacetraders_sdk/internal/jwt
pub type ErrorResponse { pub type ApiResponse(data) =
ErrorResponse( api.ApiResponse(data)
code: Int,
message: String,
data: Option(Dynamic),
request_id: Option(String),
)
}
pub type ApiError { pub type ApiError =
HttpcError(HttpError) api.ApiError
JsonDecodeError(DecodeError)
ResponseError(ErrorResponse)
}
pub type ApiResponse(a) = pub type ErrorResponse =
Result(a, ApiError) api.ErrorResponse
pub type PagedData(data) { pub type PagedData(data) =
PagedData(data: data, meta: Meta) api.PagedData(data)
}
pub opaque type AccountToken { pub type AccountToken =
AccountToken(String) api.AccountToken
}
pub opaque type AgentToken { pub type AgentToken =
AgentToken(String) api.AgentToken
}
pub type TokenParseError { pub type TokenParseError =
InvalidToken api.TokenParseError
IncorrectType
}
pub type AuthMethod { pub type AuthMethod =
AccountAuth(AccountToken) api.AuthMethod
AgentAuth(AgentToken)
NoAuth
}
pub fn parse_account_token( pub const parse_account_token = api.parse_account_token
value: String,
) -> Result(AccountToken, TokenParseError) {
use jwt <- result.try(jwt.parse(value) |> result.replace_error(InvalidToken))
case jwt.payload.subject {
"account-token" -> Ok(AccountToken(value))
_ -> Error(IncorrectType)
}
}
pub fn account_token_decoder() -> Decoder(AccountToken) { pub const account_token_decoder = api.account_token_decoder
use value <- decode.then(decode.string)
case parse_account_token(value) {
Ok(token) -> decode.success(token)
Error(_) -> decode.failure(AccountToken("invalid"), "AccountToken")
}
}
pub fn account_token_to_string(account_token: AccountToken) -> String { pub const parse_agent_token = api.parse_agent_token
let AccountToken(value) = account_token
value
}
pub fn parse_agent_token(value: String) -> Result(AgentToken, TokenParseError) { pub const agent_token_decoder = api.agent_token_decoder
use jwt <- result.try(jwt.parse(value) |> result.replace_error(InvalidToken))
case jwt.payload.subject {
"agent-token" -> Ok(AgentToken(value))
_ -> Error(IncorrectType)
}
}
pub fn agent_token_decoder() -> Decoder(AgentToken) {
use value <- decode.then(decode.string)
case parse_agent_token(value) {
Ok(token) -> decode.success(token)
Error(_) -> decode.failure(AgentToken("invalid"), "AgentToken")
}
}
pub fn agent_token_to_string(agent_token: AgentToken) -> String {
let AgentToken(value) = agent_token
value
}
@internal
pub fn set_request_auth(req: Request(a), auth_method: AuthMethod) -> Request(a) {
case auth_method {
NoAuth -> req
AccountAuth(AccountToken(token)) | AgentAuth(AgentToken(token)) ->
req |> request.set_header("Authorization", "Bearer " <> token)
}
}

View file

@ -1,18 +1,99 @@
import gleam/bit_array import gleam/bit_array
import gleam/dynamic.{type Dynamic}
import gleam/dynamic/decode.{type Decoder} import gleam/dynamic/decode.{type Decoder}
import gleam/http.{type Method} import gleam/http.{type Method}
import gleam/http/request.{type Request} import gleam/http/request.{type Request}
import gleam/http/response.{type Response} import gleam/http/response.{type Response}
import gleam/httpc import gleam/httpc.{type HttpError}
import gleam/int import gleam/int
import gleam/json.{type Json} import gleam/json.{type DecodeError, type Json}
import gleam/option.{type Option} import gleam/option.{type Option}
import gleam/result import gleam/result
import gleam/string_tree import gleam/string_tree
import spacetraders_models/meta import spacetraders_models/meta.{type Meta}
import spacetraders_sdk.{ import spacetraders_sdk/internal/jwt
type ApiResponse, type AuthMethod, type ErrorResponse, type PagedData,
ErrorResponse, HttpcError, JsonDecodeError, PagedData, ResponseError, pub type ErrorResponse {
ErrorResponse(
code: Int,
message: String,
data: Option(Dynamic),
request_id: Option(String),
)
}
pub type ApiError {
HttpcError(HttpError)
JsonDecodeError(DecodeError)
ResponseError(ErrorResponse)
}
pub type ApiResponse(a) =
Result(a, ApiError)
pub type PagedData(data) {
PagedData(data: data, meta: Meta)
}
pub opaque type AccountToken {
AccountToken(token: String)
}
pub opaque type AgentToken {
AgentToken(token: String)
}
pub type TokenParseError {
InvalidToken
IncorrectType
}
pub type AuthMethod {
AccountAuth(AccountToken)
AgentAuth(AgentToken)
NoAuth
}
pub fn parse_account_token(
value: String,
) -> Result(AccountToken, TokenParseError) {
use jwt <- result.try(jwt.parse(value) |> result.replace_error(InvalidToken))
case jwt.payload.subject {
"account-token" -> Ok(AccountToken(value))
_ -> Error(IncorrectType)
}
}
pub fn account_token_decoder() -> Decoder(AccountToken) {
use value <- decode.then(decode.string)
case parse_account_token(value) {
Ok(token) -> decode.success(token)
Error(_) -> decode.failure(AccountToken("invalid"), "AccountToken")
}
}
pub fn parse_agent_token(value: String) -> Result(AgentToken, TokenParseError) {
use jwt <- result.try(jwt.parse(value) |> result.replace_error(InvalidToken))
case jwt.payload.subject {
"agent-token" -> Ok(AgentToken(value))
_ -> Error(IncorrectType)
}
}
pub fn agent_token_decoder() -> Decoder(AgentToken) {
use value <- decode.then(decode.string)
case parse_agent_token(value) {
Ok(token) -> decode.success(token)
Error(_) -> decode.failure(AgentToken("invalid"), "AgentToken")
}
}
fn set_auth(req: Request(a), auth_method: AuthMethod) -> Request(a) {
case auth_method {
NoAuth -> req
AccountAuth(AccountToken(token)) | AgentAuth(AgentToken(token)) ->
req |> request.set_header("Authorization", "Bearer " <> token)
}
} }
const base_request = request.Request( const base_request = request.Request(
@ -54,7 +135,7 @@ fn set_json_body(req: Request(a), json: Json) {
fn make_request(method: Method, auth_method: AuthMethod, path: String) { fn make_request(method: Method, auth_method: AuthMethod, path: String) {
base_request base_request
|> request.set_method(method) |> request.set_method(method)
|> spacetraders_sdk.set_request_auth(auth_method) |> set_auth(auth_method)
|> request.set_path(base_request.path <> path) |> request.set_path(base_request.path <> path)
} }