iter.go

package stripe

import (
	"reflect"

	"github.com/stripe/stripe-go/form"
)

// Query is the function used to get a page listing.
type Query func(*form.Values) ([]interface{}, ListMeta, error)

// Iter provides a convenient interface
// for iterating over the elements
// returned from paginated list API calls.
// Successive calls to the Next method
// will step through each item in the list,
// fetching pages of items as needed.
// Iterators are not thread-safe, so they should not be consumed
// across multiple goroutines.
type Iter struct {
	cur    interface{}
	err    error
	meta   ListMeta
	params ListParams
	qs     *form.Values
	query  Query
	values []interface{}
}

// GetIter returns a new Iter for a given query and its options.
func GetIter(params *ListParams, qs *form.Values, query Query) *Iter {
	iter := &Iter{}
	iter.query = query

	p := params
	if p == nil {
		p = &ListParams{}
	}
	iter.params = *p

	q := qs
	if q == nil {
		q = &form.Values{}
	}
	iter.qs = q

	iter.getPage()
	return iter
}

func (it *Iter) getPage() {
	it.values, it.meta, it.err = it.query(it.qs)
	if it.params.EndingBefore != "" {
		// We are moving backward,
		// but items arrive in forward order.
		reverse(it.values)
	}
}

// Next advances the Iter to the next item in the list,
// which will then be available
// through the Current method.
// It returns false when the iterator stops
// at the end of the list.
func (it *Iter) Next() bool {
	if len(it.values) == 0 && it.meta.HasMore && !it.params.Single {
		// determine if we're moving forward or backwards in paging
		if it.params.EndingBefore != "" {
			it.params.EndingBefore = listItemID(it.cur)
			it.qs.Set(EndingBefore, it.params.EndingBefore)
		} else {
			it.params.StartingAfter = listItemID(it.cur)
			it.qs.Set(StartingAfter, it.params.StartingAfter)
		}
		it.getPage()
	}
	if len(it.values) == 0 {
		return false
	}
	it.cur = it.values[0]
	it.values = it.values[1:]
	return true
}

// Current returns the most recent item
// visited by a call to Next.
func (it *Iter) Current() interface{} {
	return it.cur
}

// Err returns the error, if any,
// that caused the Iter to stop.
// It must be inspected
// after Next returns false.
func (it *Iter) Err() error {
	return it.err
}

// Meta returns the list metadata.
func (it *Iter) Meta() *ListMeta {
	return &it.meta
}

func listItemID(x interface{}) string {
	return reflect.ValueOf(x).Elem().FieldByName("ID").String()
}

func reverse(a []interface{}) {
	for i := 0; i < len(a)/2; i++ {
		a[i], a[len(a)-i-1] = a[len(a)-i-1], a[i]
	}
}