refactor(result): standardize result

Author: mazinsw

.github/workflows/main.yml

@@ -0,0 +1,19 @@
+# This is a basic workflow to help you get started with Actions
+
+name: cordova-plugin-googleplus-standard
+on: push
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/v')
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '18.x'
+      - run: yarn
+      - run: yarn build
+      - uses: JS-DevTools/npm-publish@v1
+        with:
+          token: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -1,4 +1,5 @@
 .idea
 .DS_Store
 *.iml
-npm-debug.log
+npm-debug.log
+node_modules/

README.md

@@ -4,13 +4,9 @@
 [![Downloads][downloads-image]][npm-url]
 [![Twitter Follow][twitter-image]][twitter-url]
 
-[build-status]:https://travis-ci.org/EddyVerbruggen/cordova-plugin-googleplus.svg?branch=master
-[build-url]:https://travis-ci.org/EddyVerbruggen/cordova-plugin-googleplus
-[npm-image]:http://img.shields.io/npm/v/cordova-plugin-googleplus.svg
-[npm-url]:https://npmjs.org/package/cordova-plugin-googleplus
-[downloads-image]:http://img.shields.io/npm/dm/cordova-plugin-googleplus.svg
-[twitter-image]:https://img.shields.io/twitter/follow/eddyverbruggen.svg?style=social&label=Follow%20me
-[twitter-url]:https://twitter.com/eddyverbruggen
+[npm-image]:http://img.shields.io/npm/v/cordova-plugin-googleplus-standard.svg
+[npm-url]:https://npmjs.org/package/cordova-plugin-googleplus-standard
+[downloads-image]:http://img.shields.io/npm/dm/cordova-plugin-googleplus-standard.svg
 
 > ⚠️ From plugin version 6.0.0 the minimum required cordova-ios version is 4.5.0. Need to use a lower cordova-ios version? Use plugin version 5.3.2 or lower.
 
@@ -40,15 +36,15 @@ This plugin only wraps access to the Google Sign-In API. Further API access shou
 
 Android
 
-<img src="https://raw.githubusercontent.com/EddyVerbruggen/cordova-plugin-googleplus/master/screenshots/Android1.png" width="235" height="400"/>&nbsp;
-<img src="https://raw.githubusercontent.com/EddyVerbruggen/cordova-plugin-googleplus/master/screenshots/Android2.png" width="235" height="400"/>&nbsp;
-<img src="https://raw.githubusercontent.com/EddyVerbruggen/cordova-plugin-googleplus/master/screenshots/Android3.png" width="235" height="400"/>
+<img src="https://raw.githubusercontent.com/recifra/cordova-plugin-googleplus/master/screenshots/Android1.png" width="235" height="400"/>&nbsp;
+<img src="https://raw.githubusercontent.com/recifra/cordova-plugin-googleplus/master/screenshots/Android2.png" width="235" height="400"/>&nbsp;
+<img src="https://raw.githubusercontent.com/recifra/cordova-plugin-googleplus/master/screenshots/Android3.png" width="235" height="400"/>
 
  iOS
 
-<img src="https://raw.githubusercontent.com/EddyVerbruggen/cordova-plugin-googleplus/master/screenshots/iOS1.png" width="235" height="417"/>&nbsp;
-<img src="https://raw.githubusercontent.com/EddyVerbruggen/cordova-plugin-googleplus/master/screenshots/iOS2.png" width="235" height="417"/>&nbsp;
-<img src="https://raw.githubusercontent.com/EddyVerbruggen/cordova-plugin-googleplus/master/screenshots/iOS3.png" width="235" height="417"/>&nbsp;
+<img src="https://raw.githubusercontent.com/recifra/cordova-plugin-googleplus/master/screenshots/iOS1.png" width="235" height="417"/>&nbsp;
+<img src="https://raw.githubusercontent.com/recifra/cordova-plugin-googleplus/master/screenshots/iOS2.png" width="235" height="417"/>&nbsp;
+<img src="https://raw.githubusercontent.com/recifra/cordova-plugin-googleplus/master/screenshots/iOS3.png" width="235" height="417"/>&nbsp;
 
 ## 3. Google API setup
 To communicate with Google you need to do some tedious setup, sorry.
