Initial Commit v1.0.0

.editorconfig

@@ -0,0 +1,15 @@
+; This file is for unifying the coding style for different editors and IDEs.
+; More information at http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_size = 4
+indent_style = space
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

.gitattributes

@@ -0,0 +1,12 @@
+# Path-based git attributes
+# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
+
+# Ignore all test and documentation with "export-ignore".
+/.gitattributes     export-ignore
+/.gitignore         export-ignore
+/.travis.yml        export-ignore
+/.styleci.yml       export-ignore
+/phpunit.xml.dist   export-ignore
+/.scrutinizer.yml   export-ignore
+/tests              export-ignore
+/.editorconfig      export-ignore

.gitignore

@@ -0,0 +1,5 @@
+build
+composer.lock
+docs
+vendor
+coverage

.scrutinizer.yml

@@ -0,0 +1,19 @@
+filter:
+    excluded_paths: [tests/*]
+
+checks:
+    php:
+        remove_extra_empty_lines: true
+        remove_php_closing_tag: true
+        remove_trailing_whitespace: true
+        fix_use_statements:
+            remove_unused: true
+            preserve_multiple: false
+            preserve_blanklines: true
+            order_alphabetically: true
+        fix_php_opening_tag: true
+        fix_linefeed: true
+        fix_line_ending: true
+        fix_identation_4spaces: true
+        fix_doc_comments: true
+

.styleci.yml

@@ -0,0 +1,4 @@
+preset: laravel
+
+disabled:
+  - single_class_element_per_statement

.travis.yml

@@ -0,0 +1,21 @@
+language: php
+
+php:
+  - 7.1
+  - 7.2
+  - 7.3
+
+env:
+  matrix:
+    - COMPOSER_FLAGS="--prefer-lowest"
+    - COMPOSER_FLAGS=""
+
+before_script:
+  - travis_retry composer self-update
+  - travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-source
+
+script:
+  - vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover
+
+after_script:
+  - php vendor/bin/ocular code-coverage:upload --format=php-clover coverage.clover

CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+All notable changes to `laravel-cookie-consent` will be documented in this file
+
+## 1.0.0 - 2019-10-31
+
+- Initial release

CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contributing
+
+Contributions are **welcome** and will be fully **credited**.
+
+Please read and understand the contribution guide before creating an issue or pull request.
+
+## Etiquette
+
+This project is open source, and as such, the maintainers give their free time to build and maintain the source code
+held within. They make the code freely available in the hope that it will be of use to other developers. It would be
+extremely unfair for them to suffer abuse or anger for their hard work.
+
+Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
+world that developers are civilized and selfless people.
+
+It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
+quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
+
+## Viability
+
+When requesting or submitting new features, first consider whether it might be useful to others. Open
+source projects are used by many developers, who may have entirely different needs to your own. Think about
+whether or not your feature is likely to be used by other users of the project.
+
+## Procedure
+
+Before filing an issue:
+
+- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
+- Check to make sure your feature suggestion isn't already present within the project.
+- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
+- Check the pull requests tab to ensure that the feature isn't already in progress.
+
+Before submitting a pull request:
+
+- Check the codebase to ensure that your feature doesn't already exist.
+- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
+
+## Requirements
+
+If the project maintainer has any additional requirements, you will find them listed here.
+
+- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](https://pear.php.net/package/PHP_CodeSniffer).
+
+- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
+
+- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
+
+- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.
+
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+
+- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
+
+**Happy coding**!

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Macsi Digital Ltd <[email protected]> // Colin Hall <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,57 @@
+# Laravel package for Cookie Consent
+
+A little package to handle cookie consent.  All EU sites or sites targeted at EU citizens must comply with the most crazy european law of all, requesting consent to add cookies to the users comupter.
+
+### Installation
+
+This package can be used in Laravel 6.0 or higher.
+
+You can install the package via composer:
+
+``` bash
+composer require macsidigital/laravel-cookie-consent
+```
+
+The service provider will automatically get registered. Or you may manually add the service provider in your config/app.php file.
+
+We then need to install the assets:
+
+``` bash
+php artisan cookieconsent:install
+```
+
+This will publish a config file, the views and language files
+
+## Usage
+
+To use we just need to add a blade include just before the end body tag
+
+``` php
+@include('cookieConsent::widget')
+```
+
+To amend the design just go into the resources views folder and amend 'widget.blade.php'.  Note we have used inline styles so that we are not reliant on any design framework.  But we would recommend changing this to use something like tailwind.
+
+Finally the more info will try to direct to a route '/cookie-policy', you will need to create this route yourself in your routes file, as well as the template file that lists your cookie policy.
+
+### Changelog
+
+Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
+
+## Contributing
+
+Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+### Security
+
+If you discover any security related issues, please email [email protected] instead of using the issue tracker.
+
+## Credits
+
+- [Macsi Digital](https://github.com/macsidigital)
+- [Colin Hall](https://github.com/colinhall17)
+- [All Contributors](../../contributors)
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

composer.json

@@ -0,0 +1,52 @@
+{
+    "name": "macsidigital/laravel-cookie-consent",
+    "description": "Laravel cookie consent package",
+    "homepage": "https://github.com/MacsiDigital/laravel-cookie-consent",
+    "keywords": ["macsidigital", "laravel-cookie-consent", "cookie-consent", "laravel", "api", "client"],
+    "license": "MIT",
+    "type": "library",
+    "authors": [
+        {
+            "name": "Colin Hall",
+            "email": "[email protected]",
+            "role": "Developer"
+        }
+    ],
+    "require": {
+        "php": "^7.3",
+        "illuminate/support": "^6.0"
+    },
+    "require-dev": {
+        "orchestra/testbench": "^4.0",
+        "phpunit/phpunit": "^8.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "MacsiDigital\\CookieConsent\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "MacsiDigital\\CookieConsent\\Tests\\": "tests"
+        }
+    },
+    "scripts": {
+        "test": "vendor/bin/phpunit",
+        "test-coverage": "vendor/bin/phpunit --coverage-html coverage"
+
+    },
+    "config": {
+        "sort-packages": true
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "MacsiDigital\\CookieConsent\\Providers\\CookieConsentServiceProvider"
+            ],
+            "aliases": {
+                "Boilerplate": "MacsiDigital\\CookieConsent\\Facades\\Boilerplate"
+            }
+        }
+    },
+    "minimum-stability" : "dev"
+}

config/cookie-consent.php

@@ -0,0 +1,19 @@
+<?php
+
+return [
+
+    /*
+     * setting to enable the dialogue box.
+     */
+    'enabled' => env('COOKIE_CONSENT_ENABLED', true),
+
+    /*
+     * Cookie name to save if user consented
+     */
+    'cookie_name' => 'laravel_cookie_consent',
+
+    /*
+     * Cookie duration in minutes. Default is 60 * 24 * 365 * 5. (5 years)
+     */
+    'cookie_duration' => 60 * 24 * 365 * 5,
+];

