Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix to ensure restoreTransactions completion callback is called #150

Open
wants to merge 21 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion RMStore.podspec
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Pod::Spec.new do |s|
s.name = 'RMStore'
s.version = '0.7.1'
s.license = 'Apache 2.0'
s.summary = 'A lightweight iOS library for In-App Purchases that adds blocks and notifications to StoreKit, plus verification, persistence and downloads.'
s.summary = 'A lightweight iOS library for In-App Purchases. RMStore add blocks and notifications to StoreKit, plus receipt verification, content downloads and transaction persistence.'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I remember having to shorten the description for some reason.

In any case, would you mind taking this change out of the PR?

s.homepage = 'https://github.com/robotmedia/RMStore'
s.author = 'Hermes Pique'
s.social_media_url = 'https://twitter.com/hpique'
Expand Down
102 changes: 53 additions & 49 deletions RMStore/RMStore.m
Original file line number Diff line number Diff line change
Expand Up @@ -133,16 +133,16 @@ @implementation RMStore {
NSMutableDictionary *_addPaymentParameters; // HACK: We use a dictionary of product identifiers because the returned SKPayment is different from the one we add to the queue. Bad Apple.
NSMutableDictionary *_products;
NSMutableSet *_productsRequestDelegates;

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please refrain from making style changes. It makes the PR harder to review, and -unless done globally- makes the code style heterogenous.

NSMutableArray *_restoredTransactions;
NSInteger _pendingRestoredTransactionsCount;

NSMutableSet *_pendingRestoredTransactionIds;
BOOL _restoredCompletedTransactionsFinished;

SKReceiptRefreshRequest *_refreshReceiptRequest;
void (^_refreshReceiptFailureBlock)(NSError* error);
void (^_refreshReceiptSuccessBlock)();

void (^_restoreTransactionsFailureBlock)(NSError* error);
void (^_restoreTransactionsSuccessBlock)(NSArray* transactions);
}
Expand All @@ -155,6 +155,7 @@ - (id) init
_products = [NSMutableDictionary dictionary];
_productsRequestDelegates = [NSMutableSet set];
_restoredTransactions = [NSMutableArray array];
_pendingRestoredTransactionIds = [NSMutableSet set];
[[SKPaymentQueue defaultQueue] addTransactionObserver:self];
}
return self;
Expand Down Expand Up @@ -188,16 +189,16 @@ - (void)addPayment:(NSString*)productIdentifier
}

- (void)addPayment:(NSString*)productIdentifier
success:(void (^)(SKPaymentTransaction *transaction))successBlock
failure:(void (^)(SKPaymentTransaction *transaction, NSError *error))failureBlock
success:(void (^)(SKPaymentTransaction *transaction))successBlock
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same.

failure:(void (^)(SKPaymentTransaction *transaction, NSError *error))failureBlock
{
[self addPayment:productIdentifier user:nil success:successBlock failure:failureBlock];
}

- (void)addPayment:(NSString*)productIdentifier
user:(NSString*)userIdentifier
success:(void (^)(SKPaymentTransaction *transaction))successBlock
failure:(void (^)(SKPaymentTransaction *transaction, NSError *error))failureBlock
user:(NSString*)userIdentifier
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same.

success:(void (^)(SKPaymentTransaction *transaction))successBlock
failure:(void (^)(SKPaymentTransaction *transaction, NSError *error))failureBlock
{
SKProduct *product = [self productForIdentifier:productIdentifier];
if (product == nil)
Expand All @@ -215,12 +216,12 @@ - (void)addPayment:(NSString*)productIdentifier
{
payment.applicationUsername = userIdentifier;
}

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same.

RMAddPaymentParameters *parameters = [[RMAddPaymentParameters alloc] init];
parameters.successBlock = successBlock;
parameters.failureBlock = failureBlock;
_addPaymentParameters[productIdentifier] = parameters;

[[SKPaymentQueue defaultQueue] addPayment:payment];
}

Expand All @@ -230,18 +231,18 @@ - (void)requestProducts:(NSSet*)identifiers
}

- (void)requestProducts:(NSSet*)identifiers
success:(RMSKProductsRequestSuccessBlock)successBlock
failure:(RMSKProductsRequestFailureBlock)failureBlock
success:(RMSKProductsRequestSuccessBlock)successBlock
failure:(RMSKProductsRequestFailureBlock)failureBlock
{
RMProductsRequestDelegate *delegate = [[RMProductsRequestDelegate alloc] init];
delegate.store = self;
delegate.successBlock = successBlock;
delegate.failureBlock = failureBlock;
[_productsRequestDelegates addObject:delegate];

SKProductsRequest *productsRequest = [[SKProductsRequest alloc] initWithProductIdentifiers:identifiers];
productsRequest.delegate = delegate;
productsRequest.delegate = delegate;

[productsRequest start];
}

