Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

socialtext::resting::defaultrester(3pm) [debian man page]

Socialtext::Resting::DefaultRester(3pm) 		User Contributed Perl Documentation		   Socialtext::Resting::DefaultRester(3pm)

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:

       o   AnnoCPAN: Annotated CPAN documentation

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

       o   CPAN Ratings

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

       o   RT: CPAN's request tracker

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

       o   Search CPAN

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

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.

perl v5.10.1							    2009-08-28				   Socialtext::Resting::DefaultRester(3pm)

Check Out this Related Man Page

Socialtext::Resting::Mock(3pm)				User Contributed Perl Documentation			    Socialtext::Resting::Mock(3pm)

NAME

       Socialtext::Resting::Mock - Fake rester

SYNOPSIS

	 my $rester = Socialtext::Resting::Mock->(file => 'foo');

	 # returns content of 'foo'
	 $rester->get_page('bar');

FUNCTIONS

   new( %opts )
       Create a new fake rester object.  Options:

       file
	   File to return the contents of.

   server( $new_server )
       Get or set the server.

   username( $new_username )
       Get or set the username.

   password( $new_password )
       Get or set the password.

   workspace( $new_workspace )
       Get or set the workspace.

   get_page( $page_name )
       Returns the content of the specified file or the page stored locally in the object.

   get_pages
       Retrieve a list of pages in the current workspace.

   put_page( $page_name )
       Stores the page content in the object.

   put_pagetag( $page, $tag )
       Stores the page tags in the object.

   get_pagetags( $page )
       Retrieves page tags stored in the object.

   die_on_put( $rc )
       Tells the next put_page() to die with the supplied return code.

   accept( $mime_type )
       Stores the requested mime type.

   order( $order )
       Stores the requested order.

   get_taggedpages( $tag )
       Retrieves the taggedpages stored in the object.

   set_taggedpages( $tag, $return )
       Store the taggedpages return value in the object.

       This is not a real function, but it can make testing easier.

   json_verbose
       Set the json_verbose flag.

   response
       Retrieve a fake response object.

AUTHOR

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

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.

perl v5.10.1							    2009-01-09					    Socialtext::Resting::Mock(3pm)
Man Page