Catalyst-Plugin-SmartURI-0.039 000755 000766 000024 0 12264327647 16360 5 ustar 00rkitover staff 000000 000000 README 100644 000766 000024 11620 12264327647 17341 0 ustar 00rkitover staff 000000 000000 Catalyst-Plugin-SmartURI-0.039 NAME
Catalyst::Plugin::SmartURI - Configurable URIs for Catalyst
SYNOPSIS
In your lib/MyApp.pm, load the plugin and your other plugins, for
example:
use Catalyst qw/
-Debug
ConfigLoader
Static::Simple
Session
Session::Store::Memcached
Session::State::Cookie
Authentication
Authorization::Roles
+CatalystX::SimpleLogin
SmartURI
/;
In your .conf:
disposition host-header # application-wide
uri_class URI::SmartURI # by default
Per request:
$c->uri_disposition('absolute');
Methods on URIs:
uri_for" and "$c->req->uri_with" return absolute,
hostless or relative URIs, or URIs based on the 'Host' header. Also
allows configuring which URI class to use. Works on application-wide or
per-request basis.
This is useful in situations where you're for example, redirecting to a
lighttpd from a firewall rule, instead of a real proxy, and you want
your links and redirects to still work correctly.
To use your own URI class, just subclass URI::SmartURI and set
"uri_class", or write a class that follows the same interface.
This plugin installs a custom "$c->request_class", however it does so in
a way that won't break if you've already set "$c->request_class"
yourself, ie. by using Catalyst::Action::REST (thanks mst!).
There is a minor performance penalty in perls older than 5.10, due to
Class::C3, but only at initialization time.
METHODS
$c->uri_for
$c->req->uri_with
Returns a "$c->uri_class" object (URI::SmartURI by default) in the
configured "$c->uri_disposition".
$c->req->uri
Returns a "$c->uri_class" object. If the context hasn't been prepared
yet, uses the configured value for "uri_class".
"$c->req->uri->relative" will be relative to "$c->req->base".
$c->req->referer
Returns a "$c->uri_class" object for the referer (or configured
"uri_class" if there's no context) with reference set to "$c->req->uri"
if it comes from "$c->req->base".
In other words, if referer is your app, you can do
"$c->req->referer->relative" and it will do the right thing.
CONFIGURATION
In myapp.conf:
disposition absolute
uri_class URI::SmartURI
disposition
One of 'absolute', 'hostless', 'relative' or 'host-header'. Defaults
to 'absolute'.
The special disposition 'host-header' uses the value of your 'Host:'
header.
uri_class
The class to use for URIs, defaults to URI::SmartURI.
PER REQUEST
package MyAPP::Controller::RSSFeed;
...
sub begin : Private {
my ($self, $c) = @_;
$c->uri_class('Your::URI::Class::For::Request');
$c->uri_disposition('absolute');
}
$c->uri_disposition('absolute'|'hostless'|'relative'|'host-header')
Set URI disposition to use for the duration of the request.
$c->uri_class($class)
Set the URI class to use for "$c->uri_for" and "$c->req->uri_with"
for the duration of the request.
EXTENDING
"$c->prepare_uri" actually creates the URI, which you can override.
SEE ALSO
URI::SmartURI, Catalyst, URI
AUTHOR
Rafael Kitover, ""
BUGS
Please report any bugs or feature requests to
"bug-catalyst-plugin-smarturi at rt.cpan.org", or through the web
interface at
. 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 Catalyst::Plugin::SmartURI
You can also look for information at:
* RT: CPAN's request tracker
* AnnoCPAN: Annotated CPAN documentation
* CPAN Ratings
* Search CPAN
ACKNOWLEDGEMENTS
from #catalyst:
vipul came up with the idea
mst came up with the design and implementation details for the current
version
kd reviewed my code and offered suggestions
TODO
I'd like to extend on Catalyst::Plugin::RequireSSL, and make a plugin
that rewrites URIs for actions with an SSL attribute.
COPYRIGHT & LICENSE
Copyright (c) 2008 Rafael Kitover
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
Changes 100644 000766 000024 3273 12264327647 17741 0 ustar 00rkitover staff 000000 000000 Catalyst-Plugin-SmartURI-0.039 Revision history for Catalyst-Plugin-SmartURI
0.039 2014-01-11 15:55:01
- remove Class::MOP::load_class RT#90916
0.038 2013-11-14 20:02:08
- return undef for $c->req->referer correctly when there is no Referer
header
0.037 2013-08-26 23:50:44
- converted to git and moved to github
- converted to dzil
- add plugin loading example to SYNOPSIS (RT#88069)
0.036 2009-11-24 09:08:09
- POD fixes from Frank Wiegand (RT#51885)
0.035 2009-09-24 04:35:28
- fix typo in pod (RT#49933)
0.034 2009-05-13 23:46:18
- fix compatibility with Catalyst::Action::REST v0.71
- move inline tests into t/lib
0.033 2009-04-29 19:46:04
- last dist was missing inc/
0.032 2009-04-27 15:42:07
- converted to Moose
- some minor POD cleanups
0.030 2008-11-19 17:54:37
- fixed for Catalyst 5.8
0.029 2008-10-09 07:02:46
- fixed the host-header stuff for when there's no port.
0.028 2008-08-22 03:53:49
- added note to the POD about usage with C::C::REST.
0.027 2008-07-06 14:17:12
- improved request class, better Host header parsing, fixed POD.
0.025 2008-06-28 08:33:57
- fucked up the pod for SYNOPSIS...
0.024 2008-06-28 03:01:53
- added 'host-header' disposition.
- converted conf key to 'Plugin::SmartURI'
0.023 2008-06-28 01:14:49
- weaken saved context.
0.022 2008-06-24 16:52:55
- fix weird bug with initialization that sometimes happens.
0.021 2008-06-16 22:20:42
- minor speedup, avoiding unnecessary string evals.
0.02 2008-06-03 21:58:17
- moved Catalyst::SmartURI into a separate dist as URI::SmartURI
0.01_01 2008-04-01 08:33:13
- first dev release.
0.01 2008-03-08 03:30:31
- first version.
LICENSE 100644 000766 000024 43661 12264327647 17500 0 ustar 00rkitover staff 000000 000000 Catalyst-Plugin-SmartURI-0.039 This software is copyright (c) 2013 by Rafael Kitover.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
Terms of the Perl programming language system itself
a) the GNU General Public License as published by the Free
Software Foundation; either version 1, or (at your option) any
later version, or
b) the "Artistic License"
--- The GNU General Public License, Version 1, February 1989 ---
This software is Copyright (c) 2013 by Rafael Kitover.
This is free software, licensed under:
The GNU General Public License, Version 1, February 1989
GNU GENERAL PUBLIC LICENSE
Version 1, February 1989
Copyright (C) 1989 Free Software Foundation, Inc.
51 Franklin St, Suite 500, Boston, MA 02110-1335 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The license agreements of most software companies try to keep users
at the mercy of those companies. By contrast, our General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. The
General Public License applies to the Free Software Foundation's
software and to any other program whose authors commit to using it.
You can use it for your programs, too.
When we speak of free software, we are referring to freedom, not
price. Specifically, the General Public License is designed to make
sure that you have the freedom to give away or sell copies of free
software, that you receive source code or can get it if you want it,
that you can change the software or use pieces of it in new free
programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of a such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must tell them their rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License Agreement applies to any program or other work which
contains a notice placed by the copyright holder saying it may be
distributed under the terms of this General Public License. The
"Program", below, refers to any such program or work, and a "work based
on the Program" means either the Program or any work containing the
Program or a portion of it, either verbatim or with modifications. Each
licensee is addressed as "you".
1. You may copy and distribute verbatim copies of the Program's source
code as you receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice and
disclaimer of warranty; keep intact all the notices that refer to this
General Public License and to the absence of any warranty; and give any
other recipients of the Program a copy of this General Public License
along with the Program. You may charge a fee for the physical act of
transferring a copy.
2. You may modify your copy or copies of the Program or any portion of
it, and copy and distribute such modifications under the terms of Paragraph
1 above, provided that you also do the following:
a) cause the modified files to carry prominent notices stating that
you changed the files and the date of any change; and
b) cause the whole of any work that you distribute or publish, that
in whole or in part contains the Program or any part thereof, either
with or without modifications, to be licensed at no charge to all
third parties under the terms of this General Public License (except
that you may choose to grant warranty protection to some or all
third parties, at your option).
c) If the modified program normally reads commands interactively when
run, you must cause it, when started running for such interactive use
in the simplest and most usual way, to print or display an
announcement including an appropriate copyright notice and a notice
that there is no warranty (or else, saying that you provide a
warranty) and that users may redistribute the program under these
conditions, and telling the user how to view a copy of this General
Public License.
d) You may charge a fee for the physical act of transferring a
copy, and you may at your option offer warranty protection in
exchange for a fee.
Mere aggregation of another independent work with the Program (or its
derivative) on a volume of a storage or distribution medium does not bring
the other work under the scope of these terms.
3. You may copy and distribute the Program (or a portion or derivative of
it, under Paragraph 2) in object code or executable form under the terms of
Paragraphs 1 and 2 above provided that you also do one of the following:
a) accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of
Paragraphs 1 and 2 above; or,
b) accompany it with a written offer, valid for at least three
years, to give any third party free (except for a nominal charge
for the cost of distribution) a complete machine-readable copy of the
corresponding source code, to be distributed under the terms of
Paragraphs 1 and 2 above; or,
c) accompany it with the information you received as to where the
corresponding source code may be obtained. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form alone.)
Source code for a work means the preferred form of the work for making
modifications to it. For an executable file, complete source code means
all the source code for all modules it contains; but, as a special
exception, it need not include source code for modules which are standard
libraries that accompany the operating system on which the executable
file runs, or for standard header files or definitions files that
accompany that operating system.
4. You may not copy, modify, sublicense, distribute or transfer the
Program except as expressly provided under this General Public License.
Any attempt otherwise to copy, modify, sublicense, distribute or transfer
the Program is void, and will automatically terminate your rights to use
the Program under this License. However, parties who have received
copies, or rights to use copies, from you under this General Public
License will not have their licenses terminated so long as such parties
remain in full compliance.
5. By copying, distributing or modifying the Program (or any work based
on the Program) you indicate your acceptance of this license to do so,
and all its terms and conditions.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the original
licensor to copy, distribute or modify the Program subject to these
terms and conditions. You may not impose any further restrictions on the
recipients' exercise of the rights granted herein.
7. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of the license which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
the license, you may choose any version ever published by the Free Software
Foundation.
8. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
Appendix: How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to humanity, the best way to achieve this is to make it
free software which everyone can redistribute and change under these
terms.
To do so, attach the following notices to the program. It is safest to
attach them to the start of each source file to most effectively convey
the exclusion of warranty; and each file should have at least the
"copyright" line and a pointer to where the full notice is found.
Copyright (C) 19yy
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 1, or (at your option)
any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) 19xx name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the
appropriate parts of the General Public License. Of course, the
commands you use may be called something other than `show w' and `show
c'; they could even be mouse-clicks or menu items--whatever suits your
program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the
program `Gnomovision' (a program to direct compilers to make passes
at assemblers) written by James Hacker.
, 1 April 1989
Ty Coon, President of Vice
That's all there is to it!
--- The Artistic License 1.0 ---
This software is Copyright (c) 2013 by Rafael Kitover.
This is free software, licensed under:
The Artistic License 1.0
The Artistic License
Preamble
The intent of this document is to state the conditions under which a Package
may be copied, such that the Copyright Holder maintains some semblance of
artistic control over the development of the package, while giving the users of
the package the right to use and distribute the Package in a more-or-less
customary fashion, plus the right to make reasonable modifications.
Definitions:
- "Package" refers to the collection of files distributed by the Copyright
Holder, and derivatives of that collection of files created through
textual modification.
- "Standard Version" refers to such a Package if it has not been modified,
or has been modified in accordance with the wishes of the Copyright
Holder.
- "Copyright Holder" is whoever is named in the copyright or copyrights for
the package.
- "You" is you, if you're thinking about copying or distributing this Package.
- "Reasonable copying fee" is whatever you can justify on the basis of media
cost, duplication charges, time of people involved, and so on. (You will
not be required to justify it to the Copyright Holder, but only to the
computing community at large as a market that must bear the fee.)
- "Freely Available" means that no fee is charged for the item itself, though
there may be fees involved in handling the item. It also means that
recipients of the item may redistribute it under the same conditions they
received it.
1. You may make and give away verbatim copies of the source form of the
Standard Version of this Package without restriction, provided that you
duplicate all of the original copyright notices and associated disclaimers.
2. You may apply bug fixes, portability fixes and other modifications derived
from the Public Domain or from the Copyright Holder. A Package modified in such
a way shall still be considered the Standard Version.
3. You may otherwise modify your copy of this Package in any way, provided that
you insert a prominent notice in each changed file stating how and when you
changed that file, and provided that you do at least ONE of the following:
a) place your modifications in the Public Domain or otherwise make them
Freely Available, such as by posting said modifications to Usenet or an
equivalent medium, or placing the modifications on a major archive site
such as ftp.uu.net, or by allowing the Copyright Holder to include your
modifications in the Standard Version of the Package.
b) use the modified Package only within your corporation or organization.
c) rename any non-standard executables so the names do not conflict with
standard executables, which must also be provided, and provide a separate
manual page for each non-standard executable that clearly documents how it
differs from the Standard Version.
d) make other distribution arrangements with the Copyright Holder.
4. You may distribute the programs of this Package in object code or executable
form, provided that you do at least ONE of the following:
a) distribute a Standard Version of the executables and library files,
together with instructions (in the manual page or equivalent) on where to
get the Standard Version.
b) accompany the distribution with the machine-readable source of the Package
with your modifications.
c) accompany any non-standard executables with their corresponding Standard
Version executables, giving the non-standard executables non-standard
names, and clearly documenting the differences in manual pages (or
equivalent), together with instructions on where to get the Standard
Version.
d) make other distribution arrangements with the Copyright Holder.
5. You may charge a reasonable copying fee for any distribution of this
Package. You may charge any fee you choose for support of this Package. You
may not charge a fee for this Package itself. However, you may distribute this
Package in aggregate with other (possibly commercial) programs as part of a
larger (possibly commercial) software distribution provided that you do not
advertise this Package as a product of your own.
6. The scripts and library files supplied as input to or produced as output
from the programs of this Package do not automatically fall under the copyright
of this Package, but belong to whomever generated them, and may be sold
commercially, and may be aggregated with this Package.
7. C or perl subroutines supplied by you and linked into this Package shall not
be considered part of this Package.
8. The name of the Copyright Holder may not be used to endorse or promote
products derived from this software without specific prior written permission.
9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
The End
dist.ini 100644 000766 000024 543 12264327647 20067 0 ustar 00rkitover staff 000000 000000 Catalyst-Plugin-SmartURI-0.039 name = Catalyst-Plugin-SmartURI
author = Rafael Kitover
license = Perl_5
copyright_holder = Rafael Kitover
copyright_year = 2013
[@AVAR]
dist = Catalyst-Plugin-SmartURI
bugtracker = rt
authority = cpan:RKITOVER
github_user = rkitover
install_command = cpanm .
META.yml 100644 000766 000024 2226 12264327647 17714 0 ustar 00rkitover staff 000000 000000 Catalyst-Plugin-SmartURI-0.039 ---
abstract: 'Configurable URIs for Catalyst'
author:
- 'Rafael Kitover '
build_requires:
Catalyst: 0
Catalyst::Action::REST: 0
Catalyst::Controller: 0
Catalyst::Test: 0
File::Spec: 0
FindBin: 0
HTTP::Request: 0
IO::Handle: 0
IPC::Open3: 0
Test::More: 0
URI::SmartURI: 0
lib: 0
parent: 0
strict: 0
warnings: 0
configure_requires:
ExtUtils::MakeMaker: 6.30
dynamic_config: 0
generated_by: 'Dist::Zilla version 5.008, CPAN::Meta::Converter version 2.132830'
license: perl
meta-spec:
url: http://module-build.sourceforge.net/META-spec-v1.4.html
version: 1.4
name: Catalyst-Plugin-SmartURI
no_index:
directory:
- t
requires:
Catalyst::Exception: 0
Catalyst::Request: 0
Class::C3::Componentised: 0
Class::Load: 0
Moose: 0
Scalar::Util: 0
mro: 0
namespace::clean: 0
perl: 5.008001
resources:
bugtracker: https://rt.cpan.org/Public/Dist/Display.html?Name=Catalyst-Plugin-SmartURI
homepage: http://metacpan.org/release/Catalyst-Plugin-SmartURI
license: http://dev.perl.org/licenses/
repository: git://github.com/rkitover/catalyst-plugin-smarturi.git
version: 0.039
x_authority: cpan:RKITOVER
MANIFEST 100644 000766 000024 630 12264327647 17551 0 ustar 00rkitover staff 000000 000000 Catalyst-Plugin-SmartURI-0.039 # This file was automatically generated by Dist::Zilla::Plugin::Manifest v5.008.
Changes
LICENSE
MANIFEST
META.json
META.yml
Makefile.PL
README
dist.ini
lib/Catalyst/Plugin/SmartURI.pm
t/00-compile.t
t/01-basic.t
t/02-c-a-rest-compat.t
t/03-uri-class.t
t/lib/MyURI.pm
t/lib/TestApp.pm
t/lib/TestApp/Controller/MyURI.pm
t/lib/TestApp/Controller/REST.pm
t/lib/TestApp/Controller/Root.pm
t/release-pod-syntax.t
META.json 100644 000766 000024 4375 12264327647 20073 0 ustar 00rkitover staff 000000 000000 Catalyst-Plugin-SmartURI-0.039 {
"abstract" : "Configurable URIs for Catalyst",
"author" : [
"Rafael Kitover "
],
"dynamic_config" : 0,
"generated_by" : "Dist::Zilla version 5.008, CPAN::Meta::Converter version 2.132830",
"license" : [
"perl_5"
],
"meta-spec" : {
"url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec",
"version" : "2"
},
"name" : "Catalyst-Plugin-SmartURI",
"no_index" : {
"directory" : [
"t"
]
},
"prereqs" : {
"configure" : {
"requires" : {
"ExtUtils::MakeMaker" : "6.30"
}
},
"develop" : {
"requires" : {
"Test::Pod" : "1.41"
}
},
"runtime" : {
"requires" : {
"Catalyst::Exception" : "0",
"Catalyst::Request" : "0",
"Class::C3::Componentised" : "0",
"Class::Load" : "0",
"Moose" : "0",
"Scalar::Util" : "0",
"mro" : "0",
"namespace::clean" : "0",
"perl" : "5.008001"
}
},
"test" : {
"requires" : {
"Catalyst" : "0",
"Catalyst::Action::REST" : "0",
"Catalyst::Controller" : "0",
"Catalyst::Test" : "0",
"File::Spec" : "0",
"FindBin" : "0",
"HTTP::Request" : "0",
"IO::Handle" : "0",
"IPC::Open3" : "0",
"Test::More" : "0",
"URI::SmartURI" : "0",
"lib" : "0",
"parent" : "0",
"strict" : "0",
"warnings" : "0"
}
}
},
"release_status" : "stable",
"resources" : {
"bugtracker" : {
"mailto" : "bug-Catalyst-Plugin-SmartURI@rt.cpan.org",
"web" : "https://rt.cpan.org/Public/Dist/Display.html?Name=Catalyst-Plugin-SmartURI"
},
"homepage" : "http://metacpan.org/release/Catalyst-Plugin-SmartURI",
"license" : [
"http://dev.perl.org/licenses/"
],
"repository" : {
"type" : "git",
"url" : "git://github.com/rkitover/catalyst-plugin-smarturi.git",
"web" : "http://github.com/rkitover/catalyst-plugin-smarturi"
}
},
"version" : "0.039",
"x_authority" : "cpan:RKITOVER"
}
Makefile.PL 100644 000766 000024 4052 12264327647 20414 0 ustar 00rkitover staff 000000 000000 Catalyst-Plugin-SmartURI-0.039
# This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v5.008.
use strict;
use warnings;
use 5.008001;
use ExtUtils::MakeMaker 6.30;
my %WriteMakefileArgs = (
"ABSTRACT" => "Configurable URIs for Catalyst",
"AUTHOR" => "Rafael Kitover ",
"BUILD_REQUIRES" => {},
"CONFIGURE_REQUIRES" => {
"ExtUtils::MakeMaker" => "6.30"
},
"DISTNAME" => "Catalyst-Plugin-SmartURI",
"EXE_FILES" => [],
"LICENSE" => "perl",
"NAME" => "Catalyst::Plugin::SmartURI",
"PREREQ_PM" => {
"Catalyst::Exception" => 0,
"Catalyst::Request" => 0,
"Class::C3::Componentised" => 0,
"Class::Load" => 0,
"Moose" => 0,
"Scalar::Util" => 0,
"mro" => 0,
"namespace::clean" => 0
},
"TEST_REQUIRES" => {
"Catalyst" => 0,
"Catalyst::Action::REST" => 0,
"Catalyst::Controller" => 0,
"Catalyst::Test" => 0,
"File::Spec" => 0,
"FindBin" => 0,
"HTTP::Request" => 0,
"IO::Handle" => 0,
"IPC::Open3" => 0,
"Test::More" => 0,
"URI::SmartURI" => 0,
"lib" => 0,
"parent" => 0,
"strict" => 0,
"warnings" => 0
},
"VERSION" => "0.039",
"test" => {
"TESTS" => "t/*.t"
}
);
my %FallbackPrereqs = (
"Catalyst" => 0,
"Catalyst::Action::REST" => 0,
"Catalyst::Controller" => 0,
"Catalyst::Exception" => 0,
"Catalyst::Request" => 0,
"Catalyst::Test" => 0,
"Class::C3::Componentised" => 0,
"Class::Load" => 0,
"File::Spec" => 0,
"FindBin" => 0,
"HTTP::Request" => 0,
"IO::Handle" => 0,
"IPC::Open3" => 0,
"Moose" => 0,
"Scalar::Util" => 0,
"Test::More" => 0,
"URI::SmartURI" => 0,
"lib" => 0,
"mro" => 0,
"namespace::clean" => 0,
"parent" => 0,
"strict" => 0,
"warnings" => 0
);
unless ( eval { ExtUtils::MakeMaker->VERSION(6.63_03) } ) {
delete $WriteMakefileArgs{TEST_REQUIRES};
delete $WriteMakefileArgs{BUILD_REQUIRES};
$WriteMakefileArgs{PREREQ_PM} = \%FallbackPrereqs;
}
delete $WriteMakefileArgs{CONFIGURE_REQUIRES}
unless eval { ExtUtils::MakeMaker->VERSION(6.52) };
WriteMakefile(%WriteMakefileArgs);
t 000755 000766 000024 0 12264327647 16544 5 ustar 00rkitover staff 000000 000000 Catalyst-Plugin-SmartURI-0.039 01-basic.t 100644 000766 000024 3166 12264327647 20376 0 ustar 00rkitover staff 000000 000000 Catalyst-Plugin-SmartURI-0.039/t #!perl
use strict;
use warnings;
use Test::More;
use FindBin '$Bin';
use lib "$Bin/lib";
use Catalyst::Test 'TestApp';
use HTTP::Request;
is(request('/test_uri_for_redirect')->header('location'),
'/test_uri_for_redirect', 'redirect location');
is(get('/per_request'), 'dummy', 'per-request disposition');
is(get('/test_req_uri_with'),
'/test_req_uri_with?the_word_that_must_be_heard=mtfnpy',
'$c->req->uri_with test, and disposition reset');
is(get('/test_uri_object'), '/test_uri_object',
'URI objects are functional');
my $req = HTTP::Request->new(GET => '/host_header');
$req->header(Host => 'www.dongs.com');
is(request($req)->content, 'http://www.dongs.com/dummy',
'host-header disposition');
$req = HTTP::Request->new(GET => '/host_header_with_port');
$req->header(Host => 'www.hlagh.com:8080');
is(request($req)->content, 'http://www.hlagh.com:8080/dummy',
'host-header disposition with port');
my %try_referers = (
foo => 'foo',
blank => '',
'undef' => undef
);
while (my ($referer_val_name, $referer_val) = each %try_referers) {
$req = HTTP::Request->new(GET => '/say_referer');
$req->header(Referer => $referer_val);
my $content = request($req)->content;
is($content, $referer_val_name,
"Referer: $referer_val_name gives \$c->req->referer of '$content'");
}
is(get('/req_uri_class'), 'MyURI::http http://localhost/req_uri_class',
'overridden $c->req->uri');
$req = HTTP::Request->new(GET => '/req_referer_class');
$req->header(Referer => 'dummy');
like(get($req), qr/^MyURI::/,
'overridden $c->req->referer');
done_testing;
# vim: expandtab shiftwidth=4:
lib 000755 000766 000024 0 12264327647 17312 5 ustar 00rkitover staff 000000 000000 Catalyst-Plugin-SmartURI-0.039/t MyURI.pm 100644 000766 000024 227 12264327647 20736 0 ustar 00rkitover staff 000000 000000 Catalyst-Plugin-SmartURI-0.039/t/lib package MyURI;
use parent 'URI::SmartURI';
sub mtfnpy {
my $uri = shift;
$uri->query_form([ $uri->query_form, qw(foo bar) ]);
$uri
}
1;
00-compile.t 100644 000766 000024 1735 12264327647 20744 0 ustar 00rkitover staff 000000 000000 Catalyst-Plugin-SmartURI-0.039/t use 5.006;
use strict;
use warnings;
# this test was generated with Dist::Zilla::Plugin::Test::Compile 2.039
use Test::More tests => 1 + ($ENV{AUTHOR_TESTING} ? 1 : 0);
my @module_files = (
'Catalyst/Plugin/SmartURI.pm'
);
# no fake home requested
my $inc_switch = -d 'blib' ? '-Mblib' : '-Ilib';
use File::Spec;
use IPC::Open3;
use IO::Handle;
open my $stdin, '<', File::Spec->devnull or die "can't open devnull: $!";
my @warnings;
for my $lib (@module_files)
{
# see L
my $stderr = IO::Handle->new;
my $pid = open3($stdin, '>&STDERR', $stderr, $^X, $inc_switch, '-e', "require q[$lib]");
binmode $stderr, ':crlf' if $^O eq 'MSWin32';
my @_warnings = <$stderr>;
waitpid($pid, 0);
is($?, 0, "$lib loaded ok");
if (@_warnings)
{
warn @_warnings;
push @warnings, @_warnings;
}
}
is(scalar(@warnings), 0, 'no warnings found') if $ENV{AUTHOR_TESTING};
03-uri-class.t 100644 000766 000024 362 12264327647 21174 0 ustar 00rkitover staff 000000 000000 Catalyst-Plugin-SmartURI-0.039/t #!perl
use strict;
use warnings;
use FindBin '$Bin';
use lib "$Bin/lib";
use Catalyst::Test 'TestApp';
use Test::More tests => 1;
is(get('/test_my_uri'), '/dummy?foo=bar', 'configured uri_class');
# vim: expandtab shiftwidth=4 ts=4 tw=80:
TestApp.pm 100644 000766 000024 262 12264327647 21350 0 ustar 00rkitover staff 000000 000000 Catalyst-Plugin-SmartURI-0.039/t/lib package TestApp;
use Catalyst qw/SmartURI/;
__PACKAGE__->config({'Plugin::SmartURI' => {
disposition => 'hostless',
uri_class => 'MyURI',
}});
__PACKAGE__->setup;
1;
02-c-a-rest-compat.t 100644 000766 000024 563 12264327647 22170 0 ustar 00rkitover staff 000000 000000 Catalyst-Plugin-SmartURI-0.039/t #!perl
use strict;
use warnings;
use Test::More tests => 1;
use FindBin '$Bin';
use lib "$Bin/lib";
use Catalyst::Test 'TestApp';
SKIP: {
skip 'Catalyst::Action::REST not installed', 1
if eval { require Catalyst::Action::REST }, $@;
is(get('/foo'), '/foo?foo=bar',
'C::A::REST and SmartURI are both functional');
}
# vim: expandtab shiftwidth=4 ts=4 tw=80:
release-pod-syntax.t 100644 000766 000024 570 12264327647 22577 0 ustar 00rkitover staff 000000 000000 Catalyst-Plugin-SmartURI-0.039/t #!perl
BEGIN {
unless ($ENV{RELEASE_TESTING}) {
require Test::More;
Test::More::plan(skip_all => 'these tests are for release candidate testing');
}
}
# This file was automatically generated by Dist::Zilla::Plugin::PodSyntaxTests.
use Test::More;
eval "use Test::Pod 1.41";
plan skip_all => "Test::Pod 1.41 required for testing POD" if $@;
all_pod_files_ok();
Plugin 000755 000766 000024 0 12264327647 22071 5 ustar 00rkitover staff 000000 000000 Catalyst-Plugin-SmartURI-0.039/lib/Catalyst SmartURI.pm 100644 000766 000024 22167 12264327647 24265 0 ustar 00rkitover staff 000000 000000 Catalyst-Plugin-SmartURI-0.039/lib/Catalyst/Plugin package Catalyst::Plugin::SmartURI;
BEGIN {
$Catalyst::Plugin::SmartURI::AUTHORITY = 'cpan:RKITOVER';
}
{
$Catalyst::Plugin::SmartURI::VERSION = '0.039';
}
use Moose;
use mro 'c3';
use 5.008001;
use Class::C3::Componentised;
use Scalar::Util 'weaken';
use Catalyst::Exception ();
use Class::Load ();
use namespace::clean -except => 'meta';
has uri_disposition => (is => 'rw', isa => 'Str');
has uri_class => (is => 'rw', isa => 'Str');
my $context; # keep a weakend copy for the Request class to use
my ($conf_disposition, $conf_uri_class); # configured values
=head1 NAME
Catalyst::Plugin::SmartURI - Configurable URIs for Catalyst
=head1 SYNOPSIS
In your lib/MyApp.pm, load the plugin and your other plugins, for example:
use Catalyst qw/
-Debug
ConfigLoader
Static::Simple
Session
Session::Store::Memcached
Session::State::Cookie
Authentication
Authorization::Roles
+CatalystX::SimpleLogin
SmartURI
/;
In your .conf:
disposition host-header # application-wide
uri_class URI::SmartURI # by default
Per request:
$c->uri_disposition('absolute');
Methods on URIs:
uri_for >> and C<< $c->req->uri_with >> return absolute, hostless or
relative URIs, or URIs based on the 'Host' header. Also allows configuring which
URI class to use. Works on application-wide or per-request basis.
This is useful in situations where you're for example, redirecting to a lighttpd
from a firewall rule, instead of a real proxy, and you want your links and
redirects to still work correctly.
To use your own URI class, just subclass L and set
C, or write a class that follows the same interface.
This plugin installs a custom C<< $c->request_class >>, however it does so in a way
that won't break if you've already set C<< $c->request_class >> yourself, ie. by
using L (thanks mst!).
There is a minor performance penalty in perls older than 5.10, due to
L, but only at initialization time.
=head1 METHODS
=head2 $c->uri_for
=head2 $c->req->uri_with
Returns a C<< $c->uri_class >> object (L by default) in the configured
C<< $c->uri_disposition >>.
=head2 $c->req->uri
Returns a C<< $c->uri_class >> object. If the context hasn't been prepared yet, uses
the configured value for C.
C<< $c->req->uri->relative >> will be relative to C<< $c->req->base >>.
=head2 $c->req->referer
Returns a C<< $c->uri_class >> object for the referer (or configured C if
there's no context) with reference set to C<< $c->req->uri >> if it comes from
C<< $c->req->base >>.
In other words, if referer is your app, you can do
C<< $c->req->referer->relative >> and it will do the right thing.
=head1 CONFIGURATION
In myapp.conf:
disposition absolute
uri_class URI::SmartURI
=over
=item disposition
One of 'absolute', 'hostless', 'relative' or 'host-header'. Defaults to
'absolute'.
The special disposition 'host-header' uses the value of your 'Host:' header.
=item uri_class
The class to use for URIs, defaults to L.
=back
=head1 PER REQUEST
package MyAPP::Controller::RSSFeed;
...
sub begin : Private {
my ($self, $c) = @_;
$c->uri_class('Your::URI::Class::For::Request');
$c->uri_disposition('absolute');
}
=over
=item $c->uri_disposition('absolute'|'hostless'|'relative'|'host-header')
Set URI disposition to use for the duration of the request.
=item $c->uri_class($class)
Set the URI class to use for C<< $c->uri_for >> and C<< $c->req->uri_with >> for the
duration of the request.
=back
=head1 EXTENDING
C<< $c->prepare_uri >> actually creates the URI, which you can override.
=cut
sub uri_for {
my $c = shift;
$c->prepare_uri($c->next::method(@_))
}
{
package Catalyst::Request::SmartURI;
BEGIN {
$Catalyst::Request::SmartURI::AUTHORITY = 'cpan:RKITOVER';
}
{
$Catalyst::Request::SmartURI::VERSION = '0.039';
}
use Moose;
extends 'Catalyst::Request';
use namespace::clean -except => 'meta';
sub uri_with {
my $req = shift;
$context->prepare_uri($req->next::method(@_))
}
sub uri {
my $req = shift;
my $uri_class = $context ? $context->uri_class : $conf_uri_class;
$req->next::method(
$uri_class->new(
$req->next::method(@_),
($req->{base} ? { reference => $req->base } : ())
)
)
}
sub referer {
my $req = shift;
my $uri_class = $context ? $context->uri_class : $conf_uri_class;
my $referer = $req->next::method(@_);
return $referer if not defined $referer;
my $base = $req->base;
my $uri = $req->uri;
if ($referer =~ /^$base/) {
return $uri_class->new($referer, { reference => $uri })
} else {
return $uri_class->new($referer);
}
}
__PACKAGE__->meta->make_immutable;
}
sub setup {
my $app = shift;
my $config =$app->config->{'Plugin::SmartURI'} || $app->config->{smarturi};
($conf_uri_class, $conf_disposition) = @$config{qw/uri_class disposition/};
$conf_uri_class ||= 'URI::SmartURI';
$conf_disposition ||= 'absolute';
eval { Class::Load::load_class($conf_uri_class) };
Catalyst::Exception->throw(
message => "Could not load configured uri_class $conf_uri_class: $@"
) if $@;
my $request_class = $app->request_class;
unless ($request_class->isa('Catalyst::Request::SmartURI')) {
my $new_request_class = $app.'::Request::SmartURI';
my $inject_rest = (not $request_class->isa('Catalyst::Request::REST'))
&& eval { Class::Load::load_class('Catalyst::Request::REST') };
Class::C3::Componentised->inject_base(
$new_request_class,
'Catalyst::Request::SmartURI',
($inject_rest ?
'Catalyst::Request::REST' : ()),
$request_class,
);
Class::C3::reinitialize();
$app->request_class($new_request_class);
}
$app->next::method(@_)
}
sub prepare_uri {
my ($c, $uri) = @_;
my $disposition = $c->uri_disposition || $conf_disposition;
my $uri_class = $c->uri_class || $conf_uri_class;
# Need the || for $c->welcome_message, otherwise initialization works fine.
eval { Class::Load::load_class($uri_class) };
Catalyst::Exception->throw(
message => "Could not load configured uri_class $uri_class: $@"
) if $@;
my $res;
if ($disposition eq 'host-header') {
$res = $uri_class->new($uri, { reference => $c->req->uri })->absolute;
my $host = $c->req->header('Host');
my $port = $host =~ s/:(\d+)$// ? $1 : '';
if ($port) {
$port = '' if $c->req->uri->scheme eq 'http' && $port == 80;
$port = '' if $c->req->uri->scheme eq 'https' && $port == 443;
}
$res->host($host);
$res->port($port) if $port;
} else {
$res = $uri_class->new($uri, { reference => $c->req->uri })->$disposition
}
$res
}
# Reset accessors to configured values at beginning of request.
sub prepare {
my $app = shift;
# Also save a copy of the context for the Request class to use.
my $c = $context = $app->next::method(@_);
weaken $context;
$c->uri_class($conf_uri_class);
$c->uri_disposition($conf_disposition);
$c
}
__PACKAGE__->meta->make_immutable;
=head1 SEE ALSO
L, L, L
=head1 AUTHOR
Rafael Kitover, C<< >>
=head1 BUGS
Please report any bugs or feature requests to
C, or through the web
interface at
L. I
will be notified, and then you'll automatically be notified of progress on your
bug as I make changes.
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
perldoc Catalyst::Plugin::SmartURI
You can also look for information at:
=over 4
=item * RT: CPAN's request tracker
L
=item * AnnoCPAN: Annotated CPAN documentation
L
=item * CPAN Ratings
L
=item * Search CPAN
L
=back
=head1 ACKNOWLEDGEMENTS
from #catalyst:
vipul came up with the idea
mst came up with the design and implementation details for the current version
kd reviewed my code and offered suggestions
=head1 TODO
I'd like to extend on L, and make a plugin that
rewrites URIs for actions with an SSL attribute.
=head1 COPYRIGHT & LICENSE
Copyright (c) 2008 Rafael Kitover
This program is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.
=cut
__PACKAGE__; # End of Catalyst::Plugin::SmartURI
# vim: expandtab shiftwidth=4 tw=80:
Controller 000755 000766 000024 0 12264327647 23015 5 ustar 00rkitover staff 000000 000000 Catalyst-Plugin-SmartURI-0.039/t/lib/TestApp REST.pm 100644 000766 000024 647 12264327647 24257 0 ustar 00rkitover staff 000000 000000 Catalyst-Plugin-SmartURI-0.039/t/lib/TestApp/Controller package TestApp::Controller::REST;
use parent 'Catalyst::Controller';
use Class::Load ();
eval { Class::Load::load_class('Catalyst::Action::REST') } && eval q{
sub foo : Global ActionClass('REST') {}
sub foo_GET {
my ($self, $c) = @_;
# should break if request_class is not set correctly
$c->req->accepted_content_types;
$c->res->output($c->req->uri_with({foo => 'bar'}));
}
};
1;
Root.pm 100644 000766 000024 2432 12264327647 24437 0 ustar 00rkitover staff 000000 000000 Catalyst-Plugin-SmartURI-0.039/t/lib/TestApp/Controller package TestApp::Controller::Root;
use parent 'Catalyst::Controller';
sub test_uri_for_redirect : Global {
my ($self, $c) = @_;
$c->res->redirect($c->uri_for('/test_uri_for_redirect'));
}
sub test_req_uri_with : Global {
my ($self, $c) = @_;
$c->res->output($c->req->uri_with({
the_word_that_must_be_heard => 'mtfnpy'
}));
}
sub test_uri_object : Global {
my ($self, $c) = @_;
$c->res->output($c->uri_for('/test_uri_object')->path);
}
sub per_request : Global {
my ($self, $c) = @_;
$c->uri_disposition('relative');
$c->res->output($c->uri_for('/dummy'));
}
sub host_header : Global {
my ($self, $c) = @_;
$c->uri_disposition('host-header');
$c->res->output($c->uri_for('/dummy'));
}
sub host_header_with_port : Global {
my ($self, $c) = @_;
$c->uri_disposition('host-header');
$c->res->output($c->uri_for('/dummy'));
}
sub req_uri_class : Global {
my ($self, $c) = @_;
$c->res->output(ref($c->req->uri).' '.$c->req->uri);
}
sub req_referer_class : Global {
my ($self, $c) = @_;
$c->res->output(ref $c->req->referer);
}
sub say_referer : Global {
my ($self, $c) = @_;
my $r = $c->req->referer;
$c->res->output((!defined $r) ? 'undef' : $r eq '' ? 'blank' : $r);
}
sub dummy : Global {}
1;
MyURI.pm 100644 000766 000024 266 12264327647 24444 0 ustar 00rkitover staff 000000 000000 Catalyst-Plugin-SmartURI-0.039/t/lib/TestApp/Controller package TestApp::Controller::MyURI;
use parent 'Catalyst::Controller';
sub test_my_uri : Global {
my ($self, $c) = @_;
$c->res->output($c->uri_for('/dummy')->mtfnpy)
}
1;