Skip to content

Class: User

Jump to bottom
Adam Campbell edited this page Oct 3, 2016 · 13 revisions

Class Definition

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec mollis congue ligula, at fringilla libero placerat a. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Phasellus libero sapien, luctus eu magna ut, laoreet malesuada lacus. Ut mollis nulla a tristique sodales. Praesent ultricies cursus convallis. Phasellus ac facilisis ex.

Method Overview

Name Description
login Logs a User into a new session.
logout Logs a User out of their current session.
get_all_users Gets a list of data for all Users.
get_user Gets data about a specific User.
put_user Inserts a new User into the CMS.
delete_user Deletes an existing User from the CMS.
get_all_roles Gets a list of data for all Roles.
get_role Gets data about a specific Role.
put_role Inserts a new Role into the CMS.
delete_role Deletes an existing Role from the CMS.

Method Detail

login

Logs an existing User into a session by creating and storing an active Token for the User. Returns Token in the form of a Set-Cookie header, which is then logged into the Users machine.

Parameters
email - The email address for the existing User.
password - The password for the existing User.
token - Needs removing
user-table - The CMS-specific table name for the User table.
token-table - The CMS-specific table name for the Token table.

Returns
Message - Successfully logged in
Cookie - Returns Set-Cookie header containing the active Token for the User. Cookie has a 24 hour lifetime before expiring.

Throws
invalidEmail - The email address provided does not exist.
userHasNoRole - The User does not have a Role assigned to themselves.
userHasNoPassword - The User does not have a password.
invalidPassword - The password provided does not match the password stored. Botocore Exception - To be completed

Input JSON Sample

[
]

Output JSON Sample

[
]

logout

Logs an existing User out of their current session by deleting their active Token in the Token table.

Parameters
token - The Token string associated with a User. token-table - The CMS-specific table name for the Token table.

Returns
message - Successfully logged out

Throws
Botocore Exception - To be completed

Input JSON Sample

[
]

Output JSON Sample

[
]

get_all_users

Retrieves a data set of information regarding the existing Users from the User table.

Parameters
user-table - The CMS-specific table name for the User table.

Returns
Message - Successfully retrieved User data Data - A data set of information for existing Users.

Throws
noUsers - There are no existing Users within the User table. Botocore Exception - To be completed

Input JSON Sample

[
]

Output JSON Sample

[
]

get_user

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec mollis congue ligula, at fringilla libero placerat a. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Phasellus libero sapien, luctus eu magna ut, laoreet malesuada lacus. Ut mollis nulla a tristique sodales. Praesent ultricies cursus convallis. Phasellus ac facilisis ex.

Parameters
param1 - blah blah blah
param2 - blah blah blah
param3 - blah blah blah

Returns
return1 - blah blah blah
return2 - blah blah blah
return3 - blah blah blah

Throws
throw1 - blah blah blah
throw2 - blah blah blah
throw3 - blah blah blah

Input JSON Sample

[
  {
    "_id": "57f05487c696f85149c19d59",
    "index": 0,
    "guid": "903e41e6-b25b-4c5e-9b46-16896bd353c7",
    "isActive": true,
    "balance": "$2,637.63",
    "picture": "http://placehold.it/32x32",
    "age": 36,
    "eyeColor": "green",
    "name": "Meyers Rosario",
    "gender": "male",
    "company": "KENEGY",
    "email": "meyersrosario@kenegy.com",
    "phone": "+1 (946) 434-2432",
    "address": "710 Havens Place, Sidman, New York, 4142",
    "about": "aute exercitation non enim non sunt duis non irure minim est dolor anim tempor non sint quis amet eu qui nostrud nulla sint sunt cillum",
    "registered": "2015-04-04T01:42:14 -13:00",
    "latitude": -65.637769,
    "longitude": 131.338209,
    "tags": [
      "commodo",
      "eu",
      "nisi",
      "ut",
      "aliquip",
      "amet",
      "cupidatat"
    ]
  }
]

Output JSON Sample

