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

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

NAME

       Socialtext::Resting::LocalCopy - Maintain a copy on disk of a workspace

SYNOPSIS

       Socialtext::Resting::LocalCopy allows one to copy a workspace into files on the local disk, and to update a workspace from files on disk.

METHODS

   new
       Create a new LocalCopy object.  Requires a "rester" parameter, which should be a Socialtext::Rester-like object.

   pull
       Reads a workspace and pulls all of the pages into files in the specified directory.  Options are passed in as a list of named options:

       dir - The directory the files should be saved to.
       tag - an optional tag.  If specified, only tagged files will be pulled.

   push
       Reads a directory and pushes all the files in that directory up to the specified workspace.  Options are passed in as a list of named
       options:

       dir - The directory the files should be saved to.
       tag - an optional tag.  If specified, only tagged files will be pushed.
	   Note - tag is not yet implemented.

BUGS

       Attachments are not yet supported.  Push by tag is not yet supported.

AUTHOR

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

COPYRIGHT &; LICENSE
       Copyright 2007 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::LocalCopy(3pm)

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)