- init commit

Author: toni-suarez

.github/workflows/tests-php8.yml

@@ -0,0 +1,39 @@
+name: Test PHP 8.x
+
+on:
+  push:
+    paths-ignore:
+      - 'readme.md'
+  pull_request:
+    paths-ignore:
+      - 'readme.md'
+  release:
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        laravel: [6.*, 7.*, 8.*]
+        php: [8.0, 8.1]
+      fail-fast: false
+
+    name: Laravel ${{ matrix.laravel }}, PHP ${{ matrix.php }}
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v2
+
+      - name: Set up PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extension: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick
+
+      - name: Install dependencies
+        run: |
+            composer require "illuminate/support:${{ matrix.laravel }}" "illuminate/contracts:${{ matrix.laravel }}" --no-interaction --no-update
+            composer update --prefer-stable --prefer-dist --no-interaction --no-suggest
+      - name: Run tests
+        run: vendor/bin/phpunit

.gitignore

@@ -0,0 +1,3 @@
+vendor
+composer.lock
+*.cache

.php-cs-fixer.php

@@ -0,0 +1,37 @@
+<?php
+
+use PhpCsFixer\Config;
+use PhpCsFixer\Finder;
+
+$rules = [
+    'array_syntax' => ['syntax' => 'short'],
+    '@PSR2' => true,
+    'phpdoc_inline_tag_normalizer' => true,
+    'phpdoc_tag_type' => true,
+    'phpdoc_no_access' => true,
+    'phpdoc_no_package' => true,
+    'phpdoc_no_useless_inheritdoc' => true,
+    'phpdoc_scalar' => true,
+    'phpdoc_single_line_var_spacing' => true,
+    'phpdoc_summary' => true,
+    'phpdoc_to_comment' => true,
+    'phpdoc_trim' => true,
+    'phpdoc_types' => true,
+];
+
+
+$finder = Finder::create()
+    ->in([
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ])
+    ->name('*.php')
+    ->notName('*.blade.php')
+    ->ignoreDotFiles(true)
+    ->ignoreVCS(true);
+
+$config = new Config();
+return $config->setFinder($finder)
+    ->setRules($rules)
+    ->setRiskyAllowed(true)
+    ->setUsingCache(true);

CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 1.0.0
+
+- Init Commit :)

LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) <Toni Suarez>
+
+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,102 @@
+# Laravel UTM-Parameters
+
+- [Introduction](#introduction)
+- [Installation](#installation)
+  - [Middleware](#middleware)
+- [Usage](#usage)
+  - [get_all_utm](#all-utm-parameters)
+  - [get_utm](#Certain-utm-parameter)
+  - [has_utm|has_not_utm](#determine-utm-parameter)
+- [License](#license)
+
+---
+
+## Introduction
+
+A lightweight way to handle UTM-Parameters session-based in your Laravel Application.
+
+*Example*
+
+```blade
+@if(has_utm('source', 'newsletter'))
+  <p>Special Content for Newsletter-Subscriber.</p>
+@endif
+```
+
+## Installation
+
+Install the `utm-parameter` package with composer:
+
+```
+$ composer require suarez/laravel-utm-parameter
+```
+
+### Middleware
+
+Open `app/Http/Kernel.php` and add a new item to the `web` middleware group:
+
+```php
+protected $middlewareGroups = [
+    'web' => [
+        /* ... keep the existing middleware here */
+        \Suarez\UtmParameter\Middleware\UtmParameters::class,
+    ],
+];
+```
+
+If you want to selectively make UTM-Parameters available on specific requests to your site, you should instead add a new mapping to the `routeMiddleware` array:
+
+```php
+protected $routeMiddleware = [
+    /* ... keep the existing mappings here */
+    'utm-parameters' => \Suarez\UtmParameter\Middleware\UtmParameters::class,
+];
+```
+
+To make UTM-Parameters available for certain given requests, use the `utm-parameters` middleware:
+
+```php
+Route::middleware('utm-parameters')->get('langing-page/{slug}', 'LandingPageController@show');
+```
+
+## Usage
+
+### All UTM-Parameters
+
+To get all UTM-Parameters as an array, you can use `get_all_utm()`.
+
+###  Certain UTM-Parameter
+
+If you wish to retrieve certain UTM-Parameter, you can use ``get_utm('source|medium|campaign|term|content')`.
+
+**For example:**
+
+```blade
+ <p>You came from {{ get_utm('source') }}</p>
+```
+
+### Determine UTM-Parameter
+
+Sometimes you want to show or do something, if user might have some or specific utm-parameters. Simply use `has_utm('source|medium|campaign|term|content', 'optional-value')` or `has_not_utm('source|medium|campaign|term|content', 'optional-value')`
+
+**For example:**
+
+```blade
+ @if(has_utm('term'))
+  <p>You have any term.</p>
+ @end
+```
+
+or
+
+```php
+ if (has_utm('campaign', 'special-sale')) {
+   redirect('to/special-sale/page');
+ }
+```
+
+---
+
+## License
+
+The Laravel UTM-Parameters package is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).

composer.json

@@ -0,0 +1,52 @@
+{
+    "name": "suarez/laravel-utm-parameter",
+    "description": "A little helper to store and handle utm-parameter",
+    "homepage": "https://github.com/toni-suarez/laravel-utm-parameter",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Toni Suarez",
+            "email": "[email protected]",
+            "role": "Developer"
+        }
+    ],
+    "require": {
+        "php": "^8.0",
+        "illuminate/support": "^8.0",
+        "illuminate/contracts": "^8.0"
+    },
+    "require-dev": {
+        "nunomaduro/collision": "^5.10",
+        "orchestra/testbench": "^6.22",
+        "phpunit/phpunit": "^9.5",
+        "friendsofphp/php-cs-fixer": "^3.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "Suarez\\UtmParameter\\": "src"
+        },
+        "files": [
+            "src/helper.php"
+        ]
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Suarez\\UtmParameter\\Tests\\": "tests"
+        }
+    },
+    "scripts": {
+        "test": "vendor/bin/phpunit"
+    },
+    "config": {
+        "sort-packages": true
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Suarez\\UtmParameter\\Providers\\UtmParameterServiceProvider"
+            ]
+        }
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
+}

phpunit.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false">
+    <testsuites>
+        <testsuite name="Unit">
+            <directory suffix="Test.php">./tests/Unit</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">./src</directory>
+        </whitelist>
+    </filter>
+</phpunit>

src/Middleware/UtmParameters.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Suarez\UtmParameter\Middleware;
+
+use Closure;
+use Illuminate\Http\Request;
+use Illuminate\Http\Response;
+use Suarez\UtmParameter\UtmParameter;
+
+class UtmParameters
+{
+    /**
+     * Handle an incoming request.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @param  \Closure  $next
+     * @return mixed
+     */
+    public function handle(Request $request, Closure $next)
+    {
+        $response = $next($request);
+
+        if ($this->shouldAcceptUtmParameter($request, $response)) {
+            app(UtmParameter::class)->boot(session('utm'));
+        }
+
+        return $response;
+    }
+
+    /**
+     * Determines whether the given request/response pair should accept UTM-Parameters.
+     *
+     * @param  \Illuminate\Http\Request $request
+     * @param  \Illuminate\Http\Response $response
+     * @return bool
+     */
+    protected function shouldAcceptUtmParameter(Request $request, Response $response)
+    {
+        return $request->isMethod('GET') && $response->getStatusCode() == 200;
+    }
+}

src/Providers/UtmParameterServiceProvider.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Suarez\UtmParameter\Providers;
+
+use Suarez\UtmParameter\UtmParameter;
+use Illuminate\Support\ServiceProvider;
+
+class UtmParameterServiceProvider extends ServiceProvider
+{
+    /**
+     * Register any application services.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        $this->app->singleton(UtmParameter::class, function () {
+            return new UtmParameter();
+        });
+    }
+
+    /**
+     * Bootstrap any application services.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        //
+    }
+}