Plugin Study Monitoring #385

christhofer · 2022-06-30T09:22:38Z

Step saat merge

1. Run

composer require masbug/flysystem-google-drive-ext:"^1.0.0"
php artisan migrate
php artisan migrate --database=tenant --path=database/migrations/tenant

2. (Optional) Re cache config and routes

php artisan optimize

3. Enable google drive api

https://console.cloud.google.com/apis/library/drive.googleapis.com

4. Tambah Authorised redirect URIs

Go to https://console.cloud.google.com/apis/credentials
Click client name in OAuth 2.0 Client IDs
Add https://cloud.point.red/oauth/google/callback in Authorised redirect URIs (base app url, without tenant subdomain)

5. Edit .env tambahkan

GOOGLE_PROJECT_ID=
GOOGLE_DRIVE_ROOT=POINT_DEV # default location file dalam google drive user

6. Insert plugin study to database

$plugin = [
    'name' => 'STUDY',
    'description' => 'Document your child learning activities',
];

7. Insert permission (maybe with php artisan tinker)

$permissions = [
    'menu study',
    'read study sheets',
    'create study sheets',
    'edit study sheets',
    'delete study sheets',
    'read study subjects',
    'create study subjects',
    'edit study subjects',
    'delete study subjects',
];

foreach ($permissions as $permission) {
    \App\Model\Auth\Permission::create(['name' => $permission, 'guard_name' => 'api']);
}

8. Insert role (maybe with php artisan tinker)

$role = \App\Model\Auth\Role::create(['name' => 'Parent', 'guard_name' => 'api']);

9. Give permission (maybe with php artisan tinker)

$role = \App\Model\Auth\Role::findByName('Parent', 'api');
$role->givePermissionTo([
    'menu plugin',
    'menu study',
    'read study sheets',
    'create study sheets',
    'edit study sheets',
    'delete study sheets',
]);

10. (Optional) Seed default subjects (maybe with php artisan tinker)

\App\Model\Plugin\Study\StudySubject::create(['name' => 'Math']),
\App\Model\Plugin\Study\StudySubject::create(['name' => 'English']),
\App\Model\Plugin\Study\StudySubject::create(['name' => 'Physics']),
\App\Model\Plugin\Study\StudySubject::create(['name' => 'Biology']),
\App\Model\Plugin\Study\StudySubject::create(['name' => 'Chemistry']),
\App\Model\Plugin\Study\StudySubject::create(['name' => 'History']),
\App\Model\Plugin\Study\StudySubject::create(['name' => 'Geography']),
\App\Model\Plugin\Study\StudySubject::create(['name' => 'Sociology'])

… sheet # Conflicts: # app/Http/Controllers/Api/Plugin/Study/StudySheetController.php # app/Model/Plugin/Study/StudySheet.php # database/factories/Plugin/Study/StudySheetFactory.php # database/migrations/tenant/2022_06_30_150001_create_study_sheets_table.php # database/seeds/PluginSeeder.php # tests/Feature/Http/Plugins/Study/StudySheetControllerTest.php

… controller

christhofer · 2022-07-18T08:59:30Z

API documentation

Routes

Route Study Subject

Method	Path	Description	Notes
GET	/subject	Get subject list	API collection Ordered by name ascending. See Request & Response
GET	/subject/{subject}	Unused, return nothing
POST	/subject	Create subject	See Request & Response
PUT	/subject/{subject}	Update subject	See Request & Response
DELETE	/subject/{subject}	Delete subject	Permanently delete the subject, existing sheet will have no subject

Route Study Sheet

Method	Path	Description	Notes
GET	/sheet	Get study sheet list	Extends eloquent filter. See Response
GET	/sheet/{sheet}	Get detail study sheet	See Response
POST	/sheet	Create study sheet	See Request & Response
PUT	/sheet/{sheet}	Update study sheet	See Request & Response
DELETE	/sheet/{sheet}	Delete study sheet

Requests & Responses

Create Study Subject Requests & Responses

REQUEST BODY

Query	Notes
-	No query params

RESPONSE BODY

{
  "data": [
    {
      "id": 1,
      "name": "Math",
      "created_at": "2022-07-01T06:00:00.000Z",
      "updated_at": "2022-07-01T06:00:00.000Z",
    }
  ],
}

