CPANEL RELEASE V0.21

Includes refactored api_query including the ulimate inclusion of parameters specified with location='query' to be added as GET params. Performed an audit of existing endpoints to cofirm that can always assume ok to append the '?'. The other hackable options remain available but default behavious is now working thanks to @rabbiveesh

Author: pscott-au

README.md

@@ -15,7 +15,7 @@ WebService::GoogleAPI::Client - Perl Google API Services OAUTH Client.
 
 # VERSION
 
-version 0.20.1
+version 0.21
 
 # SYNOPSIS
 

README.txt

@@ -4,7 +4,7 @@ NAME
 
 VERSION
 
-    version 0.20.1
+    version 0.21
 
 SYNOPSIS
 
@@ -125,6 +125,13 @@ METHODS
       if the pre-query validation fails then a 418 - I'm a Teapot error response is returned with the 
       body containing the specific description of the errors ( Tea Leaves ;^) ).   
 
+    NB: If you pass a 'path' parameter this takes precendence over the API
+    Discovery Spec. Any parameters defined in the path of the format
+    {VARNAME} will be filled in with values within the options=>{ VARNAME
+    => 'value '} parameter structure. This is the simplest way of
+    addressing issues where the API discovery spec is inaccurate. ( See
+    dev_sheets_example.pl as at 14/11/18 for illustration )
+
     To allow the user to fix discrepencies in the Discovery Specification
     the cb_method_discovery_modify callback can be used which must accept
     the method specification as a parameter and must return a (potentially

dist.ini

@@ -3,7 +3,7 @@ author = Peter Scott <[email protected]>
 license = Apache_2_0
 copyright_holder = Peter Scott and others
 copyright_year = 2017-2018
-version = 0.20.1
+version = 0.21
 main_module = lib/WebService/GoogleAPI/Client.pm
 
 ;[MinimumPerl]

examples/dev_sheets_example.pl

@@ -184,19 +184,20 @@ =head2 LIST ALL SHEETS
                             range => $config->{sheet_update_range},
                             majorDimension => 'ROWS',
                             'values' => [[99],[98]],
-                            #responseValueRenderOption => 'FORMATTED_VALUE',
+                           responseValueRenderOption => 'FORMATTED_VALUE',
+                           includeValuesInResponse => 'true'
 
                     } ;
 
     my $r = $gapi_client->api_query(  api_endpoint_id => "$versioned_api.spreadsheets.values.update",  
-    path => 'v4/spreadsheets/{spreadsheetId}/values/{range}?valueInputOption={valueInputOption}&responseValueRenderOption=FORMATTED_VALUE',
+    #path => 'v4/spreadsheets/{spreadsheetId}/values/{range}?valueInputOption={valueInputOption}&responseValueRenderOption=FORMATTED_VALUE',
                                     options => $options,
-                                   # cb_method_discovery_modify => sub { 
-                                   #   my  $meth_spec  = shift; 
-                                   #   $meth_spec->{parameters}{valueInputOption}{location} = 'path';
-                                   #   $meth_spec->{path} = "v4/spreadsheets/{spreadsheetId}/values/{range}?valueInputOption={valueInputOption}";
-                                   #   return $meth_spec;
-                                   # }
+                            #        cb_method_discovery_modify => sub { 
+                            #          my  $meth_spec  = shift; 
+                            #          $meth_spec->{parameters}{valueInputOption}{location} = 'path';
+                            #          $meth_spec->{path} = "v4/spreadsheets/{spreadsheetId}/values/{range}?valueInputOption={valueInputOption}";
+                            #          return $meth_spec;
+                            #        }
                                     );
     print dd  $r->json; # ->json;
     ############################################################################

lib/WebService/GoogleAPI/Client.pm

@@ -311,7 +311,7 @@ sub _process_params_for_api_endpoint_and_return_errors
   $params->{ path } = $method_discovery_struct->{ path } unless $params->{ path }; ## Set default path iff not set by user - NB - will prepend baseUrl later
   push @teapot_errors, 'path is a required parameter'    unless $params->{ path };
 
-  push @teapot_errors, $self->_interpolate_path_parameters_and_return_errors( $params, $method_discovery_struct );
+  push @teapot_errors, $self->_interpolate_path_parameters_append_query_params_and_return_errors( $params, $method_discovery_struct );
 
   $params->{ path } =~ s/^\///sxmg;    ## remove leading '/'  from path  
   $params->{ path } = "$api_discovery_struct->{baseUrl}/$params->{path}" unless $params->{ path } =~ /^$api_discovery_struct->{baseUrl}/ixsmg; ## prepend baseUrl if required
@@ -325,12 +325,12 @@ sub _process_params_for_api_endpoint_and_return_errors
 
 
 ##################################################
-sub _interpolate_path_parameters_and_return_errors
+sub _interpolate_path_parameters_append_query_params_and_return_errors
 {
   my ( $self, $params, $method_discovery_struct ) = @_;
   my @teapot_errors = ();
 
-  
+  my @get_query_params = ();
   my %path_params = map { $_ => 1 } ($params->{path} =~ /\{\+*([^\}]+)\}/xg); ## the params embedded in the path as indexes of hash
 
   foreach my $meth_param_spec ( uniq(keys %path_params ,keys %{ $method_discovery_struct->{ parameters } } ) )
@@ -367,11 +367,20 @@ sub _interpolate_path_parameters_and_return_errors
         }
       }
     }
-    elsif (  ( !defined $params->{ options }{ $meth_param_spec } ) && ( $method_discovery_struct->{ parameters }{ $meth_param_spec }{ 'location' } eq 'query' ))    ## check post form variables .. assume not get?
+    elsif (  ( defined $params->{ options }{ $meth_param_spec } ) && ( $method_discovery_struct->{ parameters }{ $meth_param_spec }{ 'location' } eq 'query' ))    ## check post form variables .. assume not get?
     {
         $params->{ options }{ $meth_param_spec } = $method_discovery_struct->{ parameters }{ $meth_param_spec }{ default } if ( defined $method_discovery_struct->{ parameters }{ $meth_param_spec }{ default } );
+        push( @get_query_params,  "$meth_param_spec=$params->{options}{$meth_param_spec}"   ) if defined $params->{ options }{ $meth_param_spec };
+        delete $params->{ options }{ $meth_param_spec };
     }
   }
+  if ( scalar(@get_query_params)>0 )
+  {
+    #$params->{path} .= '/' unless $params->{path} =~ /\/$/mx;
+    $params->{path} .= '?' . join('&', @get_query_params );
+  }
+  #print pp $params;
+  #exit;
   return @teapot_errors;
 }
 ##################################################