# ExJira

Elixir wrapper for the JIRA REST API as outlined [here](https://docs.atlassian.com/jira/REST/cloud/).

Still in development. POST has not been tested. Need remainder of resources implemented. Contributions welcome!

[![Build Status](https://travis-ci.com/TheFirstAvenger/elixir-ex_jira.svg?branch=master)](https://travis-ci.com/TheFirstAvenger/elixir-ex_jira)
[![Coverage Status](https://coveralls.io/repos/github/TheFirstAvenger/elixir-ex_jira/badge.svg?branch=master)](https://coveralls.io/github/TheFirstAvenger/elixir-ex_jira?branch=master)
[![Project license](https://img.shields.io/hexpm/l/ex_jira.svg)](https://unlicense.org/)
[![Hex.pm package](https://img.shields.io/hexpm/v/ex_jira.svg)](https://hex.pm/packages/ex_jira)
[![Hex.pm downloads](https://img.shields.io/hexpm/dt/ex_jira.svg)](https://hex.pm/packages/ex_jira)

## Installation

ExJira can be installed by adding `ex_jira` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [{:ex_jira, "~> 0.0.5"}]
end
```

## Configuration

ExJira requires three application variables. Add the following variables to your config.exs file (this example retrieves those variables from environment variables):

```elixir
config :ex_jira,
  account: System.get_env("JIRA_ACCOUNT"),
  username: System.get_env("JIRA_USERNAME"),
  password: System.get_env("JIRA_PASSWORD")
```

The HTTPotion timeout value is configurable by the optional `timeout` application variable, which defaults to 30_000 (30 seconds) when not set:

```elixir
config :ex_jira,
  timeout: 60_000
```

For testing purposes, you can override the HTTP client that ExJira uses via the following application variable:

```elixir
config :ex_jira,
  http_client: ExJira.MockClient
```

## Usage

### Dashboard

```elixir
{:ok, dashboards} = ExJira.Dashboard.all()
{:ok, dashboards} = ExJira.Dashboard.all(filter: "favourite")
dashboards = ExJira.Dashboard.all!()
dashboards = ExJira.Dashboard.all!(filter: "favourite")
```

### Project

```elixir
{:ok, projects} = ExJira.Project.all()
{:ok, projects} = ExJira.Project.all(expand: "description,url")
projects = ExJira.Project.all!()
projects = ExJira.Project.all!(expand: "description,url")

{:ok, project} = ExJira.Project.get("1001")
{:ok, project} = ExJira.Project.get("1001", expand: "description,url")
project = ExJira.Project.get!("1001")
project = ExJira.Project.get!("1001", expand: "description,url")

{:ok, issues} = ExJira.Project.get_issues("1001")
{:ok, issues} = ExJira.Project.get_issues("1001", expand: "operations")
issues = ExJira.Project.get_issues!("1001")
issues = ExJira.Project.get_issues!("1001", expand: "operations")
```

Raw requests to Jira for resources that are not yet implemented can be made like this:

```elixir
{:ok, dashboards} = ExJira.Request.get_one("/dashboard","filter=favourite")
{:ok, ret} = ExJira.Request.post("/project", "", "{\"name\":\"test\"}")
```

Docs can be found at [https://hexdocs.pm/ex_jira](https://hexdocs.pm/ex_jira).