mycookbook/api

cookbook api - this is the core application that powers all the services used to make cookbooksHQ function.

Prerequisites

• Download and install composer globally https://getcomposer.org/download/
• Add an alias to your bash or zsh profile

open ~/.bashrc OR
open ~/.zshrc

# add this line
alias composer='/usr/local/bin/composer'

# remember to source the file.
e.g
source ~/.bashrc OR
source ~/.zshrc

• Ensure php is correctly installed on your machine. You can use brew, follow the instructions to update your httpd.conf file and restart apache.
• install the docker desktop app suitable for your hardware https://www.docker.com/products/docker-desktop/

Installation

Use the make command to setup the project like so:

make install

This command spins up the containers, install project dependencies, creates a barebone .env file which you can update as needed, sets the app key etc For a full glossary of all the make commands, look in the Makefile in the project root.

Now you can access the app via:

http://localhost:8080/api/v1/ping

To run a command directly in the "app" container, you could use docker-compose exec app [command], for example

docker-compose exec app php artisan env
# which prints the application environment

Contributing

1. Always rebase your branch against the base branch git rebase -i --autosquash origin/staging
2. Strictly adhere to branch naming rules e.g feature/descriptive-branch-name, bugfix/descriptive-branch-name etc (hotfix, chore)

Testing in dev

• Follow this guide to learn how to setup phpunit in phpstorm.
• You can also use any of the following make cmds to run tests

make test
make test_unit
make test_api

Help

To see a list of all the make commands, type make in the project root. It will dispplay the full list of available commands you can use.

Examples:

Setup PHPStorm + + Docker + Xdebug + postman

• Open settings by pressing (cmd + ,) button
• Under PHP, add a new CLI interpreter

• Select From Docker, Vagrant ... option

• Select Docker Compose, set the configuration file to ./docker-compose.yml and the service select app

• Now your PHP interpreter settings hosuld look like this

• Next, you want to set up the test framework, click the plus sign and select PHPUnit by remote interpreter

• Select the interpreter you just created from the dropdown list

• Now you can start debugging, set a break point in any controller class and run the test associated with it in debug mode

Listening for requests from postman

• First step is to set up a server
• On postman add this parameter. When postman detects this in a request, it creates a cookie with the value of XDEBUG_SESSION_START. This has an expiry time of 30 minutes so you dont have to include it in your requests all the time.

XDEBUG_SESSION_START=PHPSTORM

• Finally, tell postman to listen for PHP Debug Connections

• Set a break point in the code called by the endpoint you are consuming on postman, hit send to start debugging

api's Issues

Ads and Campaign Manager

This is likely both frontend and backend. The details of this is not fully mapped out yet.

- use a common request class to validate requests

• use a common request class to validate requests - done
• have transformer classes to transform responses
• many more ...

Originally posted by @fokosun in #67

Refactor All Functional Tests

Refactor All Functional Tests

As an authenticated user, I should be able to update my profile

A user should be able to update the following:

• username [must be unique]
• must be able to delete their profile
• must be able to update their avatar
• must be able to update their bio

search query syntax

The search query syntax is broken for most of it

• find and fix the broken ones
• fix regular search

add ability to subscribe by email through contact form on landing page

• create a new entry in the subscribers table
• return response 200 on success
• trigger a slack alert to notify about the new subscription
• send thank you email to user

this week

SPIKE: how to authenticate users in counties where tiktok is banned

https://www.makeuseof.com/what-countries-is-tiktok-banned/

suggestions:
provide basic auth option for all users

Already have an account? [signin](https://web.cookbookshq.com/#/signin?m=basic)

This will present a basic auth screen, which will also have the create account option and forgot password option

h4. dev note

• modify back end to require username
• username must be unique
• a new api to verify uniqueness of username perhaps?

As an authenticated user, I want to be able to save my new recipe as a draft

Dev Notes

• does not require a new endpoint to create a recipe

• requires creating a new migration

• update the create recipe code to save the recipe as a draft if draft is set to true in the request

• When a recipe is not in draft, it's considered a final state and transition back to drafts in not allowed.

• the newly created table should contain only the recipe id [id, recipe_id], the recipe should still be stored in the recipes table

• add a new attribute to the recipe model [is_draft]

• add a new attribute to the user model [drafts] this should be a collection of all the user recipes that are drafts i.e each item in the collection must be a serialized copy of the recipe instance

#206

Upgrade framework version to compatible php version 8

Upgrade lumen to a php 8 compatible version

TikTok videos

Create an endpoint that will return a list of tiktok videos of an authenticated user

Dev notes

SPIKE: As an authenticated user, I want to be able to see items on my for you page

Dev Notes

• requires a scheduled job that will run daily (twice a day or more)

• the job will write for you page data to pub/sub topics

• For users having user preferences, the data written to pub/sub will be driven by their configured preferences

• The cronjob will alongside also publish generic data to pub/sub topics, this will determine what users without user preferences see on their fir you page

• Need to figure out the most cost effective approach to use, between google pub/sub or plain simple pusher

• Figure out how to setup supervisor on heroku to keep the schedular running

Tiktok social auth with socialite

Problem
When some users try to login with tiktok, their user info is not returned. It only works for admin at the moment..

Describe alternatives you've considered
Swap current implementation to use Socialte to help fix the problem.

Logging and Monitoring

Sentry and datadog (api or agent)

Twitter social auth with socialite

Problem
Not currently implemented

Describe alternatives you've considered
Use Socialte

research on how to integrate elastic search

integrate elastic search into the platform

As a user, I want to be able to register/signin with basic auth

Dev Notes

• does not require a new endpoint to register
• does not require a new endpoint to signin
• register endpoint must now require username (username must be unique)
• ensure unique constraint is applied to the username i.e name_slug field in the users table
• another endpoint to verify uniqueness of username is required

POST /api/v1/auth/register

request {
    body: {
        name: required
        email: required|email|unique
        password: required
        username: required|unique
    }
}

POST /api/v1/auth/signin

request {
    body: {
        email: required|exists
        password: required
    }
}

GET /api/v1/username-available?q={username}

response {
    code: 200 OK
    body: true
}

response {
    code: 400
    body: false
}

Fix broken CI

CI is complete broken
Unable to run tests locally inside docker

refactor codebase

• use a common request class to validate requests
• have transformer classes to transform responses
• many more ...

pinterest auth with socialite

Problem
Not currently implemented

Describe alternatives you've considered
Use Socialte

As a user, I want to be able to configure my preferences

Dev Notes

• requires a new api endpoint
• requires creating a new migration

POST /api/v1/users/{user_id}/preferences

header {
    Authorization: Bearer {token}
}

User preferences can be stored as a json representation in the user_preferences table.

The following preferences can be set:

- default cookbook id
- default image picker
- topics
- store fronts (urls)

Note

• add user preferences as an attribute to the user model
• add coverage for this change in the tests

who to follow

Instagram auth with socialte

Problem
Not currently implemented

Describe alternatives you've considered
Use Socialte

Refactor All Unit Tests

Refactor All Unit Tests

enable logging

either

• logdna
• or some other logging and monitoring service