WIP

Author: mikebronner

.gitattributes

@@ -0,0 +1,13 @@
+* text=auto
+
+/.github export-ignore
+/.gitattributes export-ignore
+/.gitignore export-ignore
+/.scrutinizer.yml export-ignore
+/.travis.yml export-ignore
+/phpunit.xml export-ignore
+/tests export-ignore
+/webpack.mix.js export-ignore
+/yarn.lock export-ignore
+/qa-checklist.md export-ignore
+/package.json export-ignore

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: [mikebronner]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.gitignore

@@ -0,0 +1,6 @@
+composer.lock
+/vendor
+/node_modules
+yarn.lock
+.phpunit.result.cache
+package-lock.json

.scrutinizer.yml

@@ -0,0 +1,5 @@
+filter:
+    excluded_paths:
+        - "public/"
+        - "tests/"
+        - "resources/assets/js/mixpanel.js"

.travis.yml

@@ -0,0 +1,25 @@
+language: php
+
+php:
+    - 7.2.5
+    - 7.3
+    - 7.4
+
+before_script:
+    - travis_retry composer self-update
+    - travis_retry composer install --no-interaction --prefer-source --dev
+
+script:
+    - mkdir -p ./build/logs
+    - ./vendor/bin/phpunit --coverage-text --coverage-clover ./build/logs/clover.xml
+
+after_success:
+    - travis_retry php vendor/bin/php-coveralls -v
+
+notifications:
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/30886f28c25b1e31088f
+    on_success: change  # options: [always|never|change] default: always
+    on_failure: always  # options: [always|never|change] default: always
+    on_start: never     # options: [always|never|change] default: always

CHANGELOG.md

