Improved SendConsentForm logic

app/src/main/java/uprrp/tania/SendConsentForm.java

@@ -1,85 +0,0 @@
-/*************************************************************
- * By: Coralys Cubero Rivera
- * Date: 2019
- *************************************************************/
-
-package uprrp.tania;
-
-import android.os.AsyncTask;
-import android.util.Log;
-
-import java.io.BufferedReader;
-import java.io.BufferedWriter;
-import java.io.InputStream;
-import java.io.InputStreamReader;
-import java.io.OutputStreamWriter;
-import java.io.UnsupportedEncodingException;
-import java.io.Writer;
-import java.net.URL;
-import java.net.URLConnection;
-import java.net.URLEncoder;
-import java.nio.charset.StandardCharsets;
-
-public class SendConsentForm extends AsyncTask <String, String, String> {
-    @Override
-    protected String doInBackground(String... strings) {
-        String jsonConsentSignature  = "";
-
-        try {
-            jsonConsentSignature = URLEncoder.encode("data", "UTF-8") + "=" + URLEncoder.encode(strings[0], "UTF-8");
-        }
-
-        catch (UnsupportedEncodingException e) {
-            e.printStackTrace();
-        }
-
-        String serverReply = "";
-        BufferedReader serverReader;
-
-        //Send the signature to MARLE's server
-        try
-        {
-            //Defined URL  where to send data
-            URL url = new URL("https://tania.uprrp.edu/getSignatureIOS.php");
-
-            //Send POST data request
-            URLConnection conn = url.openConnection();
-            conn.setDoOutput(true);
-
-            Writer writer = new BufferedWriter(new OutputStreamWriter(conn.getOutputStream(), StandardCharsets.UTF_8));
-            writer.write(jsonConsentSignature);
-            writer.close();
-
-            InputStream inputStream = conn.getInputStream();
-            if (inputStream == null) {
-                return null;
-            }
-
-            //Get the server response
-            serverReader = new BufferedReader(new InputStreamReader(inputStream));
-            StringBuilder serverResponse = new StringBuilder();
-            String serverResponseLine;
-
-            // Read Server Response
-            while((serverResponseLine = serverReader.readLine()) != null)
-            {
-                //Append server response in string
-                serverResponse.append(serverResponseLine);
-            }
-
-            serverReply = serverResponse.toString();
-        }
-        catch(Exception ex) {
-            Log.e("ERROR CONSENT SIGNATURE", ex.getMessage());
-        }
-
-        return serverReply;
-    }
-
-    @Override
-    protected void onPostExecute(String s) {
-        Log.d("CONSENT SERVER REPLY", s);
-
-    }
-
-}

app/src/main/java/uprrp/tania/activities/GettingStartedActivity.java

@@ -26,8 +26,6 @@ import com.itextpdf.text.Image;
 import com.itextpdf.text.Paragraph;
 import com.itextpdf.text.pdf.PdfWriter;
 
-import org.json.JSONException;
-import org.json.JSONObject;
 import org.researchstack.backbone.StorageAccess;
 import org.researchstack.backbone.model.ConsentDocument;
 import org.researchstack.backbone.model.ConsentSection;
@@ -50,7 +48,8 @@ import java.io.IOException;
 
 import uprrp.tania.GlobalValues;
 import uprrp.tania.R;