[
  {
    "friends": [
      {
        "id": 0,
        "name": "Maddox Sparks"
      },
      {
        "id": 1,
        "name": "Tracy Pugh"
      },
      {
        "id": 2,
        "name": "Whitehead Price"
      }
    ],
    "greeting": "Hello, undefined! You have 10 unread messages.",
    "favoriteFruit": "banana"
  }
]

put_user

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec mollis congue ligula, at fringilla libero placerat a. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Phasellus libero sapien, luctus eu magna ut, laoreet malesuada lacus. Ut mollis nulla a tristique sodales. Praesent ultricies cursus convallis. Phasellus ac facilisis ex.

Parameters
param1 - blah blah blah
param2 - blah blah blah
param3 - blah blah blah

Returns
return1 - blah blah blah
return2 - blah blah blah
return3 - blah blah blah

Throws
throw1 - blah blah blah
throw2 - blah blah blah
throw3 - blah blah blah

Input JSON Sample

[
  {
    "_id": "57f05487c696f85149c19d59",
    "index": 0,
    "guid": "903e41e6-b25b-4c5e-9b46-16896bd353c7",
    "isActive": true,
    "balance": "$2,637.63",
    "picture": "http://placehold.it/32x32",
    "age": 36,
    "eyeColor": "green",
    "name": "Meyers Rosario",
    "gender": "male",
    "company": "KENEGY",
    "email": "meyersrosario@kenegy.com",
    "phone": "+1 (946) 434-2432",
    "address": "710 Havens Place, Sidman, New York, 4142",
    "about": "aute exercitation non enim non sunt duis non irure minim est dolor anim tempor non sint quis amet eu qui nostrud nulla sint sunt cillum",
    "registered": "2015-04-04T01:42:14 -13:00",
    "latitude": -65.637769,
    "longitude": 131.338209,
    "tags": [
      "commodo",
      "eu",
      "nisi",
      "ut",
      "aliquip",
      "amet",
      "cupidatat"
    ]
  }
]

Output JSON Sample

[
  {
    "friends": [
      {
        "id": 0,
        "name": "Maddox Sparks"
      },
      {
        "id": 1,
        "name": "Tracy Pugh"
      },
      {
        "id": 2,
        "name": "Whitehead Price"
      }
    ],
    "greeting": "Hello, undefined! You have 10 unread messages.",
    "favoriteFruit": "banana"
  }
]

delete_user

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec mollis congue ligula, at fringilla libero placerat a. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Phasellus libero sapien, luctus eu magna ut, laoreet malesuada lacus. Ut mollis nulla a tristique sodales. Praesent ultricies cursus convallis. Phasellus ac facilisis ex.

Parameters
param1 - blah blah blah
param2 - blah blah blah
param3 - blah blah blah

Returns
return1 - blah blah blah
return2 - blah blah blah
return3 - blah blah blah

Throws
throw1 - blah blah blah
throw2 - blah blah blah
throw3 - blah blah blah

Input JSON Sample

[
  {
    "_id": "57f05487c696f85149c19d59",
    "index": 0,
    "guid": "903e41e6-b25b-4c5e-9b46-16896bd353c7",
    "isActive": true,
    "balance": "$2,637.63",
    "picture": "http://placehold.it/32x32",
    "age": 36,
    "eyeColor": "green",
    "name": "Meyers Rosario",
    "gender": "male",
    "company": "KENEGY",
    "email": "meyersrosario@kenegy.com",
    "phone": "+1 (946) 434-2432",
    "address": "710 Havens Place, Sidman, New York, 4142",
    "about": "aute exercitation non enim non sunt duis non irure minim est dolor anim tempor non sint quis amet eu qui nostrud nulla sint sunt cillum",
    "registered": "2015-04-04T01:42:14 -13:00",
    "latitude": -65.637769,
    "longitude": 131.338209,
    "tags": [
      "commodo",
      "eu",
      "nisi",
      "ut",
      "aliquip",
      "amet",
      "cupidatat"
    ]
  }
]

Output JSON Sample

[
  {
    "friends": [
      {
        "id": 0,
        "name": "Maddox Sparks"
      },
      {
        "id": 1,
        "name": "Tracy Pugh"
      },
      {
        "id": 2,
        "name": "Whitehead Price"
      }
    ],
    "greeting": "Hello, undefined! You have 10 unread messages.",
    "favoriteFruit": "banana"
  }
]

