Changed the way the SDK works so it doesn't break continuity in

jrb2137 · jrb2137 · commit 218b8fde6b64 · 2012-02-22T12:37:55.000-05:00
third-party apps
diff --git a/README.md b/README.md
@@ -3,59 +3,72 @@ Use this SDK to easily add Venmo payments to your Android app!  Just follow thes
 1) First you need to register your app with Venmo here: https://venmo.com/account/app/new (for a description on what these fields are,
 go here: https://venmo.com/api#registering-an-application). After your app has been approved, you will need to get your app credentials here: https://venmo.com/account/settings/developers.  
 
-2) Download the two files listed in this repository, and include them in your directory: VenmoSDK.java and VenmoResponse.java. You'll need to add your package name at the top of each file (e.g. "package com.name;") 
+2) Download the two following two files and include them in your directory: VenmoSDK.java and VenmoWebViewActivity. You'll need to edit your manifest to add VenmoWebViewActivity as an activity, and you'll need to add your package name at the top of each file (e.g. "package com.name;").
 
-3) You'll also need to download json_simple-1.1.jar from here: http://code.google.com/p/json-simple/.  Add this to your libs directory (create this folder if it doesn't already exist). 
+3) Download venmo_webview.xml and add it to your res/layout directory.  
 
-4) You need to add that json jar to your class path.  To do so, in Eclipse go to Project -> Properties, and then click "Java Build Path" on the left.  Click the Libraries tab at the top.  Click "Add Jar" and then find the .jar file you just put in your libs directory.  Select it and click "OK".  See screenshot.png for a screenshot of this. 
+4) You'll also need to download json_simple-1.1.jar from here: http://code.google.com/p/json-simple/.  Add this to your libs directory (create this folder if it doesn't already exist). You'll need to add that json jar to your class path.  To do so, in Eclipse go to Project -> Properties, and then click "Java Build Path" on the left.  Click the Libraries tab at the top.  Click "Add Jar" and then find the .jar file you just put in your libs directory.  Select it and click "OK".  See screenshot.png for a screenshot of this. 
 
-5) Now, you're ready to use the SDK!  From your app, include the following code when you want the Venmo app to open:
+5) Now, you're ready to use the SDK!  From the activity in your app where you want to open the Venmo app, include the following code:
 
-    Intent sendIntent = VenmoSDK.openVenmoPayment(app_id, local_app_id, app_name, recipient, amount, note, txn);
-    try{
-        myListActivity.startActivity(sendIntent);
+
+
+    try {
+        Intent venmoIntent = VenmoSDK.openVenmoPayment(app_id, app_name, recipient, amount, note, txn);
+        myListActivity.startActivityForResult(venmoIntent, 1); //1 is the requestCode we are using for Venmo. Feel free to change this to another number. 
     }
-    catch (ActivityNotFoundException e) // Exception thrown when Venmo native app not install on device, so fallback to web version
+    catch (ActivityNotFoundException e) //Venmo native app not install on device, so let's instead open a mobile web version of Venmo in a webview
     {
-    	sendIntent = VenmoSDK.openVenmoPaymentInBrowser(app_id, local_app_id, app_name, recipient, amount, note, txn);
-    	myListActivity.startActivity(sendIntent);
+        Intent venmoIntent = new Intent(MainActivity.this, VenmoWebViewActivity.class);
+        String venmo_uri = VenmoSDK.openVenmoPaymentInWebView(app_id, app_name, recipients, amount, note, txn);
+        venmoIntent.putExtra("url", venmo_uri);
+        startActivityForResult(venmoIntent, 1);
     }
 
 where all of these parameters are Strings:
 
 * app_id is the app_id you have registered with venmo.com 
-* app_local_id is something you make up. An example is "abcd".  
 * app_name is the name of your app 
 * recipient is the venmo username, phone number, or email address of the person who is being paid or charged 
 * amount is the amount to be paid or charged 
 * note is the note that will be sent with the payment/charge.  For example, the note might be "for a drink on me!" 
 * txn is either "pay" or "charge"
 
+This will open the Venmo app's pay/charge screen if the user has the Venmo app installed on the phone.  If they don't have it installed, it will instead send them to the activity you added - VenmoWebViewActivity - which displays a mobile web version of Venmo in a webview.  This will allow the user to enter his credit card information and complete the transaction. 
+
+6) If you look at the previous step, you'll see that the Venmo activity that allows the transaction to be completed is opened using the "startActivityForResult" method, which means that once the activity is finished, control will be yielded back to your activity.  To handle the response (i.e. to know whether the payment was completed successfully), implement Android's onActivityResult method in the same activity where you wrote the code in step 5.  This will look like the following: 
+
+@Override
+protected void onActivityResult(int requestCode, int resultCode, Intent data)
+{
+    switch(requestCode) {
+        case 1: { //1 is the requestCode we picked for Venmo earlier when we called startActivityForResult
+            if(resultCode == RESULT_OK) {
+                String signedrequest = data.getStringExtra("signedrequest");
+                if(signedrequest != null) {
+                    VenmoResponse response = (new VenmoSDK()).validateVenmoPaymentResponse(signedrequest, app_secret);
+                    if(response.getSuccess().equals("1")) {
+                        //Payment successful.  Use data from response object to display a success message
+                        String note = response.getNote();
+                        String amount = response.getAmount();
+                    }
+                }
+                else {
+                    String error_message = data.getStringExtra("error_message");
+                    //An error ocurred.  Make sure to display the error_message to the user
+                }                               
+            }
+            else if(resultCode == RESULT_CANCELED) {
+                //The user cancelled the payment
+            }
+            break;
+        }       
+    }
+}
 
