Merge pull request #88 from onelogin/develop

Move forward with v1

Author: Subterrane

.github/workflows/go.yml

@@ -1,4 +1,8 @@
-on: [push, pull_request]
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
 name: CI
 jobs:
   tests:
@@ -13,9 +17,5 @@ jobs:
       run: go build ./...
     - name: Vet
       run: go vet ./...
-    - name: Test
-      uses: cedrickring/golang-action@master
-      with:
-        args: make test
     - name: Secure
       run: make secure

.github/workflows/release.yml

@@ -7,16 +7,18 @@ jobs:
   goreleaser:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-      - name: Unshallow
-        run: git fetch --prune --unshallow
-      - name: Set up Go
-        uses: actions/setup-go@v2
+      - uses: actions/checkout@v3
         with:
-          go-version: 1.14
-      - name: Release
-        uses: docker://antonyurchenko/git-release:latest
+          fetch-depth: 0
+      - run: git fetch --force --tags
+      - uses: actions/setup-go@v4
+        with:
+          go-version: stable
+      - uses: goreleaser/goreleaser-action@v4
+        with:
+          distribution: goreleaser
+          version: latest
+          args: release --clean
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           DRAFT_RELEASE: "false"

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2021 OneLogin, Inc.
+Copyright (c) 2010-2023 OneLogin, Inc.
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

Makefile

@@ -13,4 +13,4 @@ secure:
 	./bin/gosec -exclude=G104 ./...
 
 link:
-	ln -s ${GOPATH}/src/github.com/onelogin/onelogin-go-sdk .
+	ln -s ${GOPATH}/src/github.com/onelogin/onelogin-go-sdk .

config.yml

@@ -1 +1 @@
-version: "4.0.0"
+version: "4.0.1"

docs/api.md

@@ -35,4 +35,4 @@ The `Authenticator` interface is used for handling authentication. It uses the `
 
 The `Authenticator` is initialized with the `NewAuthenticator` function and the token is generated with the `GenerateToken` method within the `NewClient` function. If a request is unauthorized (HTTP 401), the token is refreshed using the `GenerateToken` method in the `sendRequest` function.
 
-In summary, the API module simplifies the process of interacting with the OneLogin API by encapsulating the details of creating, sending, and processing HTTP requests. It uses environment variables for the API credentials and handles error scenarios such as unauthorized requests and token refresh. It forms the backbone of the OneLogin Go SDK, providing a streamlined interface for making API calls.
+In summary, the API module simplifies the process of interacting with the OneLogin API by encapsulating the details of creating, sending, and processing HTTP requests. It uses environment variables for the API credentials and handles error scenarios such as unauthorized requests and token refresh. It forms the backbone of the OneLogin Go SDK, providing a streamlined interface for making API calls.

docs/authentication.md

@@ -14,11 +14,11 @@ type Authenticator struct {
 
 ## NewAuthenticator Function
 
-The `NewAuthenticator` function is used to create a new `Authenticator` instance. It does not require any arguments and it initializes a new Authenticator with an empty `accessToken`.
+The `NewAuthenticator` function is used to create a new `Authenticator` instance. It requires the subdomain as an argument, and it initializes a new Authenticator with an empty `accessToken`.
 
 ```go