Attribute	Notes
id	Unsigned BigInt, auto increment
name	String
created_at	Timestamp, format: ISO String
updated_at	Timestamp, format: ISO String

Create Study Subject Requests & Responses

REQUEST BODY

Fields	Validation Rules
name	required, string, max length 255

{
  "name": "Math",
}

RESPONSE BODY

{
  "id": 1,
  "name": "Math",
  "created_at": "2022-07-01T06:00:00.000Z",
  "updated_at": "2022-07-01T06:00:00.000Z",
}

Study Sheet Index Requests & Responses

REQUEST BODY

{
  "id": 1,
  "is_draft": true,
  "started_at": "2022-07-01T06:00:00.000Z",
  "ended_at": "2022-07-01T06:30:00.000Z",
  "subject_id": 1,
  "subject": {
    "id": 1,
    "name": "Math",
  },
  "institution": "ruangguru.com",
  "teacher": "John Doe",
  "competency": "Algebra",
  "learning_goals": "understand basic algebra",
  "activities": "classroom",
  "grade": 90,
  "behavior": "A",
  "remarks": "can follow the learning session",
  "created_at": "2022-07-01T06:00:00.000Z",
  "updated_at": "2022-07-01T06:00:00.000Z",
}

RESPONSE BODY

{
  "data": [
    {
      "id": 1,
      "is_draft": true,
      "started_at": "2022-07-01T06:00:00.000Z", // timestamp, ISO string
      "ended_at": "2022-07-01T06:30:00.000Z", // timestamp, ISO string
      "subject_id": 1,
      "subject": {
        "id": 1,
        "name": "Math",
      },
      "institution": "ruangguru.com",
      "teacher": "John Doe",
      "competency": "Algebra",
      "learning_goals": "understand basic algebra",
      "activities": "classroom",
      "grade": 90,
      "behavior": "A",
      "remarks": "can follow the learning session",
      "created_at": "2022-07-01T06:00:00.000Z", // Timestamp, format: ISO String  
      "updated_at": "2022-07-01T06:00:00.000Z", // Timestamp, format: ISO String  
    }
  ],
  "meta": {
    "from": 1,
    "to": 25,
    "total": 250,
    "last_page": 10,
    "current_page": 1,
  },
}

Study Sheet Create Requests & Responses

Used to create sheet

Fields	Validation Rules
is_draft	required, boolean
started_at	required if is_draft = false
ended_at	required if is_draft = false
photo	nullable, image
audio	nullable, audio
video	nullable, video
subject_id	required if is_draft = false, exists in table study_subjects
institution	nullable, string, max: 180
teacher	nullable, string, max: 180
competency	required if is_draft = false, string, max:180
learning_goals	required if is_draft = false, string, max:180
activities	nullable, string, max:180
grade	nullable, integer, max:100
behavior	required if is_draft = false, string, max:1, only "A" / "B" / "C"
remarks	nullable, string, max:180

REQUEST BODY

{
  "is_draft": true,
  "started_at": "2022-07-01T06:00:00.000Z", // timestamp, ISO string
  "ended_at": "2022-07-01T06:30:00.000Z", // timestamp, ISO string
  "photo": "<file>", // File, Image. Use multipart/form-data
  "audio": "<file>", // File, Audio. Use multipart/form-data
  "video": "<file>", // File, Video. Use multipart/form-data
  "subject_id": 1,
  "institution": "ruangguru.com",
  "teacher": "John Doe",
  "competency": "Algebra",
  "learning_goals": "understand basic algebra",
  "activities": "classroom",
  "grade": 90,
  "behavior": "A",
  "remarks": "can follow the learning session",
}

RESPONSE BODY

{
  "id": 1,
  "is_draft": true,
  "started_at": "2022-07-01T06:00:00.000Z",
  "ended_at": "2022-07-01T06:30:00.000Z",
  "photo": "<preview_link_to_file_in_gdrive>", // put this link to an iframe
  "audio": "<preview_link_to_file_in_gdrive>", // put this link to an iframe
  "video": "<preview_link_to_file_in_gdrive>", // put this link to an iframe
  "subject_id": 1,
  "subject": {
    "id": 1,
    "name": "Math",
  },
  "institution": "ruangguru.com",
  "teacher": "John Doe",
  "competency": "Algebra",
  "learning_goals": "understand basic algebra",
  "activities": "classroom",
  "grade": 90,
  "behavior": "A",
  "remarks": "can follow the learning session",
  "created_at": "2022-07-01T06:00:00.000Z",
  "updated_at": "2022-07-01T06:00:00.000Z",
}

