2.1.2 - fix pagination when paginator result key is a compound key

Author: rlauer6

ChangeLog

@@ -1,3 +1,13 @@
+Wed Feb 12 09:17:23 2025  Rob Lauer  <rlauer6@comcast.net>
+
+	[2.1.2]:
+	* NEWS.md: updated
+	* VERSION: bump
+	* src/main/perl/lib/Amazon/API.pm.in
+	(invoke_api): fix pagination for compound keys
+	(dig): new
+	(bury): new
+
 Thu Dec  5 05:46:10 2024  Rob Lauer  <rlauer6@comcast.net>
 
 	[2.1.1]:

NEWS.md

@@ -6,23 +6,21 @@ as well as a running list of changes from previous versions.  If
 critical bugs are found in any of the software, notice of such bugs
 and the versions in which they were fixed will be noted here, as well.
 
-# perl-Amazon-API 2.1.0 (2024-12-03)
+# perl-Amazon-API 2.1.2 (2025-02-12)
 
-_Version 2.1.0 is a minor update to which fixes a few small bugs and
-updates the documetation. More importantly, this is the first release
-that I would consider production ready._
+_Version 2.1.2 is a minor update to which fixes a bug in the way
+pagination is implemented. Some paginators need to use a compound key
+to find the paged result set in the returned results element.  For
+example, the CloudFront ListDistributions API uses
+'DistributionList.Items' as the result key...
 
 ## Fixes
 
-* initialize log level to error
-* fix bug when invoking API directly (not using botocore)
+* fix paginatiors that use a compound key
 
 ## Enhancements
 
-* perltidy'ing of Botocore generated classes is now disabled by
-  default to make creating classes a little faster. See
-  [cpan-dist/README.md](cpan-dist/README.md).
-* documentation cleanups and better more detailed explanations overall
+None
 
 # perl-Amazon-API 2.1.1 (2024-12-05)
 
@@ -40,6 +38,24 @@ was being generated.
   [cpan-dist/README.md](cpan-dist/README.md).
 * documentation cleanups and better more detailed explanations overall
 
+# perl-Amazon-API 2.1.0 (2024-12-03)
+
+_Version 2.1.0 is a minor update to which fixes a few small bugs and
+updates the documetation. More importantly, this is the first release
+that I would consider production ready._
+
+## Fixes
+
+* initialize log level to error
+* fix bug when invoking API directly (not using botocore)
+     
+## Enhancements
+
+* perltidy'ing of Botocore generated classes is now disabled by
+  default to make creating classes a little faster. See
+  [cpan-dist/README.md](cpan-dist/README.md).
+* documentation cleanups and better more detailed explanations overall
+
 # perl-Amazon-API 2.0.15 (2024-11-19)
 
 _Version 2.0.15 is a minor update to which fixes a few small bugs_

README.md

@@ -947,7 +947,7 @@ by passing the `content_type` option to the constructor.
 
 # VERSION
 
-This documentation refers to version 2.1.1  of `Amazon::API`.
+This documentation refers to version 2.1.2  of `Amazon::API`.
 
 # DIAGNOSTICS
 

VERSION

@@ -1 +1 @@
-2.1.1
+2.1.2

src/main/perl/lib/Amazon/API.pm.in

@@ -1271,16 +1271,29 @@ sub invoke_api {
     if ($use_paginator) {
       my $result = $self->decode_response;
 
+      DEBUG(
+        sub {
+          return Dumper(
+            [ paginator     => $paginator,
+              paged_results => @paged_results,
+              result        => $result
+            ]
+          );
+        }
+      );
+
+      my $actual_result = dig( $result, $paginator, 'result_key' );
+
       return \@paged_results
-        if !$result->{ $paginator->{result_key} };
+        if !$actual_result;
 
       DEBUG(
         sub {
           return Dumper( [ result => $result, ] );
         }
       );
 
-      push @paged_results, @{ $result->{ $paginator->{result_key} } };
+      push @paged_results, @{$actual_result};
 
       DEBUG(
         sub {
@@ -1293,9 +1306,8 @@ sub invoke_api {
         }
       );
 
-      if ( !$result->{ $paginator->{more_results} } ) {
-        delete $result->{ $paginator->{more_results} };
-
+      if ( !dig( $result, $paginator, 'more_results' ) ) {
+        # might have to dig here too, but generally I don't think so
         if ( $paginator->{limit_key} ) {
           delete $result->{ $paginator->{limit_key} };
         }
@@ -1327,9 +1339,8 @@ sub invoke_api {
     }
   }
 
-  if ($use_paginator) {
-    return { $paginator->{result_key} => \@paged_results };
-  }
+  return bury( \@paged_results, $paginator, 'result_key' )
+    if $use_paginator;
 
   my $results = $self->decode_response;
 
@@ -1343,15 +1354,74 @@ sub invoke_api {
   # 'use_paginator' is tested above and if it is false (you told me not to use the
   # paginator) we return the results...
 
-  if ( !$results->{ $paginator->{more_results} } ) {
-    delete $results->{ $paginator->{more_results} };
+  if ( !dig( $results, $paginator, 'more_results' ) ) {
     delete $results->{ $paginator->{input_token} };
     delete $results->{ $paginator->{limit_key} };
   }
 
   return $results;
 }
 
+########################################################################
+# the analog to dig, we need to set the result to a hash element specified
+# by a dot encoded string. Example: DistributionList.Item
+########################################################################
+sub bury {
+########################################################################
+  my ( $result, $paginator, $key ) = @_;
+
+  return $result
+    if !$paginator;
+
+  $key = $paginator->{$key};
+
+  return { $key => $result }
+    if $key !~ /[.]/xsm;
+
+  my $parent = {};
+  my $child  = $parent;
+
+  my @keys       = split /[.]/xsm, $key;
+  my $result_key = pop @keys;  # remove last element
+
+  foreach (@keys) {
+    $child->{$_} = {};
+    $child = $child->{$_};
+  }
+
+  $child->{$result_key} = $result;
+
+  return $parent;
+}
+
+########################################################################
+# follow the . encoded key to find the hash element
+# example: DistributionList.Items
+########################################################################
+sub dig {
+########################################################################
+  my ( $result, $paginator, $key, $delete ) = @_;
+
+  return $result
+    if !$paginator || !$paginator->{$key};
+
+  $key = $paginator->{$key};
+
+  return $result->{$key}
+    if $key !~ /[.]/xsm;
+
+  foreach ( split /[.]/xsm, $key ) {
+    $result = $result->{$_};
+    $key    = $_;
+  }
+
+  if ($delete) {
+    delete $result->{$key};
+  }
+
+  return $result;
+}
+
 ########################################################################
 sub print_error {
 ########################################################################

src/main/perl/lib/README.md

@@ -947,7 +947,7 @@ by passing the `content_type` option to the constructor.
 
 # VERSION
 
-This documentation refers to version 2.1.1  of `Amazon::API`.
+This documentation refers to version 2.1.2  of `Amazon::API`.
 
 # DIAGNOSTICS