https://github.com/mattweldon/exjira

JIRA client library for Elixir
https://github.com/mattweldon/exjira

Last synced: 7 days ago
JSON representation

JIRA client library for Elixir

• Host: GitHub
• URL: https://github.com/mattweldon/exjira
• Owner: mattweldon
• Created: 2015-01-03T15:34:54.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2015-02-14T23:57:57.000Z (over 9 years ago)
• Last Synced: 2024-10-06T03:57:45.818Z (about 1 month ago)
• Language: Elixir
• Size: 230 KB
• Stars: 6
• Watchers: 3
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• freaking_awesome_elixir - Elixir - JIRA client library for Elixir. (Third Party APIs)
• fucking-awesome-elixir - exjira - JIRA client library for Elixir. (Third Party APIs)
• awesome-elixir - exjira - JIRA client library for Elixir. (Third Party APIs)

README

        
# ExJira

A JIRA client library for Elixir using erlang-oauth to call the JIRA REST API.

A non-trivial project to help me get started using Elixir - Currently WIP.

### Usage

#### 1. Add dependencies

Add the following to the deps section in `mix.exs`.

```elixir

defp deps do

  [

    {:oauth, github: "tim/erlang-oauth"},

    {:extwitter, "~> 0.1"}

  ]

end

```

#### 2. Setup OAuth parameters

Use `ExJira.configure` to setup the JIRA OAuth parameters. See the Configuration section below for further details.

#### 3. Access JIRA endpoints

Call the functions in the ExJira module (e.g. `ExJira.projects` to return all projects or `ExJira.project("KEY")` to return a specifc one).

### Configuration

There are three ways to configure ExJira:

#### Using config.exs

In `config/config.exs` add the following:

```elixir

config :ex_jira, [

  site: "http://youraccount.atlassian.net",

  private_key_file: "private_key.pem"

  consumer_key: ""

]

```

#### Across the application at runtime

```elixir

ExJira.configure([consumer_key: "", ...])

```

#### For the current process at runtime

```elixir

ExJira.configure(:process, [consumer_key: "", ...])

```