Add capabilities to block address ranges and use a blocking cookie

OliverO2 commented 7 years ago

This pull request adds the following capabilities:

Blacklist IPv4 address ranges (useful for testing sites in private networks without triggering GA)
Block tracking via a cookie (useful for testing public sites without triggering GA via a browser-based setting). Such a blocking cookie can be administered using this Gist: https://gist.github.com/OliverO2/07200c36dd5100f60b3834b3d4046b18

It also contains the following changes:

It updates Google's 'ga' function to use https (as currently suggested by Google).
It corrects the .editorconfig according to http://editorconfig.org/ (otherwise IntelliJ IDEA won't recognize it).

escopecz commented 7 years ago

Looks good to me 👍

OliverO2 commented 7 years ago

Thanks to both of you for looking at this pull request so quickly!

@cworreschk Here are my reasons for using a blocking cookie:

When a site is published on its production web server, normal users can access it and their usage should be tracked by GA. However, at the same time I still want to be able to test such a published site without these tests being tracked. If I'd disable the plugin, I'd disable tracking for everyone. So I set the blocking cookie only on my browsers for testing.
I'd like tests to behave as closely as possible to the production site's behavior. Changing the site's configuration on a production server (turning off the plugin) for testing would deviate from that goal.
In my tests, I generally review the generated HTML source. That's why I've also implemented documenting the reason for blocking as a JS comment instead of an HTML comment. The JS comment is as close as possible to actually inserting the GA script.
Another case for using a blocking cookie would be to implement a site-specific "do not track" option for users, for example as part of a cookie banner.

Hope this helps. I'll take care of the blueprint stuff and will amend the pull request appropriately.

OliverO2 commented 7 years ago

Two months have passed since this PR was approved. Any plans on merging this and releasing a new version?

escopecz / grav-ganalytics