# ExHubic [![Build Status](https://travis-ci.org/stephenmoloney/ex_hubic.svg)](https://travis-ci.org/stephenmoloney/ex_hubic) [![Hex Version](http://img.shields.io/hexpm/v/ex_hubic.svg?style=flat)](https://hex.pm/packages/ex_hubic) [![Hex docs](http://img.shields.io/badge/hex.pm-docs-green.svg?style=flat)](https://hexdocs.pm/ex_hubic)

ExHubic is client for in the [elixir language](http://elixir-lang.org/) for the [Hubic Api](https://api.hubic.com/).

To use the Openstack components of the HUBIC API, see [Openstex](https://github.com/stephenmoloney/openstex)

## Project Features

- Cache supervised Genserver running in the background which stores frequently accessed authentication information.
- Config supervised Agent running in the background which stores frequently accessed config information.
- Query modules for making building requests to the [Hubic Api](https://api.hubic.com/).
- request functions to send Queries to the [Hubic Api](https://api.hubic.com/).


## Documentation

- [See Hex Docs](https://hexdocs.pm/ex_hubic/)

## Getting started

#### Example (1)

| Step 1: Generating the Hubic application | Step 2: Setup |
|---|---|
| [Mix Task](https://github.com/stephenmoloney/ex_hubic/blob/master/docs/mix_task_basic.md) (optional) | [Setting up the Client](https://github.com/stephenmoloney/ex_hubic/blob/master/docs/getting_started_basic.md) |

#### Example (2) - Recommended way of getting started

| Step 1: Generating the Hubic application | Step 2: Setup |
|---|---|
| [Mix Task](https://github.com/stephenmoloney/ex_hubic/blob/master/docs/mix_task_advanced.md) (optional) | [Setting up Clients](https://hexdocs.pm/ex_hubic/blob/master/docs/getting_started_advanced.md) |


## Usage

- To be added (for now, take a look at the tests)


## Contributing

- Pull requests welcome.


## Tests

*Note:* Requires that the elixir client `Openstex.ExHubic` and the `EX_HUBIC` environment variables have been configured.

```
mix test
```


## Note

This is an unofficial client to the HUBIC API and is not maintained by OVH.


## Licence

[MIT Licence](LICENSE.md)