Luke Closs > Socialtext-Resting-Utils > Socialtext::Resting::DefaultRester

Download:
Socialtext-Resting-Utils-0.21.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 0.02   Source  

NAME ^

Socialtext::Resting::DefaultRester - load a rester from a config file.

SYNOPSIS ^

Load server, workspace and username from a file, so you don't need to specify that for every program using Socialtext::Resting.

    use Socialtext::Resting::DefaultRester;

    my $rester = Socialtext::Resting::DefaultRester->new;
    print $rester->get_page('Foo');

FUNCTIONS ^

new

Create a new Default Rester by using values from ~/.wikeditrc.

Options:

rester-config

File to use as the config file. Defaults to $ENV{HOME}/.wikeditrc.

class

Specifies the rester class to use. Defaults to Socialtext::Resting.

*

All other args are passed through to the rester class's new().

Rester Config File

The config file is expected to be in the following format:

  server = your-server
  workspace = some-workspace
  username = your-user
  password = your-password

Your password will become crypted the first time it is loaded if Crypt::CBC is installed.

Alternately, you can use this format:

  server = your-server
  workspace = some-workspace
  user_cookie = an-NLW-user-cookie

AUTHOR ^

Luke Closs, <luke.closs at socialtext.com>

BUGS ^

Please report any bugs or feature requests to bug-socialtext-default-rester at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Socialtext-Resting-Utils. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc Socialtext::Resting::DefaultRester

You can also look for information at:

ACKNOWLEDGEMENTS ^

COPYRIGHT & LICENSE ^

Copyright 2006 Luke Closs, all rights reserved.

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

syntax highlighting: