- new: client: add support for calculated field Search API parameter

Author: GomoR

Changes

@@ -1,5 +1,8 @@
 Revision history for Perl extension Metabrik::Client::Onyphe.
 
+3.02 Tue 13 Sep 11:28:31 CEST 2022
+   - new: support for calculated fields in Search API
+
 3.01 Wed 20 Apr 15:18:29 CEST 2022
    - bugfix: avoid auto-paging on non-existent pages by using _maxpage internal value
    - new function: flat

META.json

@@ -30,15 +30,15 @@
    "provides" : {
       "Metabrik::Api::Onyphe" : {
          "file" : "lib/Metabrik/Api/Onyphe.pm",
-         "version" : "3.01"
+         "version" : "3.02"
       },
       "Metabrik::Client::Onyphe" : {
          "file" : "lib/Metabrik/Client/Onyphe.pm",
-         "version" : "3.01"
+         "version" : "3.02"
       },
       "Metabrik::Client::Onyphe::Function" : {
          "file" : "lib/Metabrik/Client/Onyphe/Function.pm",
-         "version" : "3.01"
+         "version" : "3.02"
       },
       "Metabrik::Client::Onyphe::Function::Addcount" : {
          "file" : "lib/Metabrik/Client/Onyphe/Function/Addcount.pm"
@@ -119,6 +119,6 @@
          "http://opensource.org/licenses/BSD-3-Clause"
       ]
    },
-   "version" : "3.01",
+   "version" : "3.02",
    "x_serialization_backend" : "JSON::PP version 4.02"
 }

META.yml

@@ -15,13 +15,13 @@ name: Metabrik-Client-Onyphe
 provides:
   Metabrik::Api::Onyphe:
     file: lib/Metabrik/Api/Onyphe.pm
-    version: '3.01'
+    version: '3.02'
   Metabrik::Client::Onyphe:
     file: lib/Metabrik/Client/Onyphe.pm
-    version: '3.01'
+    version: '3.02'
   Metabrik::Client::Onyphe::Function:
     file: lib/Metabrik/Client/Onyphe/Function.pm
-    version: '3.01'
+    version: '3.02'
   Metabrik::Client::Onyphe::Function::Addcount:
     file: lib/Metabrik/Client/Onyphe/Function/Addcount.pm
   Metabrik::Client::Onyphe::Function::Allowlist:
@@ -76,5 +76,5 @@ requires:
   perl: v5.6.1
 resources:
   license: http://opensource.org/licenses/BSD-3-Clause
-version: '3.01'
+version: '3.02'
 x_serialization_backend: 'CPAN::Meta::YAML version 0.018'

bin/onyphe

