Skip to content

MPKitButton ported to Swift KitButton class #15

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

Open
omercadoperficient wants to merge 2 commits into
base: main
Choose a base branch
from
Open

MPKitButton ported to Swift KitButton class #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
376f428
MPKitButton ported to Swift KitButton class
omercadoperficient May 12, 2022
8c31d4b
Fix typo
omercadoperficient May 12, 2022
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
36 changes: 13 additions & 23 deletions mParticle-Button.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,10 @@
objects = {

/* Begin PBXBuildFile section */
DB0773DB1DB916610031F3E3 /* mParticle_Button.h in Headers */ = {isa = PBXBuildFile; fileRef = DB0773D91DB916610031F3E3 /* mParticle_Button.h */; settings = {ATTRIBUTES = (Public, ); }; };
DB0773E31DB916B80031F3E3 /* MPKitButton.h in Headers */ = {isa = PBXBuildFile; fileRef = DB0773E11DB916B80031F3E3 /* MPKitButton.h */; settings = {ATTRIBUTES = (Public, ); }; };
DB0773E41DB916B80031F3E3 /* MPKitButton.m in Sources */ = {isa = PBXBuildFile; fileRef = DB0773E21DB916B80031F3E3 /* MPKitButton.m */; };
83EE014A282CA8B4005F142B /* KitButton.swift in Sources */ = {isa = PBXBuildFile; fileRef = 83EE0149282CA8B4005F142B /* KitButton.swift */; };
83EE014C282D4D01005F142B /* mParticle-ButtonTests-Bridging-Header.h in Headers */ = {isa = PBXBuildFile; fileRef = 83EE014B282D4D01005F142B /* mParticle-ButtonTests-Bridging-Header.h */; };
DE811925214C4CF900AAC951 /* mParticle_Button.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = DB0773D61DB916610031F3E3 /* mParticle_Button.framework */; };
DE81192F214C4F5500AAC951 /* mParticle-ButtonTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = DE81192D214C4F5400AAC951 /* mParticle-ButtonTests.swift */; };
DEAA37222180E11800915875 /* MPKitButton+ButtonTests.m in Sources */ = {isa = PBXBuildFile; fileRef = DEAA37212180E11800915875 /* MPKitButton+ButtonTests.m */; };
/* End PBXBuildFile section */

/* Begin PBXContainerItemProxy section */
Expand All @@ -26,18 +24,14 @@
/* End PBXContainerItemProxy section */

/* Begin PBXFileReference section */
83EE0149282CA8B4005F142B /* KitButton.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = KitButton.swift; sourceTree = "<group>"; };
83EE014B282D4D01005F142B /* mParticle-ButtonTests-Bridging-Header.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = "mParticle-ButtonTests-Bridging-Header.h"; sourceTree = "<group>"; };
DB0773D61DB916610031F3E3 /* mParticle_Button.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = mParticle_Button.framework; sourceTree = BUILT_PRODUCTS_DIR; };
DB0773D91DB916610031F3E3 /* mParticle_Button.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = mParticle_Button.h; sourceTree = "<group>"; };
DB0773DA1DB916610031F3E3 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
DB0773E11DB916B80031F3E3 /* MPKitButton.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = MPKitButton.h; sourceTree = "<group>"; };
DB0773E21DB916B80031F3E3 /* MPKitButton.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = MPKitButton.m; sourceTree = "<group>"; };
DE0F93D12149694E00E0FF7F /* mParticle-Button.podspec */ = {isa = PBXFileReference; explicitFileType = text.script.ruby; path = "mParticle-Button.podspec"; sourceTree = "<group>"; xcLanguageSpecificationIdentifier = xcode.lang.ruby; };
DE811920214C4CF900AAC951 /* mParticle-ButtonTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = "mParticle-ButtonTests.xctest"; sourceTree = BUILT_PRODUCTS_DIR; };
DE81192D214C4F5400AAC951 /* mParticle-ButtonTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "mParticle-ButtonTests.swift"; sourceTree = "<group>"; };
DE81192E214C4F5400AAC951 /* Info.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
DEAA371F2180E11700915875 /* mParticle-ButtonTests-Bridging-Header.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "mParticle-ButtonTests-Bridging-Header.h"; sourceTree = "<group>"; };
DEAA37202180E11800915875 /* MPKitButton+ButtonTests.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "MPKitButton+ButtonTests.h"; sourceTree = "<group>"; };
DEAA37212180E11800915875 /* MPKitButton+ButtonTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = "MPKitButton+ButtonTests.m"; sourceTree = "<group>"; };
DEEEE6A3214C57BF006B5C06 /* ButtonMerchant.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = ButtonMerchant.framework; path = Carthage/Build/iOS/ButtonMerchant.framework; sourceTree = "<group>"; };
DEEEE6A4214C57CA006B5C06 /* mParticle_Apple_SDK.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = mParticle_Apple_SDK.framework; path = Carthage/Build/iOS/mParticle_Apple_SDK.framework; sourceTree = "<group>"; };
/* End PBXFileReference section */
Expand Down Expand Up @@ -93,10 +87,8 @@
DB0773D81DB916610031F3E3 /* mParticle-Button */ = {
isa = PBXGroup;
children = (
DB0773E11DB916B80031F3E3 /* MPKitButton.h */,
DB0773E21DB916B80031F3E3 /* MPKitButton.m */,
DB0773D91DB916610031F3E3 /* mParticle_Button.h */,
DB0773DA1DB916610031F3E3 /* Info.plist */,
83EE0149282CA8B4005F142B /* KitButton.swift */,
);
path = "mParticle-Button";
sourceTree = "<group>";
Expand All @@ -114,9 +106,7 @@
DEAA37232180E11F00915875 /* Helpers */ = {
isa = PBXGroup;
children = (
DEAA371F2180E11700915875 /* mParticle-ButtonTests-Bridging-Header.h */,
DEAA37202180E11800915875 /* MPKitButton+ButtonTests.h */,
DEAA37212180E11800915875 /* MPKitButton+ButtonTests.m */,
83EE014B282D4D01005F142B /* mParticle-ButtonTests-Bridging-Header.h */,
);
path = Helpers;
sourceTree = "<group>";
Expand All @@ -128,8 +118,7 @@
isa = PBXHeadersBuildPhase;
buildActionMask = 2147483647;
files = (
DB0773E31DB916B80031F3E3 /* MPKitButton.h in Headers */,
DB0773DB1DB916610031F3E3 /* mParticle_Button.h in Headers */,
83EE014C282D4D01005F142B /* mParticle-ButtonTests-Bridging-Header.h in Headers */,
);
runOnlyForDeploymentPostprocessing = 0;
};
Expand Down Expand Up @@ -187,7 +176,7 @@
DB0773D51DB916610031F3E3 = {
CreatedOnToolsVersion = 8.0;
DevelopmentTeam = 39F27QYP2C;
LastSwiftMigration = 0940;
LastSwiftMigration = 1300;
ProvisioningStyle = Automatic;
};
DE81191F214C4CF900AAC951 = {
Expand Down Expand Up @@ -274,7 +263,7 @@
isa = PBXSourcesBuildPhase;
buildActionMask = 2147483647;
files = (
DB0773E41DB916B80031F3E3 /* MPKitButton.m in Sources */,
83EE014A282CA8B4005F142B /* KitButton.swift in Sources */,
);
runOnlyForDeploymentPostprocessing = 0;
};
Expand All @@ -283,7 +272,6 @@
buildActionMask = 2147483647;
files = (
DE81192F214C4F5500AAC951 /* mParticle-ButtonTests.swift in Sources */,
DEAA37222180E11800915875 /* MPKitButton+ButtonTests.m in Sources */,
);
runOnlyForDeploymentPostprocessing = 0;
};
Expand Down Expand Up @@ -436,7 +424,7 @@
PROVISIONING_PROFILE_SPECIFIER = "";
SKIP_INSTALL = YES;
SWIFT_OPTIMIZATION_LEVEL = "-Onone";
SWIFT_VERSION = 3.0;
SWIFT_VERSION = 4.0;
};
name = Debug;
};
Expand All @@ -463,13 +451,14 @@
PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)";
PROVISIONING_PROFILE_SPECIFIER = "";
SKIP_INSTALL = YES;
SWIFT_VERSION = 3.0;
SWIFT_VERSION = 4.0;
};
name = Release;
};
DE811929214C4CF900AAC951 /* Debug */ = {
isa = XCBuildConfiguration;
buildSettings = {
ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES = YES;
CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE;
CLANG_CXX_LANGUAGE_STANDARD = "gnu++14";
CLANG_ENABLE_MODULES = YES;
Expand Down Expand Up @@ -500,6 +489,7 @@
DE81192A214C4CF900AAC951 /* Release */ = {
isa = XCBuildConfiguration;
buildSettings = {
ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES = YES;
CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE;
CLANG_CXX_LANGUAGE_STANDARD = "gnu++14";
CLANG_ENABLE_MODULES = YES;
Expand Down
173 changes: 173 additions & 0 deletions mParticle-Button/KitButton.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,173 @@
//
// KitButton.swift
// mParticle-Button
//
// Created by Osvaldo Rafael Mercado Espinel on 11/05/22.
// Copyright © 2022 mParticle. All rights reserved.
//

import Foundation
import mParticle_Apple_SDK
import ButtonMerchant

public class MPIButton {

public var attributionToken = {
return ButtonMerchant.attributionToken
}()
}

public let BTNMPKitVersion = "2.0.0"

public let BTNReferrerTokenDefaultsKey = "com.usebutton.referrer"
public let BTNLinkFetchStatusDefaultsKey = "com.usebutton.link.fetched"

public let MPKitButtonAttributionResultKey = "mParticle-Button Attribution Result"
public let BTNPostInstallURLKey = "BTNPostInstallURLKey"

public let MPKitButtonErrorDomain = "com.mparticle.kits.button"
public let MPKitButtonErrorMessageKey = "mParticle-Button Error"
public let MPKitButtonIntegrationAttribution = "com.usebutton.source_token"

@objc(MPKitButton)
public class KitButton: NSObject, MPKitProtocol {

public var mParticleInstance: MParticle! = MParticle.sharedInstance()
var button: MPIButton!
var applicationId: String?
public var defaultCenter: NotificationCenter! = NotificationCenter.default
public var started: Bool = false
var configuration: [AnyHashable : Any] = [:]

public var kitApi: MPKitAPI?

public var providerKitInstance: Any? {
return started ? button : nil
}

public static func kitCode() -> NSNumber {
return 1022
}

public override init() {
super.init()
let kitRegister = MPKitRegister(name: "Button", className: self.description)

MParticle.registerExtension(kitRegister!)
}

func trackIncomingURL(url: URL) {
ButtonMerchant.trackIncomingURL(url)
}

public func didFinishLaunching(withConfiguration configuration: [AnyHashable : Any]) -> MPKitExecStatus {
var execStatus: MPKitExecStatus!

self.button = MPIButton()
self.applicationId = configuration["application_id"] as? String

guard let applicationId = self.applicationId else {
execStatus = MPKitExecStatus(sdkCode: KitButton.kitCode(), returnCode: .requirementsNotMet)
return execStatus
}

ButtonMerchant.configure(applicationId: applicationId)

self.defaultCenter.addObserver(self, selector: #selector(observeAttributionTokenDidChangeNotification(_:)), name: ButtonMerchant.AttributionTokenDidChangeNotification as NSNotification.Name, object: nil)

self.configuration = configuration
self.started = true

DispatchQueue.main.async {
let userInfo = [mParticleKitInstanceKey: KitButton.kitCode()]
NotificationCenter.default.post(name: .mParticleKitDidBecomeActive, object: nil, userInfo: userInfo)
self.checkForAttribution()
}

execStatus = MPKitExecStatus(sdkCode: KitButton.kitCode(), returnCode: .success)
return execStatus
}

public func open(_ url: URL, options: [String : Any]? = nil) -> MPKitExecStatus {
self.trackIncomingURL(url: url)
return MPKitExecStatus(sdkCode: KitButton.kitCode(), returnCode: .success)
}

public func open(_ url: URL, sourceApplication: String?, annotation: Any?) -> MPKitExecStatus {
self.trackIncomingURL(url: url)
return MPKitExecStatus(sdkCode: KitButton.kitCode(), returnCode: .success)
}

public func `continue`(_ userActivity: NSUserActivity, restorationHandler: @escaping ([Any]?) -> Void) -> MPKitExecStatus {
guard let url = userActivity.webpageURL else { return MPKitExecStatus() }
self.trackIncomingURL(url: url)
return MPKitExecStatus(sdkCode: KitButton.kitCode(), returnCode: .success)
}

public func logBaseEvent(_ event: MPBaseEvent) -> MPKitExecStatus {
guard let event = event as? MPCommerceEvent else {
return MPKitExecStatus(sdkCode: KitButton.kitCode(), returnCode: .unavailable)
}

var code: MPKitReturnCode = .unavailable
let products = self.buttonProducts(from: event.products)

switch (event.action) {
case .viewDetail:
ButtonMerchant.activity.productViewed(products.first)
code = .success
case .addToCart:
ButtonMerchant.activity.productAddedToCart(products.first)
code = .success
case .checkout:
ButtonMerchant.activity.cartViewed(products)
code = .success
default: break
}

return MPKitExecStatus(sdkCode: KitButton.kitCode(), returnCode: code)
}

private func error(with message: String) -> NSError {
let error = NSError(domain: MPKitButtonErrorDomain, code: 0, userInfo: [MPKitButtonErrorMessageKey: message])
return error
}

private func checkForAttribution() {
ButtonMerchant.handlePostInstallURL { postInstallURL, error in
if error != nil || postInstallURL == nil {
let attributionError = self.error(with: "No attribution information available.")
self.kitApi?.onAttributionComplete(with: nil, error: attributionError)
}

let linkInfo = [ BTNPostInstallURLKey: postInstallURL?.absoluteString ?? "" ]
let attributionResult = MPAttributionResult()
attributionResult.linkInfo = linkInfo

}
}

@objc
private func observeAttributionTokenDidChangeNotification(_ note: NSNotification) {
if let attributionToken = note.userInfo?[ButtonMerchant.AttributionTokenKey] as? String {
let integrationAttributes = [MPKitButtonIntegrationAttribution: attributionToken]
self.mParticleInstance.setIntegrationAttributes(integrationAttributes, forKit: KitButton.kitCode())
}
}

private func buttonProducts(from products: [MPProduct]?) -> [ButtonProduct] {
return products?.map {
let buttonProduct = ButtonProduct()
buttonProduct.name = $0.name
buttonProduct.id = $0.sku
buttonProduct.value = Int(($0.price?.doubleValue ?? 0) * 100)
buttonProduct.quantity = $0.quantity.intValue
if let category = $0.category {
buttonProduct.categories = [category]
}
buttonProduct.attributes = ["btn_product_count": "\(products?.count ?? 0)"]
return buttonProduct
} ?? []
}

}
34 changes: 0 additions & 34 deletions mParticle-Button/MPKitButton.h
View file
Open in desktop

This file was deleted.

Loading