WebService::Advogato - XML-RPC interface to www.advogato.org

WebService-Advogato documentation Contained in the WebService-Advogato distribution.

Index

Code Index:

NAME

Top

WebService::Advogato - XML-RPC interface to www.advogato.org

SYNOPSIS

Top

 use WebService::Advogato;
 my $client = new WebService::Advogato('username', 'password');
 my $num_entries = $client->len('jaldhar');
 $client->set(-1, '<p>A diary entry.</p>');

ABSTRACT

Top

This module implements the XML-RPC interface to the diaries at www.advogato.org a site for developers of free software.

DESCRIPTION

Top

The module is implemented as a class. The methods use standard perl scalars and arrays but internally they use XML-RPC datatypes: int, string and date. The following descriptions include the datatype for your reference.

Constructor

An object is constructed using the standard syntax. The constructor can take two parameters: username, and password which are the name and password of an advogato user account. These are used in methods which require logging in.

Diary manipulation methods

$int_length = len($string_user)

Return the number of entries in a diary. This implements the diary.len RPC function.

$string_html = get($string_user, $int_index)

Return a diary entry. The index is zero-based, so if len returns 2 then valid indices are 0 and 1. This implements the diary.get RPC function.

($date_created, $date_updated) = getDates($string_user, $int_index)

Return the creation and last updated dates of a diary entry. If the entry has not been updated then the updated date will be the same as the creation date. This implements the diary.getDates RPC function.

set($int_index, $string_html)

Sets a diary entry. Use -1 as the index to post a new entry, although the value returned by len is also acceptable. This implements the diary.set RPC function.

$int_exists = exists($string_user)

Returns zero if the user does not exist, or one if he does. This implements the user.exists RPC function.

Test methods

These methods are only useful for testing purposes.

$string_capitalized = capitalize($string)

Capitalized a string. This implements the test.capitalize RPC function.

($string, $int) = guess()

Guesses a number. (Actually always returns 'You guessed' and 42.)

$int = square($int)

Squares a number. This implements the test.square RPC function.

($int_sum, $int_product) = sumprod($int_x, $int_y)

Returns the sum and product of a pair of numbers. This implements the test.sumprod RPC function.

$int_len = strlen($string)

Returns the length of a string. This implements the test.strlen RPC function.

SEE ALSO

Top

http://www.advogato.org/xmlrpc.html

AUTHOR

Top

Jaldhar H. Vyas, <jaldhar@braincells.com>

COPYRIGHT AND LICENSE

Top

Copyright (c) 2004, Consolidated Braincells Inc.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

WebService-Advogato documentation Contained in the WebService-Advogato distribution. 
package WebService::Advogato;

use Carp;
use RPC::XML ':types';
use RPC::XML::Client;
use strict;
use vars qw($VERSION);

$VERSION = '1.1.0';

#
# $Id: Advogato.pm,v 1.2 2004/04/04 06:29:10 jaldhar Exp $
#

sub new()
{
  my ($proto, $user, $pass) = @_;

  my $class = ref($proto) || $proto;
  my $self = {
    'client' => RPC::XML::Client->new('http://www.advogato.org/XMLRPC'),
    'user' => $user || '',
    'pass' => $pass || '',
  };
  bless($self, $class);
  return $self;
}

sub _authenticate()
{
  my ($self) = @_;

  my $result = $self->{'client'}->send_request('authenticate', 
    RPC_STRING($self->{'user'}), RPC_STRING($self->{'pass'}));
  croak $result unless ref $result;
  croak $result->code . ': ' . $result->string 
    if ref $result eq 'RPC::XML::fault';
  $self->{'cookie'} = $result->value;
}

sub _call()
{
  my ($self, $method, @args) = @_;

  my $ result = $self->{'client'}->send_request($method, @args);  
  croak $result unless defined($result);
  croak $result->code . ': ' . $result->string if $result->is_fault;
  return $result->value;
}

sub capitalize($)
{
  my ($self, $x) = @_;

  return $self->_call('test.capitalize', RPC_STRING($x));
}

sub exists($)
{
  my ($self, $user) = @_;

  return $self->_call('user.exists', RPC_STRING($user));
}

sub get($$)
{
  my ($self, $user, $index) = @_;

  return $self->_call('diary.get', RPC_STRING($user), RPC_INT($index));
}

sub getDates($$)
{
  my ($self, $user, $index) = @_;

  return @{$self->_call('diary.getDates', RPC_STRING($user), RPC_INT($index))};
}

sub guess()
{
  my ($self) = @_;

  return @{$self->_call('test.guess')};
}

sub len($)
{
  my ($self, $user) = @_;

  return $self->_call('diary.len', RPC_STRING($user));
}

sub level($)
{
  my ($self, $user) = @_;

  return $self->_call('cert.get', RPC_STRING($user));
}

sub set($$)
{
  my ($self, $index, $html) = @_;

  $self->_authenticate() unless $self->{'cookie'};
  return $self->_call('diary.set', RPC_STRING($self->{'cookie'}),
    RPC_INT($index), RPC_STRING($html));
}

sub square($)
{
  my ($self, $x) = @_;

  return $self->_call('test.square', RPC_INT($x));
}

sub strlen($)
{
  my ($self, $str) = @_;

  return $self->_call('test.strlen', RPC_STRING($str));
}

sub sumprod($$)
{
  my ($self, $x, $y) = @_;

  return @{$self->_call('test.sumprod', RPC_INT($x), RPC_INT($y))};
}

1;

__END__