Merge pull request #876 from metacpan/ssoriche/spec_cover

Create Model, Controller and spec for Cover

Author: oalders

lib/MetaCPAN/API/Controller/Cover.pm

@@ -0,0 +1,16 @@
+package MetaCPAN::API::Controller::Cover;
+
+use Mojo::Base 'Mojolicious::Controller';
+
+sub lookup {
+    my $c = shift;
+    return unless $c->openapi->valid_input;
+    my $args = $c->validation->output;
+
+    my $results = $c->model->cover->find_release_coverage( $args->{name} );
+    return $c->render( openapi => $results ) if $results;
+    $c->rendered(404);
+}
+
+1;
+

lib/MetaCPAN/API/Model/Cover.pm

@@ -0,0 +1,31 @@
+package MetaCPAN::API::Model::Cover;
+
+use MetaCPAN::Moose;
+
+with 'MetaCPAN::API::Model::Role::ES';
+
+sub find_release_coverage {
+    my ( $self, $release ) = @_;
+
+    my $query = +{ term => { release => $release } };
+
+    my $res = $self->_run_query(
+        index => 'cover',
+        type  => 'cover',
+        body  => {
+            query => $query,
+            size  => 999,
+        }
+    );
+    $res->{hits}{total} or return {};
+
+    return +{
+        %{ $res->{hits}{hits}[0]{_source} },
+        url => "http://cpancover.com/latest/$release/index.html",
+    };
+}
+
+__PACKAGE__->meta->make_immutable;
+
+1;
+

lib/MetaCPAN/API/Plugin/Model.pm

@@ -10,6 +10,7 @@ use MetaCPAN::Model::Search ();
 # New models
 use MetaCPAN::API::Model::User     ();
 use MetaCPAN::API::Model::Download ();
+use MetaCPAN::API::Model::Cover    ();
 
 has app => sub { Carp::croak 'app is required' }, weak => 1;
 
@@ -31,6 +32,11 @@ has user => sub {
     return MetaCPAN::API::Model::User->new( es => $self->app->es );
 };
 
