auth-mlsdev v0.1.3

Build

Run yarn build to build the project.

Running unit tests

Run yarn test to execute the unit tests via Karma.

Settings

To change FALLBACK URI:

{
  provide: FALLBACK_PAGE_URI,
  useValue: 'your path'
}

To use your custom auth service:

{
  provide: AUTH_SERVICE,
  deps: [ YourService ],
  useFactory: factory
}

API contract

Auth

Token based auth in header. Example:

"Authorization: Bearer ACCESS_TOKEN"

API End points

Session (Facebook) ???

POST /api/facebook/session

{
  "access_token": string
}

Responses:

• 200 Session
• 422 Errors

Session (Google Plus)

POST /api/gooogle_plus/session

{
  "access_token": string
}

Responses:

• 200 Session
• 422 Errors

Session (LinkedIn) ???

POST /api/linked_in/session

{
  "access_token": string
}

Responses:

• 200 Session
• 422 Errors

Session (Twitter) ???

POST /api/twitter/session

{
  "access_token": string
}

Responses:

• 200 Session
• 422 Errors

Session (Instagram) ???

POST /api/instagram/session

{
  "access_token": string
}

Responses:

• 200 Session
• 422 Errors

Session (Pinterest) ???

POST /api/pinterest/session

{
  "access_token": string
}

Responses:

• 200 Session
• 422 Errors

Session (Log in)

POST /api/session

{
  "session": {
    "email": string,
    "password": string,
    "password_confirmation": string,
  }
}

Responses:

• 200 Session
• 422 Errors

Profile (Sign Up)

POST /api/profile

{
  "profile": {
    "email": string,
    "first_name": string,           // required
    "last_name": string,             // required
    "password": string,           // required
    "password_confirmation": string,           // required
  }
}

Responses:

• 200 Session
• 422 Errors

Profile (Update)

PUT/PATCH /api/profile

{
  "profile": {
    "first_name": string,
    "last_name": string,
  }
}

Responses:

• 200 User
• 401
• 422 Errors

Change Password

POST /api/password_change

{
  "password_change": {
    "password": string,
    "new_password": string,
    "new_password_confirmation": string,
  }
}

Responses:

• 200
• 401
• 422 Errors

Session (Sign out)

DELETE /api/session

Responses:

• 200
• 401

Restore password

POST /api/restore_password

{
  "restore_password": {
    "email": string,
    "path":  string
  }
}

Response:

• 200
• 404

Restore password

GET /api/restore_passwords/:token

Response:

• 200
• 404

Reset password

POST /api/reset_password

{
  "reset_password": {
    "token": string,
    "password": string,
    "password_confirmation": string
  }
}

Responses:

• 200
• 404
• 422 Errors

Models

ErrorsModel

{
  "errors": {
    "base": string[] // everything that doesn't belong to `form`
    "email": string[],
    "password_confirmation": string[]
  }
}

UserModel

{
  "id": number,
  "role": string,
  "email": string,
  "phone": string,
  "banned": boolean,
  "first_name": string,
  "last_name": string,
  "avatar_url": string,
  "status": "completed" | "incompleted",
}

SessionModel

{
  "token": string,
  "user": [User](#usermodel)
}