[Jifty-commit] r4529 - in Net-Jifty: .
jifty-commit at lists.jifty.org
jifty-commit at lists.jifty.org
Wed Nov 21 22:14:53 EST 2007
Author: sartak
Date: Wed Nov 21 22:14:51 2007
New Revision: 4529
Modified:
Net-Jifty/ (props changed)
Net-Jifty/README
Net-Jifty/lib/Net/Jifty.pm
Log:
r45524 at onn: sartak | 2007-11-21 22:14:42 -0500
Doc updates. Use my bps email instead of gmail
Modified: Net-Jifty/README
==============================================================================
--- Net-Jifty/README (original)
+++ Net-Jifty/README Wed Nov 21 22:14:51 2007
@@ -42,18 +42,18 @@
This is called automatically when each Net::Jifty object is constructed
(unless a session ID is passed in).
- call Action, Args
- This uses the Jifty "web services" API to perform an action. This is NOT
- the REST interface, though it resembles it to some degree.
+ call ACTION, ARGS
+ This uses the Jifty "web services" API to perform "ACTION". This is
+ *not* the REST interface, though it resembles it to some degree.
This module currently only uses this to log in.
- method Method, URL[, Args]
+ method METHOD, URL[, ARGS]
This will perform a GET, POST, PUT, DELETE, etc using the internal
LWP::UserAgent object.
- Your URL may be a string or an array reference (which will have its
- parts properly escaped and joined with "/"). Your URL already has
+ "URL" may be a string or an array reference (which will have its parts
+ properly escaped and joined with "/"). "URL" already has
"http://your.site/=/" prepended to it, and ".yml" appended to it, so you
only need to pass something like "model/YourApp.Model.Foo/name", or
"[qw/model YourApp.Model.Foo name]".
@@ -61,56 +61,57 @@
This will return the data structure returned by the Jifty application,
or throw an error.
- post URL, Args
- This will post the arguments to the specified URL. See the documentation
- for "method".
+ post URL, ARGS
+ This will post "ARGS" to "URL". See the documentation for "method" about
+ the format of "URL".
- get URL, Args
- This will get the specified URL, using the arguments. See the
- documentation for "method".
+ get URL, ARGS
+ This will get the specified "URL" with "ARGS" as query parameters. See
+ the documentation for "method" about the format of "URL".
- act Action, Args
- Perform the specified action, using the specified arguments.
+ act ACTION, ARGS
+ Perform "ACTION", using "ARGS". This does use the REST interface.
- create Model, FIELDS
- Create a new object of type Model with the FIELDS set.
+ create MODEL, FIELDS
+ Create a new object of type "MODEL" with the "FIELDS" set.
- delete Model, Key => Value
- Find some Model where Key => Value and delete it
+ delete MODEL, KEY => VALUE
+ Find some "MODEL" where "KEY" is "VALUE" and delete it.
- update Model, Key => Value, FIELDS
- Find some Model where Key => Value and set FIELDS on it.
+ update MODEL, KEY => VALUE, FIELDS
+ Find some "MODEL" where "KEY" is "VALUE" and set "FIELDS" on it.
- read Model, Key => Value
- Find some Model where Key => Value and return it.
+ read MODEL, KEY => VALUE
+ Find some "MODEL" where "KEY" is "VALUE" and return it.
- canonicalize_package Type, Package
- Prepends "$appname.$Type." to $Package unless it's there already.
+ canonicalize_package TYPE, PACKAGE
+ Prepends "APPNAME.TYPE." to "PACKAGE" unless it's there already.
- canonicalize_action Action
- Prepends "$appname.Action." unless it's there already.
+ canonicalize_action ACTION
+ Prepends "APPNAME.Action." to "ACTION" unless it's there already.
- canonicalize_model Model
- Prepends "$appname.Model." unless it's there already.
+ canonicalize_model MODEL
+ Prepends "APPNAME.Model." to "MODEL" unless it's there already.
get_sid
- Retrieves the SID from the LWP::UserAgent object
+ Retrieves the sid from the LWP::UserAgent object.
- join_url Fragments
- Encodes the fragments and joins them with "/".
+ join_url FRAGMENTS
+ Encodes "FRAGMENTS" and joins them with "/".
- escape Strings
- URI escapes each string
+ escape STRINGS
+ Returns "STRINGS", properly URI-escaped.
- load_date Date
- Loads a yyyy-mm-dd date into a DateTime object.
+ load_date DATE
+ Loads "DATE" (which must be of the form "YYYY-MM-DD") into a DateTime
+ object.
- email_eq Email, Email
- Compares two email address. Returns true if they're equal, false if
- they're not.
+ email_eq EMAIL, EMAIL
+ Compares the two email addresses. Returns true if they're equal, false
+ if they're not.
- is_me Email
- Returns true if the given email looks like it is the current user's.
+ is_me EMAIL
+ Returns true if "EMAIL" looks like it is the same as the current user's.
load_config
This will return a hash reference of the user's preferences. Because
@@ -132,9 +133,9 @@
others.
read_config_file
- This transforms the config file to a hashref. It also does any
+ This transforms the config file into a hashref. It also does any
postprocessing needed, such as transforming localhost to 127.0.0.1 (due
- to an obscure bug, probably in HTTP::Cookies)
+ to an obscure bug, probably in HTTP::Cookies).
write_config_file
This will write the config to disk. This is usually only done when a sid
@@ -148,7 +149,7 @@
Jifty, Net::Hiveminder
AUTHOR
- Shawn M Moore, "<sartak at gmail.com>"
+ Shawn M Moore, "<sartak at bestpractical.com>"
BUGS
Please report any bugs or feature requests to "bug-net-jifty at
Modified: Net-Jifty/lib/Net/Jifty.pm
==============================================================================
--- Net-Jifty/lib/Net/Jifty.pm (original)
+++ Net-Jifty/lib/Net/Jifty.pm Wed Nov 21 22:14:51 2007
@@ -193,9 +193,9 @@
return 1;
}
-=head2 call Action, Args
+=head2 call ACTION, ARGS
-This uses the Jifty "web services" API to perform an action. This is NOT the
+This uses the Jifty "web services" API to perform C<ACTION>. This is I<not> the
REST interface, though it resembles it to some degree.
This module currently only uses this to log in.
@@ -222,13 +222,13 @@
}
}
-=head2 method Method, URL[, Args]
+=head2 method METHOD, URL[, ARGS]
This will perform a GET, POST, PUT, DELETE, etc using the internal
L<LWP::UserAgent> object.
-Your URL may be a string or an array reference (which will have its parts
-properly escaped and joined with C</>). Your URL already has
+C<URL> may be a string or an array reference (which will have its parts
+properly escaped and joined with C</>). C<URL> already has
C<http://your.site/=/> prepended to it, and C<.yml> appended to it, so you only
need to pass something like C<model/YourApp.Model.Foo/name>, or
C<[qw/model YourApp.Model.Foo name]>.
@@ -280,10 +280,10 @@
}
}
-=head2 post URL, Args
+=head2 post URL, ARGS
-This will post the arguments to the specified URL. See the documentation for
-C<method>.
+This will post C<ARGS> to C<URL>. See the documentation for C<method> about
+the format of C<URL>.
=cut
@@ -292,10 +292,10 @@
$self->method('post', @_);
}
-=head2 get URL, Args
+=head2 get URL, ARGS
-This will get the specified URL, using the arguments. See the documentation for
-C<method>.
+This will get the specified C<URL> with C<ARGS> as query parameters. See the
+documentation for C<method> about the format of C<URL>.
=cut
@@ -304,9 +304,9 @@
$self->method('get', @_);
}
-=head2 act Action, Args
+=head2 act ACTION, ARGS
-Perform the specified action, using the specified arguments.
+Perform C<ACTION>, using C<ARGS>. This does use the REST interface.
=cut
@@ -317,9 +317,9 @@
return $self->post(["action", $action], @_);
}
-=head2 create Model, FIELDS
+=head2 create MODEL, FIELDS
-Create a new object of type Model with the FIELDS set.
+Create a new object of type C<MODEL> with the C<FIELDS> set.
=cut
@@ -330,9 +330,9 @@
return $self->post(["model", $model], @_);
}
-=head2 delete Model, Key => Value
+=head2 delete MODEL, KEY => VALUE
-Find some Model where Key => Value and delete it
+Find some C<MODEL> where C<KEY> is C<VALUE> and delete it.
=cut
@@ -345,9 +345,9 @@
return $self->method(delete => ["model", $model, $key, $value]);
}
-=head2 update Model, Key => Value, FIELDS
+=head2 update MODEL, KEY => VALUE, FIELDS
-Find some Model where Key => Value and set FIELDS on it.
+Find some C<MODEL> where C<KEY> is C<VALUE> and set C<FIELDS> on it.
=cut
@@ -360,9 +360,9 @@
return $self->method(put => ["model", $model, $key, $value], @_);
}
-=head2 read Model, Key => Value
+=head2 read MODEL, KEY => VALUE
-Find some Model where Key => Value and return it.
+Find some C<MODEL> where C<KEY> is C<VALUE> and return it.
=cut
@@ -375,9 +375,9 @@
return $self->get(["model", $model, $key, $value]);
}
-=head2 canonicalize_package Type, Package
+=head2 canonicalize_package TYPE, PACKAGE
-Prepends C<$appname.$Type.> to C<$Package> unless it's there already.
+Prepends C<APPNAME.TYPE.> to C<PACKAGE> unless it's there already.
=cut
@@ -394,9 +394,9 @@
return "$appname.$type.$package";
}
-=head2 canonicalize_action Action
+=head2 canonicalize_action ACTION
-Prepends C<$appname.Action.> unless it's there already.
+Prepends C<APPNAME.Action.> to C<ACTION> unless it's there already.
=cut
@@ -405,9 +405,9 @@
return $self->canonicalize_package('Action', @_);
}
-=head2 canonicalize_model Model
+=head2 canonicalize_model MODEL
-Prepends C<$appname.Model.> unless it's there already.
+Prepends C<APPNAME.Model.> to C<MODEL> unless it's there already.
=cut
@@ -418,7 +418,7 @@
=head2 get_sid
-Retrieves the SID from the LWP::UserAgent object
+Retrieves the sid from the L<LWP::UserAgent> object.
=cut
@@ -433,9 +433,9 @@
$self->sid($sid);
}
-=head2 join_url Fragments
+=head2 join_url FRAGMENTS
-Encodes the fragments and joins them with C</>.
+Encodes C<FRAGMENTS> and joins them with C</>.
=cut
@@ -445,9 +445,9 @@
return join '/', map { $self->escape($_) } grep { defined } @_
}
-=head2 escape Strings
+=head2 escape STRINGS
-URI escapes each string
+Returns C<STRINGS>, properly URI-escaped.
=cut
@@ -459,9 +459,10 @@
@_
}
-=head2 load_date Date
+=head2 load_date DATE
-Loads a yyyy-mm-dd date into a L<DateTime> object.
+Loads C<DATE> (which must be of the form C<YYYY-MM-DD>) into a L<DateTime>
+object.
=cut
@@ -483,9 +484,10 @@
);
}
-=head2 email_eq Email, Email
+=head2 email_eq EMAIL, EMAIL
-Compares two email address. Returns true if they're equal, false if they're not.
+Compares the two email addresses. Returns true if they're equal, false if
+they're not.
=cut
@@ -511,9 +513,9 @@
return $a eq $b;
}
-=head2 is_me Email
+=head2 is_me EMAIL
-Returns true if the given email looks like it is the current user's.
+Returns true if C<EMAIL> looks like it is the same as the current user's.
=cut
@@ -608,9 +610,9 @@
=head2 read_config_file
-This transforms the config file to a hashref. It also does any postprocessing
+This transforms the config file into a hashref. It also does any postprocessing
needed, such as transforming localhost to 127.0.0.1 (due to an obscure bug,
-probably in HTTP::Cookies)
+probably in HTTP::Cookies).
=cut
@@ -699,7 +701,7 @@
=head1 AUTHOR
-Shawn M Moore, C<< <sartak at gmail.com> >>
+Shawn M Moore, C<< <sartak at bestpractical.com> >>
=head1 BUGS
More information about the Jifty-commit
mailing list