package NGCP::Panel::Controller::API::Customers; 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; use NGCP::Panel::Utils::Contract; use Path::Tiny qw(path); 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 => 'Defines a billing container for end customers. Customers usually have one or more Subscribers. A Billing Profile is assigned to a customer, and it has Contract Balances indicating the saldo of the customer for current and past billing intervals.' ); class_has 'query_params' => ( is => 'ro', isa => 'ArrayRef', default => sub {[ { param => 'reseller_id', description => 'Filter for customers belonging to a specific reseller', query => { first => sub { my $q = shift; { 'contact.reseller_id' => $q }; }, second => sub { { join => 'contact' }; }, }, }, { param => 'contact_id', description => 'Filter for customers belonging to a specific contact', query => { first => sub { my $q = shift; { contact_id => $q }; }, second => sub { }, }, }, ]}, ); with 'NGCP::Panel::Role::API::Customers'; class_has('resource_name', is => 'ro', default => 'customers'); class_has('dispatch_path', is => 'ro', default => '/api/customers/'); class_has('relation', is => 'ro', default => 'http://purl.org/sipwise/ngcp-api/#rel-customers'); __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); } sub GET :Allow { my ($self, $c) = @_; my $page = $c->request->params->{page} // 1; my $rows = $c->request->params->{rows} // 10; { my $customers = $self->item_rs($c); my $total_count = int($customers->count); $customers = $customers->search(undef, { page => $page, rows => $rows, }); my (@embedded, @links); my $form = $self->get_form($c); for my $customer($customers->all) { push @embedded, $self->hal_from_customer($c, $customer, $form); push @links, Data::HAL::Link->new( relation => 'ngcp:'.$self->resource_name, href => sprintf('/%s%d', $c->request->path, $customer->id), ); } 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', $c->request->path, $page, $rows)); if(($total_count / $rows) > $page ) { push @links, Data::HAL::Link->new(relation => 'next', href => sprintf('/%s?page=%d&rows=%d', $c->request->path, $page + 1, $rows)); } if($page > 1) { push @links, Data::HAL::Link->new(relation => 'prev', href => sprintf('/%s?page=%d&rows=%d', $c->request->path, $page - 1, $rows)); } 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 POST :Allow { my ($self, $c) = @_; my $guard = $c->model('DB')->txn_scope_guard; { my $schema = $c->model('DB'); my $resource = $self->get_valid_post_data( c => $c, media_type => 'application/json', ); last unless $resource; my $product_class = delete $resource->{type}; unless($product_class eq "sipaccount" || $product_class eq "pbxaccount") { $self->error($c, HTTP_UNPROCESSABLE_ENTITY, "Invalid 'type', must be 'sipaccount' or 'pbxaccount'."); last; } my $product = $schema->resultset('products')->find({ class => $product_class }); unless($product) { $self->error($c, HTTP_UNPROCESSABLE_ENTITY, "Invalid 'type'."); last; } unless(defined $resource->{billing_profile_id}) { $self->error($c, HTTP_UNPROCESSABLE_ENTITY, "Invalid 'billing_profile_id', not defined."); last; } # add product_id just for form check (not part of the actual contract item) # and remove it after the check $resource->{product_id} = $product->id; $resource->{contact_id} //= undef; my $form = $self->get_form($c); last unless $self->validate_form( c => $c, resource => $resource, form => $form, ); delete $resource->{product_id}; my $now = NGCP::Panel::Utils::DateTime::current_local; $resource->{create_timestamp} = $now; $resource->{modify_timestamp} = $now; my $customer; my $billing_profile_id = delete $resource->{billing_profile_id}; my $billing_profile = $schema->resultset('billing_profiles')->find($billing_profile_id); unless($billing_profile) { $self->error($c, HTTP_UNPROCESSABLE_ENTITY, "Invalid 'billing_profile_id'."); last; } try { $customer = $schema->resultset('contracts')->create($resource); } catch($e) { $c->log->error("failed to create customer contract: $e"); # TODO: user, message, trace, ... $self->error($c, HTTP_INTERNAL_SERVER_ERROR, "Failed to create customer."); last; } unless($customer->contact->reseller_id) { $self->error($c, HTTP_UNPROCESSABLE_ENTITY, "The contact_id is not a valid ngcp:customercontacts item, but an ngcp:systemcontacts item"); last; } unless($customer->contact->reseller_id == $billing_profile->reseller_id) { $self->error($c, HTTP_UNPROCESSABLE_ENTITY, "The reseller of the contact doesn't match the reseller of the billing profile"); last; } if($customer->subscriber_email_template_id && $customer->subscriber_email_template->reseller_id != $customer->contact->reseller_id) { $self->error($c, HTTP_UNPROCESSABLE_ENTITY, "Invalid 'subscriber_email_template_id', doesn't exist for reseller assigned to customer contact"); return; } if($customer->passreset_email_template_id && $customer->passreset_email_template->reseller_id != $customer->contact->reseller_id) { $self->error($c, HTTP_UNPROCESSABLE_ENTITY, "Invalid 'passreset_email_template_id', doesn't exist for reseller assigned to customer contact"); return; } try { $customer->billing_mappings->create({ billing_profile_id => $billing_profile->id, product_id => $product->id, }); NGCP::Panel::Utils::Contract::create_contract_balance( c => $c, profile => $billing_profile, contract => $customer, ); } catch($e) { $c->log->error("failed to create customer contract: $e"); # TODO: user, message, trace, ... $self->error($c, HTTP_INTERNAL_SERVER_ERROR, "Failed to create customer."); last; } $guard->commit; $c->response->status(HTTP_CREATED); $c->response->header(Location => sprintf('/%s%d', $c->request->path, $customer->id)); $c->response->body(q()); } return; } sub end : Private { my ($self, $c) = @_; $self->log_response($c); } # vim: set tabstop=4 expandtab: