Changeset 184

Timestamp:

12/24/10 05:27:34 (13 years ago)

Author:

nanardon

Message:

• document functions/urls
• ensure it works

Location:

server/trunk/web

Files:

• lib/Sophie/Controller/Distrib.pm (modified) (10 diffs)
• root/templates/html/distrib/list_rpms.html (added)
• root/templates/html/distrib/list_rpms.tt (added)
• t/controller_Distrib.t (modified) (2 diffs)

server/trunk/web/lib/Sophie/Controller/Distrib.pm

@@ -14 +14 @@
 
 =head1 METHODS
+
+=cut
+
+=head2 distrib.list( [ DISTRIBUTION [, RELEASE [, ARCH ]]]
+
+List content of distrib according arguments given. IE list availlable
+C<distribution> if no argument is given, list C<release> if C<DISTRIBUTION> is
+given, list C<arch> if both C<DISTRIBUTION> and C<RELEASE> are given. Etc... Up
+to give C<MEDIA> if C<ARCH> is specified.
+
+Results are given as C<ARRAY>.
 
 =cut
@@ -133 +144 @@
 }
 
+=head2 distrib.exists( DISTRIB )
+
+Return true or false if disteibution C<DISTRIB> exists.
+
+C<DISTRIB> is a structure with following key/value:
+
+=over 4
+
+=item distribution
+
+The distribution name
+
+=item release
+
+The release name
+
+=item arch
+
+The arch name
+
+=back
+
+This function is usefull to check if a search have chance to suceed, eg if the
+user is not searching a rpm on a not existing ditribution.
+
+=cut
 
 sub exists : XMLRPC {
@@ -150 +187 @@
 =cut
 
+=head2 Url: /distrib
+
+Return the list of currently stored distributions.
+
+=cut
+
 sub index :Path :Chained :Args(0)  {
     my ( $self, $c ) = @_;
@@ -156 +199 @@
 }
 
-=head release
+=head2 release
+
+=cut
+
+=head2 Url: /distrib/<DISTRIBUTION>
+
+Return the list of availlaible release for given C<DISTRIBUTION>.
 
 =cut
@@ -168 +217 @@
     $c->forward('list', [ $c->stash->{dist} ] );
 }
+
+=head2 Url: /distrib/<DISTRIBUTION>/<RELEASE>
+
+Return the list of availlaible architecture for given C<DISTRIBUTION>,
+C<RELEASE>.
+
+=cut
 
 sub list_arch :Path :Args(2) {
@@ -185 +241 @@
 }
 
+=head2 Url: /distrib/<DISTRIBUTION>/<RELEASE>/<ARCH>
+
+Return the list of availlaible medias for given C<DISTRIBUTION>,
+C<RELEASE>, C<ARCH>.
+
+=cut
+
 sub distrib :Chained('distrib_view') PathPart('') :Args(0) {
     my ( $self, $c ) = @_;
@@ -197 +260 @@
 }
 
+=head2 distrib.anyrpms( DISTRIB )
+
+Return a list of packages availlable for C<DISTRIB>.
+
+C<DISTRIB> is a struct with following keys/values:
+
+=over 4
+
+=item distribution
+
+The distribution name
+
+=item release
+
+The release name
+
+=item arch
+
+The arch name
+
+=back
+
+=cut
+
 sub anyrpms :XMLRPC {
     my ( $self, $c, $distribution, $release, $arch ) = @_;
@@ -222 +309 @@
     $c->stash->{xmlrpc} = $c->stash->{rpm};
 }
+
+=head2 distrib.rpms( DISTRIB )
+
+Return a list of binary packages availlable for C<DISTRIB>.
+
+C<DISTRIB> is a struct with following keys/values:
+
+=over 4
+
+=item distribution
+
+The distribution name
+
+=item release
+
+The release name
+
+=item arch
+
+The arch name
+
+=back
+
+=cut
 
 sub rpms :XMLRPC {
@@ -251 +362 @@
     $c->stash->{xmlrpc} = $c->stash->{rpm};
 }
+
+=head2 distrib.srpms( DISTRIB )
+
+Return a list of sources packages availlable for C<DISTRIB>.
+
+C<DISTRIB> is a struct with following keys/values:
+
+=over 4
+
+=item distribution
+
+The distribution name
+
+=item release
+
+The release name
+
+=item arch
+
+The arch name
+
+=back
+
+=cut
 
 sub srpms :XMLRPC {
@@ -305 +440 @@
 }
 
+
+=head2 Url: /distrib/<DISTRIBUTION>/<RELEASE>/<ARCH>/RPMS
+
+Return the list of availlaible rpms for given C<DISTRIBUTION>,
+C<RELEASE>, C<ARCH>.
+
+=cut
+
 sub list_rpms :Chained('distrib_view') PathPart('rpms') Args(0) {
     my ( $self, $c ) = @_;
-    $c->forward('rpms', $c->stash->{dist});
+    $c->forward('rpms', [ $c->stash->{dist} ]);
 }
 
 sub list_srpms :Chained('distrib_view') PathPart('srpms') Args(0) {
     my ( $self, $c ) = @_;
-    $c->forward('srpms', $c->stash->{dist});
+    $c->forward('srpms', [ $c->stash->{dist} ]);
 }
 

server/trunk/web/t/controller_Distrib.t

@@ -18 +18 @@
 
 ok( request('/distrib')->is_success, 'Request should succeed' );
-ok( request("/distrib/$distribution")->is_success, 'Request should succeed' );
+ok( request('/distrib', { ajax => 1 })->is_success, 'Request ajax should succeed' );
+ok( request('/distrib', { json => 1 })->is_success, 'Request json should succeed' );
+ok( request("/distrib/$distribution")->is_success, 'Request distribution should succeed' );
+ok( request("/distrib/$distribution", { ajax => 1 })->is_success,
+    'Request distribution as ajax should succeed' );
+ok( request("/distrib/$distribution", { json => 1 })->is_success,
+    'Request distribution as ajax should succeed' );
 ok( xmlrequest_ok( 'distrib.list'), "XMLRPC");
 ok( xmlrequest_ok( 'distrib.list', $distribution), "XMLRPC");
@@ -24 +30 @@
 ok( request("/distrib/$distribution/$release/$arch")->is_success, 'Request should succeed' );
 ok( request("/distrib/$distribution/$release/$arch/media")->is_success, 'Request should succeed' );
+
+ok( request("/distrib/$distribution/$release/rpms")->is_success, 'Request should succeed' );
+
 ok(
     request("/distrib/$distribution/$release/$arch/media/$media/by-pkgid/$pkgid")