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.

Sign up for GitHub

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

Adding imageUrl, upcType, upcCode to PayPalLineItem #871

Merged
merged 10 commits into from
Jan 11, 2024
Merged

Adding imageUrl, upcType, upcCode to PayPalLineItem #871

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
bacfe47
adding imageUrl, upcCode, upcType for PayPalLineItem type
vankads Dec 26, 2023
940340b
adding imageUrl, upcCode, upcType for PayPalNaticeCheckoutLineItem type
vankads Dec 26, 2023
a8fd7ee
Fixing typos
vankads Dec 27, 2023
d2543d8
Fixing typos
vankads Dec 27, 2023
b1dbb15
Adding changelog
vankads Jan 3, 2024
0344fb3
Addressing code review comments
vankads Jan 5, 2024
39d3713
Addins properties in alphabetical order
vankads Jan 5, 2024
5c133de
Update CHANGELOG.md
sarahkoop Jan 11, 2024
dc59edf
Merge branch 'main' into main
sarahkoop Jan 11, 2024
468888f
Fixing typos
vankads Jan 11, 2024
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
75 changes: 74 additions & 1 deletion PayPal/src/main/java/com/braintreepayments/api/PayPalLineItem.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,22 @@ public class PayPalLineItem implements Parcelable {
public static final String KIND_CREDIT = "credit";
public static final String KIND_DEBIT = "debit";

/**
* The upc type of PayPal line item.
*/
@Retention(RetentionPolicy.SOURCE)
@StringDef({PayPalLineItem.UPC_TYPE_A, PayPalLineItem.UPC_TYPE_B, PayPalLineItem.UPC_TYPE_C, PayPalLineItem.UPC_TYPE_D, PayPalLineItem.UPC_TYPE_E, PayPalLineItem.UPC_TYPE_2, PayPalLineItem.UPC_TYPE_5})
@interface PayPalLineItemUpcType {
}

public static final String UPC_TYPE_A = "UPC-A";
public static final String UPC_TYPE_B = "UPC-B";
public static final String UPC_TYPE_C = "UPC-C";
public static final String UPC_TYPE_D = "UPC-D";
public static final String UPC_TYPE_E = "UPC-E";
public static final String UPC_TYPE_2 = "UPC-2";
public static final String UPC_TYPE_5 = "UPC-5";

private static final String DESCRIPTION_KEY = "description";
private static final String KIND_KEY = "kind";
private static final String NAME_KEY = "name";
Expand All @@ -37,6 +53,9 @@ public class PayPalLineItem implements Parcelable {
private static final String UNIT_AMOUNT_KEY = "unit_amount";
private static final String UNIT_TAX_AMOUNT_KEY = "unit_tax_amount";
private static final String URL_KEY = "url";
private static final String IMAGE_URL_KEY = "image_url";
private static final String UPC_CODE_KEY = "upc_code";
private static final String UPC_TYPE_KEY = "upc_type";

private String description;
private String kind;
Expand All @@ -46,6 +65,9 @@ public class PayPalLineItem implements Parcelable {
private String unitAmount;
private String unitTaxAmount;
private String url;
private String imageUrl;
private String upcCode;
private String upcType;

/**
* Constructs a line item for PayPal checkout flows. All parameters are required.
Expand Down Expand Up @@ -137,6 +159,33 @@ public void setUrl(@NonNull String url) {
this.url = url;
}

/**
* The image URL to product information.
*
* @param imageURL The image URL with additional information.
*/
public void setImageUrl(@NonNull String imageUrl) {
this.imageUrl = imageUrl;
}

/**
* UPC code of the item.
*
* @param upcCode The UPC code.
*/
public void setUpcCode(@NonNull String upcCode) {
this.upcCode = upcCode;
}

/**
* UPC type of the item.
*
* @param upcType The UPC type.
*/
public void setUpcType(@NonNull String upcType) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
public void setUpcType(@NonNull String upcType) {
public void setUpcType(@Nullable String upcType) {

I'd actually go for @Nullable for these properties to align the getter/setter annotations. upcType: String? makes sense since it's initially null.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Currently all the existing properties have @nonnull for setters and @nullable for getters, as these are not required fields and merchant may or may not use setter methods. We didn't see any issues so far.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think that must have been an oversight when those properties were added. When these annotations don't match up, the Kotlin property setters don't seem to work as expected (ex: lineItem.upcType = "some type" won't work in Kotlin, they would have to set lineItem.setUpcType("some type")), which isn't the ideal Kotlin integration experience. Although I'm not certain if newer versions of Kotlin have resolved this issue.

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh cool yeah if it does work in newer versions of Kotlin i'm 👍 . We should check though. The way it's written now makes total sense to me, but I have seen Kotlin get weird when the annotations aren't aligned.

Copy link
Contributor

Choose a reason for hiding this comment

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

I just confirmed with the v5 branch that uses the latest Kotlin that this issue still exists 😞 - I created a ticket to update the annotations in v5 where they don't currently align, but we should add these new properties with matching annotations.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated setter method annotation from @NonNull to @nullable to keep it consistent with getter method annotations

this.upcType = upcType;
}

@Nullable
public String getDescription() {
return description;
Expand Down Expand Up @@ -178,6 +227,21 @@ public String getUrl() {
return url;
}

@Nullable
vankads marked this conversation as resolved.
Show resolved Hide resolved
public String getImageUrl() {
return imageUrl;
}

@Nullable
public String getUpcCode() {
return upcCode;
}

@Nullable
public String getUpcType() {
return upcType;
}

public JSONObject toJson() {
try {
return new JSONObject()
Expand All @@ -188,7 +252,10 @@ public JSONObject toJson() {
.putOpt(QUANTITY_KEY, quantity)
.putOpt(UNIT_AMOUNT_KEY, unitAmount)
.putOpt(UNIT_TAX_AMOUNT_KEY, unitTaxAmount)
.putOpt(URL_KEY, url);
.putOpt(URL_KEY, url)
.putOpt(IMAGE_UTL_KRY, imageUrl)
.putOpt(UPC_CODE_KEY, upcCode)
.putOpt(UPC_TYPE_KRY, upcType);
} catch (JSONException ignored) {
}

Expand All @@ -204,6 +271,9 @@ public JSONObject toJson() {
unitAmount = in.readString();
unitTaxAmount = in.readString();
url = in.readString();
imageUrl = in.readString();
upcCode = in.readString();
upcType = in.readString();
}

public static final Creator<PayPalLineItem> CREATOR = new Creator<PayPalLineItem>() {
Expand Down Expand Up @@ -233,6 +303,9 @@ public void writeToParcel(Parcel parcel, int i) {
parcel.writeString(unitAmount);
parcel.writeString(unitTaxAmount);
parcel.writeString(url);
parcel.writeString(imageUrl);
parcel.writeString(upcCode);
parcel.writeSting(upcType);
}

}
6 changes: 6 additions & 0 deletions PayPal/src/test/java/com/braintreepayments/api/PayPalLineItemUnitTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ public void toJson_setsKeysAndValues() throws JSONException {
item.setProductCode("abc-123");
item.setUnitTaxAmount("1.50");
item.setUrl("http://example.com");
item.setImageUrl("http://example.com/image.jpg");
item.setUpcType(PayPalLineItem.UPC_TYPE_2);
item.setUpcCode("upc-code");

JSONObject json = item.toJson();

Expand All @@ -29,6 +32,9 @@ public void toJson_setsKeysAndValues() throws JSONException {
assertEquals("abc-123", json.getString("product_code"));
assertEquals("1.50", json.getString("unit_tax_amount"));
assertEquals("http://example.com", json.getString("url"));
assertEquals("http://example.com/image.jpg", json.getString("image_url"));
assertEquals("UPC-2", json.getString("upc_type"));
assertEquals("upc-code", json.getString("upc_code"));
}
}

75 changes: 74 additions & 1 deletion ...lNativeCheckout/src/main/java/com/braintreepayments/api/PayPalNativeCheckoutLineItem.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,22 @@ public class PayPalNativeCheckoutLineItem implements Parcelable {
public static final String KIND_CREDIT = "credit";
public static final String KIND_DEBIT = "debit";

/**
* The upc type of PayPal line item.
*/
@Retention(RetentionPolicy.SOURCE)
@StringDef({PayPalLineItem.UPC_TYPE_A, PayPalLineItem.UPC_TYPE_B, PayPalLineItem.UPC_TYPE_C, PayPalLineItem.UPC_TYPE_D, PayPalLineItem.UPC_TYPE_E, PayPalLineItem.UPC_TYPE_2, PayPalLineItem.UPC_TYPE_5})
@interface PayPalLineItemUpcType {
}

public static final String UPC_TYPE_A = "UPC-A";
public static final String UPC_TYPE_B = "UPC-B";
public static final String UPC_TYPE_C = "UPC-C";
public static final String UPC_TYPE_D = "UPC-D";
public static final String UPC_TYPE_E = "UPC-E";
public static final String UPC_TYPE_2 = "UPC-2";
public static final String UPC_TYPE_5 = "UPC-5";

private static final String DESCRIPTION_KEY = "description";
private static final String KIND_KEY = "kind";
private static final String NAME_KEY = "name";
Expand All @@ -37,6 +53,9 @@ public class PayPalNativeCheckoutLineItem implements Parcelable {
private static final String UNIT_AMOUNT_KEY = "unit_amount";
private static final String UNIT_TAX_AMOUNT_KEY = "unit_tax_amount";
private static final String URL_KEY = "url";
private static final String IMAGE_URL_KEY = "image_url";
private static final String UPC_CODE_KEY = "upc_code";
private static final String UPC_TYPE_KEY = "upc_type";

private String description;
private String kind;
Expand All @@ -46,6 +65,9 @@ public class PayPalNativeCheckoutLineItem implements Parcelable {
private String unitAmount;
private String unitTaxAmount;
private String url;
private String imageUrl;
private String upcCode;
private String upcType;

/**
* Constructs a line item for PayPal checkout flows. All parameters are required.
Expand Down Expand Up @@ -137,6 +159,33 @@ public void setUrl(@NonNull String url) {
this.url = url;
}

/**
* The image URL to product information.
*
* @param imageURL The image URL with additional information.
*/
public void setImageUrl(@NonNull String imageUrl) {
this.imageUrl = imageUrl;
}

/**
* UPC code of the item.
*
* @param upcCode The UPC code.
*/
public void setUpcCode(@NonNull String upcCode) {
this.upcCode = upcCode;
}

/**
* UPC type of the item.
*
* @param upcType The UPC type.
*/
public void setUpcType(@NonNull String upcType) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
public void setUpcType(@NonNull String upcType) {
public void setUpcType(@NonNull @PayPalLineItemUpcType String upcType) {

This type should be added here and in the getter right (and in doc string too probably)? Or is that interface used somewhere else?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added interface type to setter and getter annotations

this.upcType = upcType;
}

@Nullable
public String getDescription() {
return description;
Expand Down Expand Up @@ -178,6 +227,21 @@ public String getUrl() {
return url;
}

@Nullable
public String getImageUrl() {
return imageUrl;
}

@Nullable
public String getUpcCode() {
return upcCode;
}

@Nullable
public String getUpcType() {
return upcType;
}

public JSONObject toJson() {
try {
return new JSONObject()
Expand All @@ -188,7 +252,10 @@ public JSONObject toJson() {
.putOpt(QUANTITY_KEY, quantity)
.putOpt(UNIT_AMOUNT_KEY, unitAmount)
.putOpt(UNIT_TAX_AMOUNT_KEY, unitTaxAmount)
.putOpt(URL_KEY, url);
.putOpt(URL_KEY, url)
.putOpt(IMAGE_UTL_KRY, imageUrl)
.putOpt(UPC_CODE_KEY, upcCode)
.putOpt(UPC_TYPE_KRY, upcType);
} catch (JSONException ignored) {
}

Expand All @@ -204,6 +271,9 @@ public JSONObject toJson() {
unitAmount = in.readString();
unitTaxAmount = in.readString();
url = in.readString();
imageUrl = in.readString();
upcCode = in.readString();
upcType = in.readString();
}

public static final Creator<PayPalNativeCheckoutLineItem> CREATOR = new Creator<PayPalNativeCheckoutLineItem>() {
Expand Down Expand Up @@ -233,6 +303,9 @@ public void writeToParcel(Parcel parcel, int i) {
parcel.writeString(unitAmount);
parcel.writeString(unitTaxAmount);
parcel.writeString(url);
parcel.writeString(imageUrl);
parcel.writeString(upcCode);
parcel.writeSting(upcType);
}

}
7 changes: 7 additions & 0 deletions PayPalNativeCheckout/src/test/java/com/braintreepayments/api/PayPalLineItemUnitTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ public void toJson_setsKeysAndValues() throws JSONException {
item.setProductCode("abc-123");
item.setUnitTaxAmount("1.50");
item.setUrl("http://example.com");
item.setImageUrl("http://example.com/image.jpg");
item.setUpcType(PayPalLineItem.UPC_TYPE_2);
item.setUpcCode("upc-code");

JSONObject json = item.toJson();

Expand All @@ -29,6 +32,10 @@ public void toJson_setsKeysAndValues() throws JSONException {
assertEquals("abc-123", json.getString("product_code"));
assertEquals("1.50", json.getString("unit_tax_amount"));
assertEquals("http://example.com", json.getString("url"));
assertEquals("http://example.com/image.jpg", json.getString("image_url"));
assertEquals("UPC-2", json.getString("upc_type"));
assertEquals("upc-code", json.getString("upc_code"));
}

}