myclubhouse

myClubhouse

CLI tool

Installation

Clone the repo. Then:

go install .

Help

myclubhouse help

Config

myclubhouse set-config {authToken} {subDomain} 

API Client

Package Instantiation

import "github.com/c-m-hunt/myclubhouse/apiclient"

c := apiclient.MakeClient(subdomain, apiToken, nil)

Testing

To run unit tests, run

go test ./...

To run integration tests, connection to a service is required.

Create a file .env with the following contents subbing in the values:

ACCESS_TOKEN=xxxxxxxxxxxxxxxxxxxxxxx
SUBDOMAIN=mysubdomain

Integration tests can be run with:

go test -tags=integration ./...

Basic functionality

Users

users := []data.User{}
cr, err := c.Users(nil, &users)

User

id := 1
user, err := c.User(id)

Events

events := []data.Event{}
cr, err = c.Events(nil, &events)

Event

id := 1
event, err := c.Event(id)

Request query

All client requests accept a request query as first argument which is in the following structure which will be passed through

type RequestQuery struct {
	View         string `url:"view"`
	Sort         string `url:"sort"`
	Filter       string `url:"filter"`
	SelectedPage int    `url:"selectedPage"`
	PageSize     int    `url:"pageSize"`
}

Example:

q := apiclient.RequestQuery{
  PageSize: 200,
}
users := []data.User{}
cr, err := c.Users(&q, &users)