-import uprrp.tania.SendConsentForm;
+import uprrp.tania.networking.SendConsentForm;
+import uprrp.tania.utils.URLEventListener;
 
 public class GettingStartedActivity extends AppCompatActivity {
 
@@ -123,62 +122,64 @@ public class GettingStartedActivity extends AppCompatActivity {
     }
 
 
-    // TODO: decide which parts in this function to move to a background task
-    // TODO: define a model for the JSON and use Gson to encode it
     private void processConsentResult(TaskResult result) {
 
         boolean consented = (boolean) result.getStepResult(CONSENT_DOC).getResult();
         StorageAccess.getInstance().getAppDatabase().saveTaskResult(result);
 
         if(consented) {
-            try {
-
-                // Get signature in base64
-                TaskResult taskResult = StorageAccess.getInstance()
-                        .getAppDatabase()
-                        .loadLatestTaskResult(CONSENT);
-                String signatureBase64 = (String) taskResult.getStepResult(SIGNATURE)
-                        .getResultForIdentifier(ConsentSignatureStepLayout.KEY_SIGNATURE);
-
-                // Get signature date
-                String signatureDate = (String) result.getStepResult(SIGNATURE)
-                        .getResultForIdentifier(ConsentSignatureStepLayout.KEY_SIGNATURE_DATE);
-
-                // Use signature to get encoded consent form
-                byte[] signatureBytes = Base64.decode(signatureBase64, Base64.DEFAULT);
-                String consentFormBase64 = createPdf(signatureBytes, signatureDate);
-
-                // Send JSON with consent form, signature date, and token
-                JSONObject signatureJSON = new JSONObject();
-                signatureJSON.put("signaturePDFBase64", consentFormBase64);
-                signatureJSON.put("signatureDate", signatureDate);
-                signatureJSON.put("token", GlobalValues.getInstance().getDeviceToken()); // FirebaseInstanceId.getInstance().getToken()
-                Log.d("CONSENT JSON", signatureJSON.toString()); // log
-                SendConsentForm sendConsentForm = new SendConsentForm();
-                sendConsentForm.execute(signatureJSON.toString());
-
-                // Save consent signature and date separately on preferences
-                SharedPreferences prefs = getSharedPreferences("prefs", MODE_PRIVATE);
-                SharedPreferences.Editor editor = prefs.edit();
-                editor.putString("consentSignature", signatureBase64);
-                editor.putString("consentDate", signatureDate);
-                editor.apply();
-
-                // Prompt user to register as student
-                Intent registration = new Intent(this, RegisterActivity.class);
-                startActivity(registration);
-
-            } catch (JSONException e) {
-                Log.e(TAG, "Couldn't prepare consent form JSON!");
-                e.printStackTrace();
-            } catch (Exception e) {
-                Log.e(TAG, "Error on processConsentResult(): " + e.getMessage());
-                e.printStackTrace();
-            }
+
+            // Get signature in base64
+            TaskResult taskResult = StorageAccess.getInstance()
+                    .getAppDatabase()
+                    .loadLatestTaskResult(CONSENT);
+            String signatureBase64 = (String) taskResult.getStepResult(SIGNATURE)
+                    .getResultForIdentifier(ConsentSignatureStepLayout.KEY_SIGNATURE);
+
+            // Get signature date
+            String signatureDate = (String) result.getStepResult(SIGNATURE)
+                    .getResultForIdentifier(ConsentSignatureStepLayout.KEY_SIGNATURE_DATE);
+
+            // Use signature to get encoded consent form
+            byte[] signatureBytes = Base64.decode(signatureBase64, Base64.DEFAULT);
+            String consentFormBase64 = createPdf(signatureBytes, signatureDate);
+
+            // Send JSON with consent form, signature date, and token
+            String deviceToken = GlobalValues.getInstance().getDeviceToken();
+            this.sendConsentForm(deviceToken, consentFormBase64, signatureDate);
+
+            // Save consent signature and date separately on preferences
+            SharedPreferences prefs = getSharedPreferences("prefs", MODE_PRIVATE);
+            SharedPreferences.Editor editor = prefs.edit();
+            editor.putString("consentSignature", signatureBase64);
+            editor.putString("consentDate", signatureDate);
+            editor.apply();
+
+            // Prompt user to register as student
+            Intent registration = new Intent(this, RegisterActivity.class);
+            startActivity(registration);
+
         }
 
     }
 
+    private void sendConsentForm(String deviceToken, String consentFormBase64, String signatureDate) {
+        SendConsentForm sendConsentFormTask = new SendConsentForm(new URLEventListener() {
+            @Override
+            public void onSuccess() {
+                Toast.makeText(getApplicationContext(), "Sent consent form to server!", Toast.LENGTH_LONG).show();
+            }
+
+            @Override
+            public void onFailure(Exception e) {
+                Toast.makeText(getApplicationContext(), "Couldn't send consent form to server!", Toast.LENGTH_LONG).show();
+                Log.e(TAG, "Couldn't send consent form to server!");
+                e.printStackTrace();
+            }
+        });
+
+        sendConsentFormTask.execute(deviceToken, consentFormBase64, signatureDate);
+    }
 
     private void launchConsent() {
 

app/src/main/java/uprrp/tania/networking/SendAccountRecovery.java

@@ -16,7 +16,7 @@ import java.net.URLEncoder;
 
 import uprrp.tania.utils.URLEventListener;
 
-public class SendAccountRecovery extends AsyncTask<String, String, String> {
+public class SendAccountRecovery extends AsyncTask<String, Void, String> {
 
     private static final String TAG = "SendAccountRecovery";
     private static final String loginBaseURL = "https://tania.uprrp.edu/recoverAccount.php";

app/src/main/java/uprrp/tania/networking/SendConsentForm.java

@@ -0,0 +1,154 @@
+package uprrp.tania.networking;
+
+import android.os.AsyncTask;
+import android.util.Log;
+
+import org.json.JSONException;
+import org.json.JSONObject;
+
+import java.io.BufferedReader;
+import java.io.BufferedWriter;
+import java.io.InputStreamReader;
+import java.io.OutputStreamWriter;
+import java.io.UnsupportedEncodingException;
+import java.io.Writer;
+import java.net.URL;
+import java.net.URLConnection;
+import java.net.URLEncoder;
+import java.nio.charset.StandardCharsets;
+
+import uprrp.tania.utils.URLEventListener;
+
+public class SendConsentForm extends AsyncTask <String, Void, String> {
+
+    private static final String TAG = "SendConsentForm";
+    private static final String consentFormBaseURL = "https://tania.uprrp.edu/getSignatureIOS.php";
+    private final URLEventListener myCallback;
+
+    public SendConsentForm(URLEventListener callback) {
+        this.myCallback = callback;
+    }
+
+    private boolean validInputs(String... strings) {
+
+        if(strings.length != 3) {
+            Log.e(TAG, "Invalid string array length!");
+            return false;
+        }
+
+        String deviceToken = strings[0];
+        String consentFormBase64 = strings[1];
+        String signatureDate = strings[2];
+
+        if(consentFormBase64 == null) {
+            Log.e(TAG, "Encountered null consent form!");
+            return false;
+        } else if (deviceToken == null) {
+            Log.e(TAG, "Encountered null device token!");
+            return false;
+        } else if (signatureDate == null) {
+            Log.e(TAG, "Encountered null signature date!");
+            return false;
+        }
+
+        return true;
+
+    }
+
+    // TODO: instead of making a normal POST request with
+    //  the body data=<JSON>, we should just send the JSON itself
+    //  This is adding unnecessary layers of complexity when decoding AND encoding
+    /*
+        JSON format:
+        {
+            "signatureDate": String,
+            "signaturePDFBase64": String,
+            "token": String,
+        }
+    */
+    @Override
+    protected String doInBackground(String... strings) {
+
+        // Validation
+        if(!validInputs(strings)) {
+            Log.e(TAG, "Invalid inputs given!");
+            return null;
+        }
+
+        // Extract variables
+        String deviceToken = strings[0];
+        String consentFormBase64 = strings[1];
+        String signatureDate = strings[2];
+
+        try {
+
+            // Create JSON
+            JSONObject consentFormJSON = new JSONObject();
+            consentFormJSON.put("token", deviceToken);
+            consentFormJSON.put("signaturePDFBase64", consentFormBase64);
+            consentFormJSON.put("signatureDate", signatureDate);
+            Log.d(TAG, "ConsentFormJSON is " + consentFormJSON.toString()); // log
+
+            // Encode data
+            String jsonConsentSignature = URLEncoder.encode("data", "UTF-8") + "=" + URLEncoder.encode(strings[0], "UTF-8");
+
+            // Send POST data request
+            URL url = new URL(consentFormBaseURL);
+            URLConnection conn = url.openConnection();
+            conn.setDoOutput(true);
+            Writer writer = new BufferedWriter(new OutputStreamWriter(conn.getOutputStream(), StandardCharsets.UTF_8));
+            writer.write(jsonConsentSignature);
+            writer.close();
+
+            // Get the server response
+            BufferedReader serverReader = new BufferedReader(new InputStreamReader(conn.getInputStream()));
+            StringBuilder serverResponse = new StringBuilder();
+
+            String line = "";
+            while(line != null) {
+                serverResponse.append(line);
+                line = serverReader.readLine();
+            }
+
+            String response = serverResponse.toString();
+            Log.d(TAG, "The server's response is " + response);
+            if(response.toLowerCase().contains("error")) {
+                return null;
+            } else {
+                return response;
+            }
+
+        } catch (JSONException e) {
+            Log.e(TAG, "Couldn't prepare consentFormJSON!");
+            e.printStackTrace();
+            return null;
+        } catch (UnsupportedEncodingException e) {
+            Log.e(TAG, "Couldn't encode consentFormJSON");
+            e.printStackTrace();
+            return null;
+        } catch(Exception e) {
+            Log.e(TAG, "Couldn't communicate with server while recovering account!");
+            e.printStackTrace();
+            return null;
+        }
+
+    }
+
+    @Override
+    protected void onPostExecute(String response) {
+
+        if(this.myCallback == null) {
+            Log.e(TAG, "Callback wasn't initialized first!");
+            return;
+        }
+
+        if(response == null) {
+            this.myCallback.onFailure(new Exception("Error occurred during transaction!"));
+            return;
+        }
+
+        this.myCallback.onSuccess();
+
+    }
+
+}

app/src/main/java/uprrp/tania/networking/SendExperienceRegistration.java

@@ -17,7 +17,7 @@ import javax.net.ssl.HttpsURLConnection;
 
 import uprrp.tania.utils.URLEventListener;
 
-public class SendExperienceRegistration extends AsyncTask<String, String, String> {
+public class SendExperienceRegistration extends AsyncTask<String, Void, String> {
 
     private static final String TAG = "SendActivateExperience";
     private static final String activateExperienceURL = "https://tania.uprrp.edu/inscripcionExperiencia.php";

app/src/main/java/uprrp/tania/networking/SendWithdrawal.java

@@ -20,7 +20,7 @@ import javax.net.ssl.HttpsURLConnection;
 
 import uprrp.tania.utils.URLEventListener;
 
-public class SendWithdrawal extends AsyncTask<String, String, String> {
+public class SendWithdrawal extends AsyncTask<String, Void, String> {
 
     private static final String TAG = "SendWithdrawal";
     private static final String withdrawalURL = "https://tania.uprrp.edu/withdrawal.php";