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

Shopper Insights - Update sendSelected Events #1486

Merged
merged 10 commits into from
Dec 20, 2024
Merged

Shopper Insights - Update sendSelected Events #1486

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
4b4579d
Added BTButtonType enum and `sendSelectedEvent()`
stechiu Dec 14, 2024
8ea62ea
Updated unit tests
stechiu Dec 14, 2024
7f41732
Addressed PR comments
stechiu Dec 16, 2024
c2bb71f
Merge branch 'shopper-insights-rp2-feature' into shopper-insights-rp2…
stechiu Dec 16, 2024
9e1a125
Fixed unit tests
stechiu Dec 17, 2024
2e56774
Merge branch 'shopper-insights-rp1-feature' of https://github.com/bra…
stechiu Dec 17, 2024
4fa49cf
Fixed failing unit test
stechiu Dec 17, 2024
ae46697
Removed unnecessary unit tests
stechiu Dec 17, 2024
0b9e0d4
Merge branch 'shopper-insights-rp2-feature' into shopper-insights-rp2…
jaxdesmarais Dec 20, 2024
871d01f
add parameters to docstring for presented event
jaxdesmarais Dec 20, 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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
* `experimentType`
* `pageType`
* `buttonOrder`
* Replace `sendPayPalSelectedEvent()` and `sendPayPalSelectedEvent()` with `sendSelectedEvent(for:)`