Expand All @@ -251,23 +252,23 @@ - (void)restoreTransactions
}

- (void)restoreTransactionsOnSuccess:(void (^)(NSArray *transactions))successBlock
failure:(void (^)(NSError *error))failureBlock
failure:(void (^)(NSError *error))failureBlock
{
_restoredCompletedTransactionsFinished = NO;
_pendingRestoredTransactionsCount = 0;
[_pendingRestoredTransactionIds removeAllObjects];
_restoredTransactions = [NSMutableArray array];
_restoreTransactionsSuccessBlock = successBlock;
_restoreTransactionsFailureBlock = failureBlock;
[[SKPaymentQueue defaultQueue] restoreCompletedTransactions];
}

- (void)restoreTransactionsOfUser:(NSString*)userIdentifier
onSuccess:(void (^)(NSArray *transactions))successBlock
failure:(void (^)(NSError *error))failureBlock
onSuccess:(void (^)(NSArray *transactions))successBlock
failure:(void (^)(NSError *error))failureBlock
{
NSAssert([[SKPaymentQueue defaultQueue] respondsToSelector:@selector(restoreCompletedTransactionsWithApplicationUsername:)], @"restoreCompletedTransactionsWithApplicationUsername: not supported in this iOS version. Use restoreTransactionsOnSuccess:failure: instead.");
_restoredCompletedTransactionsFinished = NO;
_pendingRestoredTransactionsCount = 0;
[_pendingRestoredTransactionIds removeAllObjects];
_restoreTransactionsSuccessBlock = successBlock;
_restoreTransactionsFailureBlock = failureBlock;
[[SKPaymentQueue defaultQueue] restoreCompletedTransactionsWithApplicationUsername:userIdentifier];
Expand All @@ -289,7 +290,7 @@ - (void)refreshReceipt
}

