README.md

JiraAgileApi

This gem allows you to easily use the Jira Agile API.

It’s powered by Faraday and Virtus.

##Demonstration Dash of Agile uses jira_agile_api to create agile dashboards from Jira Agile projects.

Installation

Add this line to your application's Gemfile:

gem 'jira_agile_api', '~> 0.1.0'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install jira_agile_api

Basic Usage

client = JiraAgileApi::Client.new(token: 'my-api-token')                        # Create API client

rapid_views = client.rapid_views                                                # Get all rapid views
rapid_view  = client.rapid_view(123456)                                         # Get rapid view with given ID

rapid_view.sprints                                                              # Get all sprints for a rapid view

TODO

• Add missing resources and endpoints
• Add create, update, delete for resources

Contributing

Currently this client supports read-only access to Jira Agile. We will be extending it as our use cases require, but are always happy to accept contributions.

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request