@@ -114,15 +110,15 @@ This plugin is compatible with:
 
 Here's how it works (backup your project first!):
 
-Using the Cordova CLI and [npm](https://www.npmjs.com/package/cordova-plugin-googleplus):
+Using the Cordova CLI and [npm](https://www.npmjs.com/package/cordova-plugin-googleplus-standard):
 ```
-$ cordova plugin add cordova-plugin-googleplus --save --variable REVERSED_CLIENT_ID=myreversedclientid --variable WEB_APPLICATION_CLIENT_ID=mywebapplicationclientid
+$ cordova plugin add cordova-plugin-googleplus-standard --save --variable REVERSED_CLIENT_ID=myreversedclientid --variable WEB_APPLICATION_CLIENT_ID=mywebapplicationclientid
 $ cordova prepare
 ```
 
-Using the Cordova CLI to fetch the latest version from GitHub:
+Using the Cordova CLI to fetch the latest version from GitHub (not recommended):
 ```
-$ cordova plugin add https://github.com/EddyVerbruggen/cordova-plugin-googleplus --save --variable REVERSED_CLIENT_ID=myreversedclientid  --variable WEB_APPLICATION_CLIENT_ID=mywebapplicationclientid
+$ cordova plugin add https://github.com/recifra/cordova-plugin-googleplus --save --variable REVERSED_CLIENT_ID=myreversedclientid  --variable WEB_APPLICATION_CLIENT_ID=mywebapplicationclientid
 $ cordova prepare
 ```
 
@@ -155,15 +151,15 @@ Add this to your config.xml:
 
 For the (stable) NPM Version:
 ```xml
-<plugin name="cordova-plugin-googleplus" source="npm">
+<plugin name="cordova-plugin-googleplus-standard" source="npm">
   <variable name="REVERSED_CLIENT_ID" value="myreversedclientid" />
   <variable name="WEB_APPLICATION_CLIENT_ID" value="mywebapplicationclientid" />
 </plugin>
 ```
 
 For the latest version from Git (not recommended):
 ```xml
-<plugin spec="https://github.com/EddyVerbruggen/cordova-plugin-googleplus.git" source="git">
+<plugin spec="https://github.com/recifra/cordova-plugin-googleplus.git" source="git">
   <variable name="REVERSED_CLIENT_ID" value="myreversedclientid" />
   <variable name="WEB_APPLICATION_CLIENT_ID" value="mywebapplicationclientid" />
 <plugin>
@@ -221,18 +217,18 @@ window.plugins.googleplus.login(
       'webClientId': 'client id of the web app/server side', // optional clientId of your Web application from Credentials settings of your project - On Android, this MUST be included to get an idToken. On iOS, it is not required.
       'offline': true // optional, but requires the webClientId - if set to true the plugin will also return a serverAuthCode, which can be used to grant offline access to a non-Google server
     },
-    function (obj) {
-      alert(JSON.stringify(obj)); // do something useful instead of alerting
+    function (json) {
+      alert(json); // do something useful instead of alerting
     },
-    function (msg) {
-      alert('error: ' + msg);
+    function (json) {
+      alert('error: ' + json);
     }
 );
 ```
 
-The success callback (second argument) gets a JSON object with the following contents, with example data of my Google account:
+The success callback (second argument) gets a JSON string with the following contents, with example data of my Google account:
 ```javascript
- obj.email          // 'eddyverbruggen@gmail.com'
+ obj.email          // 'recifra@gmail.com'
  obj.userId         // user id
  obj.displayName    // 'Eddy Verbruggen'
  obj.familyName     // 'Verbruggen'
@@ -245,16 +241,16 @@ The success callback (second argument) gets a JSON object with the following con
 
 Additional user information is available by use case. Add the scopes needed to the scopes option then return the info to the result object being created in the `handleSignInResult` and `didSignInForUser` functions on Android and iOS, respectively.
 
-On Android, the error callback (third argument) receives an error status code if authentication was not successful. A description of those status codes can be found on Google's android developer website at [GoogleSignInStatusCodes](https://developers.google.com/android/reference/com/google/android/gms/auth/api/signin/GoogleSignInStatusCodes).
+On Android, the error callback (third argument) receives an JSON string with error status and code into message if authentication was not successful. A description of those status codes can be found on Google's android developer website at [GoogleSignInStatusCodes](https://developers.google.com/android/reference/com/google/android/gms/auth/api/signin/GoogleSignInStatusCodes).
 
 On iOS, the error callback will include an [NSError localizedDescription](https://developer.apple.com/library/mac/documentation/Cocoa/Reference/Foundation/Classes/NSError_Class/).
 
 ### logout
 This will clear the OAuth2 token.
 ``` javascript
 window.plugins.googleplus.logout(
-    function (msg) {
-      alert(msg); // do something useful instead of alerting
+    function (json) {
+      alert(json); // do something useful instead of alerting
     }
 );
 ```
@@ -263,8 +259,8 @@ window.plugins.googleplus.logout(
 This will clear the OAuth2 token, forget which account was used to login, and disconnect that account from the app. This will require the user to allow the app access again next time they sign in. Be aware that this effect is not always instantaneous. It can take time to completely disconnect.
 ``` javascript
 window.plugins.googleplus.disconnect(
-    function (msg) {
-      alert(msg); // do something useful instead of alerting
+    function (json) {
+      alert(json); // do something useful instead of alerting
     }
 );
 ```

package.json

@@ -1,17 +1,17 @@
 {
-  "version": "8.5.2",
-  "name": "cordova-plugin-googleplus",
+  "version": "9.0.0",
+  "name": "cordova-plugin-googleplus-standard",
   "cordova_name": "Google SignIn",
   "description": "Use your Google account to authenticate with the app.",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/EddyVerbruggen/cordova-plugin-googleplus.git"
+    "url": "https://github.com/recifra/cordova-plugin-googleplus.git"
   },
   "bugs": {
-    "url": "https://github.com/EddyVerbruggen/cordova-plugin-googleplus/issues"
+    "url": "https://github.com/recifra/cordova-plugin-googleplus/issues"
   },
-  "homepage": "https://github.com/EddyVerbruggen/cordova-plugin-googleplus#readme",
+  "homepage": "https://github.com/recifra/cordova-plugin-googleplus#readme",
   "keywords": [
     "Google",
     "Google SignIn",
@@ -33,11 +33,5 @@
   ],
   "dependencies": {
     "q": "*"
-  },
-  "engines": [
-    {
-      "name": "cordova",
-      "version": ">=3.5.0"
-    }
-  ]
+  }
 }

src/android/GooglePlus.java

@@ -99,8 +99,8 @@ public boolean execute(String action, CordovaArgs args, CallbackContext callback
         this.savedCallbackContext = callbackContext;
 
         if (ACTION_IS_AVAILABLE.equals(action)) {
-            final boolean avail = true;
-            savedCallbackContext.success("" + avail);
+            final boolean available = true;
+            savedCallbackContext.success(toStatus("success", String.valueOf(available)));
 
         } else if (ACTION_LOGIN.equals(action)) {
             //pass args into api client build
@@ -231,7 +231,7 @@ private void trySilentLogin() {
      */
     private void signOut() {
         if (this.mGoogleApiClient == null) {
-            savedCallbackContext.error("Please use login or trySilentLogin before logging out");
+            savedCallbackContext.error(toStatus("error", "Please use login or trySilentLogin before logging out"));
             return;
         }
 
@@ -244,9 +244,9 @@ private void signOut() {
                         public void onResult(Status status) {
                             //on success, tell cordova
                             if (status.isSuccess()) {
-                                savedCallbackContext.success("Logged user out");
+                                savedCallbackContext.success(toStatus("success", "Logged user out"));
                             } else {
-                                savedCallbackContext.error(status.getStatusCode());
+                                savedCallbackContext.error(toStatus("error", String.valueOf(status.getStatusCode())));
                             }
                         }
                     }
@@ -259,7 +259,7 @@ public void onResult(Status status) {
      */
     private void disconnect() {
         if (this.mGoogleApiClient == null) {
-            savedCallbackContext.error("Please use login or trySilentLogin before disconnecting");
+            savedCallbackContext.error(toStatus("error", "Please use login or trySilentLogin before disconnecting"));
             return;
         }
 
@@ -271,9 +271,9 @@ private void disconnect() {
                         @Override
                         public void onResult(Status status) {
                             if (status.isSuccess()) {
-                                savedCallbackContext.success("Disconnected user");
+                                savedCallbackContext.success(toStatus("success", "Disconnected user"));
                             } else {
-                                savedCallbackContext.error(status.getStatusCode());
+                                savedCallbackContext.error(toStatus("error", String.valueOf(status.getStatusCode())));
                             }
                         }
                     }
@@ -289,7 +289,7 @@ public void onResult(Status status) {
     @Override
     public void onConnectionFailed(ConnectionResult result) {
         Log.i(TAG, "Unresolvable failure in connecting to Google APIs");
-        savedCallbackContext.error(result.getErrorCode());
+        savedCallbackContext.error(toStatus("error", String.valueOf(result.getErrorCode())));
     }
 
 
@@ -312,12 +312,12 @@ public void onConnectionFailed(ConnectionResult result) {
      */
     private void handleSignInResult(final GoogleSignInResult signInResult) {
         if (this.mGoogleApiClient == null) {
-            savedCallbackContext.error("GoogleApiClient was never initialized");
+            savedCallbackContext.error(toStatus("error", "GoogleApiClient was never initialized"));
             return;
         }
 
         if (signInResult == null) {
-          savedCallbackContext.error("SignInResult is null");
+          savedCallbackContext.error(toStatus("error", "SignInResult is null"));
           return;
         }
 
@@ -327,7 +327,7 @@ private void handleSignInResult(final GoogleSignInResult signInResult) {
             Log.i(TAG, "Wasn't signed in");
 
             //Return the status code to be handled client side
-            savedCallbackContext.error(signInResult.getStatus().getStatusCode());
+            savedCallbackContext.error(toStatus("error", String.valueOf(signInResult.getStatus().getStatusCode())));
         } else {
             new AsyncTask<Void, Void, Void>() {
                 @Override
@@ -349,9 +349,9 @@ protected Void doInBackground(Void... params) {
                         result.put("familyName", acct.getFamilyName());
                         result.put("givenName", acct.getGivenName());
                         result.put("imageUrl", acct.getPhotoUrl());
-                        savedCallbackContext.success(result);
+                        savedCallbackContext.success(result.toString());
                     } catch (Exception e) {
-                        savedCallbackContext.error("Trouble obtaining result, error: " + e.getMessage());
+                        savedCallbackContext.error(toStatus("error", "Trouble obtaining result, error: " + e.getMessage()));
                     }
                     return null;
                 }
@@ -383,11 +383,11 @@ private void getSigningCertificateFingerprint() {
             // strip the last ':'
             strResult = strResult.substring(0, strResult.length()-1);
             strResult = strResult.toUpperCase();
-            this.savedCallbackContext.success(strResult);
+            this.savedCallbackContext.success(toStatus("success", strResult));
 
         } catch (Exception e) {
             e.printStackTrace();
-            savedCallbackContext.error(e.getMessage());
+            savedCallbackContext.error(toStatus("error", e.getMessage()));
         }
     }
 
@@ -448,4 +448,11 @@ public static String fromStream(InputStream is) throws IOException {
         reader.close();
         return sb.toString();
     }
+
+    public static String toStatus(String status, String message) {
+        JSONObject jsonResponse = new JSONObject();
+        jsonResponse.put("status", status);
+        jsonResponse.put("message", message);
+        return jsonResponse.toString();
+    }
 }

yarn.lock

@@ -0,0 +1,8 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+q@*:
+  version "1.5.1"
+  resolved "https://registry.yarnpkg.com/q/-/q-1.5.1.tgz#7e32f75b41381291d04611f1bf14109ac00651d7"
+  integrity sha512-kV/CThkXo6xyFEZUugw/+pIOywXcDbFYgSct5cT3gqlbkBE1SJdwy6UQoZvodiWF/ckQLZyDE/Bu1M6gVu5lVw==