Changeset 229

Timestamp:

12/29/10 21:37:10 (13 years ago)

Author:

nanardon

Message:

• complete docs for /rpms functions
• rename some functions for coherency

Location:

server/trunk/web

Files:

• lib/Sophie/Controller/Rpms.pm (modified) (6 diffs)
• root/templates/html/rpms/deps.html (moved) (moved from server/trunk/web/root/templates/html/rpms/alldeps.html) (1 diff)
• root/templates/html/rpms/deps.tt (moved) (moved from server/trunk/web/root/templates/html/rpms/alldeps.tt)
• t/controller_Rpms.t (modified) (2 diffs)

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

@@ -67 +67 @@
 }
 
-sub basicinfo : XMLRPCLocal {
+=head2 rpms.basicinfo( PKGID )
+
+Return a struct about basic informations about rpm having pkgid C<PKGID>.
+
+Example of information return:
+
+    {
+          'arch' => 'x86_64',
+          'version' => '0.0.3',
+          'src' => '1',
+          'issrc' => '1',
+          'name' => 'ecap-samples',
+          'release' => '1mdv2010.2',
+          'description' => 'The sample contains three basic adapters.',
+          'pkgid' => 'aa17ce95dd816e0817da78d7af54abdb',
+          'summary' => 'Simple ecap samples',
+          'filename' => 'ecap-samples-0.0.3-1mdv2010.2.src.rpm',
+          'evr' => '0.0.3-1mdv2010.2'
+    };
+
+=head2 Url: /rpms/<PKGID>/basicinfo?json
+
+Return a struct about basic informations about rpm having pkgid C<PKGID>.
+
+Example of information return:
+
+    {
+          'arch' => 'x86_64',
+          'version' => '0.0.3',
+          'src' => '1',
+          'issrc' => '1',
+          'name' => 'ecap-samples',
+          'release' => '1mdv2010.2',
+          'description' => 'The sample contains three basic adapters.',
+          'pkgid' => 'aa17ce95dd816e0817da78d7af54abdb',
+          'summary' => 'Simple ecap samples',
+          'filename' => 'ecap-samples-0.0.3-1mdv2010.2.src.rpm',
+          'evr' => '0.0.3-1mdv2010.2'
+    };
+
+NB: This url works only in JSON format.
+
+=cut
+
+sub basicinfo :XMLRPCLocal :Chained('rpms_') :PathPart('basicinfo') :Args(0) {
     my ($self, $c, $pkgid) = @_;
+    $pkgid ||= $c->stash->{pkgid};
 
     my $rpm = $c->model('base::Rpms')->find(
@@ -96 +141 @@
 }
 
-
-sub info : XMLRPCLocal {
+=head2 rpms.info( PKGID )
+
+Like rpms.basicinfo return a struct containing single information about the request rpm.
+
+=head2 Url: /rpms/<PKGID>/info?json
+
+Like rpms/<PKGID>basicinfo return a struct containing single information about the request rpm.
+
+NB: This url works only in JSON format.
+
+=cut
+
+sub info : XMLRPCLocal :Chained('rpms_') :PathPart('info') :Args(0) {
     my ($self, $c, $pkgid) = @_;
-
+    $pkgid ||= $c->stash->{pkgid};
 
     my $info = $c->forward('basicinfo', [ $pkgid ]);
@@ -120 +176 @@
 }
 
-sub deps : XMLRPCLocal {
+=head2 rpms.dependency(PKGID, DEPTYPE)
+
+Return a list of C<DEPTYPE> dependencies for package C<PKGID> where C<DEPTYPE>
+is one of:
+
+=over 4
+
+=item C<P> for Provides
+
+=item C<R> for Requires
+
+=item C<C> for Conflicts
+
+=item C<O> for Obsoletes
+
+=item C<E> for Enhanced
+
+=item C<S> for Suggests
+
+=back
+
+=cut
+
+sub xmlrpc_dependency : XMLRPCPath('dependency') {
+    my ($self, $c, @args) = @_;
+    $c->forward('dependency', [ @args ]);
+}
+
+=head2 Url: /rpms/<PKGID>/dependency/<DEPTYPE>?json
+
+Return a list of C<DEPTYPE> dependencies for package C<PKGID> where C<DEPTYPE>
+is one of:
+
+=over 4
+
+=item C<P> for Provides
+
+=item C<R> for Requires
+
+=item C<C> for Conflicts
+
+=item C<O> for Obsoletes
+
+=item C<E> for Enhanced
+
+=item C<S> for Suggests
+
+=back
+
+=cut
+
+sub dependency :XMLRPC :Chained('rpms_') :PathPart('dependency') :Args(1) {
     my ($self, $c, $pkgid, $deptype) = @_;
+    if (!$deptype) {
+        $deptype = $pkgid;
+        $pkgid = $c->stash->{pkgid};
+    }
 
     $c->stash->{xmlrpc} = [ 
@@ -263 +374 @@
     $c->forward('rpms_', [ $pkgid ]);
     for ($subpart || '') {
-        /^deps$/      and $c->go('alldeps',   [ $pkgid, @args ]);
-        /^files$/     and $c->go('files',     [ $pkgid, @args ]);
-        /^changelog$/ and $c->go('changelog', [ $pkgid, @args ]);
-        /^location$/  and $c->go('location',  [ $pkgid, @args ]);
-        /^analyse$/   and $c->go('analyse',  [ $pkgid, @args ]);
-        /./           and $c->go('/404/index'); # other subpart dont exists
+        /^deps$/       and $c->go('deps',        [ $pkgid, @args ]);
+        /^files$/      and $c->go('files',       [ $pkgid, @args ]);
+        /^changelog$/  and $c->go('changelog',   [ $pkgid, @args ]);
+        /^location$/   and $c->go('location',    [ $pkgid, @args ]);
+        /^basicinfo$/  and $c->go('basicinfo',   [ $pkgid, @args ]);
+        /^info$/       and $c->go('info',        [ $pkgid, @args ]);
+        /^analyse$/    and $c->go('analyse',     [ $pkgid, @args ]);
+        /^dependency$/ and $c->go('dependency',  [ $pkgid, @args ]);
+        /./            and $c->go('/404/index'); # other subpart dont exists
     }
     $c->stash->{rpmurl} = $c->req->path;
@@ -282 +396 @@
 
 
-sub alldeps :Chained('rpms_') :PathPart('deps') :Args(0) :XMLRPCLocal {
+sub deps :Chained('rpms_') :PathPart('deps') :Args(0) :XMLRPCLocal {
     my ( $self, $c, $pkgid ) = @_;
     $c->stash->{rpmurl} = ($c->req->path =~ m:(.*)/[^/]+:)[0];
@@ -441 +555 @@
         my @deplist = map {
             [ $_->{name}, $_->{sense}, $_->{evr} ]
-        } @{ $c->forward('deps', [ $pkgid, 'R' ]) };
+        } @{ $c->forward('dependency', [ $pkgid, 'R' ]) };
 
         $c->stash->{xmlrpc} = $c->forward(

server/trunk/web/root/templates/html/rpms/deps.html

@@ -3 +3 @@
 [% INCLUDE 'rpms/menu.tt' %]
 
-[% INCLUDE 'rpms/alldeps.tt' %]
+[% INCLUDE 'rpms/deps.tt' %]

server/trunk/web/t/controller_Rpms.t

@@ -2 +2 @@
 use warnings;
 use Test::More;
+use FindBin;
+require "$FindBin::Bin/xml.pl";
 
 BEGIN { use_ok 'Catalyst::Test', 'Sophie' }
@@ -14 +16 @@
 ok( request("/rpms/$pkgid/changelog")->is_success, 'Request a pkgid/changelog should succeed' );
 ok( request("/rpms/$pkgid/location")->is_success, 'Request a pkgid/location should succeed' );
+
+ok( xmlrequest_ok('rpms.basicinfo', $pkgid), 'XMLRPC rpms.basicinfo' );
+ok( request("/rpms/$pkgid/basicinfo?json"), "rpms/basicinfo?json" );
+ok( xmlrequest_ok('rpms.info', $pkgid), 'XMLRPC rpms.basicinfo' );
+ok( request("/rpms/$pkgid/info?json"), "rpms/basicinfo?json" );
+ok( xmlrequest_ok('rpms.dependency', $pkgid, 'R'), 'XMLRPC rpms.dependency' );
+ok( request("/rpms/$pkgid/dependency/R?json"), "rpms/dependency?json" );
+
 done_testing();