rest::application::routes(3pm) [debian man page]

REST::Application::Routes(3pm)				User Contributed Perl Documentation			    REST::Application::Routes(3pm)

NAME

       REST::Application::Routes - An implementation of Ruby on Rails type routes.

SYNOPSIS

	   package MyApp;
	   use base 'REST::Application::Routes';

	   my $obj = REST::Application::Routes->new();
	   $obj->loadResource(
	       '/data/workspaces/:ws/pages/:page', => &do_thing,
	       # ... other routes here ...
	   );

	   sub do_thing {
	       my %vars = @_;
	       print $vars{ws} . " " . $vars{page} . "
";
	   }

	   # Now, in some other place.	Maybe a CGI file or an Apache handler, do:
	   use MyApp;
	   MyApp->new->run("/data/workspaces/cows/pages/good"); # prints "cows good"

DESCRIPTION

       Ruby on Rails has this concept of routes.  Routes are URI path info templates which are tied to specific code (i.e. Controllers and Actions
       in Rails).  That is routes consist of key value pairs, called the route map, where the key is the path info template and the value is a
       code reference.

       A template is of the form: "/foo/:variable/bar" where variables are always prefaced with a colon.  When a given path is passed to "run()"
       the code reference which the template maps to will be passed a hash where the keys are the variable names (sans colon) and the values are
       what was specified in place of the variables.

       The route map is ordered, so the most specific matching template is used and so you should order your templates from least generic to most
       generic.

       See REST::Application for details.  The only difference between this module and that one is that this one uses URI templates as keys in the
       "resourceHooks" rather than regexes.

METHODS

       These are methods which REST::Application::Routes has but its superclass does not.

       getTemplateVars()

       Returns a hash whose keys are the ":symbols" from the URI template and whose values are what where matched to be there.	It is assumed that
       this method is called either from within or after "loadResource()" is called.  Otherwise you're likely to get an empty hash back.

       getLastMatchTemplate()

       This is an alias for "getLastMatchPattern()", since this class is about templates rather than regexes.

AUTHORS

       Matthew O'Connor <matthew@canonical.org>

LICENSE

       This program is free software. It is subject to the same license as Perl itself.

SEE ALSO

       REST::Application, <http://manuals.rubyonrails.com/read/chapter/65>

perl v5.10.0							    2007-08-09					    REST::Application::Routes(3pm)

Check Out this Related Man Page

RT::Client::REST::User(3pm)				User Contributed Perl Documentation			       RT::Client::REST::User(3pm)

NAME

       RT::Client::REST::User -- user object representation.

SYNOPSIS

	 my $rt = RT::Client::REST->new(server => $ENV{RTSERVER});

	 my $user = RT::Client::REST::User->new(
	   rt  => $rt,
	   id  => $id,
	 )->retrieve;

DESCRIPTION

       RT::Client::REST::User is based on RT::Client::REST::Object.  The representation allows one to retrieve, edit, comment on, and create users
       in RT.

       Note: RT currently does not allow REST client to search users.

ATTRIBUTES

       id
	 For retrieval, you can specify either the numeric ID of the user or his username.  After the retrieval, however, this attribute will be
	 set to the numeric id.

       name
	 This is the username of the user.

       password
	 User's password.  Reading it will only give you a bunch of stars (what else would you expect?).

       privileged
	 Can the user have special rights?

       disabled
	 Can this user access RT?

       email_address
	 E-mail address of the user, EmailAddress.

       real_name
	 Real name of the user, RealName.

       gecos
	 Gecos.

       comments
	 Comments about this user.

       nickname
	 Nickname of this user.

       lang
	 Language for this user.

       organization
       address_one
	 First line of the street address, Address1.

       address_two
	 Second line of the street address, Address2.

       city
	 City segment of user's address.

       zip
	 ZIP or Postal code segment of user's address.

       country
	 Country segment of user's address.

       home_phone
	 User's home phone number, HomePhone.

       work_phone
	 User's work phone number, WorkPhone.

       cell_phone
	 User's cell phone number, MobilePhone.

       pager
	 User's pager number, PagerPhone.

       contactinfo
	 Contact info (Extra Info field).

       signature
	 Signature for the user.

DB METHODS

       For full explanation of these, please see "DB METHODS" in RT::Client::REST::Object documentation.

       retrieve
	 Retrieve RT user from database.

       store
	 Create or update the user.

       search
	 Currently RT does not allow REST clients to search users.

INTERNAL METHODS

       rt_type
	 Returns 'user'.

SEE ALSO

       RT::Client::REST, RT::Client::REST::Object, RT::Client::REST::SearchResult.

AUTHOR

       Dmitri Tikhonov <dtikhonov@yahoo.com>

LICENSE

       Perl license with the exception of RT::Client::REST, which is GPLed.

perl v5.14.2							    2012-01-20					       RT::Client::REST::User(3pm)

Linux and UNIX Man Pages

rest::application::routes(3pm) [debian man page]

Check Out this Related Man Page