+has cover => sub {
+    my $self = shift;
+    return MetaCPAN::API::Model::Cover->new( es => $self->app->es );
+};
+
 sub register {
     my ( $plugin, $app, $conf ) = @_;
     $plugin->app($app);
@@ -39,6 +45,7 @@ sub register {
     $app->helper( 'model.download' => sub { $plugin->download } );
     $app->helper( 'model.search'   => sub { $plugin->search } );
     $app->helper( 'model.user'     => sub { $plugin->user } );
+    $app->helper( 'model.cover'    => sub { $plugin->cover } );
 }
 
 1;

lib/MetaCPAN/Script/Cover.pm

@@ -5,7 +5,8 @@ use namespace::autoclean;
 
 use Cpanel::JSON::XS qw( decode_json );
 use Log::Contextual qw( :log :dlog );
-use MetaCPAN::Types qw( Bool Uri);
+use MetaCPAN::Types qw( Bool Str Uri);
+use Path::Class qw( file );
 
 with 'MetaCPAN::Role::Script', 'MooseX::Getopt';
 
@@ -30,6 +31,14 @@ has test => (
     documentation => 'Test mode (pulls smaller development data set)',
 );
 
+has json_file => (
+    is      => 'ro',
+    isa     => Str,
+    default => 0,
+    documentation =>
+        'Path to JSON file to be read instead of URL (for testing)',
+);
+
 my %valid_keys
     = map { $_ => 1 } qw< branch condition statement subroutine total >;
 
@@ -96,6 +105,11 @@ sub index_cover_data {
 sub retrieve_cover_data {
     my $self = shift;
 
+    if ( $self->json_file ) {
+        my $file = file( $self->json_file );
+        return decode_json( $file->slurp );
+    }
+
     my $url = $self->test ? $self->cover_dev_url : $self->cover_url;
 
     log_info { 'Fetching data from ', $url };
@@ -129,4 +143,3 @@ Retrieves the CPAN cover data from its source and
 updates our ES information.
 
 =cut
-

root/static/definitions/common.yml

@@ -0,0 +1,13 @@
+---
+
+ErrorModel:
+  type: "object"
+  required:
+    - "code"
+    - "message"
+  properties:
+    code:
+      type: "integer"
+      format: "int32"
+    message:
+      type: "string"

root/static/requests/cover.yml

@@ -0,0 +1,31 @@
+---
+
+cover:
+  get:
+    tags:
+      - Coverage
+    operationId: cover
+    x-mojo-to: Cover#lookup
+    summary: Get coverage details about a release
+    parameters:
+      - name: name
+        in: path
+        description: |
+          The name of the Release
+        type: string
+        required: true
+        # tell Mojolicious to use relaxed placeholders when
+        # parsing this parameter (dots are allowed)
+        x-mojo-placeholder: "#"
+    responses:
+      200:
+        description: Release response
+        schema:
+          type: object
+          properties:
+            name:
+              type: string
+      default:
+        description: "unexpected error"
+        schema:
+          $ref: "../definitions/common.yml#/ErrorModel"

root/static/v1.yml

@@ -22,3 +22,5 @@ paths:
     $ref: "requests/search.yml#/search_web"
   /search/first:
     $ref: "requests/search.yml#/search_first"
+  /cover/{name}:
+    $ref: "requests/cover.yml#/cover"

t/00_setup.t

@@ -105,6 +105,7 @@ $server->prepare_user_test_data;
 $server->index_cpantesters;
 $server->index_mirrors;
 $server->index_favorite;
+$server->index_cover;
 
 ok(
     MetaCPAN::Script::Tickets->new_with_options(

t/api/controller/cover.t

@@ -0,0 +1,57 @@
+use Mojo::Base -strict;
+use lib 't/lib';
+
+use Test::More;
+use Test::Mojo;
+use Mojo::JSON qw(true false);
+
+use MetaCPAN::Model::Search ();
+use MetaCPAN::TestServer    ();
+my $server = MetaCPAN::TestServer->new;
+
+my $t = Test::Mojo->new(
+    'MetaCPAN::API' => {
+        es     => $server->es_client,
+        secret => 'just a test',
+    }
+);
+
+my %expect = (
+    'MetaFile-Both-1.1' => {
+        criteria => {
+            branch     => '12.50',
+            condition  => '0.00',
+            statement  => '63.64',
+            subroutine => '71.43',
+            total      => '46.51',
+        },
+        distribution => 'MetaFile-Both',
+        release      => 'MetaFile-Both-1.1',
+        url     => 'http://cpancover.com/latest/MetaFile-Both-1.1/index.html',
+        version => '1.1',
+    },
+    'Pod-With-Generator-1' => {
+        criteria => {
+            branch     => '78.95',
+            condition  => '46.67',
+            statement  => '95.06',
+            subroutine => '100.00',
+            total      => '86.58',
+        },
+        distribution => 'Pod-With-Generator',
+        release      => 'Pod-With-Generator-1',
+        url => 'http://cpancover.com/latest/Pod-With-Generator-1/index.html',
+        version => '1',
+    },
+);
+
+for my $release ( keys %expect ) {
+    my $expected = $expect{$release};
+    subtest "Check $release" => sub {
+
+        $t->get_ok("/v1/cover/$release")->status_is(200)->json_is($expected)
+            ->or( sub { diag $t->tx->res->dom } );
+
+    };
+}
+done_testing;

t/lib/MetaCPAN/TestServer.pm

@@ -4,6 +4,7 @@ use MetaCPAN::Moose;
 
 use MetaCPAN::DarkPAN                ();
 use MetaCPAN::Script::Author         ();
+use MetaCPAN::Script::Cover          ();
 use MetaCPAN::Script::CPANTestersAPI ();
 use MetaCPAN::Script::Favorite       ();
 use MetaCPAN::Script::First          ();
@@ -226,6 +227,14 @@ sub index_mirrors {
         'index mirrors' );
 }
 
+sub index_cover {
+    my $self = shift;
+
+    local @ARGV = ( 'cover', '--json_file', 't/var/cover.json' );
+    ok( MetaCPAN::Script::Cover->new_with_options( $self->_config )->run,
+        'index cover' );
+}
+
 sub index_permissions {
     my $self = shift;