marcelgwerder / laravel-api-handler Goto Github PK

It would be nice to add ability to make appends on results.
For example if user model has getFullNameAttribute() we could use something like:

/users?_appends=fullName

I make workaround in my Repository Base Class (parserResult is method from Repository library and its called with ->all()):

    /**
     * @param array $fullTextSearchColumns Columns to search in fulltext search
     * @param array|boolean $queryParams A list of query parameter
     * @return $this
     */
    public function scopeQueryParametersMultiple($fullTextSearchColumns = array(), $queryParams = false)
    {
        if ($queryParams === false) {
            $queryParams = request()->except('_appends');
        }

        return $this->scopeQuery(function($query) use ($fullTextSearchColumns, $queryParams) {
            return ApiHandler::parseMultiple($query, $fullTextSearchColumns, $queryParams)->getBuilder();
        });
    }

    public function scopeQueryParametersSingle()
    {
        return $this->scopeQuery(function($query) {
            return ApiHandler::parseSingle($query, [])->getBuilder();
        });
    }

    /**
     * Wrapper result data
     *
     * @param mixed $result
     *
     * @return mixed
     */
    public function parserResult($result)
    {
        $result  = parent::parserResult($result);

        $appends = request()->filled('_appends') ? explode(',', request('_appends')) : null;

        if ($appends) {
            if ($result instanceof Collection) {
                $result->each(function($row) use ($appends) {
                    $row->setAppends($appends);
                });
            } elseif ($result instanceof Model) {
                $result->setAppends($appends);
            }
        }

        return $result;
    }

But would be nice to transfer this logic to Your library.

It would be great to have a flag to allow the API handler to also use soft-deleted entities (deleted_at not null) as Laravel allows it easily with:

Model::withTrashed()->get();

I guess you have an idea on which project this could help ;)

Cheers, Dan

I have a Model:

Then an index method in my controller which returns all DayExercise(s) using this wonderfull package

    public function index()
    {
        $model = new \App\Models\DayExercise;
        return ApiHandler::parseMultiple($model)->getResult();
    }

All is working fine, I am getting my data like so:

