Initial commit

Author: mikefrancis

.gitignore

@@ -0,0 +1,6 @@
+/vendor
+
+.phpunit.result.cache
+phpunit.xml
+
+composer.lock

.travis.yml

@@ -0,0 +1,18 @@
+language: php
+
+php:
+ - '7.2'
+ - '7.3'
+ 
+cache:
+ directories:
+ - $HOME/.composer/cache
+
+install:
+ - composer install --no-interaction
+
+script:
+ - phpunit --coverage-clover=coverage.xml
+
+after_success:
+ - bash <(curl -s https://codecov.io/bash)

README.md

@@ -0,0 +1,58 @@
+# Laravel Unleash
+
+[![Build Status](https://travis-ci.org/mikefrancis/laravel-unleash.svg?branch=master)](https://travis-ci.org/mikefrancis/laravel-unleash) [![codecov](https://codecov.io/gh/mikefrancis/laravel-unleash/branch/master/graph/badge.svg)](https://codecov.io/gh/mikefrancis/laravel-unleash)
+
+An [Unleash](https://unleash.github.io) client for Laravel.
+
+## Installation
+
+```bash
+composer require mikefrancis/laravel-unleash
+```
+
+Export package config:
+
+```bash
+php artisan vendor:publish --provider="MikeFrancis\LaravelUnleash\ServiceProvider"
+```
+
+## Configuration
+
+Documentation for configuration can be found in [config/unleash.php](https://github.com/mikefrancis/laravel-unleash/blob/master/config/unleash.php).
+
+## Usage
+
+```php
+
+use \MikeFrancis\LaravelUnleash\Unleash;
+
+$unleash = app(Unleash::class);
+
+if ($unleash->isFeatureEnabled('myAwesomeFeature')) {
+ // Congratulations, you can see this awesome feature!
+}
+
+if ($unleash->isFeatureDisabled('myAwesomeFeature')) {
+ // Check back later for more features!
+}
+
+$allFeatures = $unleash->getFeatures();
+```
+
+### Blade
+
+Blade directive for checking if a feature is **enabled**:
+
+```php
+@featureEnabled('myAwesomeFeature')
+Congratulations, you can see this awesome feature!
+@endfeatureEnabled
+```
+
+Or if a feature is **disabled**:
+
+```php
+@featureDisabled('myAwesomeFeature')
+Check back later for more features!
+@endfeatureDisabled
+```

composer.json

@@ -0,0 +1,37 @@
+{
+ "name": "mikefrancis/laravel-unleash",
+ "description": "An Unleash client for Laravel",
+ "type": "library",
+ "require": {
+ "guzzlehttp/guzzle": "^6.3",
+ "illuminate/support": "^5.8",
+ "illuminate/http": "^5.8"
+ },
+ "require-dev": {
+ "phpunit/phpunit": "^8.3"
+ },
+ "autoload": {
+ "psr-4": {
+ "MikeFrancis\\LaravelUnleash\\": "src/"
+ }
+ },
+ "autoload-dev": {
+ "psr-4": {
+ "MikeFrancis\\LaravelSecureHeaders\\Tests\\": "tests/"
+ }
+ },
+ "license": "MIT",
+ "authors": [
+ {
+ "name": "Mike Francis",
+ "email": "mikeffrancis@gmail.com"
+ }
+ ],
+ "extra": {
+ "laravel": {
+ "providers": [
+ "MikeFrancis\\LaravelUnleash\\ServiceProvider"
+ ]
+ }
+ }
+}

config/unleash.php

@@ -0,0 +1,28 @@
+<?php
+
+return [
+ // URL of the Unleash server. 
+ // This should be the base URL, do not include /api or anything else.
+ 'url' => env('UNLEASH_URL'),
+
+ // Globally control whether Unleash is enabled or disabled.
+ // If not enabled, no API requests will be made and all "enabled" checks will return `false` and 
+ // "disabled" checks will return `true`.
+ 'isEnabled' => env('UNLEASH_ENABLED', true),
+
+ // Allow the Unleash API response to be cached.
+ 'cache' => [
+ 'isEnabled' => false,
+ 'ttl' => 3600,
+ ],
+
+ // Mapping of strategies used to guard features on Unleash. The default strategies are already 
+ // mapped below, and more strategies can be added - they just need to implement the 
+ // `\MikeFrancis\LaravelUnleash\Strategies\Strategy` interface. If you would like to disable 
+ // a built-in strategy, please comment it out or remove it below.
+ 'strategies' => [
+ 'applicationHostname' => \MikeFrancis\LaravelUnleash\Strategies\ApplicationHostnameStrategy::class,
+ 'remoteAddress' => \MikeFrancis\LaravelUnleash\Strategies\RemoteAddressStrategy::class,
+ 'userWithIds' => \MikeFrancis\LaravelUnleash\Strategies\UserWithIdStrategy::class,
+ ],
+];

phpunit.xml.dist

@@ -0,0 +1,24 @@
+<?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</directory>
+ </testsuite>
+ </testsuites>
+ <filter>
+ <whitelist>
+ <directory suffix=".php">./src</directory>
+ <exclude>
+ <file>./src/ServiceProvider.php</file>
+ </exclude>
+ </whitelist>
+ </filter>
+</phpunit>

src/Client.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace MikeFrancis\LaravelUnleash;
+
+use GuzzleHttp\Client as GuzzleClient;
+use Illuminate\Contracts\Config\Repository as Config;
+
+class Client extends GuzzleClient
+{
+ public function __construct(Config $config)
+ {
+ parent::__construct([
+ 'base_uri' => $config->get('unleash.url'),
+ ]);
+ }
+}

src/ServiceProvider.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace MikeFrancis\LaravelUnleash;
+
+use Illuminate\Support\Facades\Blade;
+use Illuminate\Support\ServiceProvider as IlluminateServiceProvider;
+
+class ServiceProvider extends IlluminateServiceProvider
+{
+ /**
+ * Register bindings in the container.
+ *
+ * @return void
+ */
+ public function register()
+ {
+ $this->mergeConfigFrom($this->getConfigPath(), 'unleash');
+ }
+
+ /**
+ * Perform post-registration booting of services.
+ *
+ * @return void
+ */
+ public function boot()
+ {
+ $this->publishes([
+ $this->getConfigPath() => config_path('unleash.php'),
+ ]);
+
+
+ Blade::if('featureEnabled', function (string $feature) {
+ $client = app(Client::class);
+ $unleash = app(Unleash::class, ['client' => $client]);
+
+ return $unleash->isFeatureEnabled($feature);
+ });
+
+ Blade::if('featureDisabled', function (string $feature) {
+ $client = app(Client::class);
+ $unleash = app(Unleash::class, ['client' => $client]);
+
+ return !$unleash->isFeatureEnabled($feature);
+ });
+ }
+
+ /**
+ * Get the path to the config.
+ *
+ * @return string
+ */
+ private function getConfigPath(): string
+ {
+ return __DIR__ . '/../config/unleash.php';
+ }
+}

src/Strategies/ApplicationHostnameStrategy.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace MikeFrancis\LaravelUnleash\Strategies;
+
+use Illuminate\Http\Request;
+use MikeFrancis\LaravelUnleash\Strategies\Contracts\Strategy;
+
+class ApplicationHostnameStrategy implements Strategy
+{
+ public function isEnabled(array $params, Request $request): bool
+ {
+ $applicationHostnames = explode(',', array_get($params, 'applicationHostname', ''));
+
+ if (count($applicationHostnames) === 0) {
+ return false;
+ }
+
+ return in_array($request->getHost(), $applicationHostnames);
+ }
+}

src/Strategies/Contracts/Strategy.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace MikeFrancis\LaravelUnleash\Strategies\Contracts;
+
+use Illuminate\Http\Request;
+
+interface Strategy
+{
+ public function isEnabled(array $params, Request $request): bool;
+}