Skip to content
This repository was archived by the owner on Sep 22, 2024. It is now read-only.
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
This repository was forked from github.com/signifly/laravel-api-responder. Here is the original license:

# The MIT License (MIT)

Copyright (c) Signifly <[email protected]>
Expand Down
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# API Responses for your Laravel API

[![Latest Version on Packagist](https://img.shields.io/packagist/v/signifly/laravel-api-responder.svg?style=flat-square)](https://packagist.org/packages/signifly/laravel-api-responder)
[![Build Status](https://img.shields.io/travis/signifly/laravel-api-responder/master.svg?style=flat-square)](https://travis-ci.org/signifly/laravel-api-responder)
[![Latest Version on Packagist](https://img.shields.io/packagist/v/r4nkt/laravel-api-responder.svg?style=flat-square)](https://packagist.org/packages/r4nkt/laravel-api-responder)
[![Build Status](https://img.shields.io/travis/r4nkt/laravel-api-responder/master.svg?style=flat-square)](https://travis-ci.org/r4nkt/laravel-api-responder)
[![StyleCI](https://styleci.io/repos/188211079/shield?branch=master)](https://styleci.io/repos/188211079)
[![Quality Score](https://img.shields.io/scrutinizer/g/signifly/laravel-api-responder.svg?style=flat-square)](https://scrutinizer-ci.com/g/signifly/laravel-api-responder)
[![Total Downloads](https://img.shields.io/packagist/dt/signifly/laravel-api-responder.svg?style=flat-square)](https://packagist.org/packages/signifly/laravel-api-responder)
[![Quality Score](https://img.shields.io/scrutinizer/g/r4nkt/laravel-api-responder.svg?style=flat-square)](https://scrutinizer-ci.com/g/r4nkt/laravel-api-responder)
[![Total Downloads](https://img.shields.io/packagist/dt/r4nkt/laravel-api-responder.svg?style=flat-square)](https://packagist.org/packages/r4nkt/laravel-api-responder)

The `signifly/laravel-api-responder` package allows you to easily return API responses in your Laravel app.
The `r4nkt/laravel-api-responder` package allows you to easily return API responses in your Laravel app.

Below is a small example of how to use it:

```php
use Signifly\Responder\Concerns\Respondable;
use R4nkt\Responder\Concerns\Respondable;

class ProductController extends Controller
{
Expand Down Expand Up @@ -58,7 +58,7 @@ To get started follow the installation instructions below.
You can install the package via composer:

```bash
composer require signifly/laravel-api-responder
composer require r4nkt/laravel-api-responder
```

The package will automatically register itself.
Expand All @@ -80,19 +80,19 @@ return [

/*
* Force the usage of resources.
*
* It will throw a ResourceNotFoundException
*
* It will throw a ResourceNotFoundException
* if it does not resolve a resource.
*/
'force_resources' => false,

/*
* Indicates if the resources uses a naming convention with a type suffix.
*
*
* If it is set to true it will try to resolve `UserResource`.
*/
'use_type_suffix' => false,

];
```

Expand All @@ -103,7 +103,7 @@ The responder can be used in several ways.
### Using the Facade

```php
use Signifly\Responder\Facades\Responder;
use R4nkt\Responder\Facades\Responder;

class ProductController
{
Expand All @@ -117,7 +117,7 @@ class ProductController
### Using the Trait

```php
use Signifly\Responder\Concerns\Respondable;
use R4nkt\Responder\Concerns\Respondable;

class ProductController
{
Expand All @@ -133,7 +133,7 @@ class ProductController
### Using the Service Container

```php
use Signifly\Responder\Contracts\Responder;
use R4nkt\Responder\Contracts\Responder;

class ProductController
{
Expand Down Expand Up @@ -180,7 +180,7 @@ composer test

## Security

If you discover any security issues, please email dev@signifly.com instead of using the issue tracker.
If you discover any security issues, please email dev@r4nkt.com instead of using the issue tracker.

## Credits

Expand Down
28 changes: 14 additions & 14 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "signifly/laravel-api-responder",
"description": "API Responses for your Laravel API.",
"homepage": "https://github.com/signifly/laravel-api-responder",
"name": "r4nkt/laravel-api-responder",
"description": "API Responses for your Laravel API. (Forked from signifly/laravel-api-responder.)",
"homepage": "https://github.com/r4nkt/laravel-api-responder",
"license": "MIT",
"authors": [
{
Expand All @@ -11,24 +11,24 @@
}
],
"require": {
"php": "^7.2.5 || ^8.0",
"illuminate/contracts": "^6.0|^7.0|^8.0",
"illuminate/database": "^6.0|^7.0|^8.0",
"illuminate/http": "^6.0|^7.0|^8.0",
"illuminate/support": "^6.0|^7.0|^8.0"
"php": "^8.1",
"illuminate/contracts": "^9.0",
"illuminate/database": "^9.0",
"illuminate/http": "^9.0",
"illuminate/support": "^9.0"
},
"require-dev": {
"phpunit/phpunit": "^7.0|^8.0|^9.0",
"orchestra/testbench": "^4.0|^5.0|^6.0"
"phpunit/phpunit": "^9.5",
"orchestra/testbench": "^7.0"
},
"autoload": {
"psr-4": {
"Signifly\\Responder\\": "src"
"R4nkt\\Responder\\": "src"
}
},
"autoload-dev": {
"psr-4": {
"Signifly\\Responder\\Tests\\": "tests"
"R4nkt\\Responder\\Tests\\": "tests"
}
},
"scripts": {
Expand All @@ -40,10 +40,10 @@
"extra": {
"laravel": {
"providers": [
"Signifly\\Responder\\ResponderServiceProvider"
"R4nkt\\Responder\\ResponderServiceProvider"
],
"aliases": {
"Responder": "Signifly\\Responder\\Facades\\Responder"
"Responder": "R4nkt\\Responder\\Facades\\Responder"
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion phpunit.xml.dist
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
processIsolation="false"
stopOnFailure="false">
<testsuites>
<testsuite name="Signifly Test Suite">
<testsuite name="Laravel API Responder Test Suite">
<directory>tests</directory>
</testsuite>
</testsuites>
Expand Down
4 changes: 2 additions & 2 deletions src/Concerns/Respondable.php
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<?php

namespace Signifly\Responder\Concerns;
namespace R4nkt\Responder\Concerns;

use Illuminate\Contracts\Support\Responsable;
use Signifly\Responder\Contracts\Responder;
use R4nkt\Responder\Contracts\Responder;

trait Respondable
{
Expand Down
2 changes: 1 addition & 1 deletion src/Contracts/ModelResolver.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

namespace Signifly\Responder\Contracts;
namespace R4nkt\Responder\Contracts;

interface ModelResolver
{
Expand Down
2 changes: 1 addition & 1 deletion src/Contracts/ResourceResolver.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

namespace Signifly\Responder\Contracts;
namespace R4nkt\Responder\Contracts;

interface ResourceResolver
{
Expand Down
2 changes: 1 addition & 1 deletion src/Contracts/Responder.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

namespace Signifly\Responder\Contracts;
namespace R4nkt\Responder\Contracts;

use Illuminate\Contracts\Support\Responsable;

Expand Down
2 changes: 1 addition & 1 deletion src/Exceptions/ResourceNotFoundException.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

namespace Signifly\Responder\Exceptions;
namespace R4nkt\Responder\Exceptions;

use Exception;

Expand Down
4 changes: 2 additions & 2 deletions src/Facades/Responder.php
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<?php

namespace Signifly\Responder\Facades;
namespace R4nkt\Responder\Facades;

use Illuminate\Support\Facades\Facade;
use Signifly\Responder\Contracts\Responder as ResponderContract;
use R4nkt\Responder\Contracts\Responder as ResponderContract;

class Responder extends Facade
{
Expand Down
26 changes: 13 additions & 13 deletions src/Responder.php
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
<?php

namespace Signifly\Responder;
namespace R4nkt\Responder;

use Illuminate\Contracts\Pagination\LengthAwarePaginator;
use Illuminate\Contracts\Support\Responsable;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Http\Resources\Json\JsonResource;
use Illuminate\Support\Collection;
use Signifly\Responder\Contracts\ModelResolver;
use Signifly\Responder\Contracts\ResourceResolver;
use Signifly\Responder\Contracts\Responder as Contract;
use Signifly\Responder\Responses\CollectionResponse;
use Signifly\Responder\Responses\DefaultResponse;
use Signifly\Responder\Responses\ModelResponse;
use Signifly\Responder\Responses\PaginatorResponse;
use R4nkt\Responder\Contracts\ModelResolver;
use R4nkt\Responder\Contracts\ResourceResolver;
use R4nkt\Responder\Contracts\Responder as Contract;
use R4nkt\Responder\Responses\CollectionResponse;
use R4nkt\Responder\Responses\DefaultResponse;
use R4nkt\Responder\Responses\ModelResponse;
use R4nkt\Responder\Responses\PaginatorResponse;

class Responder implements Contract
{
/** @var \Signifly\Responder\Contracts\ModelResolver */
/** @var \R4nkt\Responder\Contracts\ModelResolver */
protected $modelResolver;

/** @var \Signifly\Responder\Contracts\ResourceResolver */
/** @var \R4nkt\Responder\Contracts\ResourceResolver */
protected $resourceResolver;

public function __construct(
Expand Down Expand Up @@ -58,7 +58,7 @@ public function respond($data, ?string $resourceClass = null): Responsable
* Respond for a collection.
*
* @param \Illuminate\Support\Collection $data
* @return \Signifly\Responder\Responses\CollectionResponse
* @return \R4nkt\Responder\Responses\CollectionResponse
*/
protected function respondForCollection(Collection $data, ?string $resourceClass)
{
Expand All @@ -77,7 +77,7 @@ protected function respondForCollection(Collection $data, ?string $resourceClass
* Respond for a given model.
*
* @param \Illuminate\Database\Eloquent\Model $model
* @return \Signifly\Responder\Responses\ModelResponse
* @return \R4nkt\Responder\Responses\ModelResponse
*/
protected function respondForModel(Model $model, ?string $resourceClass)
{
Expand All @@ -92,7 +92,7 @@ protected function respondForModel(Model $model, ?string $resourceClass)
* Respond for a paginator.
*
* @param \Illuminate\Contracts\Pagination\LengthAwarePaginator $data
* @return \Signifly\Responder\Responses\PaginatorResponse
* @return \R4nkt\Responder\Responses\PaginatorResponse
*/
protected function respondForPaginator(LengthAwarePaginator $data, ?string $resourceClass)
{
Expand Down
12 changes: 6 additions & 6 deletions src/ResponderServiceProvider.php
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<?php

namespace Signifly\Responder;
namespace R4nkt\Responder;

use Illuminate\Support\ServiceProvider;
use Signifly\Responder\Contracts\ModelResolver as ModelResolverContract;
use Signifly\Responder\Contracts\ResourceResolver as ResourceResolverContract;
use Signifly\Responder\Contracts\Responder as ResponderContract;
use Signifly\Responder\Support\ModelResolver;
use Signifly\Responder\Support\ResourceResolver;
use R4nkt\Responder\Contracts\ModelResolver as ModelResolverContract;
use R4nkt\Responder\Contracts\ResourceResolver as ResourceResolverContract;
use R4nkt\Responder\Contracts\Responder as ResponderContract;
use R4nkt\Responder\Support\ModelResolver;
use R4nkt\Responder\Support\ResourceResolver;

class ResponderServiceProvider extends ServiceProvider
{
Expand Down
2 changes: 1 addition & 1 deletion src/Responses/CollectionResponse.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

namespace Signifly\Responder\Responses;
namespace R4nkt\Responder\Responses;

use Illuminate\Support\Collection;

Expand Down
2 changes: 1 addition & 1 deletion src/Responses/DefaultResponse.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

namespace Signifly\Responder\Responses;
namespace R4nkt\Responder\Responses;

use Illuminate\Http\JsonResponse;

Expand Down
2 changes: 1 addition & 1 deletion src/Responses/ModelResponse.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

namespace Signifly\Responder\Responses;
namespace R4nkt\Responder\Responses;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;
Expand Down
2 changes: 1 addition & 1 deletion src/Responses/PaginatorResponse.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

namespace Signifly\Responder\Responses;
namespace R4nkt\Responder\Responses;

use Illuminate\Contracts\Pagination\LengthAwarePaginator;

Expand Down
2 changes: 1 addition & 1 deletion src/Responses/Response.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

namespace Signifly\Responder\Responses;
namespace R4nkt\Responder\Responses;

use Illuminate\Contracts\Support\Responsable;

Expand Down
4 changes: 2 additions & 2 deletions src/Support/ModelResolver.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

namespace Signifly\Responder\Support;
namespace R4nkt\Responder\Support;

use Exception;
use Illuminate\Contracts\Pagination\LengthAwarePaginator;
Expand All @@ -9,7 +9,7 @@
use Illuminate\Support\Collection;
use Illuminate\Support\Str;
use InvalidArgumentException;
use Signifly\Responder\Contracts\ModelResolver as Contract;
use R4nkt\Responder\Contracts\ModelResolver as Contract;

class ModelResolver implements Contract
{
Expand Down
6 changes: 3 additions & 3 deletions src/Support/ResourceResolver.php
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<?php

namespace Signifly\Responder\Support;
namespace R4nkt\Responder\Support;

use Illuminate\Http\Resources\Json\JsonResource;
use Signifly\Responder\Contracts\ResourceResolver as Contract;
use Signifly\Responder\Exceptions\ResourceNotFoundException;
use R4nkt\Responder\Contracts\ResourceResolver as Contract;
use R4nkt\Responder\Exceptions\ResourceNotFoundException;

class ResourceResolver implements Contract
{
Expand Down
2 changes: 1 addition & 1 deletion tests/Models/Product.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

namespace Signifly\Responder\Tests\Models;
namespace R4nkt\Responder\Tests\Models;

use Illuminate\Database\Eloquent\Model;

Expand Down
2 changes: 1 addition & 1 deletion tests/Resources/Product.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

namespace Signifly\Responder\Tests\Resources;
namespace R4nkt\Responder\Tests\Resources;

use Illuminate\Http\Resources\Json\JsonResource;

Expand Down
Loading