[
  {
    "id": 27,
    "exercise_id": 28,
    "day_id": 15,
    "sets": 3,
    "reps": 5,
    "weight": null,
    "seq": 1,
    "increment": "2.50",
    "one_rm": "67.50",
    "one_rm_updated_at": "2016-08-15 00:00:00",
    "auto_reps": 1,
    "auto_weight": 1,
    "day": {
      "id": 15,
      "name": "Day 1: Chest/Biceps",
      "program_id": 39,
      "seq": 1,
      "program": {
        "id": 39,
        "name": "Chest/Back Legs/Shoulders",
        "user_id": 2,
        "reps_per_set": 4,
        "reps_per_set_updated_at": "2016-08-29 00:00:00",
        "difficulity": 1,
        "volume_cache": null,
        "created_at": "2016-08-14 19:08:00",
        "updated_at": "2016-08-29 21:46:44",
        "rank": 1
      }
    }
  },
  {
    "id": 28,
    "exercise_id": 155,
    "day_id": 15,
    "sets": 3,
    "reps": "12",
    "weight": "12.5",
    "seq": 2,
    "increment": "2.50",

However notice the

    "auto_weight": 1,
    "day": {
      "id": 15,
      "name": "Day 1: Chest/Biceps",
      "program_id": 39,
      "seq": 1,
      "program": {
        "id": 39,
        "name": "Chest/Back Legs/Shoulders",
        "user_id": 2,
        "reps_per_set": 4,
        "reps_per_set_updated_at": "2016-08-29 00:00:00",
        "difficulity": 1,
        "volume_cache": null,
        "created_at": "2016-08-14 19:08:00",
        "updated_at": "2016-08-29 21:46:44",
        "rank": 1
      }

I didn't request for the day and program object to be included in the response. I did some debuging and realized this happen due to the following Accessor in my model. The line that is causing the problem is the $this->day->program->reps_per_set; part.

    public function getRepsAttribute($value)
    {
        if($this->auto_reps) {
            $this->day->program->reps_per_set;
            return 5;
        }
        return $value;
    }

If I comment out the line, changing the function to:

    public function getRepsAttribute($value)
    {
        if($this->auto_reps) {
            //$this->day->program->reps_per_set;
            return 5;
        }
        return $value;
    }

All works fine and I get proper data returned like so:

[
  {
    "id": 27,
    "exercise_id": 28,
    "day_id": 15,
    "sets": 3,
    "reps": 5,
    "weight": null,
    "seq": 1,
    "increment": "2.50",
    "one_rm": "67.50",
    "one_rm_updated_at": "2016-08-15 00:00:00",
    "auto_reps": 1,
    "auto_weight": 1
  },
  {
    "id": 28,
    "exercise_id": 155,
    "day_id": 15,
    "sets": 3,
    "reps": "12",
    "weight": "12.5",

Whereby the whole day and program objects are not included.

Just some extra info. A DayExercise belongs to a Day, and a Day belongs to a Program.

Not a issue, but a limitation. While trying to stay away from Facades, these kind of calls in the package forces the host app to be bound to them:

$this->prefix = Config::get('apihandler.prefix');
$this->envelope = Config::get('apihandler.envelope');

There are more in the package, this is just a sample.

Do you plan on adding support for Laravel 5.5 resources?

Hello,

Has anyone tried use this library with Repository Pattern in one moment?
I use https://github.com/andersao/l5-repository and i would still use it.

For example i have method:
$this->myRepository->getItemsByUser($loggedInApi);
And now i would to add queries to this method in my api.
Is it possible? I am not sure how can i inject QB to api-handler or another side - get QB from my repository and inject to parseMultiple().

There is some old code which throws invalid exceptions.

Hey there.
I'm new to Laravel (5.1) and the whole plugin stuff and would appreciate a little help. :)

Following the instructions i got the ApiHandler to work with regular parameters and its awesome, but some of the predefined functions throw sql erros since they seem to be interpreted as table columns.

Specifically _sort, _fields and _with don't seem to work, while _offset, _limit and _q for example work as intended.
I didn't change anything in the config/apihandler.php, prefix is still '_' and i added @Relation annotations to the needed relation as described. Do i have to register these params anywhere?

Error when using sort: /api/posts?_sort=name

QueryException in Connection.php line 664:
SQLSTATE[42S22]: Column not found: Unknown column '_sort' in 'where clause' (SQL: select * from `posts` where `posts`.`deleted_at` is null and `_sort` = name order by `name` asc)

Error when using with: /api/posts?_with=user

QueryException in Connection.php line 664:
SQLSTATE[42S22]: Column not found: Unknown column '_with' in 'where clause' (SQL: select * from `posts` where `posts`.`deleted_at` is null and `_with` = user)

Any ideas what i am missing, or where to look for the source of failure would be highly appreciated! :)

This issue occurs only on the "next" branch.

It looks like it is not possible to set the sortable columns on the APIHandler itself as it is possible for filterable:

return ApiHandler::from($builder)
    ->filterable('type')
    ->sortable('id')
    ->asResourceCollection()
;

While the filterable call will make the type column filterable, the sortable call will have no effect and then calls on the API endpoint using that sort order will cause an exception:

Sort path "id" is not allowed on this endpoint.

Looking to the code I noticed that if you comment out in ApiHandler.php the following function, then the above code works and properly sort the entities.

//    /**
//     * Define the columns that should be sortable.
//     *
//     * @param  array|string|dynamic  $sortables
//     * @return $this
//     */
//    public function sortable($sortables): self
//    {
//        $this->sortables = is_array($sortables) ? $sortables : func_get_args();
//
//        return $this;
//    }

This is because there is an __call function in the APIHandler that will intercept the call to sortable just as it does for filterable.

But then it is only possible to pass a single sortable column, the following code will not work:

    ...
    ->sortable(['id', 'recipient'])
    ...

The above will cause the following exception when accessing the endpoint:

preg_quote() expects parameter 1 to be string, array given

And by the way the following syntax will only make the last field sortable (here: recipient):

    ->sortable('id')
    ->sortable('recipient')

There were no meta information returned from the _config=meta-total-count,meta-filter-count added on the URL.

Please provide more information on how this works.

Cheers

ApiHandler class parseSingle and parseMultiple is not static ,
so can't use ApiHandler::parseMultiple

It looks like I've overlooked that use case. Of course it makes no sense to sort the top level row because there is only one element but all the relationships need to be sortable.

The "parseMultiple" method makes much sense to me with filters, offset, limit, etc...

On the other hand, the "parseSingle" method seems more accessory. Yes, it makes a simpler response code in many scenarios. I was wondering what kind of uses where it would shine.

The only thing I've found was to detect if the id is a number or text and finding in the appropriate field. ie:

/api/users/1  (by id)
/api/users/Administrator  (by name)

class UsersController extends RestfulController
{
    public function show(Request $request, $id)
    {
        return ApiHandler::parseSingle(User::query(), is_numeric($id) ? $id : array('name'=>$id))->getResponse();
    }
}

I think it would be impossible to use with Doctrine, but just asking to make sure I didn't miss something.

Hi my I suggest if you can add the meta information from the response. The purpose was to use this on javascript tables such as jquery DataTable as a source. If you can make another method to have a parameter or a flag that indicate if the meta information be included in the response.

Again thanks for this wonderful API handler.

== Security Problem

Inside the function parseWith you use the following code:

//Throw a new ApiHandlerException if the relation doesn't exist
try
{
    $relation = call_user_func(array($previousModel, $part));
}

This makes it possible to call any function without parameter existing in the model.

== Example

Lets say you have a function like this in your user model:

function bang() {
    die('BANG!!!');
}

Now you call the url for users resource like:

/api/v1/users?_with=bang

You will see: "BANG!!!" on your screen. This is just an example, but this function could have some business logic inside.

Wow, really great job, friend! Not an issue, just wanted to say thank you, this package saves months of life!

Filtering works fine with an eloquent builder object but seems to fail with a query builder object.

Api like:

http://mba.cn/api/tests/users?_with=class,class.headteacher,nation&nation.id-in=1,2&_fields=class.name,class.headteacher.name

cause:

"SQLSTATE[42S22]: Column not found: 1054 Unknown column 'headteacher.name' in 'field list' (SQL: select `name`, `headteacher`.`name`, `id`, `headteacher_id` from `mba_classes` where `mba_classes`.`id` in (1))"

Stumbled upon a usercase where I would have to make an comparison on a nullable datetime field ended_at-min OR null.

Wonder if there is any way to make that possible?

Can there be a small example on how it's used. I'm fairly new, so trying to get my head around it.

I have my route set-up

Route::group(['prefix' => 'api/v1'], function()
{

    Route::resource('users', 'Api\UsersController');
    Route::resource('notifications', 'Api\NotificationsController');

});

And my controller

public function index()
    {
        $notifications = Notifications::all();
        return response()->json(['notifications' => $notifications]);
    }

This works fine just pulling data into my ember app, but I'm not sure how I would update my controller to work with this package.

Dynamic relationships are very powerfull but also bit unsecure.
Any experience with securing nested resources?
For example user is able to get posts
posts?with=author
but ..
posts?with=author.privateSettings
this should be able to download only for author or a supervisor.
Any option to set available relations?

how to send a request to order by a column form 'with' table

here is my backend code

$query = Product::query();
    $query->company();
    $query->with('category');
$result=ApiHandler::parseMultiple($query);
    return $result->getResponse(); 

and the request url

http://localhost/public/api/v1/product/view/0?&_offset=0&_limit=10&_config=meta-total-count,meta-filter-count&_sort=-category.category_name

An SQL count doesn't work in combination with offset. A solution would be to remove the offset in the CountMetaProvider.

Hi,

Laravel api handler seems to be awesome, good job! I'm wondering is it possible to use "transformers" when including related models?

Something like Fractal has: http://fractal.thephpleague.com/transformers/

There seem to be issues with many to many relations. Pivot data is merged with the model data and causes confusing results.

In the README it says that two custom headers will be returned indicating total and filter count or, if you prefer, you could include them in the body with a configuration variable. So far, neither of these seem to be working. FWIW, it doesn't appear in the config/api.php file that there is a variable for envelope anyway.

Here's an example piece of code that returns a JSON object via my Fractal transformer:

// API Handler Call
$campaigns = ApiHandler::parseMultiple(new Campaign, Campaign::getSearchedFields(), $request->all())->getBuilder();

// Simple Scope to Keep Records to the Account Calling
$response = $campaigns->inAccount($this->account, $this->user, $request->get('user_id'), null !== $request->input('me'))->get();

// Provided by Dingo API package but is basically just a helper for sending back JSON.
return $this->response()->collection($response, new CampaignTransformer);

Here's the headers I get back:

Cache-Control → no-cache
Connection → keep-alive
Content-Type → application/json
Date → Fri, 23 Oct 2015 15:00:08 GMT
Server → nginx/1.8.0
Transfer-Encoding → chunked

And note that nothing appears in the response body even if I pass the _config param explicitly.

Am I missing something? Thanks so much for a fantastic package, Marcel. Much appreciated sir!

ErrorException in Parser.php line 450:
Undefined variable: secondKey

First of all, this work is one more godsend from the community. Thx

I get a weird behavior when sorting datetime fields ..have a look
(below, just showing the field value, in the order it appears in the json response)

/api/users?_sort=created_at

"created_at": "2016-07-29 02:06:34"
"created_at": "2016-07-28 02:47:30"
"created_at": "2016-07-28 06:57:49"
"created_at": "2016-07-28 18:32:33"

/api/users?_sort=-created_at

"created_at": "2016-07-28 18:32:33"
"created_at": "2016-07-28 06:57:49"
"created_at": "2016-07-28 02:47:30"
"created_at": "2016-07-29 02:10:03"

So by looking at this, it seems that the sort is done on the date ..and the time, but the time sorting is reversed.

Below, my simple controller..

class UsersController extends RestfulController {
    public function index(Request $request) {
        return ApiHandler::parseMultiple(User::query(), array('name','email'))->getResponse();
    }
}

hi, thanks for this awesome plugin!
I am using https://github.com/jenssegers/laravel-mongodb for mongodb support in laravel.
when I use the query string "?lang.en_US.status=confirmed" it is converted to "lang_en_US_status":"confirmed" in the query string.
any idea why?
cheers riccardo

Hi,

it's possible to retrieve a list of fields that were passed to the request for the use with fractal?

E.g.:

<?php

use League\Fractal;

/**
 * UsersController Class
 *
 * Implements actions regarding user management
 */
class UsersController extends Controller
{

    public function __construct()
    {
        $this->fractal = new Fractal\Manager();
    }

    /**
     * Returns all users
     * 
     * @return Users
     */
    public function index()
    {
        $user = new User();
        $users = ApiHandler::parseMultiple($user, array('id', 'username', 'email', 'created_at'));
        // Pass this array (collection) into a resource, which will also have a "Transformer"
        // This "Transformer" can be a callback or a new instance of a Transformer object
        // We type hint for array, because each item in the $books var is an array
        $resource = new Fractal\Resource\Collection($users->getResult()->toArray(), function(array $user) {

           /*
This parts needs to be automated by the _fields that were passed to the query
*/
           /*
            return [
                'id' => (int) $user['id'],
                'username' => $user['username'],
                'email' => $user['email'],
                'created_at' => $user['created_at'],
                'links' => [
                    [
                        'rel' => 'self',
                    ]
                ]
            ];
           */
        });
        return $this->fractal->createData($resource)->toJson();

}

Thanks in advance

I need to search in a joined column name field.
By default it searches in the main table, can I change this so it searches in products_content.name=Test instead of products.name

/user/dogs?breed.name=labrador

is it possible?

In this case:

dogs->belongsTo('Breed');

In breed, name is an attribute.

I have simply index() method to get all resources but i would to use custom filter for example:

/books?category=type

But category is not a column name, but just my custom attribute to use in if/else.

if ($category) etc...

Library is taking category and use it in WHERE condition so it is causing SQL error. I tried with _category too but same result.

Thanks.