Study Sheet Update Requests & Responses

Used to update sheet

Fields	Validation Rules
is_draft	required, boolean
started_at	required if is_draft = false
ended_at	required if is_draft = false
photo_file_id	nullable, string
audio_file_id	nullable, string
video_file_id	nullable, string
photo	nullable, image
audio	nullable, audio
video	nullable, video
subject_id	required if is_draft = false, exists in table study_subjects
institution	nullable, string, max: 180
teacher	nullable, string, max: 180
competency	required if is_draft = false, string, max:180
learning_goals	required if is_draft = false, string, max:180
activities	nullable, string, max:180
grade	nullable, integer, max:100
behavior	required if is_draft = false, string, max:1, only "A" / "B" / "C"
remarks	nullable, string, max:180

REQUEST BODY

{
  "is_draft": true,
  "started_at": "2022-07-01T06:00:00.000Z", // timestamp, ISO string
  "ended_at": "2022-07-01T06:30:00.000Z", // timestamp, ISO string
  "photo_file_id": "<file>", // if don't want to update the file
  "audio_file_id": "<file>", // if don't want to update the file
  "video_file_id": "<file>", // if don't want to update the file
  "photo": "<file>", // if updating the file
  "audio": "<file>", // if updating the file
  "video": "<file>", // if updating the file
  "subject_id": 1,
  "institution": "ruangguru.com",
  "teacher": "John Doe",
  "competency": "Algebra",
  "learning_goals": "understand basic algebra",
  "activities": "classroom",
  "grade": 90,
  "behavior": "A",
  "remarks": "can follow the learning session",
}

RESPONSE BODY

{
  "id": 1,
  "is_draft": true,
  "started_at": "2022-07-01T06:00:00.000Z",
  "ended_at": "2022-07-01T06:30:00.000Z",
  "photo": "<preview_link_to_file_in_gdrive>", // put this link to an iframe
  "audio": "<preview_link_to_file_in_gdrive>", // put this link to an iframe
  "video": "<preview_link_to_file_in_gdrive>", // put this link to an iframe
  "subject_id": 1,
  "subject": {
    "id": 1,
    "name": "Math",
  },
  "institution": "ruangguru.com",
  "teacher": "John Doe",
  "competency": "Algebra",
  "learning_goals": "understand basic algebra",
  "activities": "classroom",
  "grade": 90,
  "behavior": "A",
  "remarks": "can follow the learning session",
  "created_at": "2022-07-01T06:00:00.000Z",
  "updated_at": "2022-07-01T06:00:00.000Z",
}

christhofer · 2022-12-01T04:08:10Z

Notes to setting up local dev with Laragon

Backend

set PHP to v7.3
cp .env.example .env
set .env API_URL=https://api.point.test
set .env WEBSITE_URL=https://point.test
set .env TENANT_DOMAIN=point.test:8080
set hostfile api.point.test, dev.point.test
composer install --ignore-platform-reqs
php artisan key:generate
php artisan dev:new
seed table point_dev.study_subjects (lihat di bawah)
seed table point.plugin_project

Frontend

set Node to v14
set .env VUE_APP_API_ENDPOINT=https://api.point.test/api/v1
set .env VUE_APP_API_DOMAIN=https://api.point.test
set .env VUE_APP_DOMAIN=https://point.test
set package.json scripts "serve": "vue-cli-service serve --host=point.test --https=true",
set package.json scripts "dev": "npm run serve",
npm install
npm run dev, buka di https://dev.point.test:8080

Seed study subject

\App\Model\Plugin\Study\StudySubject::create(['name' => 'Math'])
\App\Model\Plugin\Study\StudySubject::create(['name' => 'English'])
\App\Model\Plugin\Study\StudySubject::create(['name' => 'Physics'])
\App\Model\Plugin\Study\StudySubject::create(['name' => 'Biology'])
\App\Model\Plugin\Study\StudySubject::create(['name' => 'Chemistry'])
\App\Model\Plugin\Study\StudySubject::create(['name' => 'History'])
\App\Model\Plugin\Study\StudySubject::create(['name' => 'Geography'])
\App\Model\Plugin\Study\StudySubject::create(['name' => 'Sociology'])

