6 |
12 |
13 |
14 |
28 |
29 |
38 |
--------------------------------------------------------------------------------
/client/src/components/Pagination/index.vue:
--------------------------------------------------------------------------------
1 |
2 |
6 |
18 |
19 |
20 |
68 |
69 |
79 |
--------------------------------------------------------------------------------
/client/src/components/Screenfull/index.vue:
--------------------------------------------------------------------------------
1 |
2 |
3 |
8 |
9 |
10 |
52 |
--------------------------------------------------------------------------------
/client/src/icons/README.md:
--------------------------------------------------------------------------------
1 | # vue-svgicon
2 |
3 | ## English
4 |
5 | * All svg components were generated by `vue-svgicon` using svg files
6 | * After you adding new svg files into `icons/svg` folder, run `yarn svg` to regerenrate all svg components (before this, you should have `vue-svgicon` installed globally or use `npx`)
7 | * See details at: [https://github.com/MMF-FE/vue-svgicon](https://github.com/MMF-FE/vue-svgicon)
8 |
9 | ## 中文
10 |
11 | * 所有的 svg 组件都是由 `vue-svgicon` 生成的
12 | * 每当在 `icons/svg` 文件夹内添加 icon 之后，可以通过执行 `yarn svg` 来重新生成所有组件 (在此之前需要全局安装 `vue-svgicon` 或使用 `npx`)
13 | * 详细文档请见：[https://github.com/MMF-FE/vue-svgicon](https://github.com/MMF-FE/vue-svgicon)
14 |
--------------------------------------------------------------------------------
/client/src/icons/components/404.ts:
--------------------------------------------------------------------------------
1 | /* eslint-disable */
2 | /* tslint:disable */
3 | // @ts-ignore
4 | import icon from 'vue-svgicon'
5 | icon.register({
6 | '404': {
7 | width: 128,
8 | height: 128,
9 | viewBox: '0 0 128 128',
10 | data: '
6 |
7 |
13 | 
17 |
18 |
24 |
28 |
32 |
33 |
34 |
35 |
36 |
49 |
50 |
99 |
--------------------------------------------------------------------------------
/client/src/layout/components/index.ts:
--------------------------------------------------------------------------------
1 | export { default as AppMain } from './AppMain.vue'
2 | export { default as Navbar } from './Navbar/index.vue'
3 | export { default as Settings } from './Settings/index.vue'
4 | export { default as Sidebar } from './Sidebar/index.vue'
5 | export { default as TagsView } from './TagsView/index.vue'
6 |
--------------------------------------------------------------------------------
/client/src/layout/mixin/resize.ts:
--------------------------------------------------------------------------------
1 | import { Component, Vue, Watch } from 'vue-property-decorator'
2 | import { AppModule, DeviceType } from '@/store/modules/app'
3 |
4 | const WIDTH = 992; // refer to Bootstrap's responsive design
5 |
6 | @Component({
7 | name: 'ResizeMixin'
8 | })
9 | export default class extends Vue {
10 | get device() {
11 | return AppModule.device
12 | }
13 |
14 | get sidebar() {
15 | return AppModule.sidebar
16 | }
17 |
18 | @Watch('$route')
19 | private onRouteChange() {
20 | if (this.device === DeviceType.Mobile && this.sidebar.opened) {
21 | AppModule.CloseSideBar(false)
22 | }
23 | }
24 |
25 | beforeMount() {
26 | window.addEventListener('resize', this.resizeHandler)
27 | }
28 |
29 | mounted() {
30 | const isMobile = this.isMobile();
31 | if (isMobile) {
32 | AppModule.ToggleDevice(DeviceType.Mobile);
33 | AppModule.CloseSideBar(true)
34 | }
35 | }
36 |
37 | beforeDestroy() {
38 | window.removeEventListener('resize', this.resizeHandler)
39 | }
40 |
41 | private isMobile() {
42 | const rect = document.body.getBoundingClientRect();
43 | return rect.width - 1 < WIDTH
44 | }
45 |
46 | private resizeHandler() {
47 | if (!document.hidden) {
48 | const isMobile = this.isMobile();
49 | AppModule.ToggleDevice(isMobile ? DeviceType.Mobile : DeviceType.Desktop);
50 | if (isMobile) {
51 | AppModule.CloseSideBar(true)
52 | }
53 | }
54 | }
55 | }
56 |
--------------------------------------------------------------------------------
/client/src/main.ts:
--------------------------------------------------------------------------------
1 | import Vue, { DirectiveOptions } from 'vue'
2 |
3 | import 'normalize.css'
4 | import ElementUI from 'element-ui'
5 | import SvgIcon from 'vue-svgicon'
6 |
7 | import '@/styles/element-variables.scss'
8 | import '@/styles/index.scss'
9 |
10 | import App from '@/App.vue'
11 | import store from '@/store'
12 | import { AppModule } from '@/store/modules/app'
13 | import router from '@/router'
14 | import '@/icons/components'
15 | import '@/permission'
16 | import '@/utils/error-log'
17 | import '@/pwa/register-service-worker'
18 |
19 | Vue.use(ElementUI, {
20 | size: AppModule.size, // Set element-ui default size
21 | });
22 |
23 | Vue.use(SvgIcon, {
24 | tagName: 'svg-icon',
25 | defaultWidth: '1em',
26 | defaultHeight: '1em'
27 | });
28 |
29 | Vue.config.productionTip = false;
30 |
31 | new Vue({
32 | router,
33 | store,
34 | render: (h) => h(App)
35 | }).$mount('#app');
36 |
--------------------------------------------------------------------------------
/client/src/pwa/components/ServiceWorkerUpdatePopup.vue:
--------------------------------------------------------------------------------
1 |
61 |
62 |
68 |
--------------------------------------------------------------------------------
/client/src/pwa/register-service-worker.ts:
--------------------------------------------------------------------------------
1 | /* eslint-disable no-console */
2 |
3 | import { register } from 'register-service-worker'
4 |
5 | if (process.env.NODE_ENV === 'production') {
6 | register(`${process.env.BASE_URL}service-worker.js`, {
7 | ready() {
8 | console.log(
9 | 'App is being served from cache by a service worker.\n' +
10 | 'For more details, visit https://goo.gl/AFskqB'
11 | )
12 | },
13 | registered(registration) {
14 | console.log('Service worker has been registered.');
15 | // Routinely check for app updates by testing for a new service worker.
16 | setInterval(() => {
17 | registration.update()
18 | }, 1000 * 60 * 60) // hourly checks
19 | },
20 | cached() {
21 | console.log('Content has been cached for offline use.')
22 | },
23 | updatefound() {
24 | console.log('New content is downloading.')
25 | },
26 | updated(registration) {
27 | console.log('New content is available; please refresh.');
28 | // Add a custom event and dispatch it.
29 | // Used to display of a 'refresh' banner following a service worker update.
30 | // Set the event payload to the service worker registration object.
31 | document.dispatchEvent(
32 | new CustomEvent('swUpdated', { detail: registration })
33 | )
34 | },
35 | offline() {
36 | console.log('No internet connection found. App is running in offline mode.')
37 | },
38 | error(error) {
39 | console.error('Error during service worker registration:', error)
40 | }
41 | })
42 | }
43 |
--------------------------------------------------------------------------------
/client/src/pwa/service-worker.js:
--------------------------------------------------------------------------------
1 | // This is the code piece that GenerateSW mode can't provide for us.
2 | // This code listens for the user's confirmation to update the app.
3 | self.addEventListener('message', (e) => {
4 | if (e.data) {
5 | if (e.data === 'skipWaiting') {
6 | self.skipWaiting();
7 | }
8 | }
9 | });
10 |
11 | /* eslint-disable no-undef */
12 | workbox.core.clientsClaim();
13 | workbox.precaching.precacheAndRoute(self.__precacheManifest || []);
14 |
--------------------------------------------------------------------------------
/client/src/router/modules/roles.ts:
--------------------------------------------------------------------------------
1 | import { RouteConfig } from "vue-router";
2 | import Layout from "@/layout/index.vue";
3 |
4 | const rolesRouter: RouteConfig = {
5 | path: "/roles",
6 | component: Layout,
7 | redirect: "list",
8 | name: "Roles",
9 | meta: {
10 | title: "Roles",
11 | icon: "password",
12 | roles: ["admin"]
13 | },
14 | children: [
15 | {
16 | path: "list",
17 | component: () =>
18 | import(/* webpackChunkName: "role-list" */ "@/views/roles/ListRoles.vue"),
19 | name: "ListRoles",
20 | meta: { title: "List Roles", icon: "list" }
21 | },
22 | {
23 | path: "create",
24 | component: () =>
25 | import(
26 | /* webpackChunkName: "role-create" */ "@/views/roles/CreateRole.vue"
27 | ),
28 | name: "CreateRole",
29 | meta: { title: "Create Role", icon: "form" }
30 | },
31 | {
32 | path: "edit/:id",
33 | component: () =>
34 | import(/* webpackChunkName: "role-edit" */ "@/views/roles/ListRoles.vue"),
35 | name: "EditRole",
36 | meta: { title: "Edit Role", icon: "form", hidden: true }
37 | }
38 | ]
39 | };
40 |
41 | export default rolesRouter;
42 |
--------------------------------------------------------------------------------
/client/src/router/modules/shops.ts:
--------------------------------------------------------------------------------
1 | import { RouteConfig } from "vue-router";
2 | import Layout from "@/layout/index.vue";
3 |
4 | const shopsRouter: RouteConfig = {
5 | path: "/shops",
6 | component: Layout,
7 | redirect: "list",
8 | name: "shops",
9 | meta: {
10 | title: "Shops",
11 | icon: "shopping",
12 | roles: ["admin"]
13 | },
14 | children: [
15 | {
16 | path: "list",
17 | component: () =>
18 | import(/* webpackChunkName: "shop-list" */ "@/views/shops/ListShops.vue"),
19 | name: "Listshops",
20 | meta: { title: "List shops", icon: "list" }
21 | },
22 | {
23 | path: "create",
24 | component: () =>
25 | import(
26 | /* webpackChunkName: "shop-create" */ "@/views/shops/CreateShop.vue"
27 | ),
28 | name: "Createshop",
29 | meta: { title: "Create shop", icon: "form" }
30 | },
31 | {
32 | path: "edit/:id",
33 | component: () =>
34 | import(/* webpackChunkName: "shop-edit" */ "@/views/shops/EditShop.vue"),
35 | name: "Editshop",
36 | meta: { title: "Edit shop", icon: "form", hidden: true }
37 | }
38 | ]
39 | };
40 |
41 | export default shopsRouter;
42 |
--------------------------------------------------------------------------------
/client/src/router/modules/users.ts:
--------------------------------------------------------------------------------
1 | import { RouteConfig } from "vue-router";
2 | import Layout from "@/layout/index.vue";
3 |
4 | const usersRouter: RouteConfig = {
5 | path: "/users",
6 | component: Layout,
7 | redirect: "list",
8 | name: "Users",
9 | meta: {
10 | title: "Users",
11 | icon: "user",
12 | roles: ["admin"]
13 | },
14 | children: [
15 | {
16 | path: "list",
17 | component: () =>
18 | import(/* webpackChunkName: "user-list" */ "@/views/users/ListUsers.vue"),
19 | name: "ListUsers",
20 | meta: { title: "List Users", icon: "list" }
21 | },
22 | {
23 | path: "create",
24 | component: () =>
25 | import(
26 | /* webpackChunkName: "user-create" */ "@/views/users/CreateUser.vue"
27 | ),
28 | name: "CreateUser",
29 | meta: { title: "Create User", icon: "form" }
30 | },
31 | {
32 | path: "edit/:id",
33 | component: () =>
34 | import(/* webpackChunkName: "user-edit" */ "@/views/users/EditUser.vue"),
35 | name: "EditUser",
36 | meta: { title: "Edit User", icon: "form", hidden: true }
37 | }
38 | ]
39 | };
40 |
41 | export default usersRouter;
42 |
--------------------------------------------------------------------------------
/client/src/settings.ts:
--------------------------------------------------------------------------------
1 | interface ISettings {
2 | title: string // Overrides the default title
3 | showSettings: boolean // Controls settings panel display
4 | showTagsView: boolean // Controls tagsview display
5 | showSidebarLogo: boolean // Controls siderbar logo display
6 | fixedHeader: boolean // If true, will fix the header component
7 | errorLog: string[] // The env to enable the errorlog component, default 'production' only
8 | sidebarTextTheme: boolean // If true, will change active text color for sidebar based on theme
9 | devServerPort: number // Port number for webpack-dev-server
10 | mockServerPort: number // Port number for mock server
11 | }
12 |
13 | // You can customize below settings :)
14 | const settings: ISettings = {
15 | title: 'FastAPI Admin Template',
16 | showSettings: true,
17 | showTagsView: true,
18 | fixedHeader: false,
19 | showSidebarLogo: false,
20 | errorLog: ['production'],
21 | sidebarTextTheme: true,
22 | devServerPort: 9527,
23 | mockServerPort: 9528
24 | };
25 |
26 | export default settings
27 |
--------------------------------------------------------------------------------
/client/src/shims.d.ts:
--------------------------------------------------------------------------------
1 | declare module '*.vue' {
2 | import Vue from 'vue'
3 | export default Vue
4 | }
5 |
6 | declare module 'element-ui/lib/locale/lang/*' {
7 | export const elementLocale: any
8 | }
9 |
10 | declare module '*.gif' {
11 | export const gif: any
12 | }
13 |
14 | // TODO: remove this part after vue-count-to has its typescript file
15 | declare module 'vue-count-to'
16 |
17 | // TODO: remove this part after vuedraggable has its typescript file
18 | declare module 'vuedraggable'
19 |
20 | // TODO: remove this part after vue2-dropzone has its typescript file
21 | declare module 'vue2-dropzone'
22 |
23 | // TODO: remove this part after vue-image-crop-upload has its typescript file
24 | declare module 'vue-image-crop-upload'
25 |
26 | // TODO: remove this part after vue-splitpane has its typescript file
27 | declare module 'vue-splitpane'
28 |
--------------------------------------------------------------------------------
/client/src/store/index.ts:
--------------------------------------------------------------------------------
1 | import Vue from 'vue'
2 | import Vuex from 'vuex'
3 | import { IAppState } from './modules/app'
4 | import { IUserMeState } from './modules/me'
5 | import { ITagsViewState } from './modules/tags-view'
6 | import { IErrorLogState } from './modules/error-log'
7 | import { IPermissionState } from './modules/permission'
8 | import { ISettingsState } from './modules/settings'
9 | import { IUsersState } from "@/store/modules/users"
10 | import { IRolesState } from "@/store/modules/roles"
11 | import { IShopsState } from "@/store/modules/shops"
12 |
13 | Vue.use(Vuex);
14 |
15 | export interface IRootState {
16 | app: IAppState
17 | userMe: IUserMeState
18 | tagsView: ITagsViewState
19 | errorLog: IErrorLogState
20 | permission: IPermissionState
21 | settings: ISettingsState
22 | users: IUsersState
23 | roles: IRolesState
24 | shops: IShopsState
25 | }
26 |
27 | // Declare empty store first, dynamically register all modules later.
28 | export default new Vuex.Store29 | {{ title }} 30 |
31 |
3 |
5 |
6 |
7 |
21 |
22 |
30 |
--------------------------------------------------------------------------------
/client/src/views/dashboard/index.vue:
--------------------------------------------------------------------------------
1 |
2 | Admin Dashboard
4 |
3 |
5 |
6 |
7 |
34 |
--------------------------------------------------------------------------------
/client/src/views/dashboard/user/index.vue:
--------------------------------------------------------------------------------
1 |
2 |
3 |
19 |
20 |
21 |
40 |
41 |
71 |
--------------------------------------------------------------------------------
/client/src/views/profile/components/UserRoles.vue:
--------------------------------------------------------------------------------
1 |
2 |
4 |
18 |
5 | {{ name }}
6 | Editor's Dashboard
7 |
8 | Your roles:
9 |
17 |
14 | {{ item }}
15 |
16 |
3 |
4 |
7 |
8 |
9 |
13 |
15 |
16 |
17 |
19 |
20 |
21 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
60 |
--------------------------------------------------------------------------------
/client/src/views/redirect/index.vue:
--------------------------------------------------------------------------------
1 |
19 |
--------------------------------------------------------------------------------
/client/src/views/users/EditUser.vue:
--------------------------------------------------------------------------------
1 |
2 |
3 | Edit
4 | {{ user }}
5 |
6 | Log
7 |
8 |
9 |
10 |
41 |
--------------------------------------------------------------------------------
/client/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "target": "esnext",
4 | "module": "esnext",
5 | "strict": true,
6 | "jsx": "preserve",
7 | "importHelpers": true,
8 | "moduleResolution": "node",
9 | "experimentalDecorators": true,
10 | "esModuleInterop": true,
11 | "allowSyntheticDefaultImports": true,
12 | "sourceMap": true,
13 | "baseUrl": ".",
14 | "types": [
15 | "node",
16 | "jest",
17 | "webpack-env"
18 | ],
19 | "paths": {
20 | "@/*": [
21 | "src/*"
22 | ]
23 | },
24 | "lib": [
25 | "esnext",
26 | "dom",
27 | "dom.iterable",
28 | "scripthost"
29 | ]
30 | },
31 | "include": [
32 | "src/**/*.ts",
33 | "src/**/*.tsx",
34 | "src/**/*.vue",
35 | "tests/**/*.ts",
36 | "tests/**/*.tsx"
37 | ],
38 | "exclude": [
39 | "node_modules"
40 | ]
41 | }
42 |
--------------------------------------------------------------------------------
/docker-compose.yml:
--------------------------------------------------------------------------------
1 | version: "3.7"
2 |
3 | volumes:
4 | postgres_data: {}
5 |
6 | services:
7 | backend:
8 | build:
9 | context: ./server
10 | dockerfile: Dockerfile
11 | target: development
12 | volumes:
13 | - ./server:/app
14 | env_file:
15 | - docker/server.env
16 | - docker/postgres.env
17 | depends_on:
18 | - postgres
19 | - mailhog
20 | ports:
21 | - "8000:8000"
22 |
23 | postgres:
24 | image: postgres:12.2
25 | volumes:
26 | - postgres_data:/var/lib/postgresql/data
27 | - ./docker/init.sql:/docker-entrypoint-initdb.d/init.sql
28 | env_file:
29 | - docker/postgres.env
30 | ports:
31 | - "5432:5432"
32 |
33 | pgadmin:
34 | image: dpage/pgadmin4
35 | depends_on:
36 | - postgres
37 | environment:
38 | PGADMIN_DEFAULT_EMAIL: "pgadmin"
39 | PGADMIN_DEFAULT_PASSWORD: "pgadmin"
40 | ports:
41 | - "5050:80"
42 |
43 | mailhog:
44 | image: mailhog/mailhog:v1.0.0
45 | ports:
46 | - "8025:8025"
47 |
48 | splash-browser:
49 | image: scrapinghub/splash
50 | ports:
51 | - "8050:8050"
52 |
--------------------------------------------------------------------------------
/docker/init.sql:
--------------------------------------------------------------------------------
1 | CREATE EXTENSION IF NOT EXISTS pgcrypto;
--------------------------------------------------------------------------------
/docker/postgres.env:
--------------------------------------------------------------------------------
1 | # PostgreSQL
2 | # ---------------------
3 | POSTGRES_HOST=postgres
4 | POSTGRES_PORT=5432
5 | POSTGRES_USER=postgres
6 | POSTGRES_PASSWORD=postgres
7 | POSTGRES_DB=fastapi_backend
8 |
--------------------------------------------------------------------------------
/docker/server.env:
--------------------------------------------------------------------------------
1 | # docker-compose
2 | # ---------------------
3 | COMPOSE_PROJECT_NAME=fastapi
4 |
5 | # FastAPI
6 | # -----------------------------
7 | SECRET_KEY=a5dbf43e07f4d19e5b73bc8gdfdvfd9a8f74
8 | PROJECT_NAME=Fastapi Backend
9 | SERVER_HOST=0.0.0.0
10 | FIRST_SUPERUSER=user@example.com
11 | FIRST_SUPERUSER_PASSWORD=a5dbf43e07f4d19e5b73bc89a8f74
12 | USERS_OPEN_REGISTRATION=true
13 | CORS_WHITELIST=["http://localhost", "http://localhost:8000", "http://0.0.0.0:8000"]
14 |
15 | # SMTP
16 | # -----------------------------
17 | SMTP_USER=admin@backend.com
18 | SMTP_PASSWORD=wqiefasnfsafna
19 | SMTP_HOST=mailhog
20 | SMTP_PORT=1025
21 | SMTP_TLS=false
22 | SMTP_SSL=false
23 |
--------------------------------------------------------------------------------
/imgs/1-login.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/michaeloliverx/fullstack-fastapi-vuejs-price-aggregator/a686b7b71dca04f90538d00b350158cb6d7e9db2/imgs/1-login.png
--------------------------------------------------------------------------------
/imgs/2-admin-dashboard.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/michaeloliverx/fullstack-fastapi-vuejs-price-aggregator/a686b7b71dca04f90538d00b350158cb6d7e9db2/imgs/2-admin-dashboard.png
--------------------------------------------------------------------------------
/imgs/3.0-user-CRUD.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/michaeloliverx/fullstack-fastapi-vuejs-price-aggregator/a686b7b71dca04f90538d00b350158cb6d7e9db2/imgs/3.0-user-CRUD.png
--------------------------------------------------------------------------------
/imgs/3.1-user-create.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/michaeloliverx/fullstack-fastapi-vuejs-price-aggregator/a686b7b71dca04f90538d00b350158cb6d7e9db2/imgs/3.1-user-create.png
--------------------------------------------------------------------------------
/imgs/4-user-profile.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/michaeloliverx/fullstack-fastapi-vuejs-price-aggregator/a686b7b71dca04f90538d00b350158cb6d7e9db2/imgs/4-user-profile.png
--------------------------------------------------------------------------------
/imgs/5.0-shop-CRUD.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/michaeloliverx/fullstack-fastapi-vuejs-price-aggregator/a686b7b71dca04f90538d00b350158cb6d7e9db2/imgs/5.0-shop-CRUD.png
--------------------------------------------------------------------------------
/imgs/5.1-shop-select.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/michaeloliverx/fullstack-fastapi-vuejs-price-aggregator/a686b7b71dca04f90538d00b350158cb6d7e9db2/imgs/5.1-shop-select.png
--------------------------------------------------------------------------------
/imgs/6-prices-display.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/michaeloliverx/fullstack-fastapi-vuejs-price-aggregator/a686b7b71dca04f90538d00b350158cb6d7e9db2/imgs/6-prices-display.png
--------------------------------------------------------------------------------
/server/alembic/README:
--------------------------------------------------------------------------------
1 | Generic single-database configuration.
--------------------------------------------------------------------------------
/server/alembic/script.py.mako:
--------------------------------------------------------------------------------
1 | """${message}
2 |
3 | Revision ID: ${up_revision}
4 | Revises: ${down_revision | comma,n}
5 | Create Date: ${create_date}
6 |
7 | """
8 | from alembic import op
9 | import sqlalchemy as sa
10 | ${imports if imports else ""}
11 |
12 | # revision identifiers, used by Alembic.
13 | revision = ${repr(up_revision)}
14 | down_revision = ${repr(down_revision)}
15 | branch_labels = ${repr(branch_labels)}
16 | depends_on = ${repr(depends_on)}
17 |
18 |
19 | def upgrade():
20 | ${upgrades if upgrades else "pass"}
21 |
22 |
23 | def downgrade():
24 | ${downgrades if downgrades else "pass"}
25 |
--------------------------------------------------------------------------------
/server/alembic/versions/daff23253894_adding_user_shops_relationship.py:
--------------------------------------------------------------------------------
1 | """Adding user shops relationship
2 |
3 | Revision ID: daff23253894
4 | Revises: fab2a86c8b63
5 | Create Date: 2020-04-11 08:46:05.071956
6 |
7 | """
8 | import sqlalchemy as sa
9 | from alembic import op
10 |
11 | # revision identifiers, used by Alembic.
12 | revision = "daff23253894"
13 | down_revision = "fab2a86c8b63"
14 | branch_labels = None
15 | depends_on = None
16 |
17 |
18 | def upgrade():
19 | # ### commands auto generated by Alembic - please adjust! ###
20 | pass
21 | # ### end Alembic commands ###
22 |
23 |
24 | def downgrade():
25 | # ### commands auto generated by Alembic - please adjust! ###
26 | pass
27 | # ### end Alembic commands ###
28 |
--------------------------------------------------------------------------------
/server/alembic/versions/e7ff97c10b8f_adding_user_roles_association_table.py:
--------------------------------------------------------------------------------
1 | """Adding user roles association table
2 |
3 | Revision ID: e7ff97c10b8f
4 | Revises: 46773fb5dc7f
5 | Create Date: 2020-03-30 18:34:39.846931
6 |
7 | """
8 | import sqlalchemy as sa
9 | from alembic import op
10 |
11 | # revision identifiers, used by Alembic.
12 | revision = "e7ff97c10b8f"
13 | down_revision = "46773fb5dc7f"
14 | branch_labels = None
15 | depends_on = None
16 |
17 |
18 | def upgrade():
19 | # ### commands auto generated by Alembic - please adjust! ###
20 | op.create_table(
21 | "user_roles",
22 | sa.Column("id", sa.Integer(), nullable=False),
23 | sa.Column(
24 | "created_at",
25 | sa.TIMESTAMP(timezone=True),
26 | server_default=sa.text("now()"),
27 | nullable=True,
28 | ),
29 | sa.Column(
30 | "updated_at",
31 | sa.TIMESTAMP(timezone=True),
32 | server_default=sa.text("now()"),
33 | nullable=True,
34 | ),
35 | sa.Column("user_id", sa.Integer(), nullable=True),
36 | sa.Column("role_id", sa.Integer(), nullable=True),
37 | sa.ForeignKeyConstraint(
38 | ["role_id"], ["role.id"], onupdate="CASCADE", ondelete="CASCADE"
39 | ),
40 | sa.ForeignKeyConstraint(
41 | ["user_id"], ["user.id"], onupdate="CASCADE", ondelete="CASCADE"
42 | ),
43 | sa.PrimaryKeyConstraint("id"),
44 | )
45 | # ### end Alembic commands ###
46 |
47 |
48 | def downgrade():
49 | # ### commands auto generated by Alembic - please adjust! ###
50 | op.drop_table("user_roles")
51 | # ### end Alembic commands ###
52 |
--------------------------------------------------------------------------------
/server/app/api/apirouter.py:
--------------------------------------------------------------------------------
1 | from fastapi import APIRouter
2 |
3 | from .v1 import v1_router
4 |
5 | router = APIRouter()
6 | router.include_router(router=v1_router.router, prefix="/v1")
7 |
8 |
9 | @router.get("/healthcheck")
10 | def healthcheck():
11 | return {"status": "ok"}
12 |
--------------------------------------------------------------------------------
/server/app/api/v1/routes/auth.py:
--------------------------------------------------------------------------------
1 | from fastapi import APIRouter, Depends, HTTPException, status
2 | from fastapi.security import OAuth2PasswordRequestForm
3 | from sqlalchemy import orm
4 |
5 | from app.db.session import get_db
6 | from app.enums import userenums
7 | from app.models import tokenmodels, usermodels
8 | from app.service import tokenservice, userservice
9 | from app.settings import settings
10 |
11 | from ..dependencies.auth import get_current_user
12 |
13 | router = APIRouter()
14 |
15 |
16 | @router.post("/login", response_model=tokenmodels.TokenResponse)
17 | def login(
18 | *,
19 | db_session: orm.Session = Depends(get_db),
20 | form_data: OAuth2PasswordRequestForm = Depends(),
21 | ):
22 | """
23 | OAuth2 compatible token login, get an access token for future requests.
24 | """
25 | user = userservice.authenticate(
26 | db_session=db_session, email=form_data.username, password=form_data.password
27 | )
28 | if not user:
29 | raise HTTPException(
30 | status_code=status.HTTP_400_BAD_REQUEST, detail="REPLACE ME",
31 | )
32 |
33 | elif not user.status == userenums.UserStatus.active:
34 | raise HTTPException(
35 | status_code=status.HTTP_400_BAD_REQUEST, detail="USER_INACTIVE"
36 | )
37 |
38 | # TODO: maybe ? add custom encoder like ujson/orjson to encode method
39 | token = tokenservice.encode(
40 | payload={"user_id": str(user.id), "aud": tokenservice.AUTH_AUDIENCE},
41 | lifetime_seconds=settings.JWT_AUTH_LIFETIME_SECONDS,
42 | )
43 |
44 | return {
45 | "access_token": token,
46 | "token_type": "bearer",
47 | }
48 |
49 |
50 | @router.post("/logout")
51 | def logout():
52 | return {"logout-status": "successful"}
53 |
54 |
55 | @router.post("/login/test-token", response_model=usermodels.UserRead)
56 | def test_token(current_user: usermodels.User = Depends(get_current_user)):
57 | """
58 | Test access token
59 | """
60 | return current_user
61 |
--------------------------------------------------------------------------------
/server/app/api/v1/routes/roles.py:
--------------------------------------------------------------------------------
1 | from typing import List
2 |
3 | from fastapi import APIRouter, Depends, HTTPException, status
4 | from sqlalchemy.orm import Session
5 |
6 | from app.db.session import get_db
7 | from app.models import rolemodels
8 | from app.service import roleservice
9 |
10 | from ..dependencies.or_404 import get_role_by_id_or_404
11 |
12 | router = APIRouter()
13 |
14 |
15 | @router.get(
16 | "/", response_model=List[rolemodels.RoleRead],
17 | )
18 | def get_roles(*, db_session: Session = Depends(get_db)):
19 | """
20 | Retrieve a list of roles.
21 | """
22 | return roleservice.get_multiple(db_session=db_session)
23 |
24 |
25 | @router.post(
26 | "/", status_code=status.HTTP_201_CREATED, response_model=rolemodels.RoleRead,
27 | )
28 | def create_role(
29 | *, db_session: Session = Depends(get_db), role_in: rolemodels.RoleCreate
30 | ):
31 | """
32 | Create a new role.
33 | """
34 | if roleservice.get_by_name(db_session=db_session, name=role_in.name):
35 | raise HTTPException(
36 | status_code=status.HTTP_400_BAD_REQUEST, detail="Role already exists.",
37 | )
38 |
39 | return roleservice.create(db_session=db_session, role_in=role_in)
40 |
41 |
42 | @router.get("/{id}", response_model=rolemodels.RoleRead)
43 | def read_role(role: rolemodels.Role = Depends(get_role_by_id_or_404),):
44 | """
45 | Retrieve details about a specific role.
46 | """
47 | return role
48 |
49 |
50 | @router.put(
51 | "/{id}", response_model=rolemodels.RoleRead,
52 | )
53 | def update_role(
54 | *,
55 | db_session: Session = Depends(get_db),
56 | role: rolemodels.Role = Depends(get_role_by_id_or_404),
57 | role_in: rolemodels.RoleUpdate,
58 | ):
59 | """
60 | Update an individual role.
61 | """
62 |
63 | return roleservice.update(db_session=db_session, role=role, role_in=role_in)
64 |
65 |
66 | @router.delete(
67 | "/{id}", response_model=rolemodels.RoleRead,
68 | )
69 | def delete_role(
70 | *,
71 | db_session: Session = Depends(get_db),
72 | role: rolemodels.Role = Depends(get_role_by_id_or_404),
73 | ):
74 | """
75 | Delete an individual role.
76 | """
77 | return roleservice.delete(db_session=db_session, id_=role.id)
78 |
--------------------------------------------------------------------------------
/server/app/api/v1/v1_router.py:
--------------------------------------------------------------------------------
1 | from fastapi import APIRouter, Depends
2 |
3 | from .dependencies.auth import admin_role
4 | from .routes import auth, me, roles, shops, users
5 |
6 | router = APIRouter()
7 |
8 | router.include_router(router=auth.router, prefix="/auth", tags=["auth"])
9 |
10 | router.include_router(router=me.router, tags=["self"])
11 |
12 | router.include_router(
13 | router=users.router,
14 | prefix="/users",
15 | tags=["users"],
16 | dependencies=[Depends(admin_role)],
17 | )
18 |
19 | router.include_router(
20 | router=roles.router,
21 | prefix="/roles",
22 | tags=["roles"],
23 | dependencies=[Depends(admin_role)],
24 | )
25 |
26 | router.include_router(router=shops.router, prefix="/shops", tags=["shops"])
27 |
--------------------------------------------------------------------------------
/server/app/bgtasks.py:
--------------------------------------------------------------------------------
1 | from fastapi.background import BackgroundTasks
2 |
3 |
4 | def send_signup_email():
5 | pass
6 |
--------------------------------------------------------------------------------
/server/app/db/initdb.py:
--------------------------------------------------------------------------------
1 | from typing import Dict, List
2 |
3 | import yaml
4 | from sqlalchemy import engine, orm
5 |
6 | from app.models import rolemodels, shopmodels, usermodels
7 | from app.service import roleservice, shopservice, userservice
8 | from app.settings import settings
9 |
10 | INITDB_PATH = settings.APP_DIR / "db" / "initdb.yaml"
11 | with open(INITDB_PATH) as file:
12 | config = yaml.safe_load(file)
13 |
14 |
15 | def initdb(db_session: orm.Session):
16 | init_roles(db_session=db_session)
17 | init_shops(db_session=db_session)
18 |
19 |
20 | def init_roles(db_session: orm.Session):
21 | roles_in = [
22 | rolemodels.RoleCreate(name=role["name"], description=role["description"])
23 | for role in config["roles"]
24 | ]
25 | roleservice.create_multiple(db_session=db_session, roles_in=roles_in)
26 |
27 |
28 | def init_shops(db_session: orm.Session):
29 | for shop in config["shops"]:
30 | shop_in = shopmodels.ShopCreate(**shop)
31 | shopservice.create(db_session=db_session, shop_in=shop_in)
32 |
33 |
34 | def setup_guids_postgresql(engine: engine.Engine) -> None: # pragma: no cover
35 | """
36 | Set up UUID generation using the pgcrypto extension for postgres
37 | This query only needs to be executed once when the database is created
38 | """
39 | engine.execute('create EXTENSION if not EXISTS "pgcrypto"')
40 |
--------------------------------------------------------------------------------
/server/app/db/session.py:
--------------------------------------------------------------------------------
1 | from sqlalchemy import create_engine, orm
2 |
3 | from app.settings import settings
4 |
5 | engine = create_engine(settings.POSTGRES_URL, pool_pre_ping=True)
6 | SessionLocal = orm.sessionmaker(bind=engine)
7 |
8 |
9 | def get_db():
10 | """Endpoint dependency for getting db session."""
11 | db = SessionLocal()
12 | try:
13 | yield db
14 | finally:
15 | db.close()
16 |
--------------------------------------------------------------------------------
/server/app/enums/logenums.py:
--------------------------------------------------------------------------------
1 | from enum import Enum
2 |
3 |
4 | class LogLevel(str, Enum):
5 | debug = "debug"
6 | info = "info"
7 | error = "error"
8 | warning = "warning"
9 | critical = "critical"
10 |
--------------------------------------------------------------------------------
/server/app/enums/userenums.py:
--------------------------------------------------------------------------------
1 | from enum import Enum
2 |
3 |
4 | class UserStatus(str, Enum):
5 | """
6 | UserStatus enum.
7 |
8 | active: User account is active.
9 | inactive: User account is inactive, perhaps email has not been validated.
10 | disabled: User has been disabled, perhaps banned by an administrator.
11 | """
12 |
13 | active = "active"
14 | inactive = "inactive"
15 | disabled = "disabled"
16 |
--------------------------------------------------------------------------------
/server/app/exceptions/apiexceptions.py:
--------------------------------------------------------------------------------
1 | from typing import Any
2 |
3 | from fastapi import HTTPException, status
4 |
5 | JWTExpiredException = HTTPException(
6 | status_code=status.HTTP_403_FORBIDDEN, detail="JWT has expired"
7 | )
8 |
9 | JWTInvalidAudienceException = HTTPException(
10 | status_code=status.HTTP_403_FORBIDDEN, detail="Incorrect JWT audience."
11 | )
12 |
13 | InvalidCredentialsException = HTTPException(
14 | status_code=status.HTTP_401_UNAUTHORIZED,
15 | detail="Credentials could not be validated",
16 | )
17 |
18 | UnauthorizedException = HTTPException(
19 | status_code=status.HTTP_401_UNAUTHORIZED, detail="User is not authenticated."
20 | )
21 |
22 | UserNotFoundException = HTTPException(
23 | status_code=status.HTTP_404_NOT_FOUND, detail="The specified user was not found."
24 | )
25 |
26 | AUTHENTICATION_FAILED = "Could not validate credentials."
27 | FORBIDDEN = "You are not authorized to access this resource."
28 | REGISTRATION_CLOSED = "Open user registration is forbidden on this server"
29 |
30 | USER_EXISTS = "Email address is already in use."
31 | USER_INACTIVE = "User is inactive."
32 |
33 | _NOT_FOUND = "{item} not found."
34 | USER_NOT_FOUND = _NOT_FOUND.format(item="User")
35 |
36 | EMAIL_NOT_FOUND = _NOT_FOUND.format(item="Email address")
37 |
--------------------------------------------------------------------------------
/server/app/main.py:
--------------------------------------------------------------------------------
1 | import logging
2 |
3 | from fastapi import FastAPI
4 | from fastapi.middleware.cors import CORSMiddleware
5 |
6 | from .api import apirouter
7 | from .settings import settings
8 |
9 | log = logging.getLogger(__name__)
10 |
11 | app = FastAPI(debug=settings.DEBUG, title=settings.PROJECT_NAME)
12 |
13 | # TODO: Add correct local CORS origins to .env file, atm everything is allowed
14 | if settings.CORS_WHITELIST:
15 | app.add_middleware(
16 | CORSMiddleware,
17 | allow_origins=["*"],
18 | allow_credentials=True,
19 | allow_methods=["*"],
20 | allow_headers=["*"],
21 | )
22 |
23 |
24 | app.include_router(router=apirouter.router, prefix="/api")
25 |
--------------------------------------------------------------------------------
/server/app/messages/apimsg.py:
--------------------------------------------------------------------------------
1 | import enum
2 |
3 | from fastapi import HTTPException, status
4 |
5 | AUTHENTICATION_FAILED = "Could not validate credentials."
6 | FORBIDDEN = "You are not authorized to access this resource."
7 | REGISTRATION_CLOSED = "Open user registration is forbidden on this server"
8 |
9 | USER_EXISTS = "Email address is already in use."
10 | USER_INACTIVE = "User is inactive."
11 |
12 | _NOT_FOUND = "{item} not found."
13 | USER_NOT_FOUND = _NOT_FOUND.format(item="User")
14 |
15 | EMAIL_NOT_FOUND = _NOT_FOUND.format(item="Email address")
16 |
--------------------------------------------------------------------------------
/server/app/messages/usermsgs.py:
--------------------------------------------------------------------------------
1 | from app.enums.userenums import UserStatus
2 |
3 | USER_STATUS_DESCRIPTIONS = {
4 | UserStatus.active: "User account is activated.",
5 | UserStatus.inactive: "User account is not activated.",
6 | UserStatus.disabled: "User account has been disabled.",
7 | }
8 |
--------------------------------------------------------------------------------
/server/app/models/__init__.py:
--------------------------------------------------------------------------------
1 | """
2 | All known models are imported here so Alembic can see them.
3 | """
4 |
5 | from .rolemodels import *
6 | from .shopmodels import *
7 | from .usermodels import *
8 |
--------------------------------------------------------------------------------
/server/app/models/meta/pydanticbase.py:
--------------------------------------------------------------------------------
1 | from datetime import datetime
2 |
3 | import orjson
4 | from pydantic import BaseModel
5 |
6 |
7 | def orjson_dumps(v, *, default):
8 | """
9 | orjson.dumps returns bytes, to match standard json.dumps we need to decode.
10 | orjson.dumps option arguments provide many options such as `option=orjson.OPT_SERIALIZE_UUID` to natively encode UUID instances.
11 | """
12 | return orjson.dumps(v, default=default).decode()
13 |
14 |
15 | class PydanticBase(BaseModel):
16 | """PydanticBase with custom JSON implementation.
17 | 'orjson' is used here as it takes care of datetime
18 | encoding natively and gives better (de)serialisation performance.
19 |
20 | .. seealso::
21 |
22 | https://pydantic-docs.helpmanual.io/usage/exporting_models/#custom-json-deserialisation
23 |
24 | """
25 |
26 | class Config:
27 | orm_mode = True
28 | validate_assignment = True
29 | json_loads = orjson.loads
30 | json_dumps = orjson_dumps
31 |
--------------------------------------------------------------------------------
/server/app/models/meta/pydanticmixins.py:
--------------------------------------------------------------------------------
1 | from datetime import datetime
2 | from typing import Optional
3 |
4 | from pydantic import BaseModel
5 |
6 |
7 | class PydanticTS(BaseModel):
8 | created_at: datetime
9 | updated_at: Optional[datetime]
10 |
--------------------------------------------------------------------------------
/server/app/models/meta/pydantictypes.py:
--------------------------------------------------------------------------------
1 | """
2 |
3 | See: https://pydantic-docs.helpmanual.io/usage/types/#custom-data-types
4 | """
5 |
--------------------------------------------------------------------------------
/server/app/models/meta/sqlalchemybase.py:
--------------------------------------------------------------------------------
1 | from sqlalchemy.ext.declarative import declarative_base
2 | from sqlalchemy_utils import EmailType, generic_repr
3 |
4 |
5 | @generic_repr
6 | class SQLAlchemyBase:
7 | """
8 | SQLAlchemyBase class.
9 | """
10 |
11 | __abstract__ = True
12 |
13 | # https://gist.githubusercontent.com/mjhea0/9b9c400a2bc58e6c90e5f77eeb739d6b/raw/2ca3e8c696011b500cf2864cd4a8f125112f4251/base_mixin.py
14 | # _repr_hide = ["created_at", "updated_at"]
15 | #
16 | # def __repr__(self): # pragma: no cover
17 | # values = ", ".join(
18 | # "%s=%r" % (n, getattr(self, n))
19 | # for n in self.__table__.c.keys()
20 | # if n not in self._repr_hide
21 | # )
22 | # return "%s(%s)" % (self.__class__.__name__, values)
23 |
24 |
25 | SQLAlchemyBase = declarative_base(cls=SQLAlchemyBase)
26 |
--------------------------------------------------------------------------------
/server/app/models/meta/sqlalchemymixins.py:
--------------------------------------------------------------------------------
1 | from sqlalchemy import TIMESTAMP, Column, Integer
2 | from sqlalchemy.sql import func
3 |
4 | from .sqlalchemytypes import GUID
5 |
6 |
7 | class SQLAlchemyIntPK:
8 | """
9 | Provides an integer PK column named `id`.
10 | """
11 |
12 | id = Column(Integer, primary_key=True)
13 |
14 |
15 | class SQLAlchemyGUIDPK:
16 | """
17 | Provides a GUID PK column named `id`.
18 | """
19 |
20 | id = Column(GUID, primary_key=True)
21 |
22 |
23 | class SQLAlchemyTS:
24 | """
25 | SQLAlchemy timestamp mixin.
26 | """
27 |
28 | created_at = Column(TIMESTAMP(timezone=True), server_default=func.now())
29 | updated_at = Column(TIMESTAMP(timezone=True), server_onupdate=func.now())
30 |
--------------------------------------------------------------------------------
/server/app/models/meta/sqlalchemytypes.py:
--------------------------------------------------------------------------------
1 | """
2 | See: https://docs.sqlalchemy.org/en/13/core/custom_types.html
3 | """
4 |
5 | import datetime
6 | import uuid
7 |
8 | from sqlalchemy import DateTime
9 | from sqlalchemy.dialects.postgresql import UUID
10 | from sqlalchemy.types import CHAR, TypeDecorator
11 |
12 |
13 | class GUID(TypeDecorator):
14 | """Platform-independent GUID type.
15 |
16 | Uses Postgresql's UUID type, otherwise uses
17 | CHAR(32), storing as stringified hex values.
18 |
19 | .. seealso::
20 |
21 | http://docs.sqlalchemy.org/en/latest/core/custom_types.html#backend-agnostic-guid-type
22 |
23 | """
24 |
25 | impl = CHAR
26 |
27 | def load_dialect_impl(self, dialect):
28 | if dialect.name == "postgresql":
29 | return dialect.type_descriptor(UUID())
30 | else:
31 | return dialect.type_descriptor(CHAR(32))
32 |
33 | def process_bind_param(self, value, dialect):
34 | if value is None:
35 | return value
36 | elif dialect.name == "postgresql":
37 | return str(value)
38 | else:
39 | if not isinstance(value, uuid.UUID):
40 | return "%.32x" % uuid.UUID(value)
41 | else:
42 | # hexstring
43 | return "%.32x" % value
44 |
45 | def process_result_value(self, value, dialect):
46 | if value is None:
47 | return value
48 | else:
49 | return uuid.UUID(value)
50 |
51 |
52 | class TZDateTime(TypeDecorator):
53 | impl = DateTime
54 |
55 | def process_bind_param(self, value, dialect):
56 | if value is not None:
57 | if not value.tzinfo:
58 | raise TypeError("tzinfo is required")
59 | value = value.astimezone(datetime.timezone.utc).replace(tzinfo=None)
60 | return value
61 |
62 | def process_result_value(self, value, dialect):
63 | if value is not None:
64 | value = value.replace(tzinfo=datetime.timezone.utc)
65 | return value
66 |
--------------------------------------------------------------------------------
/server/app/models/rolemodels.py:
--------------------------------------------------------------------------------
1 | """
2 |
3 | https://flask-user.readthedocs.io/en/latest/data_models.html
4 |
5 | https://factoryboy.readthedocs.io/en/latest/orms.html#factory.alchemy.SQLAlchemyOptions.sqlalchemy_session
6 |
7 | """
8 |
9 | from typing import Optional
10 |
11 | from sqlalchemy import Column, ForeignKey, Integer, String
12 |
13 | from .meta.pydanticbase import PydanticBase
14 | from .meta.pydanticmixins import PydanticTS
15 | from .meta.sqlalchemybase import SQLAlchemyBase
16 | from .meta.sqlalchemymixins import SQLAlchemyIntPK, SQLAlchemyTS
17 |
18 |
19 | # sqlalchemy models
20 | class Role(SQLAlchemyTS, SQLAlchemyIntPK, SQLAlchemyBase):
21 | __tablename__ = "role"
22 | name = Column(String, unique=True, nullable=False)
23 | description = Column(String)
24 |
25 |
26 | class UserRoles(SQLAlchemyTS, SQLAlchemyIntPK, SQLAlchemyBase):
27 | """Association table to hold user roles."""
28 |
29 | __tablename__ = "user_roles"
30 | user_id = Column(
31 | Integer, ForeignKey("user.id", ondelete="CASCADE", onupdate="CASCADE")
32 | )
33 | role_id = Column(
34 | Integer, ForeignKey("role.id", ondelete="CASCADE", onupdate="CASCADE")
35 | )
36 |
37 |
38 | # pydantic models
39 | class RoleCreate(PydanticBase):
40 | """Properties to receive via API on creation"""
41 |
42 | name: str
43 | description: Optional[str]
44 |
45 |
46 | class RoleRead(PydanticTS, PydanticBase):
47 | """Attributes to return via API"""
48 |
49 | id: int
50 | name: str
51 | description: str
52 |
53 |
54 | class RoleUpdate(PydanticBase):
55 | """Properties to receive via API on update"""
56 |
57 | name: Optional[str]
58 | description: Optional[str]
59 |
--------------------------------------------------------------------------------
/server/app/models/scrapermodels.py:
--------------------------------------------------------------------------------
1 | import logging
2 | import re
3 | from typing import List, Optional
4 |
5 | from pydantic import BaseModel, validator
6 |
7 | from .meta.pydanticbase import PydanticBase
8 |
9 | logger = logging.getLogger(__name__)
10 |
11 | # Matching 00p in currency
12 | CURRENCY_PENCE_REGEX = re.compile(r"(\d{2})[p]")
13 |
14 | # Matches any whitespace characters and £ symbol
15 | CURRENCY_WHITESPACE_REGEX = re.compile(r"[£()\s+]")
16 |
17 |
18 | class ScrapedItem(PydanticBase):
19 | name: Optional[str] = None
20 | url: Optional[str] = None
21 | price: Optional[str] = None
22 | price_per_unit: Optional[str] = None
23 | image_url: Optional[str] = None
24 |
25 | @validator("price")
26 | def format_p(cls, v):
27 | """Transforms varying pricing formats to #.##"""
28 | if v:
29 | v = re.sub(CURRENCY_WHITESPACE_REGEX, "", v)
30 | match = re.match(CURRENCY_PENCE_REGEX, v)
31 | if match:
32 | v = f"0.{match.group(1)}"
33 | return v
34 |
35 | @validator("price_per_unit")
36 | def format_ppu(cls, v):
37 | if v:
38 | v = re.sub(CURRENCY_WHITESPACE_REGEX, "", v)
39 | v = v.replace("per", "/")
40 | return v
41 |
42 | @validator("*", pre=True)
43 | def filter_invalid_values(cls, v):
44 | if isinstance(v, list):
45 | return None
46 | return v
47 |
48 |
49 | class ShopListings(BaseModel):
50 | id: int
51 | name: str
52 | listings: Optional[List[ScrapedItem]] = None
53 |
--------------------------------------------------------------------------------
/server/app/models/shopmodels.py:
--------------------------------------------------------------------------------
1 | from typing import Optional
2 |
3 | from sqlalchemy import JSON, Boolean, Column, ForeignKey, Integer, String
4 |
5 | from .meta.pydanticbase import PydanticBase
6 | from .meta.pydanticmixins import PydanticTS
7 | from .meta.sqlalchemybase import SQLAlchemyBase
8 | from .meta.sqlalchemymixins import SQLAlchemyIntPK, SQLAlchemyTS
9 |
10 |
11 | # sqlalchemy models
12 | class Shop(SQLAlchemyTS, SQLAlchemyIntPK, SQLAlchemyBase):
13 | __tablename__ = "shop"
14 | name = Column(String, unique=True, nullable=False)
15 | url = Column(String, unique=True, nullable=False)
16 | query_url = Column(String, nullable=False)
17 | render_javascript = Column(Boolean, nullable=False, default=False)
18 | listing_page_selector = Column(JSON, nullable=True)
19 |
20 |
21 | class UserShops(SQLAlchemyTS, SQLAlchemyIntPK, SQLAlchemyBase):
22 | __tablename__ = "user_shops"
23 | user_id = Column(
24 | Integer, ForeignKey("user.id", ondelete="CASCADE", onupdate="CASCADE")
25 | )
26 | shop_id = Column(
27 | Integer, ForeignKey("shop.id", ondelete="CASCADE", onupdate="CASCADE")
28 | )
29 |
30 |
31 | # pydantic models
32 | class ShopCreate(PydanticBase):
33 | """Properties to receive via API on creation"""
34 |
35 | name: str
36 | url: str
37 | query_url: str
38 | render_javascript: bool
39 | listing_page_selector: Optional[dict]
40 |
41 |
42 | class ShopRead(PydanticTS, ShopCreate):
43 | """Attributes to return via API"""
44 |
45 | id: int
46 |
47 |
48 | class ShopUpdate(PydanticBase):
49 | """Properties to receive via API on update"""
50 |
51 | name: Optional[str]
52 | url: Optional[str]
53 | query_url: Optional[str]
54 | render_javascript: Optional[bool]
55 | listing_page_selector: Optional[dict]
56 |
--------------------------------------------------------------------------------
/server/app/models/tokenmodels.py:
--------------------------------------------------------------------------------
1 | from .meta.pydanticbase import PydanticBase
2 |
3 |
4 | class TokenResponse(PydanticBase):
5 | access_token: str
6 | token_type: str
7 |
8 |
9 | class JWTAccessToken(PydanticBase):
10 | exp: int
11 | user_id: int
12 |
--------------------------------------------------------------------------------
/server/app/service/emailservice.py:
--------------------------------------------------------------------------------
1 | import logging
2 |
3 | import yagmail
4 | from jinja2 import Template
5 |
6 | from app.settings import settings
7 |
8 | logger = logging.getLogger(__name__)
9 |
10 |
11 | TEMPLATES = {
12 | "verify_account": settings.EMAIL_TEMPLATES_DIR / "verify-account.html",
13 | }
14 |
15 |
16 | def send_email(to: str, subject: str, contents: str, **kwargs):
17 | """Sends an email with the project defined SMTP settings."""
18 | # Using a context manager here ensures the SMTP connection is closed,
19 | # even if there is an exception.
20 | with yagmail.SMTP(
21 | user=settings.SMTP.USER,
22 | password=settings.SMTP.PASSWORD.get_secret_value(),
23 | host=settings.SMTP.HOST,
24 | port=settings.SMTP.PORT,
25 | smtp_starttls=settings.SMTP.TLS,
26 | smtp_ssl=settings.SMTP.SSL,
27 | ) as client:
28 | client.send(to=to, subject=subject, contents=contents, **kwargs)
29 |
30 |
31 | def send_verify_account_email(to: str, first_name: str) -> True:
32 | template_path = TEMPLATES["verify_account"]
33 | with open(str(template_path)) as file:
34 | template_str = file.read()
35 |
36 | subject = f"{settings.PROJECT_NAME} - Verify Email"
37 | kwargs = {
38 | "project_name": settings.PROJECT_NAME,
39 | "first_name": first_name.title(),
40 | "link": settings.SERVER_HOST,
41 | }
42 | rendered_template = Template(template_str).render(kwargs)
43 |
44 | return send_email(to=to, subject=subject, contents=rendered_template)
45 |
--------------------------------------------------------------------------------
/server/app/service/passwordservice.py:
--------------------------------------------------------------------------------
1 | from passlib.context import CryptContext
2 |
3 | pwd_context = CryptContext(schemes=["bcrypt"], deprecated="auto")
4 |
5 |
6 | def verify_password(plain_password: str, hashed_password: str) -> bool:
7 | return pwd_context.verify(plain_password, hashed_password)
8 |
9 |
10 | def get_password_hash(password: str) -> str:
11 | return pwd_context.hash(password)
12 |
--------------------------------------------------------------------------------
/server/app/service/roleservice.py:
--------------------------------------------------------------------------------
1 | from typing import List, Optional
2 |
3 | from sqlalchemy.orm import Session
4 |
5 | from app.models.rolemodels import Role, RoleCreate, RoleUpdate
6 |
7 |
8 | def get(db_session: Session, id_: int) -> Optional[Role]:
9 | return db_session.query(Role).filter(Role.id == id_).first()
10 |
11 |
12 | def get_by_name(db_session: Session, name: str) -> Optional[Role]:
13 | return db_session.query(Role).filter(Role.name == name).first()
14 |
15 |
16 | def get_multiple(
17 | db_session: Session, *, offset: int = 0, limit: int = 100
18 | ) -> List[Role]:
19 | return db_session.query(Role).offset(offset).limit(limit).all()
20 |
21 |
22 | def get_multiple_by_ids(db_session: Session, *, ids_: List[int]) -> List[Role]:
23 | return db_session.query(Role).filter(Role.id.in_(ids_)).all()
24 |
25 |
26 | def create(db_session: Session, role_in: RoleCreate) -> Role:
27 | db_obj = Role(name=role_in.name, description=role_in.description)
28 | db_session.add(db_obj)
29 | db_session.commit()
30 | return db_obj
31 |
32 |
33 | def create_multiple(db_session: Session, roles_in: List[RoleCreate]) -> List[Role]:
34 | db_objs = [Role(name=role.name, description=role.description) for role in roles_in]
35 | db_session.add_all(db_objs)
36 | db_session.commit()
37 | return db_objs
38 |
39 |
40 | def update(db_session: Session, role: Role, role_in: RoleUpdate) -> Role:
41 | update_data = role_in.dict(exclude_unset=True)
42 | for field in update_data:
43 | setattr(role, field, update_data[field])
44 |
45 | db_session.add(role)
46 | db_session.commit()
47 | return role
48 |
49 |
50 | def delete(db_session: Session, *, id_: int):
51 | obj = db_session.query(Role).get(id_)
52 | db_session.delete(obj)
53 | db_session.commit()
54 |
--------------------------------------------------------------------------------
/server/app/service/shopservice.py:
--------------------------------------------------------------------------------
1 | from typing import List, Optional
2 |
3 | from sqlalchemy.orm import Session
4 |
5 | from app.models.shopmodels import Shop, ShopCreate, ShopUpdate
6 |
7 |
8 | def get(db_session: Session, id_: int) -> Optional[Shop]:
9 | return db_session.query(Shop).filter(Shop.id == id_).first()
10 |
11 |
12 | def get_by_name(db_session: Session, name: str) -> Optional[Shop]:
13 | return db_session.query(Shop).filter(Shop.name == name).first()
14 |
15 |
16 | def get_multiple(
17 | db_session: Session, *, offset: int = 0, limit: int = 100
18 | ) -> List[Shop]:
19 | return db_session.query(Shop).offset(offset).limit(limit).all()
20 |
21 |
22 | def get_multiple_by_ids(db_session: Session, *, ids_: List[int]) -> List[Shop]:
23 | return db_session.query(Shop).filter(Shop.id.in_(ids_)).all()
24 |
25 |
26 | def create(db_session: Session, shop_in: ShopCreate) -> Shop:
27 |
28 | db_obj = Shop(
29 | name=shop_in.name,
30 | url=shop_in.url,
31 | query_url=shop_in.query_url,
32 | render_javascript=shop_in.render_javascript,
33 | listing_page_selector=shop_in.listing_page_selector,
34 | )
35 |
36 | db_session.add(db_obj)
37 | db_session.commit()
38 | return db_obj
39 |
40 |
41 | def update(db_session: Session, shop: Shop, shop_in: ShopUpdate) -> Shop:
42 | update_data = shop_in.dict(exclude_unset=True)
43 | for field in update_data:
44 | setattr(shop, field, update_data[field])
45 | db_session.add(shop)
46 | db_session.commit()
47 | return shop
48 |
49 |
50 | def delete(db_session: Session, id_: int) -> None:
51 | obj = db_session.query(Shop).get(id_)
52 | db_session.delete(obj)
53 | db_session.commit()
54 |
--------------------------------------------------------------------------------
/server/app/service/tokenservice.py:
--------------------------------------------------------------------------------
1 | from datetime import datetime, timedelta
2 | from typing import Union
3 |
4 | import jwt
5 |
6 | from app.settings import settings
7 |
8 | ALGORITHM: str = "HS256"
9 |
10 | AUTH_AUDIENCE = "auth-login"
11 |
12 |
13 | def decode(token: str, **jwtkwargs) -> dict:
14 | return jwt.decode(
15 | jwt=token,
16 | key=settings.SECRET_KEY.get_secret_value(),
17 | algorithms=[ALGORITHM],
18 | **jwtkwargs,
19 | )
20 |
21 |
22 | def encode(payload: dict, lifetime_seconds: Union[int, float]) -> str:
23 | to_encode = payload.copy()
24 | expire = datetime.utcnow() + timedelta(seconds=lifetime_seconds)
25 | to_encode["exp"] = expire
26 | encoded_jwt = jwt.encode(
27 | payload=to_encode,
28 | key=settings.SECRET_KEY.get_secret_value(),
29 | algorithm=ALGORITHM,
30 | ).decode("utf-8")
31 | return encoded_jwt
32 |
--------------------------------------------------------------------------------
/server/app/settings.py:
--------------------------------------------------------------------------------
1 | from pathlib import Path
2 | from typing import List
3 |
4 | from pydantic import (
5 | AnyHttpUrl,
6 | BaseSettings,
7 | DirectoryPath,
8 | PostgresDsn,
9 | SecretStr,
10 | validator,
11 | )
12 |
13 | from app.enums.logenums import LogLevel
14 |
15 |
16 | class Settings(BaseSettings):
17 |
18 | APP_DIR: DirectoryPath = Path(__file__).resolve().parent
19 | STATIC_DIR: DirectoryPath = APP_DIR / "static"
20 | EMAIL_TEMPLATES_DIR: DirectoryPath = STATIC_DIR / "email-templates" / "html"
21 |
22 | PROJECT_NAME: str
23 |
24 | SERVER_HOST: str
25 | CORS_WHITELIST: List[AnyHttpUrl] = []
26 |
27 | FASTAPI_ENV: str
28 | DEBUG: bool = False
29 | LOG_LEVEL: LogLevel = LogLevel.debug
30 |
31 | FIRST_SUPERUSER: str
32 | FIRST_SUPERUSER_PASSWORD: str
33 |
34 | USERS_OPEN_REGISTRATION: bool
35 |
36 | SECRET_KEY: SecretStr
37 | JWT_AUTH_LIFETIME_SECONDS: int = 60 * 60 * 24 * 7 # 7 days
38 | JWT_EMAIL_LIFETIME_SECONDS: int = 60 * 60 * 1 # 1 hour
39 |
40 | SMTP_USER: str
41 | SMTP_PASSWORD: SecretStr
42 | SMTP_TLS: bool
43 | SMTP_SSL: bool
44 | SMTP_HOST: str
45 | SMTP_PORT: int
46 |
47 | POSTGRES_USER: str
48 | POSTGRES_PASSWORD: SecretStr
49 | POSTGRES_HOST: str
50 | POSTGRES_PORT: int
51 | POSTGRES_DB: str
52 | POSTGRES_URL: PostgresDsn = None
53 |
54 | @validator("POSTGRES_URL", pre=True)
55 | def build_pgdsn(cls, v, values):
56 | if isinstance(v, str):
57 | return v
58 | return PostgresDsn.build(
59 | scheme="postgresql",
60 | user=values["POSTGRES_USER"],
61 | password=values["POSTGRES_PASSWORD"].get_secret_value(),
62 | host=values["POSTGRES_HOST"],
63 | port=str(values["POSTGRES_PORT"]),
64 | path="/" + values["POSTGRES_DB"],
65 | )
66 |
67 |
68 | settings = Settings()
69 |
--------------------------------------------------------------------------------
/server/app/static/email-templates/src/verify-account.mjml:
--------------------------------------------------------------------------------
1 |