-Then, you need to provide a way for the Venmo app to be able to get back to your app after the request goes through.  Here's how: 
-
-6) Add this to your manifest file, inside of your <application> </application> tags: 
-
-	<activity android:name=".URLActivity">
-		<intent-filter>
-	      <action android:name="android.intent.action.VIEW" />
-	      <category android:name="android.intent.category.DEFAULT" />
-	      <category android:name="android.intent.category.BROWSABLE" />
-	       <data android:scheme="venmo9999abcd" /> 
-	    </intent-filter> 
-	</activity>
-
-where 9999 is your app_id and abcd is the app_local_id you created above.
-
-7) Create a file named URLActivity.java, which should extend Activity.  This is the activity that is called when control is given back to your app, after a payment has gone through and the user pressed "back to your app".  Inside of the onCreate method, include the following:
-
-	Uri data = getIntent().getData();
-	String signed_request = data.getQueryParameter("signed_request");	
-	VenmoResponse response = VenmoSDK.validateVenmoPaymentResponse(signed_request, app_secret);
-
-where app_secret is the secret key you were given when you registered your app with Venmo.  
+Note that we're using 1 as the requestCode for Venmo.
 
-If you want to display the results of the transaction, then the response variable contains public methods you can use to access these variables:
+Make sure you display the results of the transaction after it is completed.  The response variable above contains public methods you can use to access these variables:
 
 * response.getSuccess()
 * response.getNote()
diff --git a/VenmoSDK.java b/VenmoSDK.java
@@ -80,7 +80,9 @@ public static Intent openVenmoPayment(String myAppId, String myAppLocalId, Strin
     		Log.e("venmodemo", "cannot encode app local id");
     	}
     	
-    	
+    
+        venmo_uri += "&using_new_sdk=true";
+
     	Log.d("VenmoSDK", "URI: " + venmo_uri);
     	
     	venmo_uri = venmo_uri.replaceAll("\\+", "%20"); // use %20 encoding instead of +

Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,9 @@ public static Intent openVenmoPayment(String myAppId, String myAppLocalId, Strin`
`80`	`80`	`Log.e("venmodemo", "cannot encode app local id");`
`81`	`81`	`}`
`82`	`82`
`83`		`-`
	`83`	`+`
	`84`	`+ venmo_uri += "&using_new_sdk=true";`
	`85`	`+`
`84`	`86`	`Log.d("VenmoSDK", "URI: " + venmo_uri);`
`85`	`87`
`86`	`88`	`venmo_uri = venmo_uri.replaceAll("\\+", "%20"); // use %20 encoding instead of +`