get_all_roles

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec mollis congue ligula, at fringilla libero placerat a. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Phasellus libero sapien, luctus eu magna ut, laoreet malesuada lacus. Ut mollis nulla a tristique sodales. Praesent ultricies cursus convallis. Phasellus ac facilisis ex.

Parameters
param1 - blah blah blah
param2 - blah blah blah
param3 - blah blah blah

Returns
return1 - blah blah blah
return2 - blah blah blah
return3 - blah blah blah

Throws
throw1 - blah blah blah
throw2 - blah blah blah
throw3 - blah blah blah

Input JSON Sample

[
  {
    "_id": "57f05487c696f85149c19d59",
    "index": 0,
    "guid": "903e41e6-b25b-4c5e-9b46-16896bd353c7",
    "isActive": true,
    "balance": "$2,637.63",
    "picture": "http://placehold.it/32x32",
    "age": 36,
    "eyeColor": "green",
    "name": "Meyers Rosario",
    "gender": "male",
    "company": "KENEGY",
    "email": "meyersrosario@kenegy.com",
    "phone": "+1 (946) 434-2432",
    "address": "710 Havens Place, Sidman, New York, 4142",
    "about": "aute exercitation non enim non sunt duis non irure minim est dolor anim tempor non sint quis amet eu qui nostrud nulla sint sunt cillum",
    "registered": "2015-04-04T01:42:14 -13:00",
    "latitude": -65.637769,
    "longitude": 131.338209,
    "tags": [
      "commodo",
      "eu",
      "nisi",
      "ut",
      "aliquip",
      "amet",
      "cupidatat"
    ]
  }
]

Output JSON Sample

[
  {
    "friends": [
      {
        "id": 0,
        "name": "Maddox Sparks"
      },
      {
        "id": 1,
        "name": "Tracy Pugh"
      },
      {
        "id": 2,
        "name": "Whitehead Price"
      }
    ],
    "greeting": "Hello, undefined! You have 10 unread messages.",
    "favoriteFruit": "banana"
  }
]

get_role

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec mollis congue ligula, at fringilla libero placerat a. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Phasellus libero sapien, luctus eu magna ut, laoreet malesuada lacus. Ut mollis nulla a tristique sodales. Praesent ultricies cursus convallis. Phasellus ac facilisis ex.

Parameters
param1 - blah blah blah
param2 - blah blah blah
param3 - blah blah blah

Returns
return1 - blah blah blah
return2 - blah blah blah
return3 - blah blah blah

Throws
throw1 - blah blah blah
throw2 - blah blah blah
throw3 - blah blah blah

Input JSON Sample

[
  {
    "_id": "57f05487c696f85149c19d59",
    "index": 0,
    "guid": "903e41e6-b25b-4c5e-9b46-16896bd353c7",
    "isActive": true,
    "balance": "$2,637.63",
    "picture": "http://placehold.it/32x32",
    "age": 36,
    "eyeColor": "green",
    "name": "Meyers Rosario",
    "gender": "male",
    "company": "KENEGY",
    "email": "meyersrosario@kenegy.com",
    "phone": "+1 (946) 434-2432",
    "address": "710 Havens Place, Sidman, New York, 4142",
    "about": "aute exercitation non enim non sunt duis non irure minim est dolor anim tempor non sint quis amet eu qui nostrud nulla sint sunt cillum",
    "registered": "2015-04-04T01:42:14 -13:00",
    "latitude": -65.637769,
    "longitude": 131.338209,
    "tags": [
      "commodo",
      "eu",
      "nisi",
      "ut",
      "aliquip",
      "amet",
      "cupidatat"
    ]
  }
]

Output JSON Sample

[
  {
    "friends": [
      {
        "id": 0,
        "name": "Maddox Sparks"
      },
      {
        "id": 1,
        "name": "Tracy Pugh"
      },
      {
        "id": 2,
        "name": "Whitehead Price"
      }
    ],
    "greeting": "Hello, undefined! You have 10 unread messages.",
    "favoriteFruit": "banana"
  }
]

