Merge pull request #169 from Shopify/task/payment-provider-refactor

Refactor payment provider

Mobile Buy SDK/Mobile Buy SDK Tests/BUYPaymentProviderTests.m

@@ -240,7 +240,7 @@
 {
 }
 
-- (void)paymentProvider:(id <BUYPaymentProvider>)provider didFailCheckoutWithError:(NSError *)error;
+- (void)paymentProvider:(id <BUYPaymentProvider>)provider didFailWithError:(NSError *)error;
 {
 	if (self.expectations[@"failedCheckout"]) {
 		[self.expectations[@"failedCheckout"] fulfill];

Mobile Buy SDK/Mobile Buy SDK/Payment Providers/BUYApplePayPaymentProvider.m

@@ -100,8 +100,8 @@ NSString *const BUYApplePayPaymentProviderId = @"BUYApplePayPaymentProviderId";
 	[self.client getShop:^(BUYShop *theShop, NSError *error) {
 		
 		if (error) {
-			if ([self.delegate respondsToSelector:@selector(paymentProvider:didFailCheckoutWithError:)]) {
-				[self.delegate paymentProvider:self didFailCheckoutWithError:error];
+			if ([self.delegate respondsToSelector:@selector(paymentProvider:didFailWithError:)]) {
+				[self.delegate paymentProvider:self didFailWithError:error];
 			}
 			[[NSNotificationCenter defaultCenter] postNotificationName:BUYPaymentProviderDidFailCheckoutNotificationKey object:self];
 		}
@@ -115,8 +115,8 @@ NSString *const BUYApplePayPaymentProviderId = @"BUYApplePayPaymentProviderId";
 	dispatch_group_enter(group);
 	[self.client handleCheckout:checkout completion:^(BUYCheckout *checkout, NSError *error) {
 		if (error) {
-			if ([self.delegate respondsToSelector:@selector(paymentProvider:didFailCheckoutWithError:)]) {
-				[self.delegate paymentProvider:self didFailCheckoutWithError:error];
+			if ([self.delegate respondsToSelector:@selector(paymentProvider:didFailWithError:)]) {
+				[self.delegate paymentProvider:self didFailWithError:error];
 			}
 			[[NSNotificationCenter defaultCenter] postNotificationName:BUYPaymentProviderDidFailCheckoutNotificationKey object:self];
 		}
@@ -181,8 +181,8 @@ NSString *const BUYApplePayPaymentProviderId = @"BUYApplePayPaymentProviderId";
 		[self.delegate paymentProvider:self wantsControllerPresented:controller];
 	}
 	else {
-		if ([self.delegate respondsToSelector:@selector(paymentProvider:didFailCheckoutWithError:)]) {
-			[self.delegate paymentProvider:self didFailCheckoutWithError:nil];
+		if ([self.delegate respondsToSelector:@selector(paymentProvider:didFailWithError:)]) {
+			[self.delegate paymentProvider:self didFailWithError:nil];
 		}
 		[[NSNotificationCenter defaultCenter] postNotificationName:BUYPaymentProviderDidFailCheckoutNotificationKey object:self];
 	}
@@ -225,15 +225,15 @@ NSString *const BUYApplePayPaymentProviderId = @"BUYApplePayPaymentProviderId";
 		self.paymentAuthorizationStatus = status;
 		switch (status) {
 			case PKPaymentAuthorizationStatusFailure:
-				if ([self.delegate respondsToSelector:@selector(paymentProvider:didFailCheckoutWithError:)]) {
-					[self.delegate paymentProvider:self didFailCheckoutWithError:self.applePayHelper.lastError];
+				if ([self.delegate respondsToSelector:@selector(paymentProvider:didFailWithError:)]) {
+					[self.delegate paymentProvider:self didFailWithError:self.applePayHelper.lastError];
 				}
 				[[NSNotificationCenter defaultCenter] postNotificationName:BUYPaymentProviderDidFailCheckoutNotificationKey object:self];
 				break;
 				
 			case PKPaymentAuthorizationStatusInvalidShippingPostalAddress:
-				if ([self.delegate respondsToSelector:@selector(paymentProvider:didFailToUpdateCheckoutWithError:)]) {
-					[self.delegate paymentProvider:self didFailToUpdateCheckoutWithError:self.applePayHelper.lastError];
+				if ([self.delegate respondsToSelector:@selector(paymentProvider:didFailWithError:)]) {
+					[self.delegate paymentProvider:self didFailWithError:self.applePayHelper.lastError];
 				}
 				[[NSNotificationCenter defaultCenter] postNotificationName:BUYPaymentProviderDidFailToUpdateCheckoutNotificationKey object:self];
 				break;
@@ -263,8 +263,8 @@ NSString *const BUYApplePayPaymentProviderId = @"BUYApplePayPaymentProviderId";
 {
 	[self.applePayHelper paymentAuthorizationViewController:controller didSelectShippingMethod:shippingMethod completion:^(PKPaymentAuthorizationStatus status, NSArray<PKPaymentSummaryItem *> * _Nonnull summaryItems) {
 		if (status == PKPaymentAuthorizationStatusInvalidShippingPostalAddress) {
-			if ([self.delegate respondsToSelector:@selector(paymentProvider:didFailToUpdateCheckoutWithError:)]) {
-				[self.delegate paymentProvider:self didFailToUpdateCheckoutWithError:self.applePayHelper.lastError];
+			if ([self.delegate respondsToSelector:@selector(paymentProvider:didFailWithError:)]) {
+				[self.delegate paymentProvider:self didFailWithError:self.applePayHelper.lastError];
 			}
 			[[NSNotificationCenter defaultCenter] postNotificationName:BUYPaymentProviderDidFailToUpdateCheckoutNotificationKey object:self];
 		}
@@ -276,8 +276,8 @@ NSString *const BUYApplePayPaymentProviderId = @"BUYApplePayPaymentProviderId";
 {
 	[self.applePayHelper paymentAuthorizationViewController:controller didSelectShippingAddress:address completion:^(PKPaymentAuthorizationStatus status, NSArray<PKShippingMethod *> * _Nonnull shippingMethods, NSArray<PKPaymentSummaryItem *> * _Nonnull summaryItems) {
 		if (status == PKPaymentAuthorizationStatusInvalidShippingPostalAddress) {
-			if ([self.delegate respondsToSelector:@selector(paymentProvider:didFailToUpdateCheckoutWithError:)]) {
-				[self.delegate paymentProvider:self didFailToUpdateCheckoutWithError:self.applePayHelper.lastError];
+			if ([self.delegate respondsToSelector:@selector(paymentProvider:didFailWithError:)]) {
+				[self.delegate paymentProvider:self didFailWithError:self.applePayHelper.lastError];
 			}
 			[[NSNotificationCenter defaultCenter] postNotificationName:BUYPaymentProviderDidFailToUpdateCheckoutNotificationKey object:self];
 		}
@@ -289,8 +289,8 @@ NSString *const BUYApplePayPaymentProviderId = @"BUYApplePayPaymentProviderId";
 {
 	[self.applePayHelper paymentAuthorizationViewController:controller didSelectShippingContact:contact completion:^(PKPaymentAuthorizationStatus status, NSArray<PKShippingMethod *> * _Nonnull shippingMethods, NSArray<PKPaymentSummaryItem *> * _Nonnull summaryItems) {
 		if (status == PKPaymentAuthorizationStatusInvalidShippingPostalAddress) {
-			if ([self.delegate respondsToSelector:@selector(paymentProvider:didFailToUpdateCheckoutWithError:)]) {
-				[self.delegate paymentProvider:self didFailToUpdateCheckoutWithError:self.applePayHelper.lastError];
+			if ([self.delegate respondsToSelector:@selector(paymentProvider:didFailWithError:)]) {
+				[self.delegate paymentProvider:self didFailWithError:self.applePayHelper.lastError];
 			}
 			[[NSNotificationCenter defaultCenter] postNotificationName:BUYPaymentProviderDidFailToUpdateCheckoutNotificationKey object:self];
 		}

Mobile Buy SDK/Mobile Buy SDK/Payment Providers/BUYPaymentProvider.h

@@ -75,20 +75,12 @@ extern NSString *const BUYPaymentProviderDidCompleteCheckoutNotificationKey;
 - (void)paymentProviderDidDismissCheckout:(id <BUYPaymentProvider>)provider;
 
 /**
- *  Called when a checkout failed to update
+ *  Called when a checkout payment operation has failed
  *
  *  @param provider   the `BUYPaymentProvider`
  *  @param error    the optional `NSError`
  */
-- (void)paymentProvider:(id <BUYPaymentProvider>)provider didFailToUpdateCheckoutWithError:(NSError *)error;
-
-/**
- *  Called when the checkout failed
- *
- *  @param provider   the `BUYPaymentProvider`
- *  @param error    the optional `NSError`
- */
-- (void)paymentProvider:(id <BUYPaymentProvider>)provider didFailCheckoutWithError:(NSError * _Nullable)error;
+- (void)paymentProvider:(id <BUYPaymentProvider>)provider didFailWithError:(nullable NSError *)error;
 
 /**
  *  Called when the checkout has completed

Mobile Buy SDK/Mobile Buy SDK/Payment Providers/BUYWebCheckoutPaymentProvider.m

@@ -128,8 +128,8 @@ static NSString *const WebCheckoutCustomerAccessToken = @"customer_access_token"
 		[self openWebCheckout:checkout];
 	}
 	else {
-		if ([self.delegate respondsToSelector:@selector(paymentProvider:didFailCheckoutWithError:)]) {
-			[self.delegate paymentProvider:self didFailCheckoutWithError:error];
+		if ([self.delegate respondsToSelector:@selector(paymentProvider:didFailWithError:)]) {
+			[self.delegate paymentProvider:self didFailWithError:error];
 		}
 		[[NSNotificationCenter defaultCenter] postNotificationName:BUYPaymentProviderDidFailCheckoutNotificationKey object:self];
 		

Mobile Buy SDK/Mobile Buy SDK/Utils/BUYError+BUYAdditions.m

@@ -25,26 +25,49 @@
 //
 
 #import "BUYError+BUYAdditions.h"
+#import "NSArray+BUYAdditions.h"
+
+@interface NSDictionary (BUYCheckoutErrorParsing)
+- (NSDictionary *)buy_errorsDictionary;
+- (NSDictionary *)buy_checkoutErrorsDictionary;
+- (NSArray *)buy_lineItemErrors;
+@end
+
+@implementation NSDictionary (BUYCheckoutErrorParsing)
+
+- (NSDictionary *)buy_errorsDictionary
+{
+	NSDictionary *errorsDictionary = self[@"errors"];
+	return [errorsDictionary isKindOfClass:[NSDictionary class]] ? errorsDictionary : nil;
+}
+
+- (NSDictionary *)buy_checkoutErrorsDictionary
+{
+	NSDictionary *checkoutErrorsDictionary = [self buy_errorsDictionary][@"checkout"];
+	return [checkoutErrorsDictionary isKindOfClass:[NSDictionary class]] ? checkoutErrorsDictionary : nil;
+}
+
+- (NSArray *)buy_lineItemErrors
+{
+	NSArray *lineItemErrors = [self buy_checkoutErrorsDictionary][@"line_items"];
+	return [lineItemErrors isKindOfClass:[NSArray class]] ? lineItemErrors : nil;
+}
+
+@end
 
 @implementation BUYError (Checkout)
 
 + (NSArray<BUYError *> *)errorsFromCheckoutJSON:(NSDictionary *)json
 {
-	NSArray *lineItems = json[@"errors"][@"checkout"][@"line_items"];
-	NSMutableArray *errors = [NSMutableArray array];
+	return [[json buy_lineItemErrors] buy_map:^id(NSDictionary<NSString *, NSArray *> *lineItemError) {
+		return [lineItemError isKindOfClass:[NSDictionary class]] ? [self errorWithJSONDictionary:lineItemError] : [NSNull null];
+	}];
+}
 
-	for (NSDictionary<NSString *, NSArray *> *lineItem in lineItems) {
-		if (lineItem == (id)[NSNull null]) {
-			[errors addObject:lineItem];
-		}
-		else {
-			for (NSString *key in lineItem.allKeys) {
-				NSDictionary *reason = [lineItem[key] firstObject];
-				[errors addObject:[[BUYError alloc] initWithKey:key json:reason]];
-			};
-		}
-	};
-	return errors;
++ (BUYError *)errorWithJSONDictionary:(NSDictionary<NSString *, NSArray *> *)dictionary
+{
+	NSString *key = dictionary.allKeys.firstObject;
+	return [[self alloc] initWithKey:key json:dictionary[key].firstObject];
 }
 
 - (NSString *)quantityRemainingMessage