Setup: Initial files (#1)

Author: LucJosin

.github/workflows/coverage.yml

@@ -0,0 +1,33 @@
+name: "Go Coverage"
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  coverage:
+    # Ignore drafts
+    if: github.event.pull_request.draft == false
+    name: Go test with coverage
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 10
+
+      - name: Set up Golang
+        uses: actions/setup-go@v5
+        with:
+          go-version: '1.22'
+
+      - name: Install dependencies
+        run: go mod tidy
+
+      - uses: gwatts/go-coverage-action@v2
+        id: coverage
+        with:
+          coverage-threshold: 60
+          cover-pkg: ./...

.github/workflows/release.yml

@@ -0,0 +1,29 @@
+name: Create Release
+
+on:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Golang
+        uses: actions/setup-go@v5
+        with:
+          go-version: '1.22'
+
+      - name: Install dependencies
+        run: go mod tidy
+
+      - name: Testing
+        run: go test -v ./...
+
+      - name: Publish to pkg.go.dev
+        run: |
+          echo "VERSION=${{ github.ref_name }}"
+          GOPROXY=proxy.golang.org go list -m github.com/HawAPI/go-sdk@${{ github.ref_name }}

.idea/.gitignore

@@ -1,2 +1,117 @@
-# go-sdk
+# HawAPI - go-sdk
+
 HawAPI SDK for Golang
+
+- [API Docs](https://hawapi.theproject.id/docs/)
+- [SDK Docs](https://pkg.go.dev/github.com/HawAPI/go-sdk)
+
+## Topics
+
+- [Installation](#installation)
+- [Usage](#usage)
+    - [Init client](#init-client)
+    - [Fetch information](#fetch-information)
+    - [Error handling](#error-handling)
+
+## Installation
+
+```
+go get github.com/HawAPI/go-sdk@latest
+```
+
+## Usage
+
+- [See examples](./examples)
+
+### Init client
+
+```go
+package main
+
+import (
+  "fmt"
+
+  "github.com/HawAPI/go-sdk"
+)
+
+func main() {
+    // Create a new client with default options
+    client := hawapi.NewClient()
+    
+    // Create client with custom options
+    client = hawapi.NewClientWithOpts(hawapi.Options{
+        Endpoint: "http://localhost:8080/api",
+        // When using 'WithOpts' or 'NewClientWithOpts' the value of
+        // 'UseInMemoryCache' will be set to false
+        UseInMemoryCache: true,
+        // Version
+        // Language
+        // Token
+        // ...
+    })
+	
+    // You can also change the options later
+    client.WithOpts(hawapi.Options{
+        Language: "pt-BR",
+        // When using 'WithOpts' or 'NewClientWithOpts' the value of
+        // 'UseInMemoryCache' will be set to false
+        UseInMemoryCache: true,
+    })
+}
+```
+
+### Fetch information
+
+```go
+package main
+
+import (
+  "fmt"
+
+  "github.com/HawAPI/go-sdk"
+)
+
+func main() {
+    client := hawapi.NewClient()
+    
+    res, err := client.ListActors()
+    if err != nil {
+        panic(err)
+    }
+    
+    fmt.Println(res)
+}
+```
+
+### Error handling
+
+- Check out the [hawapi.ErrorResponse](./pkg/hawapi/error.go)
+
+```go
+package main
+
+import (
+	"fmt"
+
+	"github.com/HawAPI/go-sdk"
+	"github.com/google/uuid"
+)
+
+func main() {
+    client := hawapi.NewClient()
+    
+    id, _ := uuid.Parse("<unknown uuid>")
+    res, err := client.FindActor(id)
+    if err != nil {
+        // If the error is coming from the API request, 
+        // it'll be of type hawapi.ErrorResponse.
+        if resErr, ok := err.(hawapi.ErrorResponse); ok {
+            fmt.Printf("API error %d Message: %s\n", resErr.Code, resErr.Message)
+        } else {
+            fmt.Println("SDK error:", err)
+        }
+    }
+    
+    fmt.Println(res)
+}
+```

.idea/dataSources.xml

@@ -0,0 +1,25 @@
+package main
+
+import (
+	"fmt"
+
+	"github.com/HawAPI/go-sdk/pkg/hawapi"
+)
+
+func main() {
+	client := hawapi.NewClient()
+	client.WithOpts(hawapi.Options{
+		// JWT auth is required when performing any POST, PATCH and DELETE requests
+		Token: "<JWT>",
+	})
+
+	actor := hawapi.CreateActor{
+		// ...
+	}
+	res, err := client.CreateActor(actor)
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res.FirstName)
+}

.idea/go-sdk.iml

@@ -0,0 +1,28 @@
+package main
+
+import (
+	"fmt"
+
+	"github.com/HawAPI/go-sdk/pkg/hawapi"
+)
+
+func main() {
+	// Create a new client with default options
+	client := hawapi.NewClient()
+
+	// Override options
+	client.WithOpts(hawapi.Options{
+		Endpoint: "http://localhost:8080/api",
+		// When using 'WithOpts' or 'NewClientWithOpts' the value of
+		// 'UseInMemoryCache' will be set to false
+		UseInMemoryCache: true,
+	})
+
+	res, err := client.ListActors()
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res)
+	fmt.Println(len(res.Data))
+}

.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,14 @@
+module github.com/HawAPI/go-sdk
+
+go 1.22.0
+
+require (
+	github.com/fatih/color v1.17.0
+	github.com/google/uuid v1.6.0
+)
+
+require (
+	github.com/mattn/go-colorable v0.1.13 // indirect
+	github.com/mattn/go-isatty v0.0.20 // indirect
+	golang.org/x/sys v0.18.0 // indirect
+)

.idea/markdown.xml

@@ -0,0 +1,13 @@
+github.com/fatih/color v1.17.0 h1:GlRw1BRJxkpqUCBKzKOw098ed57fEsKeNjpTe3cSjK4=
+github.com/fatih/color v1.17.0/go.mod h1:YZ7TlrGPkiz6ku9fK3TLD/pl3CpsiFyu8N92HLgmosI=
+github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
+github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
+github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=
+github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
+github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
+github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
+golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.18.0 h1:DBdB3niSjOA/O0blCZBqDefyWNYveAYMNF1Wum0DYQ4=
+golang.org/x/sys v0.18.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=

.idea/modules.xml

@@ -0,0 +1,49 @@
+package cache
+
+// Cache is a simple key / value cache
+type Cache interface {
+	Get(key string) (any, bool)
+	Set(key string, value any)
+	Del(key string)
+	Size() int
+	Clear() int
+}
+
+type memoryCache struct {
+	cache map[string]any
+}
+
+// NewMemoryCache creates a new Cache
+func NewMemoryCache() Cache {
+	return &memoryCache{
+		cache: make(map[string]any),
+	}
+}
+
+// Get will try to get associated with a key from the cache, if present
+func (c *memoryCache) Get(key string) (any, bool) {
+	v, ok := c.cache[key]
+	return v, ok
+}
+
+// Set will store a key-value pair in the cache
+func (c *memoryCache) Set(key string, value any) {
+	c.cache[key] = value
+}
+
+// Del will remove a key and its associated value from the cache.
+func (c *memoryCache) Del(key string) {
+	delete(c.cache, key)
+}
+
+// Size will return the current number of entries in the cache.
+func (c *memoryCache) Size() int {
+	return len(c.cache)
+}
+
+// Clear will empty the cache, removing all stored key-value pairs.
+func (c *memoryCache) Clear() int {
+	count := len(c.cache)
+	c.cache = make(map[string]any)
+	return count
+}