@@ -20,6 +20,7 @@ my %lopts = (
    maxpage => 1,
    apiurl => 'https://www.onyphe.io/api/v2',
    apitrackquery => 0,
+   apicalculated => 0,
    apikeepalive => 0,
    wait => 1,
    # API options:
@@ -39,6 +40,7 @@ GetOptions(
    "apikey=s" => \$lopts{apikey},               # -apikey YOUR_APIKEY
    "apisize=i" => \$lopts{apisize},             # -apisize 100
    "apitrackquery=i" => \$lopts{apitrackquery}, # -apitrackquery 1
+   "apicalculated=i" => \$lopts{apicalculated}, # -apicalculated 1
    "apikeepalive=i" => \$lopts{apikeepalive},   # -apikeelalive 1
    "wait=i" => \$lopts{wait},                   # -wait 3
    # API options:
@@ -83,6 +85,7 @@ $cli->apiurl($lopts{apiurl});
 $cli->apikey($lopts{apikey});
 $cli->apisize($lopts{apisize});
 $cli->apitrackquery($lopts{apitrackquery});
+$cli->apicalculated($lopts{apicalculated});
 $cli->apikeepalive($lopts{apikeepalive});
 $cli->wait($lopts{wait});
 
@@ -145,6 +148,7 @@ General options:
    -apiurl <URL>                           use another URL endpoint for API calls
    -apikey <APIKEY>                        your personal ONYPHE API key
    -apitrackquery <0|1>                    add trackquery field into results (default: 0)
+   -apicalculated <0|1>                    add calculated fields into results (default: 0)
    -apikeepalive <0|1>                     use a keepalive message (default: 0)
 
 API options:

lib/Metabrik/Api/Onyphe.pm

@@ -7,7 +7,7 @@ package Metabrik::Api::Onyphe;
 use strict;
 use warnings;
 
-our $VERSION = '3.01';
+our $VERSION = '3.02';
 
 use base qw(Metabrik::Client::Rest);
 

lib/Metabrik/Client/Onyphe.pm

@@ -5,7 +5,7 @@ package Metabrik::Client::Onyphe;
 use strict;
 use warnings;
 
-our $VERSION = '3.01';
+our $VERSION = '3.02';
 
 use base qw(Metabrik);
 
@@ -24,6 +24,7 @@ sub brik_properties {
          apikey => [ qw(key) ],
          apisize => [ qw(size) ],
          apitrackquery => [ qw(0|1) ],
+         apicalculated => [ qw(0|1) ],
          apikeepalive => [ qw(0|1) ],
          wait => [ qw(seconds) ],
          # API options:
@@ -146,6 +147,7 @@ sub search {
 
    my $apiargs = [];
    push @$apiargs, { trackquery => 'true' } if $self->apitrackquery;
+   push @$apiargs, { calculated => 'true' } if $self->apicalculated;
    push @$apiargs, { size => $self->apisize } if $self->apisize;
 
    for my $page (1..$maxpage) {
@@ -178,6 +180,7 @@ sub export {
    my $apiargs = [];
    #push @$apiargs, { keepalive => 'true' } if $self->apikeepalive;  # Not supported
    #push @$apiargs, { trackquery => 'true' } if $self->apitrackquery;  # Not supported
+   #push @$apiargs, { calculated => 'true' } if $self->apicalculated;  # Not supported
    push @$apiargs, { size => $self->apisize } if $self->apisize;
 
    return $self->ao->export($oql, $apiargs, $self->callback, $opl);
@@ -205,6 +208,7 @@ sub simple {
       my $apiargs = [];
       push @$apiargs, { keepalive => 'true' } if $self->apikeepalive;
       push @$apiargs, { trackquery => 'true' } if $self->apitrackquery;
+      #push @$apiargs, { calculated => 'true' } if $self->apicalculated;  # Not supported
       push @$apiargs, { size => $self->apisize } if $self->apisize;
       return $self->best
          ? $self->ao->bulk_simple_best($oql, $category, $apiargs, $self->callback, $opl)
@@ -238,6 +242,7 @@ sub summary {
       my $apiargs = [];
       push @$apiargs, { keepalive => 'true' } if $self->apikeepalive;
       push @$apiargs, { trackquery => 'true' } if $self->apitrackquery;
+      #push @$apiargs, { calculated => 'true' } if $self->apicalculated;  # Not supported
       push @$apiargs, { size => $self->apisize } if $self->apisize;
       return $self->ao->bulk_summary($oql, $type, $apiargs, $self->callback, $opl);
    }
@@ -263,6 +268,7 @@ sub discovery {
    my $apiargs = [];
    push @$apiargs, { keepalive => 'true' } if $self->apikeepalive;
    push @$apiargs, { trackquery => 'true' } if $self->apitrackquery;
+   #push @$apiargs, { calculated => 'true' } if $self->apicalculated;  # Not supported
    push @$apiargs, { size => $self->apisize } if $self->apisize;
 
    return $self->ao->bulk_discovery($oql, $category, $apiargs, $self->callback, $opl);
@@ -536,6 +542,10 @@ Number of results to return per page. Default: 10.
 
 Activate track query mode: it will add a trackquery field to results. Default: 0.
 
+=item B<apicalculated> (0|1)
+
+Activate calculated fields mode: it will add a calculated field to results. Default: 0.
+
 =item B<apikeepalive> (0|1)
 
 Activate keep alive mode: it will print some dummy results on API calls when nothing has been rendered to support long running API calls. Default: 0.

lib/Metabrik/Client/Onyphe/Function.pm

@@ -5,7 +5,7 @@ package Metabrik::Client::Onyphe::Function;
 use strict;
 use warnings;
 
-our $VERSION = '3.01';
+our $VERSION = '3.02';
 
 use base qw(Metabrik::Client::Onyphe);