Merge pull request #1 from webkod3r/swivel-facade

Swivel facade

Author: webkod3r

.gitignore

@@ -0,0 +1,2 @@
+composer.phar
+vendor/

.travis.yml

@@ -1,36 +1,8 @@
-dist: trusty
 language: php
 
 php:
-  - 5.6
-  - 7.0
-  - 7.1
-  - hhvm
-
-# This triggers builds to run on the new TravisCI infrastructure.
-# See: http://docs.travis-ci.com/user/workers/container-based-infrastructure/
-sudo: false
-
-## Cache composer
-cache:
-  directories:
-    - $HOME/.composer/cache
-
-matrix:
-  include:
-    - php: 5.6
-      env: 'COMPOSER_FLAGS="--prefer-stable --prefer-lowest"'
+    - 5.6
+    - 7.0
 
 before_script:
-  - travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-dist
-
-script:
-  - vendor/bin/phpcs --standard=psr2 src/
-  - vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover
-
-after_script:
-  - |
-    if [[ "$TRAVIS_PHP_VERSION" != 'hhvm' && "$TRAVIS_PHP_VERSION" != '7.0' ]]; then
-      wget https://scrutinizer-ci.com/ocular.phar
-      php ocular.phar code-coverage:upload --format=php-clover coverage.clover
-    fi
+    - composer install --prefer-dist --no-interaction --no-suggest --optimize-autoloader

README.md

@@ -1,4 +1,4 @@
-# :package_name
+# Laravel Swivel
 
 [![Latest Version on Packagist][ico-version]][link-packagist]
 [![Software License][ico-license]](LICENSE.md)
@@ -7,37 +7,43 @@
 [![Quality Score][ico-code-quality]][link-code-quality]
 [![Total Downloads][ico-downloads]][link-downloads]
 
