MT#6195 API: rewrite: GET, PUT and PATCH implemented

lib/NGCP/Panel/Controller/API/RewriteRuleSets.pm

@@ -0,0 +1,132 @@
+package NGCP::Panel::Controller::API::RewriteRuleSets;
+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 Path::Tiny qw(path);
+use Safe::Isa qw($_isa);
+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 collection of <a href="#rewriterules">Rewrite Rules</a>.',
+);
+
+with 'NGCP::Panel::Role::API';
+with 'NGCP::Panel::Role::API::RewriteRuleSets';
+
+class_has('resource_name', is => 'ro', default => 'rewrite');
+class_has('dispatch_path', is => 'ro', default => '/api/rewrite/');
+class_has('relation', is => 'ro', default => 'http://purl.org/sipwise/ngcp-api/#rel-rewrite');
+
+__PACKAGE__->config(
+    action => {
+        map { $_ => {
+            ACLDetachTo => '/api/root/invalid_user',
+            AllowedRole => 'admin',
+            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 $rwr_set = $self->item_rs($c, "rulesets");
+        my $total_count = int($rwr_set->count);
+        $rwr_set = $rwr_set->search(undef, {
+            page => $page,
+            rows => $rows,
+        });
+        my (@embedded, @links);
+        for my $set ($rwr_set->search({}, {order_by => {-asc => 'me.id'}})->all) {
+            push @embedded, $self->hal_from_item($c, $set, "rewrite");
+            push @links, Data::HAL::Link->new(
+                relation => 'ngcp:'.$self->resource_name,
+                href     => sprintf('%s%d', $self->dispatch_path, $set->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', $self->dispatch_path, $page, $rows));
+        if(($total_count / $rows) > $page ) {
+            push @links, Data::HAL::Link->new(relation => 'next', href => sprintf('%s?page=%d&rows=%d', $self->dispatch_path, $page + 1, $rows));
+        }
+        if($page > 1) {
+            push @links, Data::HAL::Link->new(relation => 'prev', href => sprintf('%s?page=%d&rows=%d', $self->dispatch_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 end : Private {
+    my ($self, $c) = @_;
+
+    $self->log_response($c);
+    return 1;
+}
+
+# vim: set tabstop=4 expandtab:

lib/NGCP/Panel/Controller/API/RewriteRuleSetsItem.pm

@@ -0,0 +1,180 @@
+package NGCP::Panel::Controller::API::RewriteRuleSetsItem;
+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';
+with 'NGCP::Panel::Role::API::RewriteRuleSets';
+
+class_has('resource_name', is => 'ro', default => 'rewrite');
+class_has('dispatch_path', is => 'ro', default => '/api/rewrite/');
+class_has('relation', is => 'ro', default => 'http://purl.org/sipwise/ngcp-api/#rel-rewrite');
+
+__PACKAGE__->config(
+    action => {
+        map { $_ => {
+            ACLDetachTo => '/api/root/invalid_user',
+            AllowedRole => 'admin',
+            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 $ruleset = $self->item_by_id($c, $id, "rulesets");
+        last unless $self->resource_exists($c, ruleset => $ruleset);
+
+        my $hal = $self->hal_from_item($c, $ruleset, "rewrite");
+
+        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 PATCH :Allow {
+    my ($self, $c, $id) = @_;
+    my $guard = $c->model('DB')->txn_scope_guard;
+    {
+        my $preference = $self->require_preference($c);
+        last unless $preference;
+
+        my $json = $self->get_valid_patch_data(
+            c => $c,
+            id => $id,
+            media_type => 'application/json-patch+json',
+            ops => [qw/add replace remove copy/],
+        );
+        last unless $json;
+
+        my $ruleset = $self->item_by_id($c, $id, "rulesets");
+        last unless $self->resource_exists($c, ruleset => $ruleset);
+        my $old_resource = { $ruleset->get_inflated_columns };
+        my $resource = $self->apply_patch($c, $old_resource, $json);
+        last unless $resource;
+
+        my $form = $self->get_form($c);
+        $ruleset = $self->update_item($c, $ruleset, $old_resource, $resource, $form);
+        last unless $ruleset;
+
+        $guard->commit; 
+
+        if ('minimal' eq $preference) {
+            $c->response->status(HTTP_NO_CONTENT);
+            $c->response->header(Preference_Applied => 'return=minimal');
+            $c->response->body(q());
+        } else {
+            my $hal = $self->hal_from_item($c, $ruleset, "rulesets");
+            my $response = HTTP::Response->new(HTTP_OK, undef, HTTP::Headers->new(
+                $hal->http_headers,
+            ), $hal->as_json);
+            $c->response->headers($response->headers);
+            $c->response->header(Preference_Applied => 'return=representation');
+            $c->response->body($response->content);
+        }
+    }
+    return;
+}
+
+sub PUT :Allow {
+    my ($self, $c, $id) = @_;
+    my $guard = $c->model('DB')->txn_scope_guard;
+    {
+        my $preference = $self->require_preference($c);
+        last unless $preference;
+
+        my $ruleset = $self->item_by_id($c, $id, "rulesets");
+        last unless $self->resource_exists($c, ruleset => $ruleset);
+        my $resource = $self->get_valid_put_data(
+            c => $c,
+            id => $id,
+            media_type => 'application/json',
+        );
+        last unless $resource;
+        my $old_resource = { $ruleset->get_inflated_columns };
+
+        my $form = $self->get_form($c);
+        $ruleset = $self->update_item($c, $ruleset, $old_resource, $resource, $form);
+        last unless $ruleset;
+
+        $guard->commit; 
+
+        if ('minimal' eq $preference) {
+            $c->response->status(HTTP_NO_CONTENT);
+            $c->response->header(Preference_Applied => 'return=minimal');
+            $c->response->body(q());
+        } else {
+            my $hal = $self->hal_from_item($c, $ruleset, "rulesets");
+            my $response = HTTP::Response->new(HTTP_OK, undef, HTTP::Headers->new(
+                $hal->http_headers,
+            ), $hal->as_json);
+            $c->response->headers($response->headers);
+            $c->response->header(Preference_Applied => 'return=representation');
+            $c->response->body($response->content);
+        }
+    }
+    return;
+}
+
+sub end : Private {
+    my ($self, $c) = @_;
+
+    $self->log_response($c);
+    return 1;
+}
+
+# vim: set tabstop=4 expandtab:

lib/NGCP/Panel/Controller/API/RewriteRules.pm

@@ -0,0 +1,137 @@
+package NGCP::Panel::Controller::API::RewriteRules;
+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 => 
+        'Defines a set of Rewrite Rules which are grouped in <a href="#rewriterulesets">Rewrite Rule Sets</a>. They can be used to alter incoming and outgoing numbers.',
+);
+
+with 'NGCP::Panel::Role::API';
+with 'NGCP::Panel::Role::API::RewriteRules';
+
+class_has('resource_name', is => 'ro', default => 'rewriterules');
+class_has('dispatch_path', is => 'ro', default => '/api/rewriterules/');
+class_has('relation', is => 'ro', default => 'http://purl.org/sipwise/ngcp-api/#rel-rewriterules');
+
+__PACKAGE__->config(
+    action => {
+        map { $_ => {
+            ACLDetachTo => '/api/root/invalid_user',
+            AllowedRole => 'admin',
+            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 $rules = $self->item_rs($c, "rules");
+
+        if($c->request->query_parameters->{set_id}) { #TODO: naming? document?
+            $rules = $rules->search({
+                set_id => $c->request->query_parameters->{set_id},
+            });
+        }
+
+        my $total_count = int($rules->count);
+        $rules = $rules->search(undef, {
+            page => $page,
+            rows => $rows,
+        });
+        my (@embedded, @links);
+        for my $rule ($rules->search({}, {order_by => {-asc => 'me.id'}})->all) {
+            push @embedded, $self->hal_from_item($c, $rule, "rewriterules");
+            push @links, Data::HAL::Link->new(
+                relation => 'ngcp:'.$self->resource_name,
+                href     => sprintf('%s%d', $self->dispatch_path, $rule->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', $self->dispatch_path, $page, $rows));
+        if(($total_count / $rows) > $page ) {
+            push @links, Data::HAL::Link->new(relation => 'next', href => sprintf('%s?page=%d&rows=%d', $self->dispatch_path, $page + 1, $rows));
+        }
+        if($page > 1) {
+            push @links, Data::HAL::Link->new(relation => 'prev', href => sprintf('%s?page=%d&rows=%d', $self->dispatch_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 end : Private {
+    my ($self, $c) = @_;
+
+    $self->log_response($c);
+    return 1;
+}
+
+# vim: set tabstop=4 expandtab:

lib/NGCP/Panel/Controller/API/RewriteRulesItem.pm

@@ -0,0 +1,180 @@
+package NGCP::Panel::Controller::API::RewriteRulesItem;
+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';
+with 'NGCP::Panel::Role::API::RewriteRules';
+
+class_has('resource_name', is => 'ro', default => 'rewriterules');
+class_has('dispatch_path', is => 'ro', default => '/api/rewriterules/');
+class_has('relation', is => 'ro', default => 'http://purl.org/sipwise/ngcp-api/#rel-rewriterules');
+
+__PACKAGE__->config(
+    action => {
+        map { $_ => {
+            ACLDetachTo => '/api/root/invalid_user',
+            AllowedRole => 'admin',
+            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 $rule = $self->item_by_id($c, $id, "rules");
+        last unless $self->resource_exists($c, rule => $rule);
+
+        my $hal = $self->hal_from_item($c, $rule, "rewriterules");
+
+        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 PATCH :Allow {
+    my ($self, $c, $id) = @_;
+    my $guard = $c->model('DB')->txn_scope_guard;
+    {
+        my $preference = $self->require_preference($c);
+        last unless $preference;
+
+        my $json = $self->get_valid_patch_data(
+            c => $c,
+            id => $id,
+            media_type => 'application/json-patch+json',
+            ops => [qw/add replace remove copy/],
+        );
+        last unless $json;
+
+        my $rule = $self->item_by_id($c, $id, "rules");
+        last unless $self->resource_exists($c, rule => $rule);
+        my $old_resource = { $rule->get_inflated_columns };
+        my $resource = $self->apply_patch($c, $old_resource, $json);
+        last unless $resource;
+
+        my $form = $self->get_form($c);
+        $rule = $self->update_item($c, $rule, $old_resource, $resource, $form);
+        last unless $rule;
+
+        $guard->commit; 
+
+        if ('minimal' eq $preference) {
+            $c->response->status(HTTP_NO_CONTENT);
+            $c->response->header(Preference_Applied => 'return=minimal');
+            $c->response->body(q());
+        } else {
+            my $hal = $self->hal_from_item($c, $rule, "rewriterules");
+            my $response = HTTP::Response->new(HTTP_OK, undef, HTTP::Headers->new(
+                $hal->http_headers,
+            ), $hal->as_json);
+            $c->response->headers($response->headers);
+            $c->response->header(Preference_Applied => 'return=representation');
+            $c->response->body($response->content);
+        }
+    }
+    return;
+}
+
+sub PUT :Allow {
+    my ($self, $c, $id) = @_;
+    my $guard = $c->model('DB')->txn_scope_guard;
+    {
+        my $preference = $self->require_preference($c);
+        last unless $preference;
+
+        my $rule = $self->item_by_id($c, $id, "rules");
+        last unless $self->resource_exists($c, rule => $rule);
+        my $resource = $self->get_valid_put_data(
+            c => $c,
+            id => $id,
+            media_type => 'application/json',
+        );
+        last unless $resource;
+        my $old_resource = { $rule->get_inflated_columns };
+
+        my $form = $self->get_form($c);
+        $rule = $self->update_item($c, $rule, $old_resource, $resource, $form);
+        last unless $rule;
+
+        $guard->commit;
+
+        if ('minimal' eq $preference) {
+            $c->response->status(HTTP_NO_CONTENT);
+            $c->response->header(Preference_Applied => 'return=minimal');
+            $c->response->body(q());
+        } else {
+            my $hal = $self->hal_from_item($c, $rule, "rewriterules");
+            my $response = HTTP::Response->new(HTTP_OK, undef, HTTP::Headers->new(
+                $hal->http_headers,
+            ), $hal->as_json);
+            $c->response->headers($response->headers);
+            $c->response->header(Preference_Applied => 'return=representation');
+            $c->response->body($response->content);
+        }
+    }
+    return;
+}
+
+sub end : Private {
+    my ($self, $c) = @_;
+
+    $self->log_response($c);
+    return 1;
+}
+
+# vim: set tabstop=4 expandtab:

lib/NGCP/Panel/Form/RewriteRule/AdminSet.pm

@@ -7,6 +7,10 @@ use Moose::Util::TypeConstraints;
 has_field 'reseller' => (
     type => '+NGCP::Panel::Field::Reseller',
     validate_when_empty => 1,
+    element_attr => {
+        rel => ['tooltip'],
+        title => ['The reseller who can use the Ruleset.'],
+    },
 );
 
 has_block 'fields' => (

lib/NGCP/Panel/Form/RewriteRule/ResellerSet.pm

@@ -14,11 +14,19 @@ sub build_form_element_class {[qw(form-horizontal)]}
 has_field 'name' => (
     type => 'Text',
     required => 1,
+    element_attr => {
+        rel => ['tooltip'],
+        title => ['The name of the Rewrite Rule Set.'],
+    },
 );
 
 has_field 'description' => (
     type => 'Text',
     required => 0,
+    element_attr => {
+        rel => ['tooltip'],
+        title => ['Arbitrary text.'],
+    },
 );
 
 has_field 'save' => (

lib/NGCP/Panel/Form/RewriteRule/Rule.pm

@@ -15,6 +15,10 @@ has_field 'match_pattern' => (
     type => '+NGCP::Panel::Field::Regexp',
     required => 1,
     inflate_default_method => \&inflate_pattern,
+    element_attr => {
+        rel => ['tooltip'],
+        title => ['Match pattern, a regular expression.'],
+    },
 );
 
 has_field 'replace_pattern' => (
@@ -22,11 +26,19 @@ has_field 'replace_pattern' => (
     required => 1,
     label => 'Replacement Pattern',
     inflate_default_method => \&inflate_pattern,
+    element_attr => {
+        rel => ['tooltip'],
+        title => ['Replacement pattern.'],
+    },
 );
 
 has_field 'description' => (
     type => 'Text',
     required => 1,
+    element_attr => {
+        rel => ['tooltip'],
+        title => ['Arbitrary text.'],
+    },
 );
 
 has_field 'direction' => (
@@ -35,6 +47,10 @@ has_field 'direction' => (
         { label => 'Inbound', value => 'in'},
         { label => 'Outbound', value => 'out'},
     ],
+    element_attr => {
+        rel => ['tooltip'],
+        title => ['Inbound (in) or Outbound (out).']
+    },
 );
 
 has_field 'field' => (
@@ -43,6 +59,10 @@ has_field 'field' => (
         { label => 'Callee', value => 'callee'},
         { label => 'Caller', value => 'caller'},
     ],
+    element_attr => {
+        rel => ['tooltip'],
+        title => ['caller or callee.']
+    },
 );
 
 has_field 'save' => (

lib/NGCP/Panel/Role/API/RewriteRuleSets.pm

@@ -0,0 +1,113 @@
+package NGCP::Panel::Role::API::RewriteRuleSets;
+use Moose::Role;
+use Sipwise::Base;
+
+use boolean qw(true);
+use TryCatch;
+use Data::HAL qw();
+use Data::HAL::Link qw();
+use HTTP::Status qw(:constants);
+use JSON::Types;
+use NGCP::Panel::Form::RewriteRule::AdminSet;
+use NGCP::Panel::Form::RewriteRule::ResellerSet;
+use NGCP::Panel::Form::RewriteRule::Rule;
+
+sub get_form {
+    my ($self, $c) = @_;
+
+    if($c->user->roles eq "admin") {
+        return NGCP::Panel::Form::RewriteRule::AdminSet->new;
+    } else {
+        return NGCP::Panel::Form::RewriteRule::ResellerSet->new;
+    }
+}
+
+sub hal_from_item {
+    my ($self, $c, $item, $type) = @_;
+    my $form;
+    
+    my %resource = $item->get_inflated_columns;
+
+    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", $self->dispatch_path)),
+            Data::HAL::Link->new(relation => 'profile', href => 'http://purl.org/sipwise/ngcp-api/'),
+            Data::HAL::Link->new(relation => 'self', href => sprintf("%s%d", $self->dispatch_path, $item->id)),
+            Data::HAL::Link->new(relation => "ngcp:$type", href => sprintf("/api/%s/%d", $type, $item->id)),
+        ],
+        relation => 'ngcp:'.$self->resource_name,
+    );
+
+    $form //= $self->get_form($c);
+    return unless $self->validate_form(
+        c => $c,
+        form => $form,
+        resource => \%resource,
+        run => 0,
+    );
+    $hal->resource(\%resource);
+    return $hal;
+}
+
+sub item_rs {
+    my ($self, $c, $type) = @_;
+    my $item_rs;
+
+    if($type eq "rulesets") {
+        if($c->user->roles eq "admin") {
+            $item_rs = $c->model('DB')->resultset('voip_rewrite_rule_sets');
+        } else {
+            return;
+        }
+    } elsif($type eq "rules") {
+        if($c->user->roles eq "admin") {
+            $item_rs = $c->model('DB')->resultset('voip_rewrite_rules');
+        } else {
+            return;
+        }
+    } else {
+        die "You should not reach this";
+    }
+    return $item_rs;
+}
+
+sub item_by_id {
+    my ($self, $c, $id, $type) = @_;
+
+    my $item_rs = $self->item_rs($c, $type);
+    return $item_rs->find($id);
+}
+
+sub update_item {
+    my ($self, $c, $item, $old_resource, $resource, $form) = @_;
+
+    delete $resource->{id};
+
+    if($old_resource->{reseller_id} != $resource->{reseller_id}) {
+        my $reseller = $c->model('DB')->resultset('resellers')
+            ->find($resource->{reseller_id});
+        unless($reseller) {
+            $self->error($c, HTTP_UNPROCESSABLE_ENTITY, "Invalid 'reseller_id'");
+            return;
+        }
+    }
+
+    return unless $self->validate_form(
+        c => $c,
+        form => $form,
+        resource => $resource,
+    );
+    #TODO: priority not accessible here
+    $item->update($resource);
+
+    return $item;
+}
+
+1;
+# vim: set tabstop=4 expandtab:

lib/NGCP/Panel/Role/API/RewriteRules.pm

@@ -0,0 +1,102 @@
+package NGCP::Panel::Role::API::RewriteRules;
+use Moose::Role;
+use Sipwise::Base;
+
+use boolean qw(true);
+use TryCatch;
+use Data::HAL qw();
+use Data::HAL::Link qw();
+use HTTP::Status qw(:constants);
+use JSON::Types;
+use NGCP::Panel::Form::RewriteRule::AdminSet;
+use NGCP::Panel::Form::RewriteRule::ResellerSet;
+use NGCP::Panel::Form::RewriteRule::Rule;
+
+sub get_form {
+    my ($self, $c) = @_;
+    return NGCP::Panel::Form::RewriteRule::Rule->new;
+}
+
+sub hal_from_item {
+    my ($self, $c, $item, $type) = @_;
+    my $form;
+    
+    my %resource = $item->get_inflated_columns;
+
+    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", $self->dispatch_path)),
+            Data::HAL::Link->new(relation => 'profile', href => 'http://purl.org/sipwise/ngcp-api/'),
+            Data::HAL::Link->new(relation => 'self', href => sprintf("%s%d", $self->dispatch_path, $item->id)),
+            Data::HAL::Link->new(relation => "ngcp:$type", href => sprintf("/api/%s/%d", $type, $item->id)),
+            Data::HAL::Link->new(relation => "ngcp:rewrite", href => sprintf("/api/rewrite/%d", $item->set_id)), #TODO: naming?
+        ],
+        relation => 'ngcp:'.$self->resource_name,
+    );
+
+    $form //= $self->get_form($c);
+    return unless $self->validate_form(
+        c => $c,
+        form => $form,
+        resource => \%resource,
+        run => 0,
+    );
+    $hal->resource(\%resource);
+    return $hal;
+}
+
+sub item_rs {
+    my ($self, $c, $type) = @_;
+    my $item_rs;
+
+    if($type eq "rulesets") {
+        if($c->user->roles eq "admin") {
+            $item_rs = $c->model('DB')->resultset('voip_rewrite_rule_sets');
+        } else {
+            return;
+        }
+    } elsif($type eq "rules") {
+        if($c->user->roles eq "admin") {
+            $item_rs = $c->model('DB')->resultset('voip_rewrite_rules');
+        } else {
+            return;
+        }
+    } else {
+        die "You should not reach this";
+    }
+    return $item_rs;
+}
+
+sub item_by_id {
+    my ($self, $c, $id, $type) = @_;
+
+    my $item_rs = $self->item_rs($c, $type);
+    return $item_rs->find($id);
+}
+
+sub update_item {
+    my ($self, $c, $item, $old_resource, $resource, $form) = @_;
+
+    delete $resource->{id};
+
+    return unless $self->validate_form(
+        c => $c,
+        form => $form,
+        resource => $resource,
+    );
+
+    $item->update($resource);
+
+
+
+    return $item;
+}
+
+1;
+# vim: set tabstop=4 expandtab: