BZ::Client - A client for the Bugzilla web services API.
version 2.0_7
my $client = BZ::Client->new( url => $url, user => $user, password => $password, autologin => 0 ); $client->login();
USE THIS 2.0 DEVELOPMENT VERSION AT YOUR OWN RISK!
(Which is actually, a clausing in the open source license this software is provided under)
THE API IS CHANGING, STUFF IS BREAKING, YMMV!
USE THE 1.x SERIES UNLESS YOU PREFER DEBUGGING TO GETTING THINGS DONE.
This section lists the class methods of BZ::Client.
my $client = BZ::Client->new( url => $url, user => $user, password => $password ); my $client = BZ::Client->new( url => $url, api_key => $api_key );
The new method constructs a new instance of BZ::Client. Whenever you want to connect to the Bugzilla server, you must first create a Bugzilla client. The methods input is a hash of parameters.
For debugging, you can pass in a subref named logger which will be fed debugging information as the client works. Also the logDirectory option is a directory where the raw http content will be dumped.
The Bugzilla servers URL, for example https://bugzilla.mozilla.org/.
https://bugzilla.mozilla.org/
API keys were introduced in 5.0.
An API Key can be obtained in the web interface of your Bugzilla server, with the following steps:
The user name to use when logging in to the Bugzilla server. Typically, this will be your email address.
The password to use when logging in to the Bugzilla server.
If set to 1 (true), will try to log in (if not already logged in) when the first API call is made. This is default.
If set to 0, will try APi calls without logging in. You can still call $client->login() to log in manually.
Note: once you're logged in, you'll stay that way until you call logout
If set to 1 (true), will ask Bugzilla to restrict logins to your IP only. Generally this is a good idea, but may caused problems if you are using a loadbalanced forward proxy.
Default: 0
A hashref with options for HTTP::Tiny, this is passed through so the bellow are for reference only:
Nominates a proxy for HTTP, HTTPS or both, respectively.
You might also use $ENV{all_proxy}, $ENV{http_proxy}, $ENV{https_proxy} or $ENV{all_proxy}.
$ENV{all_proxy}
$ENV{http_proxy}
$ENV{https_proxy}
Request timeout in seconds (default is 60)
A boolean that indicates whether to validate the SSL certificate of an "https" connection (default is false)
This section lists the methods, which an instance of BZ::Client can perform.
$url = $client->url(); $client->url( $url );
Returns or sets the Bugzilla servers URL.
$user = $client->user(); $client->user( $user );
Returns or sets the user name to use when logging in to the Bugzilla server. Typically, this will be your email address.
$password = $client->password(); $client->password( $password );
Returns or sets the password to use when logging in to the Bugzilla server.
If login is automatically called, or not.
Used to login to the Bugzilla server. By default, there is no need to call this method explicitly: It is done automatically, whenever required.
If autologin is set to 0, call this to log in.
Returns 1 if logged in, otherwise 0
Deletes local cookies and calls bugzilla's logout function
Sets or gets the logging function. Argument is a coderef. Returns undef if none.
$logger = $client->logger(); $client->logger( sub { my ($level, $msg) = @_; print STDERR "$level $message\n"; return 1 });
Also can be set via new(), e.g.
$client = BZ::Client->new( logger => sub { }, url => $url user => $user, password => $password );
$client->log( $level, $message );
Sends log messages to whatever is loaded via logger.
$response = $client->api_call( $methodName, $params );
Used by subclasses of BZ::Client::API to invoke methods of the Bugzilla API. Takes a method name and a hash ref of parameters as input. Returns a hash ref of named result objects.
The username does not exist, or the password is wrong.
The ability to login with this account has been disabled. A reason may be specified with the error.
The current password is correct, but the user is asked to change his password.
A login or password parameter was not provided.
Bugzilla maintains demos of all supported versions and trunk at https://landfill.bugzilla.org
You might consider using that for testing against live versions>
BZ::Client::Exception
Dean Hamstead <dean@bytefoundry.com.au>
Jochen Wiedmann <jochen.wiedmann@gmail.com>
This software is copyright (c) 2015 by Dean Hamstad.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install BZ::Client, copy and paste the appropriate command in to your terminal.
cpanm
cpanm BZ::Client
CPAN shell
perl -MCPAN -e shell install BZ::Client
For more information on module installation, please visit the detailed CPAN module installation guide.