Differentiate between purchases and transactions. Closes robotmedia#11

Author: Robot Media

AndroidBillingLibrary/src/net/robotmedia/billing/BillingController.java

@@ -28,8 +28,8 @@
 import org.json.JSONException;
 import org.json.JSONObject;
 
-import net.robotmedia.billing.model.Purchase;
-import net.robotmedia.billing.model.PurchaseManager;
+import net.robotmedia.billing.model.Transaction;
+import net.robotmedia.billing.model.TransactionManager;
 import net.robotmedia.billing.request.BillingRequest;
 import net.robotmedia.billing.request.ResponseCode;
 import net.robotmedia.billing.utils.Compatibility;
@@ -160,7 +160,7 @@ private static void confirmNotifications(Context context, String[] notifyIds) {
 	public static int countPurchases(Context context, String itemId) {
 		final byte[] salt = getSalt();
 		itemId = salt != null ? Security.obfuscate(context, salt, itemId) : itemId;
-		return PurchaseManager.countPurchases(context, itemId);
+		return TransactionManager.countPurchases(context, itemId);
 	}
 
 	/**
@@ -181,20 +181,20 @@ private static void getPurchaseInformation(Context context, String notifyId) {
 	}
 
 	/**
-	 * Lists all purchases stored locally, including cancellations and refunds.
+	 * Lists all transactions stored locally, including cancellations and refunds.
 	 * 
 	 * @param context
-	 * @return list of purchases.
+	 * @return list of transactions.
 	 */
-	public static List<Purchase> getPurchases(Context context) {
-		List<Purchase> purchases = PurchaseManager.getPurchases(context);
+	public static List<Transaction> getTransactions(Context context) {
+		List<Transaction> transactions = TransactionManager.getTransactions(context);
 		final byte[] salt = getSalt();
 		if (salt != null) {
-			for (Purchase p : purchases) {
+			for (Transaction p : transactions) {
 				unobfuscate(context, p);
 			}
 		}
-		return purchases;
+		return transactions;
 	}
 
 	/**
@@ -224,7 +224,7 @@ private static byte[] getSalt() {
 	public static boolean isPurchased(Context context, String itemId) {
 		final byte[] salt = getSalt();
 		itemId = salt != null ? Security.obfuscate(context, salt, itemId) : itemId;
-		return PurchaseManager.isPurchased(context, itemId);
+		return TransactionManager.isPurchased(context, itemId);
 	}
 
 	/**
@@ -235,7 +235,7 @@ public static boolean isPurchased(Context context, String itemId) {
 	 * @param state
 	 *            new purchase state of the item.
 	 */
-	private static void notifyPurchaseStateChange(String itemId, Purchase.PurchaseState state) {
+	private static void notifyPurchaseStateChange(String itemId, Transaction.PurchaseState state) {
 		for (IBillingObserver o : observers) {
 			switch (state) {
 			case CANCELLED:
@@ -258,9 +258,9 @@ private static void notifyPurchaseStateChange(String itemId, Purchase.PurchaseSt
 	 * @param context
 	 * @param purchase
 	 *            purchase to be obfuscated.
-	 * @see #unobfuscate(Context, Purchase)
+	 * @see #unobfuscate(Context, Transaction)
 	 */
-	private static void obfuscate(Context context, Purchase purchase) {
+	private static void obfuscate(Context context, Transaction purchase) {
 		final byte[] salt = getSalt();
 		if (salt == null) {
 			return;
@@ -345,7 +345,7 @@ protected static void onPurchaseStateChanged(Context context, String signedData,
 			}
 		}
 
-		List<Purchase> purchases;
+		List<Transaction> purchases;
 		try {
 			JSONObject jObject = new JSONObject(signedData);
 			if (!verifyNonce(jObject)) {
@@ -359,7 +359,7 @@ protected static void onPurchaseStateChanged(Context context, String signedData,
 		}
 
 		ArrayList<String> confirmations = new ArrayList<String>();
-		for (Purchase p : purchases) {
+		for (Transaction p : purchases) {
 			if (p.notificationId != null && automaticConfirmations.contains(p.productId)) {
 				confirmations.add(p.notificationId);
 			} else {
@@ -370,9 +370,9 @@ protected static void onPurchaseStateChanged(Context context, String signedData,
 
 			// Save itemId and purchaseState before obfuscation for later use
 			final String itemId = p.productId;
-			final Purchase.PurchaseState purchaseState = p.purchaseState;
+			final Transaction.PurchaseState purchaseState = p.purchaseState;
 			obfuscate(context, p);
-			PurchaseManager.addPurchase(context, p);
+			TransactionManager.addTransaction(context, p);
 
 			notifyPurchaseStateChange(itemId, purchaseState);
 		}
@@ -427,16 +427,16 @@ protected static void onResponseCode(Context context, long requestId, int respon
 	 * @throws JSONException
 	 *             if the data couldn't be properly parsed.
 	 */
-	private static List<Purchase> parsePurchases(JSONObject data) throws JSONException {
-		ArrayList<Purchase> purchases = new ArrayList<Purchase>();
+	private static List<Transaction> parsePurchases(JSONObject data) throws JSONException {
+		ArrayList<Transaction> purchases = new ArrayList<Transaction>();
 		JSONArray orders = data.optJSONArray(JSON_ORDERS);
 		int numTransactions = 0;
 		if (orders != null) {
 			numTransactions = orders.length();
 		}
 		for (int i = 0; i < numTransactions; i++) {
 			JSONObject jElement = orders.getJSONObject(i);
-			Purchase p = Purchase.parse(jElement);
+			Transaction p = Transaction.parse(jElement);
 			purchases.add(p);
 		}
 		return purchases;
@@ -548,9 +548,9 @@ public static void startPurchaseIntent(Activity activity, PendingIntent purchase
 	 * @param context
 	 * @param purchase
 	 *            purchase to unobfuscate.
-	 * @see #obfuscate(Context, Purchase)
+	 * @see #obfuscate(Context, Transaction)
 	 */
-	private static void unobfuscate(Context context, Purchase purchase) {
+	private static void unobfuscate(Context context, Transaction purchase) {
 		final byte[] salt = getSalt();
 		if (salt == null) {
 			return;

AndroidBillingLibrary/src/net/robotmedia/billing/model/BillingDB.java

@@ -18,7 +18,7 @@
 
 package net.robotmedia.billing.model;
 
-import net.robotmedia.billing.model.Purchase.PurchaseState;
+import net.robotmedia.billing.model.Transaction.PurchaseState;
 import android.content.ContentValues;
 import android.content.Context;
 import android.database.Cursor;
@@ -28,15 +28,15 @@
 public class BillingDB {
     static final String DATABASE_NAME = "billing.db";
     static final int DATABASE_VERSION = 1;
-    static final String TABLE_PURCHASES = "purchases";
+    static final String TABLE_TRANSACTIONS = "purchases";
 
     public static final String COLUMN__ID = "_id";
     public static final String COLUMN_STATE = "state";
     public static final String COLUMN_PRODUCT_ID = "productId";
     public static final String COLUMN_PURCHASE_TIME = "purchaseTime";
     public static final String COLUMN_DEVELOPER_PAYLOAD = "developerPayload";
 
-    private static final String[] TABLE_PURCHASES_COLUMNS = {
+    private static final String[] TABLE_TRANSACTIONS_COLUMNS = {
     	COLUMN__ID, COLUMN_PRODUCT_ID, COLUMN_STATE,
     	COLUMN_PURCHASE_TIME, COLUMN_DEVELOPER_PAYLOAD
     };
@@ -53,28 +53,28 @@ public void close() {
         mDatabaseHelper.close();
     }
 
-    public void insert(Purchase purchase) {
+    public void insert(Transaction transaction) {
         ContentValues values = new ContentValues();
-        values.put(COLUMN__ID, purchase.orderId);
-        values.put(COLUMN_PRODUCT_ID, purchase.productId);
-        values.put(COLUMN_STATE, purchase.purchaseState.ordinal());
-        values.put(COLUMN_PURCHASE_TIME, purchase.purchaseTime);
-        values.put(COLUMN_DEVELOPER_PAYLOAD, purchase.developerPayload);
-        mDb.replace(TABLE_PURCHASES, null /* nullColumnHack */, values);
+        values.put(COLUMN__ID, transaction.orderId);
+        values.put(COLUMN_PRODUCT_ID, transaction.productId);
+        values.put(COLUMN_STATE, transaction.purchaseState.ordinal());
+        values.put(COLUMN_PURCHASE_TIME, transaction.purchaseTime);
+        values.put(COLUMN_DEVELOPER_PAYLOAD, transaction.developerPayload);
+        mDb.replace(TABLE_TRANSACTIONS, null /* nullColumnHack */, values);
     }
 
-    public Cursor queryPurchases() {
-        return mDb.query(TABLE_PURCHASES, TABLE_PURCHASES_COLUMNS, null,
+    public Cursor queryTransactions() {
+        return mDb.query(TABLE_TRANSACTIONS, TABLE_TRANSACTIONS_COLUMNS, null,
                 null, null, null, null);
     }
 
-    public Cursor queryPurchases(String productId, PurchaseState state) {
-        return mDb.query(TABLE_PURCHASES, TABLE_PURCHASES_COLUMNS, COLUMN_PRODUCT_ID + " = ? AND " + COLUMN_STATE + " = ?", 
+    public Cursor queryTransactions(String productId, PurchaseState state) {
+        return mDb.query(TABLE_TRANSACTIONS, TABLE_TRANSACTIONS_COLUMNS, COLUMN_PRODUCT_ID + " = ? AND " + COLUMN_STATE + " = ?", 
                 new String[] {productId, String.valueOf(state.ordinal())}, null, null, null);
     }
 
-    protected static final Purchase createPurchase(Cursor cursor) {
-    	final Purchase purchase = new Purchase();
+    protected static final Transaction createTransaction(Cursor cursor) {
+    	final Transaction purchase = new Transaction();
     	purchase.orderId = cursor.getString(0);
     	purchase.productId = cursor.getString(1);
     	purchase.purchaseState = PurchaseState.valueOf(cursor.getInt(2));
@@ -90,11 +90,11 @@ public DatabaseHelper(Context context) {
 
         @Override
         public void onCreate(SQLiteDatabase db) {
-            createPurchaseTable(db);
+            createTransactionsTable(db);
         }
 
-        private void createPurchaseTable(SQLiteDatabase db) {
-            db.execSQL("CREATE TABLE " + TABLE_PURCHASES + "(" +
+        private void createTransactionsTable(SQLiteDatabase db) {
+            db.execSQL("CREATE TABLE " + TABLE_TRANSACTIONS + "(" +
             		COLUMN__ID + " TEXT PRIMARY KEY, " +
             		COLUMN_PRODUCT_ID + " INTEGER, " +
             		COLUMN_STATE + " TEXT, " +

AndroidBillingLibrary/src/net/robotmedia/billing/model/Transaction.java

@@ -0,0 +1,84 @@
+/*	Copyright 2011 Robot Media SL <http://www.robotmedia.net>. All rights reserved.
+*
+*	This file is part of Android Billing Library.
+*
+*	Android Billing Library is free software: you can redistribute it and/or modify
+*	it under the terms of the GNU Lesser Public License as published by
+*	the Free Software Foundation, either version 3 of the License, or
+*	(at your option) any later version.
+*
+*	Android Billing Library is distributed in the hope that it will be useful,
+*	but WITHOUT ANY WARRANTY; without even the implied warranty of
+*	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+*	GNU Lesser Public License for more details.
+*
+*	You should have received a copy of the GNU Lesser Public License
+*	along with Android Billing Library.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+package net.robotmedia.billing.model;
+
+import org.json.JSONException;
+import org.json.JSONObject;
+
+public class Transaction {
+
+    public enum PurchaseState {
+        // Responses to requestPurchase or restoreTransactions.
+    	PURCHASED,    // 0: The charge failed on the server.
+        CANCELLED,   // 1: User was charged for the order.
+    	REFUNDED;    // 2: User received a refund for the order.
+
+        // Converts from an ordinal value to the PurchaseState
+        public static PurchaseState valueOf(int index) {
+            PurchaseState[] values = PurchaseState.values();
+            if (index < 0 || index >= values.length) {
+                return CANCELLED;
+            }
+            return values[index];
+        }
+    }
+	static final String DEVELOPER_PAYLOAD = "developerPayload";
+	static final String NOTIFICATION_ID = "notificationId";
+	static final String ORDER_ID = "orderId";
+	static final String PACKAGE_NAME = "packageName";
+	static final String PRODUCT_ID = "productId";
+	static final String PURCHASE_STATE = "purchaseState";
+
+	static final String PURCHASE_TIME = "purchaseTime";
+	
+    public static Transaction parse(JSONObject json) throws JSONException {
+    	final Transaction transaction = new Transaction();
+        final int response = json.getInt(PURCHASE_STATE);
+        transaction.purchaseState = PurchaseState.valueOf(response);
+        transaction.productId = json.getString(PRODUCT_ID);
+        transaction.packageName = json.getString(PACKAGE_NAME);
+        transaction.purchaseTime = json.getLong(PURCHASE_TIME);
+        transaction.orderId = json.optString(ORDER_ID, null);
+        transaction.notificationId = json.optString(NOTIFICATION_ID, null);
+        transaction.developerPayload = json.optString(DEVELOPER_PAYLOAD, null);
+        return transaction;
+    }
+
+	public String developerPayload;
+    public String notificationId;
+    public String orderId;
+    public String packageName;
+    public String productId;
+    public PurchaseState purchaseState;
+    public long purchaseTime;
+    
+    public Transaction() {}
+    
+    public Transaction(String orderId, String productId, String packageName, PurchaseState purchaseState,
+			String notificationId, long purchaseTime, String developerPayload) {
+		this.orderId = orderId;
+		this.productId = productId;
+		this.packageName = packageName;
+		this.purchaseState = purchaseState;
+		this.notificationId = notificationId;
+		this.purchaseTime = purchaseTime;
+		this.developerPayload = developerPayload;
+	}
+    
+}

AndroidBillingLibrary/src/net/robotmedia/billing/model/TransactionManager.java

@@ -0,0 +1,67 @@
+/*	Copyright 2011 Robot Media SL <http://www.robotmedia.net>. All rights reserved.
+*
+*	This file is part of Android Billing Library.
+*
+*	Android Billing Library is free software: you can redistribute it and/or modify
+*	it under the terms of the GNU Lesser Public License as published by
+*	the Free Software Foundation, either version 3 of the License, or
+*	(at your option) any later version.
+*
+*	Android Billing Library is distributed in the hope that it will be useful,
+*	but WITHOUT ANY WARRANTY; without even the implied warranty of
+*	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+*	GNU Lesser Public License for more details.
+*
+*	You should have received a copy of the GNU Lesser Public License
+*	along with Android Billing Library.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+package net.robotmedia.billing.model;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import net.robotmedia.billing.model.Transaction.PurchaseState;
+import android.content.Context;
+import android.database.Cursor;
+
+public class TransactionManager {
+	
+	public synchronized static void addTransaction(Context context, Transaction transaction) {
+		BillingDB db = new BillingDB(context);
+		db.insert(transaction);
+		db.close();
+	}
+	
+	public synchronized static boolean isPurchased(Context context, String itemId) {
+		return countPurchases(context, itemId) > 0;
+	}
+	
+	public synchronized static int countPurchases(Context context, String itemId) {
+		BillingDB db = new BillingDB(context);
+		final Cursor c = db.queryTransactions(itemId, PurchaseState.PURCHASED);
+		int count = 0;
+        if (c != null) {
+        	count = c.getCount();
+        	c.close();
+        }
+		db.close();
+		return count;
+	}
+	
+	public synchronized static List<Transaction> getTransactions(Context context) {
+		BillingDB db = new BillingDB(context);
+		final Cursor c = db.queryTransactions();
+		final List<Transaction> transactions = new ArrayList<Transaction>();
+        if (c != null) {
+        	while (c.moveToNext()) {
+        		final Transaction purchase = BillingDB.createTransaction(c);
+        		transactions.add(purchase);
+        	}
+        	c.close();
+        }
+		db.close();
+		return transactions;
+	}
+	
+}