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


Socialtext-Resting-Utils documentation  | view source Contained in the Socialtext-Resting-Utils distribution.

Index


NAME

Top

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

SYNOPSIS

Top

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

Top

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

Top

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

BUGS

Top

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

Top

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

    perldoc Socialtext::Resting::DefaultRester

You can also look for information at:

* AnnoCPAN: Annotated CPAN documentation

http://annocpan.org/dist/Socialtext-Resting-Utils

* CPAN Ratings

http://cpanratings.perl.org/d/Socialtext-Resting-Utils

* RT: CPAN's request tracker

http://rt.cpan.org/NoAuth/Bugs.html?Dist=Socialtext-Resting-Utils

* Search CPAN

http://search.cpan.org/dist/Socialtext-Resting-Utils

ACKNOWLEDGEMENTS

Top

COPYRIGHT & LICENSE

Top


Socialtext-Resting-Utils documentation  | view source Contained in the Socialtext-Resting-Utils distribution.