https://github.com/cerbos/demo-laravel

Demo of using cerbos with php laravel
https://github.com/cerbos/demo-laravel

Last synced: about 2 months ago
JSON representation

Demo of using cerbos with php laravel

• Host: GitHub
• URL: https://github.com/cerbos/demo-laravel
• Owner: cerbos
• License: apache-2.0
• Created: 2023-08-24T10:56:02.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-07T10:00:41.000Z (about 2 months ago)
• Last Synced: 2024-11-07T10:42:52.270Z (about 2 months ago)
• Language: PHP
• Size: 240 KB
• Stars: 2
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# demo-laravel

This project demonstrates how to utilize [Cerbos](https://cerbos.dev) with 

[Cerbos Laravel SDK](https://github.com/cerbos/cerbos-sdk-laravel).

## Usage

- Run `composer install` and `npm install` to install dependencies.

- Run `docker compose up` to launch a `cerbos` and `mysql` instance.

- Run `php artisan migrate` to migrate database schema to the `mysql` instance.

- Run `php artisan serve` to serve the Laravel application.

## API

### `POST /api/register`

Register a user

```json

{

    "email": "[email protected]",

    "password": "123",

    "name": "Someone",

    "roles": "USER,MANAGER",

    "region": "EU",

    "department": "IT"

}

```

### `POST /api/login`

Login with e-mail and password

```json

{

    "email": "[email protected]",

    "password": "123"

}

```

### `POST /api/logout`

Logout

### `GET /api/expenses`

List all expenses the logged-in user authorized to view

### `GET /api/expenses/{id}`

Get expense by ID if logged-in user is authorized to view

### `POST /api/expenses`

Create new expense

```json

{

    "amount": 500,

    "region": "EMEA",

    "vendor": "ACME Inc."

}

```

### `DELETE /api/expenses/{id}`

Delete the expense by ID if logged-in user is authorized to delete

### `PATCH /api/expenses/{id}`

Update the expense by ID if logged-in user is authorized to update

```json

{

    "amount": 500,

    "region": "EMEA",

    "vendor": "ACME Inc."

}

```

### `POST /api/expenses/{id}/approve`

Approve the expense by ID if logged-in user is authorized to approve

### `POST /api/expenses/{id}/reject`

Reject the expense by ID if logged-in user is authorized to reject

## Seeds

Running `php artisan db:seed` seeds the database with the following rows.

### User Seeds (`database/seeders/UserSeeder.php`)

| ID | Name   | Mail             | Password | Roles         | Department | Region |

|----|--------|------------------|----------|---------------|------------|--------|

| 1  | Sally  | [email protected]   | 123      | USER          | SALES      | EMEA   |

| 2  | Ian    | [email protected]       | 123      | ADMIN         | IT         | -      |

| 3  | Frank  | [email protected]   | 123      | USER          | FINANCE    | EMEA   |

| 4  | Derek  | [email protected]   | 123      | USER, MANAGER | FINANCE    | EMEA   |

| 5  | Simon  | [email protected]   | 123      | USER, MANAGER | SALES      | NA     |

| 6  | Mark   | [email protected]     | 123      | USER, MANAGER | SALES      | EMEA   |

| 7  | Sydney | [email protected] | 123      | USER          | SALES      | NA     |

### Expense Seeds (`database/seeders/ExpenseSeeder.php`)

| ID | Vendor          | Region | Owner ID | Approved By ID | Amount | Status   |

|----|-----------------|--------|----------|----------------|--------|----------|

| 1  | Flux Water Gear | EMEA   | 1        | -              | 500    | OPEN     |

| 2  | Vortex Solar    | EMEA   | 1        | 3              | 2500   | APPROVED |

| 3  | Global Airlines | EMEA   | 1        | -              | 12000  | OPEN     |

| 4  | Vortex Solar    | EMEA   | 3        | -              | 2421   | OPEN     |

| 5  | Vortex Solar    | EMEA   | 1        | 3              | 2500   | REJECTED |