Getting Started

Installation

Use rubygems to install this gem:

sudo gem install rally_rest_api

This gem depends on the builder gem, which will be installed automatically.

Create a RallyRestAPI

The class RallyRestAPI is the entry point to the api. Each instance corresponds to one user logged into Rally. There are several options that may be passed to the constructor:

    :username         => Your Rally login username.
    :password         => Your Rally login password. Username and password will be remembered by this 
                         instance of the API and all objects created and read by this instance.
    :base_url         => The base url for the Rally system.
                         Defaults to https://rally1.rallydev.com/slm/
    :logger           => A logger to log to. There is interesting logging info for DEBUG and INFO
    :builder          => A builder is the Class responsible for the HTTP level protocol.
                         Defaults to RestBuilder
    :version          => The version of the API you want to talk to. Defaults to "current" 

To verify your installation try printing your user’s login name:

   require 'rubygems'
   require 'rally_rest_api'

   rally = RallyRestAPI.new(:username => "<your email>", 
                            :password => "your password")
   puts rally.user.login_name

The above code invokes the #user method on the API returning an instance of RestObject representing your user. It then accessed the ‘LoginName’ element from the XML payload.

The API attempts to “rubyize” the published API. Which is to say that all CamelCase method names and identifiers are converted to lowercase and underscores. This shows through in a few instances e.g. FormattedID is converted to formatted_i_d etc.