put_role

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec mollis congue ligula, at fringilla libero placerat a. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Phasellus libero sapien, luctus eu magna ut, laoreet malesuada lacus. Ut mollis nulla a tristique sodales. Praesent ultricies cursus convallis. Phasellus ac facilisis ex.

Parameters
param1 - blah blah blah
param2 - blah blah blah
param3 - blah blah blah

Returns
return1 - blah blah blah
return2 - blah blah blah
return3 - blah blah blah

Throws
throw1 - blah blah blah
throw2 - blah blah blah
throw3 - blah blah blah

Input JSON Sample

[
  {
    "_id": "57f05487c696f85149c19d59",
    "index": 0,
    "guid": "903e41e6-b25b-4c5e-9b46-16896bd353c7",
    "isActive": true,
    "balance": "$2,637.63",
    "picture": "http://placehold.it/32x32",
    "age": 36,
    "eyeColor": "green",
    "name": "Meyers Rosario",
    "gender": "male",
    "company": "KENEGY",
    "email": "meyersrosario@kenegy.com",
    "phone": "+1 (946) 434-2432",
    "address": "710 Havens Place, Sidman, New York, 4142",
    "about": "aute exercitation non enim non sunt duis non irure minim est dolor anim tempor non sint quis amet eu qui nostrud nulla sint sunt cillum",
    "registered": "2015-04-04T01:42:14 -13:00",
    "latitude": -65.637769,
    "longitude": 131.338209,
    "tags": [
      "commodo",
      "eu",
      "nisi",
      "ut",
      "aliquip",
      "amet",
      "cupidatat"
    ]
  }
]

Output JSON Sample

[
  {
    "friends": [
      {
        "id": 0,
        "name": "Maddox Sparks"
      },
      {
        "id": 1,
        "name": "Tracy Pugh"
      },
      {
        "id": 2,
        "name": "Whitehead Price"
      }
    ],
    "greeting": "Hello, undefined! You have 10 unread messages.",
    "favoriteFruit": "banana"
  }
]

delete_role

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec mollis congue ligula, at fringilla libero placerat a. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Phasellus libero sapien, luctus eu magna ut, laoreet malesuada lacus. Ut mollis nulla a tristique sodales. Praesent ultricies cursus convallis. Phasellus ac facilisis ex.

Parameters
param1 - blah blah blah
param2 - blah blah blah
param3 - blah blah blah

Returns
return1 - blah blah blah
return2 - blah blah blah
return3 - blah blah blah

Throws
throw1 - blah blah blah
throw2 - blah blah blah
throw3 - blah blah blah

Input JSON Sample

[
  {
    "_id": "57f05487c696f85149c19d59",
    "index": 0,
    "guid": "903e41e6-b25b-4c5e-9b46-16896bd353c7",
    "isActive": true,
    "balance": "$2,637.63",
    "picture": "http://placehold.it/32x32",
    "age": 36,
    "eyeColor": "green",
    "name": "Meyers Rosario",
    "gender": "male",
    "company": "KENEGY",
    "email": "meyersrosario@kenegy.com",
    "phone": "+1 (946) 434-2432",
    "address": "710 Havens Place, Sidman, New York, 4142",
    "about": "aute exercitation non enim non sunt duis non irure minim est dolor anim tempor non sint quis amet eu qui nostrud nulla sint sunt cillum",
    "registered": "2015-04-04T01:42:14 -13:00",
    "latitude": -65.637769,
    "longitude": 131.338209,
    "tags": [
      "commodo",
      "eu",
      "nisi",
      "ut",
      "aliquip",
      "amet",
      "cupidatat"
    ]
  }
]

Output JSON Sample

[
  {
    "friends": [
      {
        "id": 0,
        "name": "Maddox Sparks"
      },
      {
        "id": 1,
        "name": "Tracy Pugh"
      },
      {
        "id": 2,
        "name": "Whitehead Price"
      }
    ],
    "greeting": "Hello, undefined! You have 10 unread messages.",
    "favoriteFruit": "banana"
  }
]

Home

Lambda Function Reference

Controller.py
User.py
Blog.py
Page.py
Security.py
Error.py
S3_Upload.py

Clone this wiki locally