## 6.25.0 (2024-12-11)
* BraintreePayPal
Expand Down
4 changes: 2 additions & 2 deletions Demo/Application/Features/ShopperInsightsViewController.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ class ShopperInsightsViewController: PaymentButtonBaseViewController {

@objc func payPalVaultButtonTapped(_ button: UIButton) {
progressBlock("Tapped PayPal Vault")
shopperInsightsClient.sendPayPalSelectedEvent()
shopperInsightsClient.sendSelectedEvent(for: .payPal)

button.setTitle("Processing...", for: .disabled)
button.isEnabled = false
Expand All @@ -157,7 +157,7 @@ class ShopperInsightsViewController: PaymentButtonBaseViewController {

@objc func venmoButtonTapped(_ button: UIButton) {
progressBlock("Tapped Venmo")
shopperInsightsClient.sendVenmoSelectedEvent()
shopperInsightsClient.sendSelectedEvent(for: .venmo)

button.setTitle("Processing...", for: .disabled)
button.isEnabled = false
Expand Down
8 changes: 3 additions & 5 deletions Sources/BraintreeShopperInsights/BTShopperInsightsAnalytics.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,10 @@ import Foundation
enum BTShopperInsightsAnalytics {

// MARK: - Merchant Triggered Events

static let payPalSelected = "shopper-insights:paypal-selected"
static let venmoSelected = "shopper-insights:venmo-selected"


static let buttonPresented = "shopper-insights:button-presented"

static let buttonSelected = "shopper-insights:button-selected"

// MARK: - SDK Triggered Events

static let recommendedPaymentsStarted = "shopper-insights:get-recommended-payments:started"
Expand Down
19 changes: 9 additions & 10 deletions Sources/BraintreeShopperInsights/BTShopperInsightsClient.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,17 +106,16 @@ public class BTShopperInsightsClient {
shopperSessionID: shopperSessionID
)
}

/// Call this method when the PayPal button has been selected/tapped by the buyer.
/// This method sends analytics to help improve the Shopper Insights feature experience
public func sendPayPalSelectedEvent() {
apiClient.sendAnalyticsEvent(BTShopperInsightsAnalytics.payPalSelected, shopperSessionID: shopperSessionID)
}

/// Call this method when the Venmo button has been selected/tapped by the buyer.
/// This method sends analytics to help improve the Shopper Insights feature experience
public func sendVenmoSelectedEvent() {
apiClient.sendAnalyticsEvent(BTShopperInsightsAnalytics.venmoSelected, shopperSessionID: shopperSessionID)
/// Call this method when a button has been selected/tapped by the buyer.
/// This method sends analytics to help improve the Shopper Insights feature experience.
/// - Parameter buttonType: Type of button presented - PayPal, Venmo, or Other
public func sendSelectedEvent(for buttonType: BTButtonType) {
apiClient.sendAnalyticsEvent(
BTShopperInsightsAnalytics.buttonSelected,
buttonType: buttonType.rawValue,
shopperSessionID: shopperSessionID
)
}

/// Indicates whether the PayPal App is installed.
Expand Down
4 changes: 1 addition & 3 deletions UnitTests/BraintreeShopperInsightsTests/BTShopperInsightsAnalytics_Tests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@ final class BTShopperInsightsAnalytics_Tests: XCTestCase {

func test_recommendedPaymentAnalyticEvents_sendExpectedEventNames() {
XCTAssertEqual(BTShopperInsightsAnalytics.buttonPresented, "shopper-insights:button-presented")
XCTAssertEqual(BTShopperInsightsAnalytics.payPalSelected, "shopper-insights:paypal-selected")
XCTAssertEqual(BTShopperInsightsAnalytics.buttonPresented, "shopper-insights:button-presented")
XCTAssertEqual(BTShopperInsightsAnalytics.venmoSelected, "shopper-insights:venmo-selected")
XCTAssertEqual(BTShopperInsightsAnalytics.buttonSelected, "shopper-insights:button-selected")
XCTAssertEqual(BTShopperInsightsAnalytics.recommendedPaymentsStarted, "shopper-insights:get-recommended-payments:started")
XCTAssertEqual(BTShopperInsightsAnalytics.recommendedPaymentsSucceeded, "shopper-insights:get-recommended-payments:succeeded")
XCTAssertEqual(BTShopperInsightsAnalytics.recommendedPaymentsFailed, "shopper-insights:get-recommended-payments:failed")
Expand Down
14 changes: 8 additions & 6 deletions UnitTests/BraintreeShopperInsightsTests/BTShopperInsightsClient_Tests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ class BTShopperInsightsClient_Tests: XCTestCase {
}

func testGetRecommendedPaymentMethods_withTokenizationKey_returnsError() async {
var apiClient = BTAPIClient(authorization: "sandbox_merchant_1234567890abc")!
let apiClient = BTAPIClient(authorization: "sandbox_merchant_1234567890abc")!
let shopperInsightsClient = BTShopperInsightsClient(apiClient: apiClient)

do {
Expand Down Expand Up @@ -243,11 +243,12 @@ class BTShopperInsightsClient_Tests: XCTestCase {
}

func testSendPayPalSelectedEvent_sendsAnalytic() {
sut.sendPayPalSelectedEvent()
XCTAssertEqual(mockAPIClient.postedAnalyticsEvents.first, "shopper-insights:paypal-selected")
sut.sendSelectedEvent(for: .payPal)
stechiu marked this conversation as resolved.
Show resolved Hide resolved
XCTAssertEqual(mockAPIClient.postedAnalyticsEvents.first, "shopper-insights:button-selected")
XCTAssertEqual(mockAPIClient.postedShopperSessionID, "fake-shopper-session-id")
XCTAssertEqual(mockAPIClient.postedButtonType, "PayPal")
}

func testSendVenmoPresentedEvent_sendsAnalytic() {
let presentmentDetails = BTPresentmentDetails(
buttonOrder: .first,
Expand Down Expand Up @@ -285,8 +286,9 @@ class BTShopperInsightsClient_Tests: XCTestCase {
}

func testSendVenmoSelectedEvent_sendsAnalytic() {
sut.sendVenmoSelectedEvent()
XCTAssertEqual(mockAPIClient.postedAnalyticsEvents.first, "shopper-insights:venmo-selected")
sut.sendSelectedEvent(for: .venmo)
XCTAssertEqual(mockAPIClient.postedAnalyticsEvents.first, "shopper-insights:button-selected")
XCTAssertEqual(mockAPIClient.postedButtonType, "Venmo")
XCTAssertEqual(mockAPIClient.postedShopperSessionID, "fake-shopper-session-id")
}

Expand Down
2 changes: 1 addition & 1 deletion UnitTests/BraintreeTestShared/MockAPIClient.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ public class MockAPIClient: BTAPIClient {
public var lastGETParameters = [:] as [String: Any]?
public var lastGETAPIClientHTTPType: BTAPIClientHTTPService?

public var postedAnalyticsEvents : [String] = []
public var postedAnalyticsEvents: [String] = []
public var postedAppSwitchURL: [String: String?] = [:]
public var postedButtonOrder: String? = nil
public var postedButtonType: String? = nil
Expand Down