Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

A Ruby wrapper for the AgileZen API (v1.0)

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 lib
Octocat-spinner-32 spec
Octocat-spinner-32 .gitignore
Octocat-spinner-32 CHANGELOG.md
Octocat-spinner-32 Gemfile
Octocat-spinner-32 Gemfile.lock
Octocat-spinner-32 LICENSE
Octocat-spinner-32 README.md
Octocat-spinner-32 Rakefile
Octocat-spinner-32 agilezen.gemspec
README.md

AgileZen - A Ruby wrapper for the AgileZen API (v1.0)

Installation

gem install agilezen

Usage

When setting up the client, just specify your api key. Methods that are designed to take options in the API are designed that way in the wrapper also, as you'd expect. For more details, read the AgileZen API documentation.

require 'agilezen'

# Setup the client
client = AgileZen::Client.new(:api_key => 'yourapikey')

# Returns info for all your projects
projects = @client.projects

# Returns info for the specified project
project = @client.project(123)

# Returns info for all stories for the specified project
stories = @client.projects_stories(123)

# Returns info for a specific story within a project
story = @client.project_story(123, 5)

# Collection resources support pagination
stories = @client.projects_stories(123, :page => 2, :pageSize => 50)

# Enrichments are supported for additional details
stories = @client.projects_stories(123, :with => 'details,tags')

# Filters are supported to limit your queries
stories = @client.projects_stories(123, :where => 'tag:authentication')

Documentation

For additional details, checkout the latest generated documentation.

Something went wrong with that request. Please try again.