Add STPBillingAddressFieldsName option for STPBillingAddressFields

CHANGELOG.md

@@ -1,5 +1,6 @@
 * Fixes payment method label overlapping the checkmark, for Amex on small devices [#952](https://github.com/stripe/stripe-ios/pull/952)
 * Adds EPS and Multibanco support to `STPSourceParams` [#961](https://github.com/stripe/stripe-ios/pull/961)
+* Adds `STPBillingAddressFieldsName` option to `STPBillingAddressFields` [#964](https://github.com/stripe/stripe-ios/pull/964)
 
 ## 13.0.2 2018-05-24
 * Makes iDEAL `name` parameter optional, also accepts empty string as `nil` [#940](https://github.com/stripe/stripe-ios/pull/940)

Example/Standard Integration (Swift)/SettingsViewController.swift

@@ -111,12 +111,14 @@ class SettingsViewController: UITableViewController {
     fileprivate enum RequiredBillingAddressFields: String {
         case None = "None"
         case Zip = "Zip"
+        case Name = "Name"
         case Full = "Full"
 
         init(row: Int) {
             switch row {
             case 0: self = .None
             case 1: self = .Zip
+            case 2: self = .Name
             default: self = .Full
             }
         }
@@ -125,6 +127,7 @@ class SettingsViewController: UITableViewController {
             switch self {
             case .None: return .none
             case .Zip: return .zip
+            case .Name: return .name
             case .Full: return .full
             }
         }
@@ -196,7 +199,7 @@ class SettingsViewController: UITableViewController {
         switch Section(section: section) {
         case .Theme: return 3
         case .ApplePay: return 2
-        case .RequiredBillingAddressFields: return 3
+        case .RequiredBillingAddressFields: return 4
         case .RequiredShippingAddressFields: return 4
         case .ShippingType: return 2
         case .Session: return 1

Stripe/PublicHeaders/STPAddress.h

@@ -35,6 +35,11 @@ typedef NS_ENUM(NSUInteger, STPBillingAddressFields) {
      Request the user's full billing address
      */
     STPBillingAddressFieldsFull,
+
+    /**
+     Just request the user's billing name
+     */
+    STPBillingAddressFieldsName,
 };
 
 

Stripe/STPAddress.m

@@ -169,6 +169,8 @@ - (BOOL)containsRequiredFields:(STPBillingAddressFields)requiredFields {
                                                              countryCode:self.country] == STPCardValidationStateValid);
         case STPBillingAddressFieldsFull:
             return [self hasValidPostalAddress];
+        case STPBillingAddressFieldsName:
+            return self.name.length > 0;
     }
     return containsFields;
 }
@@ -181,6 +183,8 @@ - (BOOL)containsContentForBillingAddressFields:(STPBillingAddressFields)desiredF
             return self.postalCode.length > 0;
         case STPBillingAddressFieldsFull:
             return [self hasPartialPostalAddress];
+        case STPBillingAddressFieldsName:
+            return self.name.length > 0;
     }
 
     return NO;
@@ -242,6 +246,8 @@ + (PKAddressField)applePayAddressFieldsFromBillingAddressFields:(STPBillingAddre
         case STPBillingAddressFieldsZip:
         case STPBillingAddressFieldsFull:
             return PKAddressFieldPostalAddress;
+        case STPBillingAddressFieldsName:
+            return PKAddressFieldName;
     }
 }
 

Stripe/STPAddressViewModel.m

@@ -52,6 +52,11 @@ - (instancetype)initWithRequiredBillingFields:(STPBillingAddressFields)requiredB
                                   [[STPAddressFieldTableViewCell alloc] initWithType:STPAddressFieldTypeCountry contents:_addressFieldTableViewCountryCode lastInList:YES delegate:self],
                                   ];
                 break;
+            case STPBillingAddressFieldsName:
+                _addressCells = @[
+                                  [[STPAddressFieldTableViewCell alloc] initWithType:STPAddressFieldTypeName contents:@"" lastInList:YES delegate:self]
+                                  ];
+                break;
         }
         [self commonInit];
     }

Stripe/STPAnalyticsClient.m

@@ -251,6 +251,8 @@ + (NSDictionary *)serializeConfiguration:(STPPaymentConfiguration *)configuratio
             dictionary[@"required_billing_address_fields"] = @"zip";
         case STPBillingAddressFieldsFull:
             dictionary[@"required_billing_address_fields"] = @"full";