-func NewAuthenticator() *Authenticator {
-	return &Authenticator{}
+func NewAuthenticator(subdomain string) *Authenticator {
+	return &Authenticator{subdomain: subdomain}
 }
 ```
 
@@ -37,7 +37,7 @@ func (a *Authenticator) GenerateToken() error {
 The `RevokeToken` function is used to revoke an existing access token. It reads the `ONELOGIN_CLIENT_ID` and `ONELOGIN_CLIENT_SECRET` environment variables, creates a revocation request, sends it, and handles the response. If the revocation is successful, a confirmation message is printed.
 
 ```go
-func (a *Authenticator) RevokeToken(token, domain *string) error {
+func (a *Authenticator) RevokeToken(token *string) error {
     // implementation details
 }
 ```

docs/usage_examples.md

@@ -1,24 +1,106 @@
+1. **User model**
+
 ```go
 package main
 
 import (
 	"fmt"
+	"github.com/onelogin/onelogin-go-sdk/v4/pkg/onelogin/models"
+	"github.com/onelogin/onelogin-go-sdk/v4/pkg/onelogin"
+)
+
+func main() {
+	var (
+		email    string = "test@example.com"
+		username string = "testuser"
+	)
+
+	client, err := onelogin.NewOneloginSDK()
+	if err != nil {
+		fmt.Println(err)
+	}
+
+	user, err := client.CreateUser(models.User{
+		Email:    &email,
+		Username: &username,
+	})
+	if err != nil {
+		fmt.Println(err)
+	}
+	fmt.Printf("%+v\n", user)
+}
+```
 
-	"github.com/onelogin/onelogin-go-sdk/internal/models"
-	"github.com/onelogin/onelogin-go-sdk/pkg/onelogin"
+2. **Role model**
+
+```go
+package main
+
+import (
+	"fmt"
+	"github.com/onelogin/onelogin-go-sdk/v4/pkg/onelogin/models"
+	"github.com/onelogin/onelogin-go-sdk/v4/pkg/onelogin"
 )
 
 func main() {
-	var testSSO = models.SSOOpenId{ClientID: "1234567890"}
-	var testConfig = models.ConfigurationOpenId{
-		RedirectURI:                   "https://example.com",
-		LoginURL:                      "https://example.com/login",
-		OidcApplicationType:           1,
-		TokenEndpointAuthMethod:       1,
-		AccessTokenExpirationMinutes:  60,
-		RefreshTokenExpirationMinutes: 60,
+	var (
+		name string = "Admin"
+	)
+
+	client, err := onelogin.NewOneloginSDK()
+	if err != nil {
+		fmt.Println(err)
 	}
 
+	role, err := client.CreateRole(models.Role{
+		Name: &name,
+	})
+	if err != nil {
+		fmt.Println(err)
+	}
+	fmt.Printf("%+v\n", role)
+}
+```
+
+3. **Event model**
+
+```go
+package main
+
+import (
+	"fmt"
+	"github.com/onelogin/onelogin-go-sdk/v4/pkg/onelogin/models"
+	"github.com/onelogin/onelogin-go-sdk/v4/pkg/onelogin"
+)
+
+func main() {
+	client, err := onelogin.NewOneloginSDK()
+	if err != nil {
+		fmt.Println(err)
+	}
+
+	eventQ := models.EventQuery{}
+	eventList, err := client.GetEvents(&eventQ)
+	if err != nil {
+		fmt.Println(err)
+	}
+	fmt.Printf("%+v\n", eventList)
+}
+```
+
+
+4. **App model**
+
+```go
+package main
+
+import (
+	"fmt"
+	"github.com/onelogin/onelogin-go-sdk/v4/pkg/onelogin/models"
+	"github.com/onelogin/onelogin-go-sdk/v4/pkg/onelogin"
+)
+
+func main() {
 	var (
 		connetorid int32  = 108419
 		name       string = "Bow wow wow yippy yo yippy yay"
@@ -29,24 +111,69 @@ func main() {
 	if err != nil {
 		fmt.Println(err)
 	}
-	appQ := models.AppQuery{}
-	applist, err := client.GetApps(&appQ)
+
+	app, err := client.CreateApp(models.App{
+		ConnectorID: &connetorid,
+		Name:        &name,
+		Description: &descr,
+	})
 	if err != nil {
 		fmt.Println(err)
 	}
-	fmt.Printf("%+v\n", applist)
+	fmt.Printf("%+v\n", app)
+}
+```
 
-	appT, err := client.CreateApp(models.App{
-		ConnectorID:   &connetorid,
-		Name:          &name,
-		Description:   &descr,
-		SSO:           testSSO,
-		Configuration: testConfig,
-	})
+5. **UserMappings model**
+
+```go
+package main
+
+import (
+	"fmt"
+	"github.com/onelogin/onelogin-go-sdk/v4/pkg/onelogin/models"
+	"github.com/onelogin/onelogin-go-sdk/v4/pkg/onelogin"
+)
+
+func main() {
+	client, err := onelogin.NewOneloginSDK()
+	if err != nil {
+		fmt.Println(err)
+	}
+
+	userMappingsQuery := models.UserMappingsQuery{}
+	userMappings, err := client.GetUserMappings(&userMappingsQuery)
+	if err != nil {
+		fmt.Println(err)
+	}
+	fmt.Printf("%+v\n", userMappings)
+}
+```
+
+6. **AppRule model**
+
+```go
+package main
+
+import (
+	"fmt"
+	"github.com/onelogin/onelogin-go-sdk/v4/pkg/onelogin/models"
+	"github.com/onelogin/onelogin-go-sdk/v4/pkg/onelogin"
+)
+
+func main() {
+	client, err := onelogin.NewOneloginSDK()
+	if err != nil {
+		fmt.Println(err)
+	}
+
+	appRuleQuery := models.AppRuleQuery{}
+	appRules, err := client.GetAppRules(&appRuleQuery)
 	if err != nil {
 		fmt.Println(err)
 	}
-	fmt.Printf("%+v\n", appT)
+	fmt.Printf("%+v\n", appRules)
 }
+```
 
-```
+Please note that these are basic examples and may not work as expected without proper setup and context. You may need to adjust them according to your needs.

go.mod

@@ -1,3 +1,3 @@
-module github.com/onelogin/onelogin-go-sdk
+module github.com/onelogin/onelogin-go-sdk/v4
 
 go 1.18

main.go

@@ -0,0 +1,38 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/onelogin/onelogin-go-sdk/v4/pkg/onelogin"
+	"github.com/onelogin/onelogin-go-sdk/v4/pkg/onelogin/models"
+)
+
+func main() {
+
+	// Set environment variables for OneLogin API credentials
+	os.Setenv("ONELOGIN_CLIENT_ID", "client_id")
+	os.Setenv("ONELOGIN_CLIENT_SECRET", "client_secret")
+	os.Setenv("ONELOGIN_SUBDOMAIN", "your-api-subdomain")
+
+	// Create a user object with the specified attributes
+	UserTwo := models.User{Firstname: "Mikhail", Lastname: "Beaverton", Email: "mb@example.com"}
+
+	// Create a user query object with the specified email
+	UserQueryOne := models.UserQuery{Email: &UserTwo.Email}
+
+	// Create a new OneLogin SDK client
+	Client, err := onelogin.NewOneloginSDK()
+	if err != nil {
+		fmt.Println(err)
+	}
+
+	// Create a new user with the specified attributes
+	Client.CreateUser(models.User{Firstname: "Jane", Lastname: "Pukalava", Email: "jp@example.com"})
+
+	// Create a new user with the specified attributes
+	Client.CreateUser(UserTwo)
+
+	// Get a list of users that match the specified query
+	Client.GetUsers(&UserQueryOne)
+}