@@ -0,0 +1,240 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## TODO
+- http://phppackagechecklist.com/#1,2,3,4,5,6,9,10,11,12,13,14
+  Complete check list items.
+- Detect through subscription create when a user had previously unsubscribed (churn), then resubscribes (unchurn).
+(This is already detected in subscription update.)
+- Filter any incoming web-hook events that are in test mode.
+
+## [0.10.3] - 2020-08-05
+### Added
+- configuration option for MixPanel Host.
+
+## [0.10.1] - 2020-03-04
+### Updated
+- Laravel dependency to release version.
+
+## [0.10.0] - 2020-02-29
+### Added
+- Laravel 7 compatibility.
+
+## [0.9.1] - 2019-10-18
+### Added
+- functionality to inject custom data points into track events.
+
+### Fixed
+- Laravel 6.x compatibility.
+
+## [0.9.0] - 2019-08-28
+### Added
+- Laravel 6.0 compatibility.
+
+## [0.8.1] - 2019-07-28
+### Fixed
+- tracking of user information.
+
+## [0.8.0] - 2019-04-05
+### Added
+- Laravel 5.8 compatibility.
+
+## [0.7.11] - 5 Oct 2018
+### Added
+- Laravel 5.7 compatibility.
+
+### Fixed
+- Stripe API compatibility.
+- disabling of default tracking.
+
+## [0.7.4] - 7 Jan 2018
+### Added
+- Laravel 5.6 compatibility.
+
+## [0.7.4] - 7 Jan 2018
+### Added
+- `Mixpanel::xxx()` facade.
+- `thanks` package as dev-dependency, as well as pretty phpunit printer package.
+
+## [0.7.3] - 5 Nov 2017
+### Added
+- initial integration tests.
+
+### Changed
+- class structure as part of refactoring.
+
+## [0.7.2] - 5 Nov 2017
+### Fixed
+- inclusion of auto-track JS scripts. NPM library is broken and seems to not be maintained anymore, switched to script provided by mixpanel setup instructions.
+
+## [0.7.1] - 18 Oct 2017
+### Updated
+- user model listener to not fail if timestamps are turned off.
+
+### Added
+- basic configuration in preparation for unit tests and code quality analysis.
+
+## [0.7.0] - 31 Aug 2017
+### Added
+- compatibility with Laravel 5.5.
+- auto-detection of package's service provider for automatic installation.
+- Console error to warn of missing ENV variable.
+
+### Updated
+- README with L5.5 particulars.
+- CHANGELOG with new entries.
+
+## [0.5.3] - 4 Apr 2016
+### Added
+- configuration setting to disable the default-bundled tracking hooks.
+
+## [0.5.2] - 16 Jan 2016
+### Fixed
+- event listeners to properly detect new laravel 5.2 events.
+
+## [0.5.1] - 11 Jan 2016
+### Fixed
+- event listener to work with Laravel 5.2 core events.
+
+## [0.4.10 - 0.4.12] - 28 Oct 2015
+### Added
+- tracking of robots, if a browser isn't detected, and it is confirmed as a robot.
+
+### Fixed
+- incorrect usage of array_filter, causing empty strings to be passed.
+
+### Changed
+- reverted from using getAttribute(), as it is redundant.
+- refactored `track()` method to track: Url, Operating System, Hardware, Browser, Referring Domain, IP (For GeoLocation)
+
+### Removed
+- any "unknown" values from being passed.
+
+## [0.4.7 - 0.4.8] - 25 Oct 2015
+### Changed
+- referenced to user model properties to use `getAttribute()` instead of referencing them directly.
+
+### Added
+- tracking of `name` in addition to `first name` and `last name`.
+- tracking of `referrer` and `referring domain` to help get additional information for Live View (may not yet work
+  fully).
+
+### Fixed
+- improper tracking of user details, which caused users' names to be blank and a `0 Object [object]` field to be tracked
+  erroneously.
+- fixed tracking to not depend on `$user->id` when referencing the primary key, but pulling it dynamically instead.
+
+## [0.4.6] - 25 Sep 2015
+### Fixed
+- documentation references to old Mixpanel class.
+- usage of first_name and last_name attributes on User classes that don't have them.
+
+## [0.4.5] - 24 Sep 2015
+### Fixed
+- Exception if no `$user->created_at` attribute exists.
+
+## [0.4.0 - 0.4.4] - 13 Sep 2015
+### Fixed
+- FQCN references in event handler.
+- namespace for controller in routes file.
+- namespace for service provider.
+- path to routes file.
+
+### Changed
+- Move to new repository, change namespace.
+- Change referer detection.
+
+## [0.3.12 - 0.3.13] - 2015-06-18
+### Added
+- Identify user when tracking Page View if logged in.
+- Update "Last Seen" timestamp when logged-in user views a page.
+
+## [0.3.1 - 0.3.11] - 2015-06-17
+### Added
+- Referrer is now also recorded in Page View tracks.
+
+### Removed
+- Temporarily disabled alias() until its purpose and usefulness is better assessed.
+
+### Changed
+- Namespace HTTP/Controllers changed to Http/Controllers.
+- Fixed method to detect current URL.
+
+### Fixed
+- Attempt at fixing client IP detection.
+- PHP version requirement updated to >5.5.
+- Fix namespace and path references.
+- Fix URL and Route detection for 'Page View' tracking.
+- Fixed detection of Page View elements to only be added if they exist.
+
+## [0.3.0] - 2015-06-16
+### Changed
+- Upgraded to Laravel 5.1
+
+### Added
+- Page View tracking.
+- MixPanel alias() on registration to enabled proper funneling.
+
+## [0.2.13] - 2015-06-10
+### Added
+- Ignore transfer transactions.
+
+## [0.2.11 - 0.2.12] - 2015-06-09
+### Added
+- Additional check to detect stripe customer number.
+- Tightened sanity checks on subscription user detection.
+
+## [0.2.10] - 2015-06-06
+### Fixed
+- Extracted logic to get stripe customer id and throw exception if not found.
+
+## [0.2.8 - 0.2.9] - 2015-06-05
+### Fixed
+- Fixed logic error in customer ID parsing.
+
+## [0.2.7] - 2015-06-04
+### Fixed
+- Refactored subscription update functionality to be a little more robust. Testing all aspects of this has proven
+difficult, as Stripes webhook tests don't account for all variations possible in a given webhook request type.
+
+## [0.2.6] - 2015-06-03
+### Changed
+- Added FromPlan and ToPlan when tracking subscription changes.
+
+### Fixed
+- Subscription updates check for previous subscription information, as not all subscription changes have it.
+
+## [0.2.5] - 2015-06-2
+### Fixed
+- Checked for existence of user when logging out before identifying with MixPanel.
+
+## [0.1.6 - 0.2.4] - 2015-05-30
+### Added
+- Webhook for tracking Stripe events.
+- Documented MixPanel events in README.
+
+### Fixed
+- Sanitize People data before setting it, so that values don't get erased if something is not set.
+- Fix method parameters.
+- Track client IP address.
+- Ignore charge updates.
+- Formatting of non-existent dates during profile setting.
+- Detection of stripe customer id in webhook.
+
+## [0.1.0 - 0.1.4] - 2015-05-30
+### Changed
+- Updated `composer.json` details.
+- Updated README details.
+- Renamed events to model the formula <what + action>, i.e. "Login Succeeded" or "Page Viewed".
+
+### Fixed
+- Update profile information if not set (i.e. for prior existing users).
+- Log signup date as string, not as object.
+- Name detection on user model.
+
+### Added
+- Initial package development.
+- User observer.
+- User events handler.
+- DocBlocks.

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,35 @@
+# How to contribute
+We welcome everyone to submit pull requests with:
+- fixes for issues
+- change suggestions
+- updateing of documentation
+
+However, not every pull request will automatically be accepted. I will review each carefully to make sure it is in line with
+ the direction I want the package to continue in. This might mean that some pull requests are not accepted, or might stay
+ unmerged until a place for them can be determined.
+
+## Testing
+- [ ] After making your changes, make sure the tests still pass.
+- [ ] When adding new functionality, also add new tests.
+- [ ] When fixing errors write and satisfy new unit tests that replicate the issue.
+- [ ] Make sure there are no build errors on our CI server (https://ci.genealabs.com/build-status/view/11)
+- [ ] All code must past PHPCS and PHPMD PSR2 validation.
+
+## Submitting changes
+When submitting a pull request, it is important to make sure to complete the following:
+- [ ] Add a descriptive header that explains in a single sentence what problem the PR solves.
+- [ ] Add a detailed description with animated screen-grab GIFs visualizing how it works.
+- [ ] Explain why you think it should be implemented one way vs. another, highlight performance improvements, etc.
+
+## Coding conventions
+Start reading our code and you'll get the hang of it. We optimize for readability:
+- indent using four spaces (soft tabs)
+- use Blade for all views
+- avoid logic in views, put it in controllers or service classes
+- ALWAYS put spaces after list items and method parameters (`[1, 2, 3]`, not `[1,2,3]`), around operators (`x += 1`, not `x+=1`), and around hash arrows.
+- this is open source software. Consider the people who will read your code, and make it look nice for them. It's sort of like driving a car: Perhaps you love doing donuts when you're alone, but with passengers the goal is to make the ride as smooth as possible.
+- emphasis readability of code over patterns to reduce mental debt
+- always add an empty line around structures (if statements, loops, etc.)
+
+Thanks!
+Mike Bronner, GeneaLabs