+        case STPBillingAddressFieldsName:
+            dictionary[@"required_billing_address_fields"] = @"name";
     }
     NSMutableArray<NSString *> *shippingFields = [NSMutableArray new];
     if ([configuration.requiredShippingAddressFields containsObject:STPContactFieldName]) {

Stripe/STPPaymentConfiguration.m

@@ -90,6 +90,9 @@ - (NSString *)description {
         case STPBillingAddressFieldsFull:
             requiredBillingAddressFieldsDescription = @"STPBillingAddressFieldsFull";
             break;
+        case STPBillingAddressFieldsName:
+            requiredBillingAddressFieldsDescription = @"STPBillingAddressFieldsName";
+            break;
     }
 
     NSString *requiredShippingAddressFieldsDescription = [self.requiredShippingAddressFields.allObjects componentsJoinedByString:@"|"];

Tests/Tests/STPAddressTests.m

@@ -19,7 +19,6 @@ @interface STPAddressTests : XCTestCase
 @implementation STPAddressTests
 
 - (void)testInitWithPKContact_complete {
-
     PKContact *contact = [PKContact new];
     {
         NSPersonNameComponents *name = [NSPersonNameComponents new];
@@ -196,7 +195,6 @@ - (void)testContainsRequiredFieldsNone {
     XCTAssertTrue([address containsRequiredFields:STPBillingAddressFieldsNone]);
 }
 
-
 - (void)testContainsRequiredFieldsZip {
     STPAddress *address = [STPAddress new];
 
@@ -215,6 +213,7 @@ - (void)testContainsRequiredFieldsZip {
     address.country = nil; // nil treated as alphanumeric
     XCTAssertTrue([address containsRequiredFields:STPBillingAddressFieldsZip]);
 }
+
 - (void)testContainsRequiredFieldsFull {
     STPAddress *address = [STPAddress new];
 
@@ -268,13 +267,22 @@ - (void)testContainsRequiredFieldsFull {
     XCTAssertTrue([address containsRequiredFields:STPBillingAddressFieldsFull]);
 }
 
+- (void)testContainsRequiredFieldsName {
+    STPAddress *address = [STPAddress new];
+
+    XCTAssertFalse([address containsRequiredFields:STPBillingAddressFieldsName]);
+    address.name = @"Jane Doe";
+    XCTAssertTrue([address containsRequiredFields:STPBillingAddressFieldsName]);
+}
+
 - (void)testContainsContentForBillingAddressFields {
     STPAddress *address = [STPAddress new];
 
     // Empty address should return false for everything
     XCTAssertFalse([address containsContentForBillingAddressFields:STPBillingAddressFieldsNone]);
     XCTAssertFalse([address containsContentForBillingAddressFields:STPBillingAddressFieldsZip]);
     XCTAssertFalse([address containsContentForBillingAddressFields:STPBillingAddressFieldsFull]);
+    XCTAssertFalse([address containsContentForBillingAddressFields:STPBillingAddressFieldsName]);
 
     // 1+ characters in postalCode will return true for .Zip && .Full
     address.postalCode = @"0";
@@ -288,6 +296,14 @@ - (void)testContainsContentForBillingAddressFields {
     XCTAssertFalse([address containsContentForBillingAddressFields:STPBillingAddressFieldsFull]);
     address.postalCode = nil;
 
+    // 1+ characters in name will return true for .Name
+    address.name = @"Jane Doe";
+    XCTAssertTrue([address containsContentForBillingAddressFields:STPBillingAddressFieldsName]);
+    // empty string returns false
+    address.name = @"";
+    XCTAssertFalse([address containsContentForBillingAddressFields:STPBillingAddressFieldsName]);
+    address.name = nil;
+
     // Test every other property that contributes to the full address, ensuring it returns True for .Full only
     // This is *not* refactoring-safe, but I think it's better than a bunch of duplicated code
     for (NSString *propertyName in @[@"line1", @"line2", @"city", @"state", @"country"]) {
@@ -296,6 +312,7 @@ - (void)testContainsContentForBillingAddressFields {
             XCTAssertFalse([address containsContentForBillingAddressFields:STPBillingAddressFieldsNone]);
             XCTAssertFalse([address containsContentForBillingAddressFields:STPBillingAddressFieldsZip]);
             XCTAssertTrue([address containsContentForBillingAddressFields:STPBillingAddressFieldsFull]);
+            XCTAssertFalse([address containsContentForBillingAddressFields:STPBillingAddressFieldsName]);
             [address setValue:nil forKey:propertyName];
         }
 
@@ -304,13 +321,15 @@ - (void)testContainsContentForBillingAddressFields {
         XCTAssertFalse([address containsContentForBillingAddressFields:STPBillingAddressFieldsNone]);
         XCTAssertFalse([address containsContentForBillingAddressFields:STPBillingAddressFieldsZip]);
         XCTAssertFalse([address containsContentForBillingAddressFields:STPBillingAddressFieldsFull]);
+        XCTAssertFalse([address containsContentForBillingAddressFields:STPBillingAddressFieldsName]);
         [address setValue:nil forKey:propertyName];
     }
 
     // ensure it still returns false for everything since it has been cleared
     XCTAssertFalse([address containsContentForBillingAddressFields:STPBillingAddressFieldsNone]);
     XCTAssertFalse([address containsContentForBillingAddressFields:STPBillingAddressFieldsZip]);
     XCTAssertFalse([address containsContentForBillingAddressFields:STPBillingAddressFieldsFull]);
+    XCTAssertFalse([address containsContentForBillingAddressFields:STPBillingAddressFieldsName]);
 }
 
 - (void)testContainsRequiredShippingAddressFields {

Tests/Tests/STPAddressViewModelTest.m

@@ -39,6 +39,10 @@ - (void)testInitWithRequiredBillingFields {
     for (NSUInteger i=0; i<[sut.addressCells count]; i++) {
         XCTAssertEqual(sut.addressCells[i].type, [types[i] integerValue]);
     }
+
+    sut = [[STPAddressViewModel alloc] initWithRequiredBillingFields:STPBillingAddressFieldsName];
+    XCTAssertTrue([sut.addressCells count] == 1);
+    XCTAssertEqual(sut.addressCells[0].type, STPAddressFieldTypeName);
 }
 
 - (void)testInitWithRequiredShippingFields {
@@ -163,4 +167,20 @@ - (void)testIsValid_Full {
     XCTAssertTrue(sut.isValid);
 }
 
+- (void)testIsValid_Name {
+    STPAddressViewModel *sut = [[STPAddressViewModel alloc] initWithRequiredBillingFields:STPBillingAddressFieldsName];
+
+    STPAddress *address = [STPAddress new];
+
+    address.name = @"";
+    sut.address = address;
+    XCTAssertEqual(sut.addressCells.count, 1ul);
+    XCTAssertFalse(sut.isValid);
+
+    address.name = @"Jane Doe";
+    sut.address = address;
+    XCTAssertEqual(sut.addressCells.count, 1ul);
+    XCTAssertTrue(sut.isValid);
+}
+
 @end