Paginate (#136)

Author: bretterer

CHANGELOG.md

@@ -20,6 +20,7 @@ Running changelog of releases since `2.0.0-rc.4`
 - Update Readme to show how to access `RequestExecutor` (Fixes #83)
 - Fixes Cache EOF (Fixes #103 and Fixes #36)
 - Update all enum objects to `type string` (Fixes #95)
+- Implement Pagination
 
 ## v2.0.0-rc.4
 - Updated Resource Executor to handle nil pointer dereference (#125, fix suggested by @johanbrandhorst)

README.md

@@ -150,6 +150,20 @@ client.GetRequestExecutor().RefreshNext()
 appUserList, _, _ = client.Application.ListApplicationUsers(context.TODO(), appId, nil)
 ```
 
+### Pagination
+If your request comes back with more than the default or set limit, you can request the next page.
+
+Exmaple of listing users 1 at a time:
+```go
+query := query.NewQueryParams(query.WithLimit(1))
+users, resp, err := client.User.ListUsers(ctx, query)
+// Do something with your users until you run out of users to iterate.
+if resp.HasNextPage() {
+  var nextUserSet []*okta.User
+  resp, err = resp.Next(ctx, &nextUserSet)
+}
+```
+
 ## Usage guide
 
 These examples will help you understand how to use this library. You can also browse the full [API reference documentation][sdkapiref].

okta/okta.go

@@ -19,6 +19,7 @@
 package okta
 
 import (
+	"context"
 	"fmt"
 	"io/ioutil"
 	"os/user"
@@ -60,7 +61,10 @@ type resource struct {
 	client *Client
 }
 
-func NewClient(conf ...ConfigSetter) (*Client, error) {
+type clientContextKey struct {
+}
+
+func NewClient(ctx context.Context, conf ...ConfigSetter) (context.Context, *Client, error) {
 	config := &config{}
 
 	setConfigDefaults(config)
@@ -113,7 +117,15 @@ func NewClient(conf ...ConfigSetter) (*Client, error) {
 	c.TrustedOrigin = (*TrustedOriginResource)(&c.resource)
 	c.User = (*UserResource)(&c.resource)
 	c.UserFactor = (*UserFactorResource)(&c.resource)
-	return c, nil
+
+	contextReturn := context.WithValue(ctx, clientContextKey{}, c)
+
+	return contextReturn, c, nil
+}
+
+func ClientFromContext(ctx context.Context) (*Client, bool) {
+	u, ok := ctx.Value(clientContextKey{}).(*Client)
+	return u, ok
 }
 
 func (c *Client) GetConfig() *config {

okta/requestExecutor.go

@@ -340,10 +340,51 @@ func Get429BackoffTime(ctx context.Context, response *http.Response) int64 {
 
 type Response struct {
 	*http.Response
+	Self     string
+	NextPage string
+}
+
+func (r *Response) Next(ctx context.Context, v interface{}) (*Response, error) {
+	client, _ := ClientFromContext(ctx)
+
+	req, err := client.requestExecutor.WithAccept("application/json").WithContentType("application/json").NewRequest("GET", r.NextPage, nil)
+	if err != nil {
+		return nil, err
+	}
+
+	return client.requestExecutor.Do(ctx, req, v)
+
+}
+
+func (r *Response) HasNextPage() bool {
+	return r.NextPage != ""
 }
 
 func newResponse(r *http.Response) *Response {
 	response := &Response{Response: r}
+	links := r.Header["Link"]
+
+	if len(links) > 0 {
+		for _, link := range links {
+			splitLinkHeader := strings.Split(link, ";")
+			if len(splitLinkHeader) < 2 {
+				continue
+			}
+			rawLink := strings.TrimRight(strings.TrimLeft(splitLinkHeader[0], "<"), ">")
+			rawUrl, _ := url.Parse(rawLink)
+			rawUrl.Scheme = ""
+			rawUrl.Host = ""
+
+			if strings.Contains(link, `rel="self"`) {
+				response.Self = rawUrl.String()
+			}
+
+			if strings.Contains(link, `rel="next"`) {
+				response.NextPage = rawUrl.String()
+			}
+		}
+	}
+
 	return response
 }
 

openapi/generator/templates/okta.go.hbs

@@ -3,6 +3,7 @@
 package okta
 
 import (
+	"context"
 	"fmt"
 	"io/ioutil"
 	"os/user"
@@ -29,7 +30,10 @@ type resource struct {
 	client *Client
 }
 
-func NewClient(conf ...ConfigSetter) (*Client, error) {
+type clientContextKey struct {
+}
+
+func NewClient(ctx context.Context, conf ...ConfigSetter) (context.Context, *Client, error) {
 	config := &config{}
 
 	setConfigDefaults(config)
@@ -67,7 +71,15 @@ func NewClient(conf ...ConfigSetter) (*Client, error) {
 	c.resource.client = c
 
 	{{{getNewClientTagProps operations}}}
-	return c, nil
+
+	contextReturn := context.WithValue(ctx, clientContextKey{}, c)
+
+	return contextReturn, c, nil
+}
+
+func ClientFromContext(ctx context.Context) (*Client, bool) {
+	u, ok := ctx.Value(clientContextKey{}).(*Client)
+	return u, ok
 }
 
 func (c *Client) GetConfig() *config {