rc

README

rc

rc standands for "REST client". It is a golang package implementing a simple wrapper around Go's standard http/https packages targetting simple interactions with REST API such as https://orcid.org. It was created to unify the REST interaction across multiple harvesting tools developed at Caltech Library in the Go lanuage.

apiexplorer

apiexplorer is just a proof of concept command line program to demonstrate using rc package in Go programs.

Documentation

Index

• Constants
• type RestAPI
  • func New(apiURL string, authType int, clientID, clientSecret string) (*RestAPI, error)
  • func (api *RestAPI) AddHeader(ky, value string)
  • func (api *RestAPI) Login() error
  • func (api *RestAPI) Request(method, docPath string, payload map[string]string) ([]byte, error)

Constants

const (
	Version = `v0.0.1`

	LicenseText = `` /* 1530-byte string literal not displayed */

)

const (
	AuthNone = iota
	BasicAuth
	OAuth
	Shibboleth
)

FIXME: Need to handle Basic auth, OAuth and Shibboleth

Types

type RestAPI

type RestAPI struct {

	// Timeout is the client time out period, default is 10 seconds
	Timeout time.Duration
	// contains filtered or unexported fields
}

func New

func New(apiURL string, authType int, clientID, clientSecret string) (*RestAPI, error)

New creates a new Rest Client RestAPI instance If clientID and clientSecret and empty and authType

func (*RestAPI) AddHeader

func (api *RestAPI) AddHeader(ky, value string)

AddHeader sets the header strings to send with the request

func (*RestAPI) Login

func (api *RestAPI) Login() error

func (*RestAPI) Request

func (api *RestAPI) Request(method, docPath string, payload map[string]string) ([]byte, error)

Request contacts the Rest API and returns the full read response body, and error payload is the used to build the URL Query object (e.g. ?key=value&key1=value...)