Initial commit

Author: chrisbjr

.editorconfig

@@ -0,0 +1,15 @@
+; This file is for unifying the coding style for different editors and IDEs.
+; More information at https://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,11 @@
+# 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
+/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,18 @@
+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,5 @@
+preset: laravel
+
+disabled:
+  - single_class_element_per_statement
+  - self_accessor

CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+All notable changes to `laravel-devices` will be documented in this file
+
+## 1.0.0 - 201X-XX-XX
+
+- 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 @@
+The MIT License (MIT)
+
+Copyright (c) CoreProc bvba <[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,113 @@
+# Store and handle devices connecting to your web application
+
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/coreproc/laravel-devices.svg?style=flat-square)](https://packagist.org/packages/coreproc/laravel-devices)
+[![Quality Score](https://img.shields.io/scrutinizer/g/coreproc/laravel-devices.svg?style=flat-square)](https://scrutinizer-ci.com/g/coreproc/laravel-devices)
+[![Total Downloads](https://img.shields.io/packagist/dt/coreproc/laravel-devices.svg?style=flat-square)](https://packagist.org/packages/coreproc/laravel-devices)
+
+This package sets up the database and middleware needed in storing devices. This is perfect for handling mobile devices
+using your web API. You'll be able to identify each device, assign them an FCM token, and relate them to users as well.
+
+## Installation
+
+You can install the package via composer:
+
+```bash
+composer require coreproc/laravel-devices
+```
+
+You must publish the migration with:
+
+```bash
+php artisan vendor:publish --provider="Coreproc\Devices\DevicesServiceProvider" --tag="migrations"
+```
+
+Migrate the statuses table:
+
+```bash
+php artisan migrate
+```
+
+Optionally you can publish the config file with:
+
+```bash
+php artisan vendor:publish --provider="Coreproc\Devices\DevicesServiceProvider" --tag="config"
+```
+
+## Usage
+
+To begin storing device information, you can attach the `store.device` middleware to any of your routes. Here is an
+example:
+
+```php
+// routes/api.php
+
+Route::middleware('store.device')->get('/test', function (Request $request) {
+    return [];
+});
+```
+
+Now, when you use the API endpoint `/api/test`, you can attach the device information to the header. Here is a complete
+list of data that you can enter:
+
+```bash
+curl --request GET \
+  --url http://devices.test/api/test \
+  --header 'x-device-app-version: 1.0.1' \
+  --header 'x-device-fcm-token: firebase-cloud-messaging-token' \
+  --header 'x-device-manufacturer: Samsung' \
+  --header 'x-device-model: Galaxy S10' \
+  --header 'x-device-os: Android' \
+  --header 'x-device-os-version: 8.0' \
+  --header 'x-device-udid: unique-device-udid'
+```
+
+This will store all of the above information to the database. Only the `x-device-udid` header field is required.
+
+If a user is authenticated, it will relate the user to this device automatically.
+
+You can define the guard to be used in the first parameter of the middleware.
+
+```php
+// routes/api.php
+
+Route::middleware('store.device:web')->get('/test', function (Request $request) {
+    return [];
+});
+```
+
+You can define if the device should be required or not in the second parameter, delimted by a comma.
+
+```php
+// routes/api.php
+
+Route::middleware('store.device:web,0')->get('/test', function (Request $request) {
+    return [];
+});
+```
+
+### Changelog
+
+Please see [CHANGELOG](CHANGELOG.md) for more information on 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.
+
+## About CoreProc
+
+CoreProc is a software development company that provides software development services to startups, digital/ad agencies, and enterprises.
+
+Learn more about us on our [website](https://coreproc.com).
+
+## Credits
+
+- [Chris Bautista](https://github.com/chrisbjr)
+- [All Contributors](../../contributors)
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

composer.json

@@ -0,0 +1,50 @@
+{
+    "name": "coreproc/laravel-devices",
+    "description": "Store and handle devices connecting to your web application.",
+    "keywords": [
+        "coreproc",
+        "laravel-devices"
+    ],
+    "homepage": "https://github.com/coreproc/laravel-devices",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Chris Bautista",
+            "email": "[email protected]",
+            "homepage": "https://coreproc.com",
+            "role": "Developer"
+        }
+    ],
+    "require": {
+        "php": "^7.1"
+    },
+    "require-dev": {
+        "larapack/dd": "^1.0",
+        "phpunit/phpunit": "^7.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "Coreproc\\Devices\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Coreproc\\Devices\\Tests\\": "tests"
+        }
+    },
+    "scripts": {
+        "test": "vendor/bin/phpunit",
+        "test-coverage": "vendor/bin/phpunit --coverage-html coverage"
+
+    },
+    "config": {
+        "sort-packages": true
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Coreproc\\Devices\\DevicesServiceProvider"
+            ]
+        }
+    }
+}