POD and replace Moose with Moo dependency

also attempt to address #4 with minor validation check addition to
Discovery

Author: pscott-au

.perlcriticrc

@@ -1,7 +1,3 @@
 [TestingAndDebugging::RequireUseStrict]
 equivalent_modules = Modern::Perl
 
-[TestingAndDebugging::RequireUseWarnings]
-equivalent_modules = Modern::Perl
-
-severity = 1

CONTRIBUTING.md

@@ -2,18 +2,25 @@
 
 - Use the [Github Issues Page](https://github.com/pscott-au/WebService-GoogleAPI-Client/issues) 
 
-# CONTRIBUTING CODE
+## Github Repo Management
 
 - Aspiring to [Trunk Based Developent](https://paulhammant.com/2013/04/05/what-is-trunk-based-development/)
+- Relase branches are created when package is published to CPAN ( starting V1.12 )
+
+
+# CONTRIBUTING CODE
+
 - Use perlcritic and perltidy if my bracer style is offensive
 - This is my first module using dzilla to package a module - I'm not completely sold on it and may be using it incorrectly - advice on improving usage welcome
 - There remain a few architectural bad smells from the original source code this was based on - don't assume that the class structure is sane
 - Pull reqeusts preferred but whatever works for you I will try to work with
 
 # HELP WANTED 
 
+- Seek reviews from http://prepan.org/module.submit and similar
 - refactor to improve test coverage
 - clean up the test structure
+- survey other Google Perl modules
 - explore handling of batch requests
 - API worked examples with help functions
 - ability to examine CHI cache and introspect on Client instance metrics ( number of HTTP calls, cache size, TTL data sent/received etc )

README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/pscott-au/WebService-GoogleAPI-Client.svg?branch=master)](https://travis-ci.org/pscott-au//WebService-GoogleAPI-Client)
+[![Build Status](https://travis-ci.org/pscott-au/WebService-GoogleAPI-Client.svg?branch=master)](https://travis-ci.org/pscott-au/WebService-GoogleAPI-Client)
 [![Coverage Status](https://coveralls.io/repos/github/pscott-au/WebService-GoogleAPI-Client/badge.svg?branch=master)](https://coveralls.io/github/pscott-au/WebService-GoogleAPI-Client?branch=master)
 [![CPAN Version](https://img.shields.io/cpan/v/WebService-GoogleAPI-Client.svg)](http://search.cpan.org/~localshop/WebService-GoogleAPI-Client/lib/WebService/GoogleAPI/Client.pm)
 
@@ -11,16 +11,20 @@ WebService::GoogleAPI::Client - Perl Google API Services OAUTH Client.
 
 # VERSION
 
-version 0.10
+version 0.12
 
 # SYNOPSIS
 
-Provides client access to All [Google API V.1](https://developers.google.com/discovery/v1) Services using a user-agent that handles OAUTH2 authentication and access control and provides helpers to exploit locally cached API Discovery specifications.
+Provides client access to [Google API V.1](https://developers.google.com/discovery/v1) Service End-Points using a user-agent that handles OAUTH2 authentication and access control and provides helpers to cache API Discovery specifications.
 
 The guiding principal is to minimise the conceptual load when using the Client agent for users who want to make calls directly, but also make available functions to help explore unfamiliar API endpoints by offering optional validation etc against the latest published Google API Discovery specifications.
 
 
-NB: To create or modify an authorization configuration file with scope and user tokens in current folder run _goauth_ CLI tool to interactively create the JSON configuration and launch a local HTTP server to acquire authenticated access permissions with a Google email account. See ````perldoc goauth```` for more detail.
+NB: To create or modify an authorization configuration file with scope and user tokens in current folder run _goauth_ CLI tool to interactively create the JSON configuration and launch a local HTTP server to acquire authenticated access permissions with a Google email account. 
+
+![goauth screen capture](https://pscott-au.github.io/WebService-Google-Client/goauth-login-cap.gif)
+
+See ````perldoc goauth```` for more detail.
 
 
 ````perl
@@ -32,8 +36,13 @@ NB: To create or modify an authorization configuration file with scope and user
 
     my $gapi_client = WebService::GoogleAPI::Client->new( debug => 1, gapi_json => './gapi.json', user=> '[email protected]' );
 
+
     ## Completely manually constructed API End-Point Request to obtain Perl Data Structure converted from JSON response.
-    print Dumper $gapi_client->api_get(  userId => 'me'   )->json;
+    my $res = $gapi_client->api_query(
+          method => 'get',
+          path => 'https://www.googleapis.com/calendar/users/me/calendarList',
+        )->json;
+
 
     ## using dotted API Endpoint id to invoke helper validation and default value interpolations etc to send email to self
     use Email::Simple;    ## RFC2822 formatted messages
@@ -54,7 +63,7 @@ NB: To create or modify an authorization configuration file with scope and user
                         );
 
 
-
+    ## TEXT TO SPEECH EXAMPLE
     my $text_to_speech_request_options =  {
             'input' => {
             'text' => 'Using the Web-Services-Google-Client Perl module, it is now a simple matter to access all of the Google API Resources in a consistent manner.'
@@ -136,16 +145,13 @@ NB: To create or modify an authorization configuration file with scope and user
 The code in this repository uses [Dist::Zilla](http://dzil.org/) Build System to assist package building and creation of Tarball and CPAN distribution. Curiously the [Github Repo](https://github.com/rjbs/dist-zilla/) describes itself as '*scary tools for building CPAN distributions*'
 
 ````shell
-sudo dzil install
+    sudo dzil install
 ````
 
 ## Install from Tarball
 
 ````
-    ## Quickest
-    sudo cpanm https://dev.pscott.com.au/WebService-Google-Client-latest.tar.gz
-
-    ## Safest
+    
     wget https://dev.pscott.com.au/WebService-Google-Client-latest.tar.gz
     tar -zxvf WebService-Google-Client-latest.tar.gz
     rm WebService-Google-Client-latest.tar.gz
@@ -214,7 +220,7 @@ sudo dzil install
 
 # SEE ALSO
 
-- [Moo::Google](https://metacpan.org/pod/Moo::Google) - The original code base later forked into [WebService::Google](https://metacpan.org/pod/WebService::Google) but is heading in a different path
+- [Moo::Google](https://metacpan.org/pod/Moo::Google) - The original code base later forked into [WebService::Google](https://metacpan.org/pod/WebService::Google) but is heading in a different direction
 - [Google Swagger API https:](https:///github.com/APIs-guru/google-discovery-to-swagger) 
 
 # AUTHORS

dist.ini

@@ -20,6 +20,10 @@ main_module = lib/WebService/GoogleAPI/Client.pm
 ;[UploadToCPAN]
 
 [PkgVersion]
+[Prereqs]
+; Mojo::Message::Response = 7.12 ## can't do this - no version info available for Mojo::Message::Response
+Moose = 2.2
+Mojolicious::Plugin::OAuth2  = 1.5
 
 [AutoPrereqs]
 

docs/goauth-login-cap.gif

@@ -7,20 +7,49 @@ package WebService::GoogleAPI::Client;
 
 Access Google API Services Version 1 using an OAUTH2 User Agent
 
-
-
-    ## use goauth CLI helper to create the OATH credentials file ( see perldoc goauth )
-
     use WebService::GoogleAPI::Client;
     use Data::Dumper;
 
-    my $gapi = WebService::GoogleAPI::Client->new(debug => 0); # my $gapi = WebService::GoogleAPI::Client->new(access_token => '');
-    my $user = '[email protected]'; # full gmail or G-Suite email
-
-    $gapi->auth_storage->setup({type => 'jsonfile', path => './gapi.json' }); # by default
-
-    $gapi->user($user);       ## allows to select user configuration by google auth'd email address
-    $gapi->do_autorefresh(1); ## refresh auth token with refresh token if auth session has expired
+    ## assumes gapi.json configuration in working directory with scoped project and user authorization
+    
+    my $gapi_client = WebService::GoogleAPI::Client->new( debug => 1, gapi_json => './gapi.json', user=> '[email protected]' );
+
+    ## Completely manually constructed API End-Point Request to obtain Perl Data Structure converted from JSON response.
+    print Dumper $gapi_client->api_get(  userId => 'me'   )->json;
+
+    ## using dotted API Endpoint id to invoke helper validation and default value interpolations etc to send email to self
+    use Email::Simple;    ## RFC2822 formatted messages
+    use MIME::Base64;
+    my $my_email_address = '[email protected]'
+
+
+    my $raw_email_payload = encode_base64( Email::Simple->create( header => [To => $my_email_address, 
+                                                                             From => $my_email_address, 
+                                                                             Subject =>"Test email from '$my_email_address' ",], 
+                                                                             body => "This is the body of email to '$my_email_address'", 
+                                                                )->as_string 
+                                        );
+
+    $gapi_client->api_query( 
+                            api_endpoint_id => 'gmail.users.messages.send',
+                            options    => { raw => $raw_email_payload },
+                        );
+
+
+
+    my $text_to_speech_request_options =  {
+            'input' => {
+            'text' => 'Using the Web-Services-Google-Client Perl module, it is now a simple matter to access all of the Google API Resources in a consistent manner.'
+            },
+            'voice' => {
+            'languageCode' => 'en-gb',
+            'name' => 'en-GB-Standard-A',
+            'ssmlGender' => 'FEMALE'
+            },
+            'audioConfig' => {
+            'audioEncoding'=> 'MP3'
+            }
+        };
 
 
 =head2 OAUTH CREDENTIALS FILE TO ACCESS SERVCICES
@@ -30,7 +59,7 @@ TODO
 =cut
 
 use Data::Dumper;
-use Moose;
+use Moo;
 use WebService::GoogleAPI::Client::UserAgent;
 use WebService::GoogleAPI::Client::Discovery;
 use Carp;

lib/WebService/GoogleAPI/Client.pm

@@ -61,9 +61,7 @@ sub get_api_discovery_for_api_id
 {
   my ( $self, $params ) = @_;
   ## TODO: warn if user doesn't have the necessary scope .. no should stil be able to examine 
-  ## TODO: consolidate the http method calls to a single function - ie - discover_all - simplistic quick fix -  assume that if no param then endpoint is as per discover_all
-
-  
+  ## TODO: consolidate the http method calls to a single function - ie - discover_all - simplistic quick fix -  assume that if no param then endpoint is as per discover_all  
 
   $params = { api => $params } if ref( $params) eq ''; ## scalar parameter not hashref - so assume is intended to be $params->{api}
   ## trim any resource, method or version details in api id
@@ -178,13 +176,16 @@ sub discover_all
 
   if ( my $expires_at = $self->chi->get_expires_at(  'https://www.googleapis.com/discovery/v1/apis' ) && not $force ) 
   {
-    #carp "discovery_data cached data expires in ", scalar($expires_at) - time(), " seconds\n" if  ($self->debug > 2);
-    return $self->chi->get( 'https://www.googleapis.com/discovery/v1/apis' );
+    carp "discovery_data cached data expires in ", scalar($expires_at) - time(), " seconds\n" if  ($self->debug > 2);
+    my $ret =  $self->chi->get( 'https://www.googleapis.com/discovery/v1/apis' );
+    croak('CHI Discovery should be a hash - got something other') unless ref($ret) eq 'HASH';
+    return $ret;
   }
   else ## 
   {
     #return $self->chi->get('https://www.googleapis.com/discovery/v1/apis') if ($self->chi->get('https://www.googleapis.com/discovery/v1/apis'));
     my $ret = $self->ua->validated_api_query( 'https://www.googleapis.com/discovery/v1/apis' );
+    # if ( $ret->is_status_class(200) ) ## older versions of Mojo::Message::Response don't support is_success .. Require V > 7.12
     if ( $ret->is_success )
     {
       my $all = $ret->json;
@@ -293,7 +294,10 @@ client->discover_all which is delegated to Client::Discovery->discover_all
 sub available_APIs
 {
   my ( $self ) = @_;
-  my $all = $self->discover_all()->{ items };
+  my $d_all = $self->discover_all(); ##
+  warn('no items in discovery data') unless defined $d_all->{ items };
+  return []  unless defined $d_all->{ items };
+  my $all = $d_all->{ items };
 
   #print Dumper $all;
   for my $i ( @$all )

lib/WebService/GoogleAPI/Client/Discovery.pm

@@ -186,7 +186,7 @@ subtest 'Discovery methods with User Configuration'  => sub {
         note("Running tests with user '$user' using '$default_file' credentials");
 
         ok( $gapi->user($user) eq $user, "\$gapi->user('$user') eq '$user'");
-
+#$ENV{CHI_FILE_PATH} = $ENV{TMPDIR};
         plan( skip_all => 'Skipping network impacting tests unless ENV VAR CHI_FILE_PATH is set'  ) unless defined $ENV{CHI_FILE_PATH};
 
 

t/01-client-discovery.t

@@ -8,6 +8,7 @@ unless ( $ENV{RELEASE_TESTING} ) {
     plan( skip_all => "Author tests not required for installation" );
 }
 
+# TODO: Consider Pod::Coverage::Moose
 # Ensure a recent version of Test::Pod
 my $min_tp = 1.22;
 eval "use Test::Pod $min_tp";