NAME
WebService::FogBugz::XML
SYNOPSIS
use WebService::FogBugz::XML;
# Config generally read from ~/.fb.conf
my $fb = WebService::FogBugz::XML->new;
my $case = $fb->get_case(1234);DESCRIPTION
WebService::FogBugz::XML provides an OO interface to the FogBugz XML API. You can use this to search for cases, change what you're working on, etc. It's particularly useful to build external reporting on development activity.
Documentation for the API itself is here: FogBugz XML API Doucmentation
CONFIGURATION
Configureation is expected to be found in ~/.fb.conf. If it's not there, you'll be prompted for url, email and password. The password should not be stored in the file, since it's only used to generate an auth_token.
Example config file: url = https://www.mysite.com/fogbugz/api.asp email = my@email.com
The URL should probably end in api.asp.
An auth token is stored in ~/.fb_auth_token. This is a persistent login key. Once this exists, neither email nor password are required again.
There are attributes available for email, password and url on the object itself, but it's a bad pattern to hard code a password ever.
ATTRIBUTES
config_filename
Where to find the configuration file.
Default: ~/.fb.conf
token_filename
Where to find and store the auth token file.
Default: ~/.fb_auth_token
url
The URL to the fogbugz API. Should include the protocol, and the full path to the api. e.g. https:://www.mysite.com/fogbugz/api.asp
The email address to logon to Fogbugz with
password
The password address to logon to Fogbugz with
token
The auth token to use when talking to fogbugz
METHODS
get_case ($number)
Fetches a case from fogbugz.
Returns a WebService::FogBugz::XML::Case object.
INTERNALS
logon
Called when there's no token present. You shouldn't ever need to call this.
Logout
Log out of the fogbugz service.
get_url ($cmd, $args)
Retrieves an arbitrary command. Accepts a hashref of arguments.
TODO
Many more methods to wrap up for convenience.AUTHOR
gbjk: Gareth Kirwan <gbjk@thermeon.com>
CONTRIBUTIORS
djh: Dominic Humphries <djh@thermeon.com>
COPYRIGHT
2012 Thermeon Worldwide PLC
LICENSE
This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself.