{"id":27296871,"url":"https://github.com/lengocduy/dlanalytics","last_synced_at":"2025-04-11T23:52:08.439Z","repository":{"id":46691083,"uuid":"281615989","full_name":"lengocduy/DLAnalytics","owner":"lengocduy","description":"Unify and modularize abstract Analytics framework written in Swift","archived":false,"fork":false,"pushed_at":"2021-09-29T18:54:50.000Z","size":993,"stargazers_count":3,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-11T23:52:02.712Z","etag":null,"topics":["analytics","improvement","logging","strategic-planning","tracking","ux-ui"],"latest_commit_sha":null,"homepage":"https://lengocduy.github.io/DLAnalytics/","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lengocduy.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-07-22T08:09:48.000Z","updated_at":"2022-10-26T16:05:11.000Z","dependencies_parsed_at":"2022-09-13T14:12:46.103Z","dependency_job_id":null,"html_url":"https://github.com/lengocduy/DLAnalytics","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lengocduy%2FDLAnalytics","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lengocduy%2FDLAnalytics/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lengocduy%2FDLAnalytics/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lengocduy%2FDLAnalytics/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lengocduy","download_url":"https://codeload.github.com/lengocduy/DLAnalytics/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248497859,"owners_count":21113984,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["analytics","improvement","logging","strategic-planning","tracking","ux-ui"],"created_at":"2025-04-11T23:52:07.693Z","updated_at":"2025-04-11T23:52:08.418Z","avatar_url":"https://github.com/lengocduy.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DLAnalytics\n\n![CI](https://github.com/lengocduy/DLAnalytics/workflows/CI/badge.svg)\n[![Version](https://img.shields.io/cocoapods/v/DLAnalytics.svg?style=flat)](http://cocoapods.org/pods/DLAnalytics)\n[![License](https://img.shields.io/cocoapods/l/DLAnalytics.svg?style=flat)](http://cocoapods.org/pods/DLAnalytics)\n[![Platform](https://img.shields.io/cocoapods/p/DLAnalytics.svg?style=flat)](http://cocoapods.org/pods/DLAnalytics)\n[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)\n\nAbstract Analytics Framework supports:\n\n- Unify Analytics.\n- Modularize, Centralize Analytics.\n- Plugin the new Analytics easier.\n- Standadize tracking method and event.\n\n## Requirements\n\n- Xcode 12+\n- Swift 5.0+\n\n## How\n\n### Setup\n\n1. Implement your AnalyticsService.\n\n```\nclass ClientAnalyticsImpl: AnalyticsService {\n    // Specify whitelist events. Accept all events by default\n    var allowEvents: Set\u003cString\u003e {\n\t\tSet\u003cString\u003e(arrayLiteral: \"\\(InputOTPEvent.self)\", \"\\(CheckoutEvent.self)\")\n\t}\n    \n    func setUserIdentifyProperty(_ property: [String : String]) {\n\t\t// To support identify the user\"\n\t}\n    \n    func reset() {\n\t\t// reset all data related to the user e.g user logout\"\n\t}\n\n\tfunc send(event: AnalyticsEvent) {\n        // Specific Analytics implementation e.g FireBaseAnalytics, MixPanel, etc.\n\t\tprint(\"### Send an event name: \\(event.name), payload = \\(event.payload)\")\n\t}\n\n    func send(event: AnalyticsEvent, from viewController: DLAnalytics.ViewController) {\n\t\tprint(\"### Send an event name:  \\(event.name), controller = \\(ViewController.self)\" )\n\t}\n}\n```\n\n2. Declare your custom event.\n\n```\n// MARK: - Support dynamic configurable payload for an event\nstruct InputOTPEvent: AnalyticsEvent {\n    private(set) var payload: [String: String]\n    \n    var name: String {\n        return \"InputOTP\"\n    }\n\n    static func inputOTPSuccess() -\u003e InputOTPEvent {\n        return InputOTPEvent(payload: [\"OTPValid\": \"1\"])\n    }\n}\n\n// MARK: - Enum support static configurable payload for an event\n@frozen\nenum CheckoutEvent: String, AnalyticsEvent {\n    case success = \"Checkout_Success\"\n    case error = \"Checkout_Error\"\n\n    internal var payload: [String: Any] {\n        return [:]\n    }\n\n    var name: String {\n        return rawValue\n    }\n}\n```\n\n3. Register your custom AnalyticsService.\n\n```\nlet analyticsService = ClientAnalyticsImpl()\nAnalytics.registerAnalyticsService(analyticsService)\n```\n\n### Use\n\n```\n/// Simulate tracking event InputOTP success\nAnalytics.send(event: InputOTPEvent.inputOTPSuccess())\nAnalytics.send(event: CheckoutEvent.success, from viewController: checkoutVC)\n\n/// Output:\nSend an event name: InputOTP, payload = [\"OTPValid\": \"1\"]\nSend an event name: Checkout_Success, controller = CheckoutViewController\n```\n\n## Installation\n\nThere are three ways to install `DLAnalytics`\n\n### CocoaPods\n\nJust add to your project's `Podfile`:\n\n```\npod 'DLAnalytics', '~\u003e 2.1'\n```\n\n### Carthage\n\nAdd following to `Cartfile`:\n\n```\ngithub \"lengocduy/DLAnalytics\" ~\u003e 2.1\n```\n\n- To building platform-independent xcframeworks Xcode 12 and above [here](https://github.com/Carthage/Carthage#building-platform-independent-xcframeworks-xcode-12-and-above)\n- To migrating from framework bundles to xcframework [here](https://github.com/Carthage/Carthage#migrating-a-project-from-framework-bundles-to-xcframeworks)\n\n### Swift Package Manager\n\nCreate a `Package.swift` file:\n\n```\n// swift-tools-version:5.0\n\nimport PackageDescription\n\nlet package = Package(\n        name: \"TestDLAnalytics\",\n\n        dependencies: [\n            .package(url: \"https://github.com/lengocduy/DLAnalytics.git\", from: \"2.1.0\"),\n        ],\n\n        targets: [\n            .target(\n                    name: \"TestDLAnalytics\",\n                    dependencies: [\"DLAnalytics\"])\n        ]\n)\n\n```\n\n## Architecture\n\n![Architecture](ArchDiagram.png)\n\n## Interaction Flow\n\n![Interaction Flow](InteractionFlow.png)\n\n## License\n\nDLAnalytics is available under the MIT license. See the [LICENSE](LICENSE) file for more info.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flengocduy%2Fdlanalytics","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flengocduy%2Fdlanalytics","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flengocduy%2Fdlanalytics/lists"}