phpunit.xml.dist

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit bootstrap="vendor/autoload.php"
+         backupGlobals="false"
+         backupStaticAttributes="false"
+         colors="true"
+         verbose="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false">
+    <testsuites>
+        <testsuite name="Test Suite">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory suffix=".php">src/</directory>
+        </whitelist>
+    </filter>
+    <logging>
+        <log type="tap" target="build/report.tap"/>
+        <log type="junit" target="build/report.junit.xml"/>
+        <log type="coverage-html" target="build/coverage" charset="UTF-8" yui="true" highlight="true"/>
+        <log type="coverage-text" target="build/coverage.txt"/>
+        <log type="coverage-clover" target="build/logs/clover.xml"/>
+    </logging>
+</phpunit>

resources/lang/en/widget.php

@@ -0,0 +1,10 @@
+<?php
+
+// resources/lang/en/messages.php
+
+return [
+    'title' => 'We use Cookies',
+    'description' => 'This site uses cookies to give you a great user experience and helps us to improve our offerings. By using our site you consent to our use of cookies',
+    'more_info_button' => 'View Cookie Policy',
+    'accept_button' => 'Accept Cookies'
+];

resources/views/widget.blade.php

@@ -0,0 +1,24 @@
+@if($consent_required)
+
+<div id="cookie-consent" style="position:fixed;bottom:0;left:0;right:0;background-color:gray;padding-top:10px;padding-bottom:10px;color:white;display:flex;align-items: center;justify-content: center;">
+	<div style="width:40%;">
+		<p style="margin:0px;padding-bottom:5px;">{{ __('cookieConsent::widget.description') }}</p>
+	</div>
+	<div style="width:35%;text-align:center;">
+		<p style="margin:0px;padding-bottom:5px;"><a style="display:inline-block;margin-right:20px;padding-top:5px;padding-bottom:5px;padding-left:10px;padding-right:10px;background-color:white;color:black;text-decoration:none;" href="/cookie-policy">{{ __('cookieConsent::widget.more_info_button') }}</a> <a style="display:inline-block;margin-right:20px;padding-top:5px;padding-bottom:5px;padding-left:10px;padding-right:10px;background-color:blue;color:white;text-decoration:none;font-weight:bold;cursor:pointer;" onclick="cookieConsent()">{{ __('cookieConsent::widget.accept_button') }}</a></p>
+	</div>
+</div>
+
+<script>
+	function cookieConsent(){
+		var xhr = new XMLHttpRequest();
+		xhr.open('GET', '{{ url("/cookie-consented") }}', true);
+		xhr.send();
+
+		var consentBox = document.getElementById('cookie-consent');
+		consentBox.style.display = 'none'; //or
+		consentBox.style.visibility = 'hidden';
+	}
+</script>
+
+@endif

routes/web.php

@@ -0,0 +1,7 @@
+<?php
+
+Route::get('/cookie-consented', function(){
+	$response = new Illuminate\Http\Response('Success');
+    $response->withCookie(cookie(config('cookie-consent.cookie_name'), 'true', config('cookie-consent.cookie_duration')));
+    return $response;
+});