helixspiral / bamboohr

An API wrapper for the BambooHR platform

bamboohr

An API wrapper for the BambooHR platform

Usage

Create a new client with bamboohr.New()

bbhr, err := bamboohr.New(BBHRNewInput{
  "company": "TestCompany",
  "apikey": "KEYHERE",
})
if err != nil {
  panic(err)
}

Use any of the built-in functions to query against your BambooHR instance.

resp, err := bbhr.GetEmployees()
if err != nil {
    panic(err)
}

fmt.Println(string(resp))

bamboohr's Issues

leaking http con

From the go docs:

func (*Client) Do

[...]
If the returned error is nil, the Response will contain a non-nil Body which the user is expected to close. If the Body is not both read to EOF and closed, the Client's underlying RoundTripper (typically Transport) may not be able to re-use a persistent TCP connection to the server for a subsequent "keep-alive" request.

But the connection is never closed, only when http 200 but readall fails.

bamboohr/bamboohr.go

Lines 42 to 62 in e75fe04

	func (b *Client) sendRequest(req *http.Request) ([]byte, error) {
	req.Header.Add("ACCEPT", "application/json")
	req.SetBasicAuth(b.APIKey, "x")
	resp, err := b.HTTPClient.Do(req)
	if err != nil {
	return []byte{}, err
	}
	if resp.StatusCode != 200 {
	return []byte{}, fmt.Errorf("status code not 200: %d", resp.StatusCode)
	}
	body, err := ioutil.ReadAll(resp.Body)
	if err != nil {
	return []byte{}, err
	}
	defer resp.Body.Close()
	return body, err

Change function input args from map[string]interface{} to structs

Originally used maps for ease of arbitrary inputs, but it seems like the idiomatic way of doing this in Golang is to use input structs.

Change returns from []byte to struct

Currently we're just returning the raw []byte from BambooHR, this would be nicer if we actually handled parsing all the information into structs and returned that to the user instead.

We could also create "raw" functions that would continue returning the raw []byte for users with more specific needs.