From ac74b9774d65db72bedf97b83cf88e808fbb08b6 Mon Sep 17 00:00:00 2001 From: Gerhard Jungwirth Date: Wed, 14 May 2014 17:16:42 +0200 Subject: [PATCH] MT#3955 API callcosts: GET --- .../Panel/Controller/API/CustomerZoneCosts.pm | 155 ++++++++++++++++ .../Controller/API/CustomerZoneCostsItem.pm | 95 ++++++++++ lib/NGCP/Panel/Role/API/CustomerZoneCosts.pm | 143 +++++++++++++++ lib/NGCP/Panel/Utils/Contract.pm | 170 +++++++++++++++--- t/api-root.t | 1 + 5 files changed, 535 insertions(+), 29 deletions(-) create mode 100644 lib/NGCP/Panel/Controller/API/CustomerZoneCosts.pm create mode 100644 lib/NGCP/Panel/Controller/API/CustomerZoneCostsItem.pm create mode 100644 lib/NGCP/Panel/Role/API/CustomerZoneCosts.pm diff --git a/lib/NGCP/Panel/Controller/API/CustomerZoneCosts.pm b/lib/NGCP/Panel/Controller/API/CustomerZoneCosts.pm new file mode 100644 index 0000000000..e84afbb676 --- /dev/null +++ b/lib/NGCP/Panel/Controller/API/CustomerZoneCosts.pm @@ -0,0 +1,155 @@ +package NGCP::Panel::Controller::API::CustomerZoneCosts; +use Sipwise::Base; +use namespace::sweep; +use boolean qw(true); +use Data::HAL qw(); +use Data::HAL::Link qw(); +use HTTP::Headers qw(); +use HTTP::Status qw(:constants); +use MooseX::ClassAttribute qw(class_has); +use NGCP::Panel::Utils::DateTime; +BEGIN { extends 'Catalyst::Controller::ActionRole'; } +require Catalyst::ActionRole::ACL; +require Catalyst::ActionRole::CheckTrailingSlash; +require Catalyst::ActionRole::HTTPMethods; +require Catalyst::ActionRole::RequireSSL; + +class_has 'api_description' => ( + is => 'ro', + isa => 'Str', + default => + 'Returns for each customer, the customer_id and the number of calls, the total duration and the call fees grouped by zone.', +); + +class_has 'query_params' => ( + is => 'ro', + isa => 'ArrayRef', + default => sub {[ + { + param => 'customer_id', + description => 'Filter for a specific customer.', + query => { + first => sub { + my $q = shift; + return { 'me.id' => $q }; + }, + second => sub { + return {}; + }, + }, + }, + ]}, +); + + +with 'NGCP::Panel::Role::API::CustomerZoneCosts'; + +class_has('resource_name', is => 'ro', default => 'customerzonecosts'); +class_has('dispatch_path', is => 'ro', default => '/api/customerzonecosts/'); +class_has('relation', is => 'ro', default => 'http://purl.org/sipwise/ngcp-api/#rel-customerzonecosts'); + +__PACKAGE__->config( + action => { + map { $_ => { + ACLDetachTo => '/api/root/invalid_user', + AllowedRole => [qw/admin reseller/], + Args => 0, + Does => [qw(ACL CheckTrailingSlash RequireSSL)], + Method => $_, + Path => __PACKAGE__->dispatch_path, + } } @{ __PACKAGE__->allowed_methods }, + }, + action_roles => [qw(HTTPMethods)], +); + +sub auto :Private { + my ($self, $c) = @_; + + $self->set_body($c); + $self->log_request($c); + return 1; +} + +sub GET :Allow { + my ($self, $c) = @_; + my $page = $c->request->params->{page} // 1; + my $rows = $c->request->params->{rows} // 10; + { + my $field_devs = $self->item_rs($c); + + my $total_count = int($field_devs->count); + $field_devs = $field_devs->search(undef, { + page => $page, + rows => $rows, + }); + my $query_string = $self->query_param_string($c); + return unless $query_string; + my (@embedded, @links); + for my $dev ($field_devs->search({}, {order_by => {-asc => 'me.id'}})->all) { + push @embedded, $self->hal_from_item($c, $dev); + push @links, Data::HAL::Link->new( + relation => 'ngcp:'.$self->resource_name, + href => sprintf('%s%d?%s', $self->dispatch_path, $dev->id, $query_string), + ); + } + push @links, + Data::HAL::Link->new( + relation => 'curies', + href => 'http://purl.org/sipwise/ngcp-api/#rel-{rel}', + name => 'ngcp', + templated => true, + ), + Data::HAL::Link->new(relation => 'profile', href => 'http://purl.org/sipwise/ngcp-api/'), + Data::HAL::Link->new(relation => 'self', href => sprintf('%s?page=%s&rows=%s&%s', $self->dispatch_path, $page, $rows, $query_string)); + if(($total_count / $rows) > $page ) { + push @links, Data::HAL::Link->new(relation => 'next', + href => sprintf('%s?page=%d&rows=%d&%s', $self->dispatch_path, $page + 1, $rows, $query_string)); + } + if($page > 1) { + push @links, Data::HAL::Link->new(relation => 'prev', + href => sprintf('%s?page=%d&rows=%d&%s', $self->dispatch_path, $page - 1, $rows, $query_string)); + } + + my $hal = Data::HAL->new( + embedded => [@embedded], + links => [@links], + ); + $hal->resource({ + total_count => $total_count, + }); + my $response = HTTP::Response->new(HTTP_OK, undef, + HTTP::Headers->new($hal->http_headers(skip_links => 1)), $hal->as_json); + $c->response->headers($response->headers); + $c->response->body($response->content); + return; + } + return; +} + +sub HEAD :Allow { + my ($self, $c) = @_; + $c->forward(qw(GET)); + $c->response->body(q()); + return; +} + +sub OPTIONS :Allow { + my ($self, $c) = @_; + my $allowed_methods = $self->allowed_methods; + $c->response->headers(HTTP::Headers->new( + Allow => $allowed_methods->join(', '), + Accept_Post => 'application/hal+json; profile=http://purl.org/sipwise/ngcp-api/#rel-'.$self->resource_name, + )); + $c->response->content_type('application/json'); + $c->response->body(JSON::to_json({ methods => $allowed_methods })."\n"); + return; +} + +sub end : Private { + my ($self, $c) = @_; + + $self->log_response($c); + return 1; +} + +# vim: set tabstop=4 expandtab: diff --git a/lib/NGCP/Panel/Controller/API/CustomerZoneCostsItem.pm b/lib/NGCP/Panel/Controller/API/CustomerZoneCostsItem.pm new file mode 100644 index 0000000000..dfac04ab93 --- /dev/null +++ b/lib/NGCP/Panel/Controller/API/CustomerZoneCostsItem.pm @@ -0,0 +1,95 @@ +package NGCP::Panel::Controller::API::CustomerZoneCostsItem; +use Sipwise::Base; +use namespace::sweep; +use boolean qw(true); +use Data::HAL qw(); +use Data::HAL::Link qw(); +use HTTP::Headers qw(); +use HTTP::Status qw(:constants); +use MooseX::ClassAttribute qw(class_has); +use NGCP::Panel::Utils::ValidateJSON qw(); +use NGCP::Panel::Utils::DateTime; +use Path::Tiny qw(path); +use Safe::Isa qw($_isa); +BEGIN { extends 'Catalyst::Controller::ActionRole'; } +require Catalyst::ActionRole::ACL; +require Catalyst::ActionRole::HTTPMethods; +require Catalyst::ActionRole::RequireSSL; + +with 'NGCP::Panel::Role::API::CustomerZoneCosts'; + +class_has('resource_name', is => 'ro', default => 'customerzonecosts'); +class_has('dispatch_path', is => 'ro', default => '/api/customerzonecosts/'); +class_has('relation', is => 'ro', default => 'http://purl.org/sipwise/ngcp-api/#rel-customerzonecosts'); + +__PACKAGE__->config( + action => { + map { $_ => { + ACLDetachTo => '/api/root/invalid_user', + AllowedRole => [qw/admin reseller/], + Args => 1, + Does => [qw(ACL RequireSSL)], + Method => $_, + Path => __PACKAGE__->dispatch_path, + } } @{ __PACKAGE__->allowed_methods }, + }, + action_roles => [qw(HTTPMethods)], +); + +sub auto :Private { + my ($self, $c) = @_; + + $self->set_body($c); + $self->log_request($c); + return 1; +} + +sub GET :Allow { + my ($self, $c, $id) = @_; + { + last unless $self->valid_id($c, $id); + my $field_dev = $self->item_by_id($c, $id); + last unless $self->resource_exists($c, deviceprofile => $field_dev); + + my $hal = $self->hal_from_item($c, $field_dev); + + my $response = HTTP::Response->new(HTTP_OK, undef, HTTP::Headers->new( + (map { # XXX Data::HAL must be able to generate links with multiple relations + s|rel="(http://purl.org/sipwise/ngcp-api/#rel-resellers)"|rel="item $1"|r + =~ s/rel=self/rel="item self"/r; + } $hal->http_headers), + ), $hal->as_json); + $c->response->headers($response->headers); + $c->response->body($response->content); + return; + } + return; +} + +sub HEAD :Allow { + my ($self, $c, $id) = @_; + $c->forward(qw(GET)); + $c->response->body(q()); + return; +} + +sub OPTIONS :Allow { + my ($self, $c, $id) = @_; + my $allowed_methods = $self->allowed_methods; + $c->response->headers(HTTP::Headers->new( + Allow => $allowed_methods->join(', '), + Accept_Patch => 'application/json-patch+json', + )); + $c->response->content_type('application/json'); + $c->response->body(JSON::to_json({ methods => $allowed_methods })."\n"); + return; +} + +sub end : Private { + my ($self, $c) = @_; + + $self->log_response($c); + return 1; +} + +# vim: set tabstop=4 expandtab: diff --git a/lib/NGCP/Panel/Role/API/CustomerZoneCosts.pm b/lib/NGCP/Panel/Role/API/CustomerZoneCosts.pm new file mode 100644 index 0000000000..ddcd229227 --- /dev/null +++ b/lib/NGCP/Panel/Role/API/CustomerZoneCosts.pm @@ -0,0 +1,143 @@ +package NGCP::Panel::Role::API::CustomerZoneCosts; +use Moose::Role; +use Sipwise::Base; +with 'NGCP::Panel::Role::API' => { + -alias =>{ item_rs => '_item_rs', }, + -excludes => [ 'item_rs' ], +}; + +use boolean qw(true); +use Data::HAL::Link qw(); +use Data::HAL qw(); +use DateTime::Format::Strptime; +use HTTP::Status qw(:constants); +use JSON::Types; +use TryCatch; +use NGCP::Panel::Utils::Contract; + +has 'datetime_format' => ( + is => 'rw', + default => sub { DateTime::Format::Strptime->new(pattern => '%Y-%m-%dT%H%M%S', + time_zone => DateTime::TimeZone->new(name => 'local'), + on_error => 'undef', + )}, +); + +sub get_form { + my ($self, $c) = @_; + return ''; +} + +sub hal_from_item { + my ($self, $c, $item) = @_; + my $form; + my $type = 'customerzonecosts'; + + my $query_string = $self->query_param_string($c); + + my $hal = Data::HAL->new( + links => [ + Data::HAL::Link->new( + relation => 'curies', + href => 'http://purl.org/sipwise/ngcp-api/#rel-{rel}', + name => 'ngcp', + templated => true, + ), + Data::HAL::Link->new(relation => 'collection', href => sprintf("%s?%s", $self->dispatch_path, $query_string)), + Data::HAL::Link->new(relation => 'profile', href => 'http://purl.org/sipwise/ngcp-api/'), + Data::HAL::Link->new(relation => 'self', href => sprintf("%s%d?%s", $self->dispatch_path, $item->id, $query_string)), + Data::HAL::Link->new(relation => "ngcp:$type", href => sprintf("/api/%s/%d?%s", $type, $item->id, $query_string)), + ], + relation => 'ngcp:'.$self->resource_name, + ); + + my $resource = $self->resource_from_item($c, $item); + $hal->resource($resource); + return $hal; +} + +sub resource_from_item { + my ($self, $c, $item) = @_; + + my %resource; + + my ($stime, $etime, $subscriber_id) = $self->get_query_params($c); + + my $zonecalls = NGCP::Panel::Utils::Contract::get_contract_zonesfees( + c => $c, + contract_id => $item->id, + stime => $stime, + etime => $etime, + ); + + $resource{customer_id} = int($item->id); + $resource{zones} = $zonecalls; + + return \%resource; +} + +sub get_query_params { + my ($self, $c) = @_; + + my $stime = NGCP::Panel::Utils::DateTime::current_local()->truncate(to => 'month'); + my $etime = $stime->clone->add(months => 1)->subtract(seconds => 1); + + my $format = $self->datetime_format; + + if ( $c->request->query_params->{start} ) { + $stime = $format->parse_datetime( $c->request->query_params->{start} ); + } + if ( $c->request->query_params->{end} ) { + $etime = $format->parse_datetime( $c->request->query_params->{end} ); + } + unless ($stime && $etime) { + $self->error($c, HTTP_UNPROCESSABLE_ENTITY, "Invalid datetime format in query parameters."); + return; + } + + my $subscriber_id = $c->request->query_params->{subscriber_id}; + + return ($stime, $etime, $subscriber_id); +} + +sub query_param_string { + my ($self, $c) = @_; + + my $format = $self->datetime_format; + + my ($stime, $etime, $subscriber_id) = $self->get_query_params($c); + return '' unless ($stime && $etime); + my $query_string = sprintf("start=%s&end=%s", + $format->format_datetime($stime), + $format->format_datetime($etime) ); + + $query_string = $query_string . "&subscriber_id=$subscriber_id" if $subscriber_id; + + return $query_string; +} + +sub item_rs { + my ($self, $c) = @_; + + my $item_rs = NGCP::Panel::Utils::Contract::get_contracts_rs_sippbx( + c => $c, + ); + if($c->user->roles eq "admin") { + } elsif($c->user->roles eq "reseller") { + $item_rs = $item_rs->search({ + 'contact.reseller_id' => $c->user->reseller_id, + }); + } + + return $item_rs; +} + +sub item_by_id { + my ($self, $c, $id) = @_; + + my $item_rs = $self->item_rs($c); + return $item_rs->find($id); +} + +1; +# vim: set tabstop=4 expandtab: diff --git a/lib/NGCP/Panel/Utils/Contract.pm b/lib/NGCP/Panel/Utils/Contract.pm index 3a90e078cc..d44d4090d4 100644 --- a/lib/NGCP/Panel/Utils/Contract.pm +++ b/lib/NGCP/Panel/Utils/Contract.pm @@ -57,7 +57,8 @@ sub create_contract_balance { $c->log->error("Creating contract balance failed: " . $e); $e->rethrow; } - } + }; + return; } sub recursively_lock_contract { @@ -97,7 +98,7 @@ sub recursively_lock_contract { # then, check all child contracts in case of reseller my $resellers = $c->model('DB')->resultset('resellers')->search({ - contract_id => $contract->id + contract_id => $contract->id, }); for my $reseller($resellers->all) { @@ -122,8 +123,7 @@ sub recursively_lock_contract { 'contact.reseller_id' => $reseller->id, }, { join => 'contact', - } - ); + }); for my $customer($customers->all) { $customer->update({ status => $status }); for my $subscriber($customer->voip_subscribers->all) { @@ -151,6 +151,7 @@ sub recursively_lock_contract { } } } + return; } sub get_contract_rs { @@ -210,7 +211,7 @@ sub get_contracts_rs_sippbx{ $customers = $customers->search({ 'contact.reseller_id' => { '-not' => undef }, },{ - join => 'contact' + join => 'contact', }); my $reseller_condition; @@ -244,29 +245,29 @@ sub get_contract_calls_rs{ my %params = @_; (my ($c,$contract_id,$stime,$etime)) = @params{qw/c contract_id stime etime/}; - # SELECT 'out' as direction, SUM(c.source_customer_cost) AS cost, b.zone, - # COUNT(*) AS number, SUM(c.duration) AS duration - # FROM accounting.cdr c - # LEFT JOIN billing.voip_subscribers v ON c.source_user_id = v.uuid - # LEFT JOIN billing.billing_zones_history b ON b.id = c.source_customer_billing_zone_id - # WHERE v.contract_id = ? - # AND c.call_status = 'ok' - # $start_time $end_time - # GROUP BY b.zone +# SELECT 'out' as direction, SUM(c.source_customer_cost) AS cost, b.zone, +# COUNT(*) AS number, SUM(c.duration) AS duration +# FROM accounting.cdr c +# LEFT JOIN billing.voip_subscribers v ON c.source_user_id = v.uuid +# LEFT JOIN billing.billing_zones_history b ON b.id = c.source_customer_billing_zone_id +# WHERE v.contract_id = ? +# AND c.call_status = 'ok' +# $start_time $end_time +# GROUP BY b.zone my $zonecalls_rs = $c->model('DB')->resultset('cdr')->search( { # source_user_id => { 'in' => [ map {$_->uuid} @{$contract->{subscriber}} ] }, call_status => 'ok', source_user_id => { '!=' => '0' }, source_account_id => $contract_id, - # start_time => - # [ -and => - # { '>=' => $stime->epoch}, - # { '<=' => $etime->epoch}, - # ], - - # { - # '>=' => ["unix_timestamp(?)", $stime], +# start_time => +# [ -and => +# { '>=' => $stime->epoch}, +# { '<=' => $etime->epoch}, +# ], + +# { +# '>=' => ["unix_timestamp(?)", $stime], # '<=' => ["unix_timestamp(?)",$etime] }, # { '>=' => \[ "unix_timestamp(?)", $stime ] }, # { '<=' => \[ "unix_timestamp(?)", $etime ] }, @@ -275,22 +276,133 @@ sub get_contract_calls_rs{ },{ 'select' => [ - { sum => 'me.source_customer_cost', -as => 'cost', }, - { sum => 'me.source_customer_free_time', -as => 'free_time', } , - { sum => 'me.duration', -as => 'duration', } , - { count => '*', -as => 'number', } , - 'source_customer_billing_zones_history.zone', + { sum => 'me.source_customer_cost', -as => 'cost' }, + { sum => 'me.source_customer_free_time', -as => 'free_time' }, + { sum => 'me.duration', -as => 'duration' }, + { count => '*', -as => 'number' }, + 'source_customer_billing_zones_history.zone', ], 'as' => [qw/cost free_time duration number zone/], join => 'source_customer_billing_zones_history', group_by => 'source_customer_billing_zones_history.zone', - } ); - + } ); + return $zonecalls_rs; } +sub get_contract_zonesfees_rs { + my %params = @_; + my $c = $params{c}; + my $provider_id = $params{provider_id}; + my $client_contact_id = $params{client_contact_id}; + my $client_contract_id = $params{client_contract_id}; + my $stime = $params{stime}; + my $etime = $params{etime}; + my $contract_id = $params{contract_id}; + + # should not be neccessary, done before +# $stime ||= NGCP::Panel::Utils::DateTime::current_local()->truncate( to => 'month' ); +# $etime ||= $stime->clone->add( months => 1 ); + +# SELECT 'out' as direction, SUM(c.source_customer_cost) AS cost, b.zone, +# COUNT(*) AS number, SUM(c.duration) AS duration +# FROM accounting.cdr c +# LEFT JOIN billing.voip_subscribers v ON c.source_user_id = v.uuid +# LEFT JOIN billing.billing_zones_history b ON b.id = c.source_customer_billing_zone_id +# WHERE v.contract_id = ? +# AND c.call_status = 'ok' +# $start_time $end_time +# GROUP BY b.zone + + my $zonecalls_rs_out = $c->model('DB')->resultset('cdr')->search( { +# source_user_id => { 'in' => [ map {$_->uuid} @{$contract->{subscriber}} ] }, + 'call_status' => 'ok', + 'source_user_id' => { '!=' => '0' }, + start_time => + [ -and => + { '>=' => $stime->epoch}, + { '<=' => $etime->epoch}, + ], + source_account_id => $contract_id, + },{ + 'select' => [ + { sum => 'me.source_customer_cost', -as => 'customercost' }, + { sum => 'me.source_carrier_cost', -as => 'carriercost' }, + { sum => 'me.source_reseller_cost', -as => 'resellercost' }, + { sum => 'me.source_customer_free_time', -as => 'free_time' }, + { sum => 'me.duration', -as => 'duration' }, + { count => '*', -as => 'number' }, + 'source_customer_billing_zones_history.zone', + ], + 'as' => [qw/customercost carriercost resellercost free_time duration number zone/], + join => 'source_customer_billing_zones_history', + group_by => 'source_customer_billing_zones_history.zone', + order_by => 'source_customer_billing_zones_history.zone', + } ); + + my $zonecalls_rs_in = $c->model('DB')->resultset('cdr')->search( { + 'call_status' => 'ok', + #'destination_user_id' => { '!=' => '0' }, + start_time => + [ -and => + { '>=' => $stime->epoch}, + { '<=' => $etime->epoch}, + ], + destination_account_id => $contract_id, + },{ + 'select' => [ + { sum => 'me.destination_customer_cost', -as => 'customercost' }, + { sum => 'me.destination_carrier_cost', -as => 'carriercost' }, + { sum => 'me.destination_reseller_cost', -as => 'resellercost' }, + { sum => 'me.destination_customer_free_time', -as => 'free_time' }, + { sum => 'me.duration', -as => 'duration' }, + { count => '*', -as => 'number' }, + 'destination_customer_billing_zones_history.zone', + ], + 'as' => [qw/customercost carriercost resellercost free_time duration number zone/], + join => 'destination_customer_billing_zones_history', + group_by => 'destination_customer_billing_zones_history.zone', + order_by => 'destination_customer_billing_zones_history.zone', + } ); + + return ($zonecalls_rs_in, $zonecalls_rs_out); +} + + +sub get_contract_zonesfees { + my %params = @_; + my $c = $params{c}; + my $provider_id = $params{provider_id}; + my $client_contact_id = $params{client_contact_id}; + my $client_contract_id = $params{client_contract_id}; + my $stime = $params{stime}; + my $etime = $params{etime}; + my $contract_id = $params{contract_id}; + + my ($zonecalls_rs_in, $zonecalls_rs_out) = get_contract_zonesfees_rs(%params); + + my %zones; + for my $zone ($zonecalls_rs_in->all, $zonecalls_rs_out->all) { + my $zname = $zone->get_column('zone') // ''; + + my %cols = $zone->get_inflated_columns; + $zones{$zname}{customercost} += $cols{customercost} || 0; + $zones{$zname}{carriercost} += $cols{carriercost} || 0; + $zones{$zname}{resellercost} += $cols{resellercost} || 0; + $zones{$zname}{duration} += $cols{duration} || 0; + $zones{$zname}{free_time} += $cols{free_time} || 0; + $zones{$zname}{number} += $cols{number} || 0; + + delete $zones{$zname}{zone}; + } + + return \%zones; +} + 1; +__END__ + =head1 NAME NGCP::Panel::Utils::Contract diff --git a/t/api-root.t b/t/api-root.t index 94b0a4eeaa..a7f0d6611a 100644 --- a/t/api-root.t +++ b/t/api-root.t @@ -85,6 +85,7 @@ $ua->ssl_opts( voicemailsettings => 1, subscriberregistrations => 1, calls => 1, + customerzonecosts => 1, }; foreach my $link(@links) { my $rex = qr!^; rel="collection http://purl\.org/sipwise/ngcp-api/#rel-([a-z]+s)"$!;