Set staging

set .env TENANT_DOMAIN=point.gradin.co.id
set .env GOOGLE_PROJECT_ID=point-test-gdrive
set .env GOOGLE_CLIENT_ID=580208808589-1fslvul9smgte7agu8dc1drdfhfnn640.apps.googleusercontent.com
set .env GOOGLE_CLIENT_SECRET=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
set .env,production VUE_APP_API_ENDPOINT=https://api.point.gradin.co.id/api/v1
set .env,production VUE_APP_API_DOMAIN=https://api.point.gradin.co.id
set .env,production VUE_APP_DOMAIN=https://point.gradin.co.id

study migration and seeder

1a1edf5

christhofer changed the title ~~WIP: study migration and seeder~~ WIP: Plugin Study Monitoring Jun 30, 2022

christhofer and others added 28 commits July 1, 2022 13:32

fixed migration name

36b2601

study subject route, model, controller, request

44a8ce3

study sheet model, route, controller, test

3a8445d

study migration and seeder

98d5ad4

fixed migration name

60e7e76

study subject route, model, controller, request

56bb94c

study sheet model, route, controller, test

b58fead

study sheet controller request

8e0f0aa

permission seeder

615f028

study sheet validation

409bc05

added more validation to study sheet request

b1d3194

study sheet controller show, add files to sheet store edit and delete…

c6209bf

… controller

oauth google drive

d3e7c20

oauth controller api

11784fc

added access type offline

d0c02a5

google drive oauth route

d08c945

added fillable scope

4f9f0fd

added is_draft to fillable

78c73a0

moved oauthcontroller google to routes api

91deccd

fixed eloquent filter equal should use strict comparison

4355ba1

always return auth url

dc0c7ff

add env website_url to config.app

e229465

fixed error invalid token format

c20ed67

added missing user_id

1bb7c94

validation mimetypes audio and video

9e1a9f5

study policy

841edd5

fixed error message for mimetypes validation

2975a56

christhofer changed the title ~~WIP: Plugin Study Monitoring~~ Plugin Study Monitoring Jul 8, 2022

christhofer added 3 commits July 18, 2022 13:52

set study sheet subject id to null when the subject deleted

7c171df

tidying up some comments

26af215

remove scopeFields call because it's already handled by eloquentFilter

4a910d8

martiendt merged commit 4596adb into point-red:alpha1 Jul 21, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Plugin Study Monitoring #385

Plugin Study Monitoring #385

christhofer commented Jun 30, 2022 •

edited

Loading

christhofer commented Jul 18, 2022

christhofer commented Dec 1, 2022 •

edited

Loading

Plugin Study Monitoring #385

Plugin Study Monitoring #385

Conversation

christhofer commented Jun 30, 2022 • edited Loading

Step saat merge

1. Run

2. (Optional) Re cache config and routes

3. Enable google drive api

4. Tambah Authorised redirect URIs

5. Edit .env tambahkan

6. Insert plugin study to database

7. Insert permission (maybe with php artisan tinker)

8. Insert role (maybe with php artisan tinker)

9. Give permission (maybe with php artisan tinker)

10. (Optional) Seed default subjects (maybe with php artisan tinker)

christhofer commented Jul 18, 2022

API documentation

Routes

Route Study Subject

Route Study Sheet

Requests & Responses

Create Study Subject Requests & Responses

REQUEST BODY

RESPONSE BODY

Create Study Subject Requests & Responses

REQUEST BODY

RESPONSE BODY

Study Sheet Index Requests & Responses

REQUEST BODY

RESPONSE BODY

Study Sheet Create Requests & Responses

REQUEST BODY

RESPONSE BODY

Study Sheet Update Requests & Responses

REQUEST BODY

RESPONSE BODY

christhofer commented Dec 1, 2022 • edited Loading

Notes to setting up local dev with Laragon

Backend

Frontend

Seed study subject

Set staging

christhofer commented Jun 30, 2022 •

edited

Loading

christhofer commented Dec 1, 2022 •

edited

Loading