- (void)refreshReceiptOnSuccess:(RMStoreSuccessBlock)successBlock
failure:(RMStoreFailureBlock)failureBlock
failure:(RMStoreFailureBlock)failureBlock
{
_refreshReceiptFailureBlock = failureBlock;
_refreshReceiptSuccessBlock = successBlock;
Expand All @@ -307,11 +308,11 @@ - (SKProduct*)productForIdentifier:(NSString*)productIdentifier

+ (NSString*)localizedPriceOfProduct:(SKProduct*)product
{
NSNumberFormatter *numberFormatter = [[NSNumberFormatter alloc] init];
numberFormatter.numberStyle = NSNumberFormatterCurrencyStyle;
numberFormatter.locale = product.priceLocale;
NSString *formattedString = [numberFormatter stringFromNumber:product.price];
return formattedString;
NSNumberFormatter *numberFormatter = [[NSNumberFormatter alloc] init];
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same.

numberFormatter.numberStyle = NSNumberFormatterCurrencyStyle;
numberFormatter.locale = product.priceLocale;
NSString *formattedString = [numberFormatter stringFromNumber:product.price];
return formattedString;
}

#pragma mark Observers
Expand Down Expand Up @@ -392,7 +393,7 @@ - (void)paymentQueueRestoreCompletedTransactionsFinished:(SKPaymentQueue *)queue
{
RMStoreLog(@"restore transactions finished");
_restoredCompletedTransactionsFinished = YES;

[self notifyRestoreTransactionFinishedIfApplicableAfterTransaction:nil];
}

Expand Down Expand Up @@ -478,7 +479,7 @@ - (void)didFinishDownload:(SKDownload*)download queue:(SKPaymentQueue*)queue
{
SKPaymentTransaction *transaction = download.transaction;
RMStoreLog(@"download %@ for product %@ finished", download.contentIdentifier, transaction.payment.productIdentifier);

[self postNotificationWithName:RMSKDownloadFinished download:download userInfoExtras:nil];

const BOOL hasPendingDownloads = [self.class hasPendingDownloadsInTransaction:transaction];
Expand Down Expand Up @@ -525,7 +526,7 @@ + (BOOL)hasPendingDownloadsInTransaction:(SKPaymentTransaction*)transaction
- (void)didPurchaseTransaction:(SKPaymentTransaction *)transaction queue:(SKPaymentQueue*)queue
{
RMStoreLog(@"transaction purchased with product %@", transaction.payment.productIdentifier);

if (self.receiptVerificator != nil)
{
[self.receiptVerificator verifyTransaction:transaction success:^{
Expand All @@ -544,23 +545,23 @@ - (void)didPurchaseTransaction:(SKPaymentTransaction *)transaction queue:(SKPaym
- (void)didFailTransaction:(SKPaymentTransaction *)transaction queue:(SKPaymentQueue*)queue error:(NSError*)error
{
SKPayment *payment = transaction.payment;
NSString* productIdentifier = payment.productIdentifier;
NSString* productIdentifier = payment.productIdentifier;
RMStoreLog(@"transaction failed with product %@ and error %@", productIdentifier, error.debugDescription);

if (error.code != RMStoreErrorCodeUnableToCompleteVerification)
{ // If we were unable to complete the verification we want StoreKit to keep reminding us of the transaction
[queue finishTransaction:transaction];
}

RMAddPaymentParameters *parameters = [self popAddPaymentParametersForIdentifier:productIdentifier];
if (parameters.failureBlock != nil)
{
parameters.failureBlock(transaction, error);
}

NSDictionary *extras = error ? @{RMStoreNotificationStoreError : error} : nil;
[self postNotificationWithName:RMSKPaymentTransactionFailed transaction:transaction userInfoExtras:extras];

if (transaction.transactionState == SKPaymentTransactionStateRestored)
{
[self notifyRestoreTransactionFinishedIfApplicableAfterTransaction:transaction];
Expand All @@ -569,9 +570,12 @@ - (void)didFailTransaction:(SKPaymentTransaction *)transaction queue:(SKPaymentQ

- (void)didRestoreTransaction:(SKPaymentTransaction *)transaction queue:(SKPaymentQueue*)queue
{
RMStoreLog(@"transaction restored with product %@", transaction.originalTransaction.payment.productIdentifier);

_pendingRestoredTransactionsCount++;
NSString *productIdentifier = transaction.originalTransaction.payment.productIdentifier;
RMStoreLog(@"transaction restored with product %@", productIdentifier);

if(productIdentifier) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: if (productIdentifier)

[_pendingRestoredTransactionIds addObject:productIdentifier];
}
if (self.receiptVerificator != nil)
{
[self.receiptVerificator verifyTransaction:transaction success:^{
Expand Down Expand Up @@ -631,18 +635,18 @@ - (void)didDownloadSelfHostedContentForTransaction:(SKPaymentTransaction *)trans
- (void)finishTransaction:(SKPaymentTransaction *)transaction queue:(SKPaymentQueue*)queue
{
SKPayment *payment = transaction.payment;
NSString* productIdentifier = payment.productIdentifier;
NSString* productIdentifier = payment.productIdentifier;
[queue finishTransaction:transaction];
[self.transactionPersistor persistTransaction:transaction];

RMAddPaymentParameters *wrapper = [self popAddPaymentParametersForIdentifier:productIdentifier];
if (wrapper.successBlock != nil)
{
wrapper.successBlock(transaction);
}

[self postNotificationWithName:RMSKPaymentTransactionFinished transaction:transaction userInfoExtras:nil];

if (transaction.transactionState == SKPaymentTransactionStateRestored)
{
[self notifyRestoreTransactionFinishedIfApplicableAfterTransaction:transaction];
Expand All @@ -654,9 +658,9 @@ - (void)notifyRestoreTransactionFinishedIfApplicableAfterTransaction:(SKPaymentT
if (transaction != nil)
{
[_restoredTransactions addObject:transaction];
_pendingRestoredTransactionsCount--;
[_pendingRestoredTransactionIds removeObject:transaction.payment.productIdentifier];
}
if (_restoredCompletedTransactionsFinished && _pendingRestoredTransactionsCount == 0)
if (_restoredCompletedTransactionsFinished && _pendingRestoredTransactionIds.count == 0)
{ // Wait until all restored transations have been verified
NSArray *restoredTransactions = [_restoredTransactions copy];
if (_restoreTransactionsSuccessBlock != nil)
Expand Down Expand Up @@ -711,7 +715,7 @@ - (void)request:(SKRequest *)request didFailWithError:(NSError *)error

- (void)addProduct:(SKProduct*)product
{
_products[product.productIdentifier] = product;
_products[product.productIdentifier] = product;
}

- (void)postNotificationWithName:(NSString*)notificationName download:(SKDownload*)download userInfoExtras:(NSDictionary*)extras
Expand Down Expand Up @@ -748,17 +752,17 @@ - (void)productsRequest:(SKProductsRequest *)request didReceiveResponse:(SKProdu
RMStoreLog(@"products request received response");
NSArray *products = [NSArray arrayWithArray:response.products];
NSArray *invalidProductIdentifiers = [NSArray arrayWithArray:response.invalidProductIdentifiers];

for (SKProduct *product in products)
{
RMStoreLog(@"received product with id %@", product.productIdentifier);
[self.store addProduct:product];
}

[invalidProductIdentifiers enumerateObjectsUsingBlock:^(NSString *invalid, NSUInteger idx, BOOL *stop) {
RMStoreLog(@"invalid product with id %@", invalid);
}];

if (self.successBlock)
{
self.successBlock(products, invalidProductIdentifiers);
Expand Down