-**Note:** Replace ```:author_name``` ```:author_username``` ```:author_website``` ```:author_email``` ```:vendor``` ```:package_name``` ```:package_description``` with their correct values in [README.md](README.md), [CHANGELOG.md](CHANGELOG.md), [CONTRIBUTING.md](CONTRIBUTING.md), [LICENSE.md](LICENSE.md) and [composer.json](composer.json) files, then delete this line. You can run `$ php prefill.php` in the command line to make all replacements at once. Delete the file prefill.php as well.
+[Zumba Swivel](https://github.com/zumba/swivel) is a library that allows PHP
+applications to manage features to multiple users via buckets. It consists
+with 10 buckets, allowing the same code have up to 10 different behaviors.
 
-This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what
-PSRs you support to avoid any confusion with users and contributors.
+This package is a bridge between Laravel/Lumen and Swivel. It provides a Facade,
+and Entity classes to be used in your Laravel application.
 
 ## Structure
 
-If any of the following are applicable to your project, then the directory structure should follow industry best practises by being named the following.
-
-```
-bin/        
-config/
-src/
-tests/
-vendor/
-```
-
+If you want to make a contribution, please make sure you follow Laravel package
+structure.
 
 ## Install
 
 Via Composer
 
 ``` bash
-$ composer require :vendor/:package_name
+$ composer require webkod3r/laravel-swivel
 ```
 
+After installing the package you can copy the default configuration and replace
+it with your own. In order to do that copy the file inside
+`vendor/webkod3r/laravel-swivel/config/swivel.php` into your onw project.
+
 ## Usage
 
+Calling the app IoC and making your own instance
+
 ``` php
-$skeleton = new League\Skeleton();
-echo $skeleton->echoPhrase('Hello, League!');
+$swivel = app()->make('swivel');
+$swivel->returnValue('CoolFeature', 'Active', 'No Active');
+```
+
+or, using the shipped `Facade`
+
+``` php
+LaravelSwivel\Facades\Swivel::returnValue('CoolFeature', 'Active', 'No Active');
 ```
 
 ## Change log
@@ -56,28 +62,22 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT
 
 ## Security
 
-If you discover any security related issues, please email :author_email instead of using the issue tracker.
-
-## Credits
-
-- [:author_name][link-author]
-- [All Contributors][link-contributors]
+If you discover any security related issues, please notify and open an issue.
 
 ## License
 
 The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
 
-[ico-version]: https://img.shields.io/packagist/v/:vendor/:package_name.svg?style=flat-square
+[ico-version]: https://img.shields.io/packagist/v/webkod3r/laravel-swivel.svg?style=flat-square
 [ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
-[ico-travis]: https://img.shields.io/travis/:vendor/:package_name/master.svg?style=flat-square
-[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/:vendor/:package_name.svg?style=flat-square
-[ico-code-quality]: https://img.shields.io/scrutinizer/g/:vendor/:package_name.svg?style=flat-square
-[ico-downloads]: https://img.shields.io/packagist/dt/:vendor/:package_name.svg?style=flat-square
-
-[link-packagist]: https://packagist.org/packages/:vendor/:package_name
-[link-travis]: https://travis-ci.org/:vendor/:package_name
-[link-scrutinizer]: https://scrutinizer-ci.com/g/:vendor/:package_name/code-structure
-[link-code-quality]: https://scrutinizer-ci.com/g/:vendor/:package_name
-[link-downloads]: https://packagist.org/packages/:vendor/:package_name
-[link-author]: https://github.com/:author_username
-[link-contributors]: ../../contributors
+[ico-travis]: https://img.shields.io/travis/webkod3r/laravel-swivel/master.svg?style=flat-square
+[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/webkod3r/laravel-swivel.svg?style=flat-square
+[ico-code-quality]: https://img.shields.io/scrutinizer/g/webkod3r/laravel-swivel.svg?style=flat-square
+[ico-downloads]: https://img.shields.io/packagist/dt/webkod3r/laravel-swivel.svg?style=flat-square
+
+[link-packagist]: https://packagist.org/packages/webkod3r/laravel-swivel
+[link-travis]: https://travis-ci.org/webkod3r/laravel-swivel
+[link-scrutinizer]: https://scrutinizer-ci.com/g/webkod3r/laravel-swivel/code-structure
+[link-code-quality]: https://scrutinizer-ci.com/g/webkod3r/laravel-swivel
+[link-downloads]: https://packagist.org/packages/webkod3r/laravel-swivel
+[link-author]: https://github.com/webkod3r

composer.json

@@ -18,35 +18,48 @@
         }
     ],
     "require": {
-        "php" : "~5.6|~7.0",
-        "illuminate/support": "~5.0",
-        "illuminate/http": "~5.0",
+        "php": "~5.6|~7.0.0",
+        "illuminate/container": "~5.4",
+        "illuminate/http": "~5.4",
+        "illuminate/support": "~5.4",
+        "psr/log": "^1.0",
         "zumba/swivel": "^2.1"
     },
     "require-dev": {
+        "mockery/mockery": "^1.2",
+        "orchestra/testbench": "~3.4.0",
         "phpunit/phpunit": "~5.0",
-        "mockery/mockery": "dev-master"
+        "squizlabs/php_codesniffer": "^3.4"
     },
     "autoload": {
         "psr-4": {
-            "Webkod3r\\LaravelSwivel\\": "src"
+            "LaravelSwivel\\": "src"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "Tests\\Webkod3r\\LaravelSwivel\\": "tests"
+            "Tests\\LaravelSwivel\\": "tests"
         }
     },
     "scripts": {
-        "test": "phpunit"
+        "test": "./vendor/bin/phpunit",
+        "post-autoload-dump": [
+            "bash ./extras/setup.sh"
+        ]
     },
     "extra": {
         "branch-alias": {
             "dev-master": "1.0-dev"
+        },
+        "laravel": {
+            "providers": [
+                "LaravelSwivel\\LaravelSwivelServiceProvider"
+            ]
         }
     },
     "config": {
+        "optimize-autoloader": true,
         "sort-packages": true
     },
-    "minimum-stability": "stable"
+    "minimum-stability": "dev"
 }