# BamboohrEx

[![Build Status](https://travis-ci.org/aditya7iyengar/bamboohr_ex.svg?branch=master)](https://travis-ci.org/aditya7iyengar/bamboohr_ex)
[![Coverage Status](https://coveralls.io/repos/github/aditya7iyengar/bamboohr_ex/badge.svg?branch=master)](https://coveralls.io/github/aditya7iyengar/bamboohr_ex?branch=master)
[![Hex Version](http://img.shields.io/hexpm/v/bamboohr_ex.svg?style=flat)](https://hex.pm/packages/bamboohr_ex)
[![hex.pm downloads](https://img.shields.io/hexpm/dt/bamboohr_ex.svg)](https://hex.pm/packages/bamboohr_ex)
[![Hex docs](http://img.shields.io/badge/hex.pm-docs-green.svg?style=flat)](https://hexdocs.pm/bamboohr_ex)
[![Incline docs](https://inch-ci.org/github/aditya7iyengar/bamboohr_ex.svg)](http://inch-ci.org/github/aditya7iyengar/bamboohr_ex)
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/aditya7iyengar/bamboohr_ex/master/LICENSE)


  This is a Wrapper around [BambooHR API](http://www.bamboohr.com/api/documentation/)

  - To use this package, you must have an API key generated in BambooHR.
    The steps to generate API key in Bamboo can be found [here](https://nexonia.zendesk.com/hc/en-us/articles/115000609072-Creating-a-BambooHR-API-Key-for-Integration)

  - This package is just a wrapper, so it will only let you see resources that
    correspond to permissions associated with the API key

  This package can be configured with default `api_key` and `subdomain`.
  This package can also be configured with a default `caller`. It should be used
  mainly for testing purposes.

  ## Example Configuration (dev.exs)(Optional):

    config :bamboohr_ex, BamboohrEx,
      caller: BamboohrEx.HTTPClient,
      api_key: "YOUR_BAMBOOHR_API_KEY",
      subdomain: "DEFAULT_SUBDOMAIN"

  ## Example Configuration (test.exs)(Optional):

    config :bamboohr_ex, BamboohrEx,
      caller: BamboohrEx.InMemory,
      api_key: "thuum",
      subdomain: "skyrim"


## Installation

This package is [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `bamboohr_ex` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:bamboohr_ex, "~> 0.1.0"}
  ]
end
```