├── app ├── __init__.py ├── models │ ├── __init__.py │ ├── posts.py │ ├── database.py │ └── users.py ├── routers │ ├── __init__.py │ ├── users.py │ └── posts.py ├── schemas │ ├── __init__.py │ ├── posts.py │ └── users.py ├── utils │ ├── __init__.py │ ├── dependencies.py │ ├── users.py │ └── posts.py ├── tests │ ├── test_health_check.py │ ├── conftest.py │ ├── test_users.py │ └── test_posts.py └── main.py ├── migrations ├── README ├── script.py.mako ├── versions │ ├── cb1409f3e7c2_create_uuid_extension.py │ ├── d5f540524f29_add_posts_table.py │ └── 223152812b5f_add_users_and_tokens_tables.py └── env.py ├── .gitignore ├── docker-entrypoint.sh ├── Dockerfile ├── .github └── workflows │ └── tests.yml ├── readme.md ├── docker-compose.yml ├── requirements.txt ├── alembic.ini └── LICENSE /app/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /app/models/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /app/routers/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /app/schemas/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /app/utils/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /migrations/README: -------------------------------------------------------------------------------- 1 | Generic single-database configuration. -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .idea/ 2 | .pytest_cache/ 3 | __pycache__/ 4 | venv/ -------------------------------------------------------------------------------- /docker-entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | /wait 4 | 5 | alembic upgrade head 6 | uvicorn app.main:app --host 0.0.0.0 --port 8000 --reload -------------------------------------------------------------------------------- /app/tests/test_health_check.py: -------------------------------------------------------------------------------- 1 | from app.main import app 2 | from fastapi.testclient import TestClient 3 | 4 | client = TestClient(app) 5 | 6 | 7 | def test_health_check(): 8 | response = client.get("/") 9 | assert response.status_code == 200 10 | assert response.json() == {"Hello": "World"} 11 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | # Dockerfile 2 | FROM python:3.8 3 | WORKDIR /async-blogs 4 | ADD https://github.com/ufoscout/docker-compose-wait/releases/download/2.9.0/wait /wait 5 | RUN chmod +x /wait 6 | COPY requirements.txt /async-blogs 7 | RUN pip install -r requirements.txt 8 | COPY . /async-blogs 9 | EXPOSE 8000 10 | ENTRYPOINT ["./docker-entrypoint.sh"] 11 | -------------------------------------------------------------------------------- /app/schemas/posts.py: -------------------------------------------------------------------------------- 1 | from datetime import datetime 2 | 3 | from pydantic import BaseModel 4 | 5 | 6 | class PostModel(BaseModel): 7 | """ Validate request data """ 8 | title: str 9 | content: str 10 | 11 | 12 | class PostDetailsModel(PostModel): 13 | """ Return response data """ 14 | id: int 15 | created_at: datetime 16 | user_name: str 17 | -------------------------------------------------------------------------------- /app/models/posts.py: -------------------------------------------------------------------------------- 1 | import sqlalchemy 2 | 3 | from .users import users_table 4 | 5 | metadata = sqlalchemy.MetaData() 6 | 7 | posts_table = sqlalchemy.Table( 8 | "posts", 9 | metadata, 10 | sqlalchemy.Column("id", sqlalchemy.Integer, primary_key=True), 11 | sqlalchemy.Column("user_id", sqlalchemy.ForeignKey(users_table.c.id)), 12 | sqlalchemy.Column("created_at", sqlalchemy.DateTime()), 13 | sqlalchemy.Column("title", sqlalchemy.String(100)), 14 | sqlalchemy.Column("content", sqlalchemy.Text()), 15 | ) 16 | -------------------------------------------------------------------------------- /app/main.py: -------------------------------------------------------------------------------- 1 | import uvicorn 2 | from app.models.database import database 3 | from app.routers import posts, users 4 | from fastapi import FastAPI 5 | 6 | app = FastAPI() 7 | 8 | 9 | @app.on_event("startup") 10 | async def startup(): 11 | await database.connect() 12 | 13 | 14 | @app.on_event("shutdown") 15 | async def shutdown(): 16 | await database.disconnect() 17 | 18 | app.include_router(users.router) 19 | app.include_router(posts.router) 20 | 21 | if __name__ == "__main__": 22 | uvicorn.run(app, host="0.0.0.0", port=8000) 23 | -------------------------------------------------------------------------------- /.github/workflows/tests.yml: -------------------------------------------------------------------------------- 1 | name: Test 2 | 3 | on: [push] 4 | 5 | jobs: 6 | docker: 7 | timeout-minutes: 10 8 | runs-on: ubuntu-latest 9 | 10 | steps: 11 | - name: Checkout 12 | uses: actions/checkout@v1 13 | 14 | - name: Start containers 15 | run: docker compose -f "docker-compose.yml" up -d --build 16 | 17 | - name: Run tests 18 | run: docker compose -f "docker-compose.yml" exec -T app python -m pytest app/tests 19 | 20 | - name: Stop containers 21 | if: always() 22 | run: docker compose -f "docker-compose.yml" down -------------------------------------------------------------------------------- /migrations/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 | -------------------------------------------------------------------------------- /migrations/versions/cb1409f3e7c2_create_uuid_extension.py: -------------------------------------------------------------------------------- 1 | """create uuid extension 2 | 3 | Revision ID: cb1409f3e7c2 4 | Revises: 5 | Create Date: 2020-06-08 15:38:20.027251 6 | 7 | """ 8 | from alembic import op 9 | import sqlalchemy as sa 10 | 11 | 12 | # revision identifiers, used by Alembic. 13 | revision = 'cb1409f3e7c2' 14 | down_revision = None 15 | branch_labels = None 16 | depends_on = None 17 | 18 | 19 | def upgrade(): 20 | conn = op.get_bind() 21 | conn.execute('create extension "uuid-ossp"') 22 | 23 | 24 | def downgrade(): 25 | conn = op.get_bind() 26 | conn.execute('drop extension "uuid-ossp"') 27 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | [![Build Status](https://travis-ci.org/NeverWalkAloner/async-blogs.svg?branch=master)](https://travis-ci.org/NeverWalkAloner/async-blogs) 2 | 3 | # Asynchronous API implementation with Python and FastAPI 4 | 5 | ## How to run 6 | 7 | Run 8 | 9 | ```` 10 | $ docker-compose up -d --build 11 | ```` 12 | 13 | and go to http://127.0.0.1:8000/docs 14 | 15 | ## How to run tests 16 | 17 | ```` 18 | $ docker-compose exec app python -m pytest app/tests 19 | ```` 20 | 21 | ## Update 22 | 23 | Starting from version 1.4 SQLAlchemy supports asyncio. This means you don't need externla tools like `encode/databases`. 24 | If you are interesting in new styled SQLAlchemy async example you can check [this repo](https://github.com/NeverWalkAloner/secureblogs). 25 | -------------------------------------------------------------------------------- /app/models/database.py: -------------------------------------------------------------------------------- 1 | from os import environ 2 | 3 | import databases 4 | 5 | DB_USER = environ.get("DB_USER", "user") 6 | DB_PASSWORD = environ.get("DB_PASSWORD", "password") 7 | DB_HOST = environ.get("DB_HOST", "localhost") 8 | 9 | TESTING = environ.get("TESTING") 10 | 11 | if TESTING: 12 | # Use separate DB for tests 13 | DB_NAME = "async-blogs-temp-for-test" 14 | TEST_SQLALCHEMY_DATABASE_URL = ( 15 | f"postgresql://{DB_USER}:{DB_PASSWORD}@{DB_HOST}:5432/{DB_NAME}" 16 | ) 17 | database = databases.Database(TEST_SQLALCHEMY_DATABASE_URL) 18 | else: 19 | DB_NAME = "async-blogs" 20 | SQLALCHEMY_DATABASE_URL = ( 21 | f"postgresql://{DB_USER}:{DB_PASSWORD}@{DB_HOST}:5432/{DB_NAME}" 22 | ) 23 | database = databases.Database(SQLALCHEMY_DATABASE_URL) 24 | -------------------------------------------------------------------------------- /app/utils/dependencies.py: -------------------------------------------------------------------------------- 1 | from app.utils import users as users_utils 2 | from fastapi import Depends, HTTPException, status 3 | from fastapi.security import OAuth2PasswordBearer 4 | 5 | oauth2_scheme = OAuth2PasswordBearer(tokenUrl="/auth") 6 | 7 | 8 | async def get_current_user(token: str = Depends(oauth2_scheme)): 9 | user = await users_utils.get_user_by_token(token) 10 | if not user: 11 | raise HTTPException( 12 | status_code=status.HTTP_401_UNAUTHORIZED, 13 | detail="Invalid authentication credentials", 14 | headers={"WWW-Authenticate": "Bearer"}, 15 | ) 16 | if not user["is_active"]: 17 | raise HTTPException( 18 | status_code=status.HTTP_400_BAD_REQUEST, detail="Inactive user" 19 | ) 20 | return user 21 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | #docker-compose.yml 2 | version: "3.0" 3 | services: 4 | app: 5 | build: . 6 | volumes: 7 | - .:/async-blogs 8 | depends_on: 9 | db: 10 | condition: service_healthy 11 | environment: 12 | DB_USER: root 13 | DB_HOST: db 14 | DB_PASSWORD: root 15 | ports: 16 | - "8000:8000" 17 | restart: always 18 | db: 19 | image: postgres 20 | ports: 21 | - "5432:5432" 22 | environment: 23 | POSTGRES_USER: root 24 | POSTGRES_DB: async-blogs 25 | POSTGRES_PASSWORD: root 26 | POSTGRES_HOST_AUTH_METHOD: trust 27 | healthcheck: 28 | test: [ "CMD-SHELL", "pg_isready", "-d", "async-blogs", "-U", "root"] 29 | interval: 5s 30 | timeout: 5s 31 | retries: 5 32 | start_period: 20s 33 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | alembic==1.4.2 2 | asyncpg==0.29.0 3 | attrs==19.3.0 4 | certifi==2020.6.20 5 | chardet==3.0.4 6 | click==7.1.2 7 | databases==0.3.2 8 | dnspython==1.16.0 9 | email-validator==1.1.1 10 | fastapi==0.60.1 11 | freezegun==0.3.15 12 | h11==0.9.0 13 | httptools==0.1.1 14 | idna==2.9 15 | importlib-metadata==1.7.0 16 | iniconfig==1.0.0 17 | Mako==1.1.3 18 | MarkupSafe==1.1.1 19 | more-itertools==8.4.0 20 | packaging==20.4 21 | pluggy==0.13.1 22 | psycopg2==2.8.5 23 | py==1.9.0 24 | pydantic==1.5.1 25 | pyparsing==2.4.7 26 | pytest==6.0.0 27 | pytest-freezegun==0.4.2 28 | python-dateutil==2.8.1 29 | python-editor==1.0.4 30 | python-multipart==0.0.5 31 | requests==2.24.0 32 | six==1.15.0 33 | SQLAlchemy==1.3.13 34 | SQLAlchemy-Utils==0.36.8 35 | starlette==0.13.6 36 | toml==0.10.1 37 | urllib3==1.25.10 38 | uvicorn==0.11.7 39 | uvloop==0.14.0 40 | websockets==8.1 41 | zipp==3.1.0 42 | -------------------------------------------------------------------------------- /app/tests/conftest.py: -------------------------------------------------------------------------------- 1 | import os 2 | 3 | import pytest 4 | 5 | # This sets `os.environ`, 6 | # If we placed it below the application import, it would raise an error 7 | # informing us that 'TESTING' had already been read from the environment. 8 | os.environ['TESTING'] = 'True' 9 | 10 | from alembic import command 11 | from alembic.config import Config 12 | from app.models import database 13 | from sqlalchemy_utils import create_database, drop_database 14 | 15 | 16 | @pytest.fixture(scope="module") 17 | def temp_db(): 18 | """ Create new DB for tests """ 19 | create_database(database.TEST_SQLALCHEMY_DATABASE_URL) 20 | base_dir = os.path.dirname(os.path.dirname(os.path.dirname(__file__))) 21 | alembic_cfg = Config(os.path.join(base_dir, "alembic.ini")) 22 | command.upgrade(alembic_cfg, "head") 23 | 24 | try: 25 | yield database.TEST_SQLALCHEMY_DATABASE_URL 26 | finally: 27 | drop_database(database.TEST_SQLALCHEMY_DATABASE_URL) 28 | -------------------------------------------------------------------------------- /app/schemas/users.py: -------------------------------------------------------------------------------- 1 | from datetime import datetime 2 | from typing import Optional 3 | 4 | from pydantic import UUID4, BaseModel, EmailStr, validator, Field 5 | 6 | 7 | class TokenBase(BaseModel): 8 | """ Return response data """ 9 | token: UUID4 = Field(..., alias="access_token") 10 | expires: datetime 11 | token_type: Optional[str] = "bearer" 12 | 13 | class Config: 14 | allow_population_by_field_name = True 15 | 16 | @validator("token") 17 | def hexlify_token(cls, value): 18 | """ Convert UUID to pure hex string """ 19 | return value.hex 20 | 21 | 22 | class UserBase(BaseModel): 23 | """ Return response data """ 24 | id: int 25 | email: EmailStr 26 | name: str 27 | 28 | 29 | class UserCreate(BaseModel): 30 | """ Validate request data """ 31 | email: EmailStr 32 | name: str 33 | password: str 34 | 35 | 36 | class User(UserBase): 37 | """ Return detailed response data with token """ 38 | token: TokenBase = {} 39 | -------------------------------------------------------------------------------- /migrations/versions/d5f540524f29_add_posts_table.py: -------------------------------------------------------------------------------- 1 | """Add posts table 2 | 3 | Revision ID: d5f540524f29 4 | Revises: 223152812b5f 5 | Create Date: 2020-07-29 19:08:41.137561 6 | 7 | """ 8 | from alembic import op 9 | import sqlalchemy as sa 10 | 11 | 12 | # revision identifiers, used by Alembic. 13 | revision = 'd5f540524f29' 14 | down_revision = '223152812b5f' 15 | branch_labels = None 16 | depends_on = None 17 | 18 | 19 | def upgrade(): 20 | # ### commands auto generated by Alembic - please adjust! ### 21 | op.create_table('posts', 22 | sa.Column('id', sa.Integer(), nullable=False), 23 | sa.Column('user_id', sa.Integer(), nullable=True), 24 | sa.Column('created_at', sa.DateTime(), nullable=True), 25 | sa.Column('title', sa.String(length=100), nullable=True), 26 | sa.Column('content', sa.Text(), nullable=True), 27 | sa.ForeignKeyConstraint(['user_id'], ['users.id'], ), 28 | sa.PrimaryKeyConstraint('id') 29 | ) 30 | # ### end Alembic commands ### 31 | 32 | 33 | def downgrade(): 34 | # ### commands auto generated by Alembic - please adjust! ### 35 | op.drop_table('posts') 36 | # ### end Alembic commands ### 37 | -------------------------------------------------------------------------------- /app/models/users.py: -------------------------------------------------------------------------------- 1 | import sqlalchemy 2 | from sqlalchemy.dialects.postgresql import UUID 3 | 4 | metadata = sqlalchemy.MetaData() 5 | 6 | users_table = sqlalchemy.Table( 7 | "users", 8 | metadata, 9 | sqlalchemy.Column("id", sqlalchemy.Integer, primary_key=True), 10 | sqlalchemy.Column("email", sqlalchemy.String(40), unique=True, index=True), 11 | sqlalchemy.Column("name", sqlalchemy.String(100)), 12 | sqlalchemy.Column("hashed_password", sqlalchemy.String()), 13 | sqlalchemy.Column( 14 | "is_active", 15 | sqlalchemy.Boolean(), 16 | server_default=sqlalchemy.sql.expression.true(), 17 | nullable=False, 18 | ), 19 | ) 20 | 21 | 22 | tokens_table = sqlalchemy.Table( 23 | "tokens", 24 | metadata, 25 | sqlalchemy.Column("id", sqlalchemy.Integer, primary_key=True), 26 | sqlalchemy.Column( 27 | "token", 28 | UUID(as_uuid=False), 29 | server_default=sqlalchemy.text("uuid_generate_v4()"), 30 | unique=True, 31 | nullable=False, 32 | index=True, 33 | ), 34 | sqlalchemy.Column("expires", sqlalchemy.DateTime()), 35 | sqlalchemy.Column("user_id", sqlalchemy.ForeignKey("users.id")), 36 | ) 37 | -------------------------------------------------------------------------------- /app/routers/users.py: -------------------------------------------------------------------------------- 1 | from app.schemas import users 2 | from app.utils import users as users_utils 3 | from app.utils.dependencies import get_current_user 4 | from fastapi import APIRouter, Depends, HTTPException 5 | from fastapi.security import OAuth2PasswordRequestForm 6 | 7 | router = APIRouter() 8 | 9 | 10 | @router.get("/") 11 | async def health_check(): 12 | return {"Hello": "World"} 13 | 14 | 15 | @router.post("/auth", response_model=users.TokenBase) 16 | async def auth(form_data: OAuth2PasswordRequestForm = Depends()): 17 | user = await users_utils.get_user_by_email(email=form_data.username) 18 | 19 | if not user: 20 | raise HTTPException(status_code=400, detail="Incorrect email or password") 21 | 22 | if not users_utils.validate_password( 23 | password=form_data.password, hashed_password=user["hashed_password"] 24 | ): 25 | raise HTTPException(status_code=400, detail="Incorrect email or password") 26 | 27 | return await users_utils.create_user_token(user_id=user["id"]) 28 | 29 | 30 | @router.post("/sign-up", response_model=users.User) 31 | async def create_user(user: users.UserCreate): 32 | db_user = await users_utils.get_user_by_email(email=user.email) 33 | if db_user: 34 | raise HTTPException(status_code=400, detail="Email already registered") 35 | return await users_utils.create_user(user=user) 36 | 37 | 38 | @router.get("/users/me", response_model=users.UserBase) 39 | async def read_users_me(current_user: users.User = Depends(get_current_user)): 40 | return current_user 41 | -------------------------------------------------------------------------------- /app/routers/posts.py: -------------------------------------------------------------------------------- 1 | from app.schemas.posts import PostDetailsModel, PostModel 2 | from app.schemas.users import User 3 | from app.utils import posts as post_utils 4 | from app.utils.dependencies import get_current_user 5 | from fastapi import APIRouter, Depends, HTTPException, status 6 | 7 | router = APIRouter() 8 | 9 | 10 | @router.post("/posts", response_model=PostDetailsModel, status_code=201) 11 | async def create_post(post: PostModel, current_user: User = Depends(get_current_user)): 12 | post = await post_utils.create_post(post, current_user) 13 | return post 14 | 15 | 16 | @router.get("/posts") 17 | async def get_posts(page: int = 1): 18 | total_cout = await post_utils.get_posts_count() 19 | posts = await post_utils.get_posts(page) 20 | return {"total_count": total_cout, "results": posts} 21 | 22 | 23 | @router.get("/posts/{post_id}", response_model=PostDetailsModel) 24 | async def get_post(post_id: int): 25 | return await post_utils.get_post(post_id) 26 | 27 | 28 | @router.put("/posts/{post_id}", response_model=PostDetailsModel) 29 | async def update_post( 30 | post_id: int, post_data: PostModel, current_user=Depends(get_current_user) 31 | ): 32 | post = await post_utils.get_post(post_id) 33 | if post["user_id"] != current_user["id"]: 34 | raise HTTPException( 35 | status_code=status.HTTP_403_FORBIDDEN, 36 | detail="You don't have access to modify this post", 37 | ) 38 | 39 | await post_utils.update_post(post_id=post_id, post=post_data) 40 | return await post_utils.get_post(post_id) 41 | -------------------------------------------------------------------------------- /migrations/versions/223152812b5f_add_users_and_tokens_tables.py: -------------------------------------------------------------------------------- 1 | """Add users and tokens tables 2 | 3 | Revision ID: 223152812b5f 4 | Revises: cb1409f3e7c2 5 | Create Date: 2020-07-29 19:08:20.253613 6 | 7 | """ 8 | from alembic import op 9 | import sqlalchemy as sa 10 | from sqlalchemy.dialects import postgresql 11 | 12 | # revision identifiers, used by Alembic. 13 | revision = '223152812b5f' 14 | down_revision = 'cb1409f3e7c2' 15 | branch_labels = None 16 | depends_on = None 17 | 18 | 19 | def upgrade(): 20 | # ### commands auto generated by Alembic - please adjust! ### 21 | op.create_table('users', 22 | sa.Column('id', sa.Integer(), nullable=False), 23 | sa.Column('email', sa.String(length=40), nullable=True), 24 | sa.Column('name', sa.String(length=100), nullable=True), 25 | sa.Column('hashed_password', sa.String(), nullable=True), 26 | sa.Column('is_active', sa.Boolean(), server_default=sa.text('true'), nullable=False), 27 | sa.PrimaryKeyConstraint('id') 28 | ) 29 | op.create_index(op.f('ix_users_email'), 'users', ['email'], unique=True) 30 | op.create_table('tokens', 31 | sa.Column('id', sa.Integer(), nullable=False), 32 | sa.Column('token', postgresql.UUID(), server_default=sa.text('uuid_generate_v4()'), nullable=False), 33 | sa.Column('expires', sa.DateTime(), nullable=True), 34 | sa.Column('user_id', sa.Integer(), nullable=True), 35 | sa.ForeignKeyConstraint(['user_id'], ['users.id'], ), 36 | sa.PrimaryKeyConstraint('id') 37 | ) 38 | op.create_index(op.f('ix_tokens_token'), 'tokens', ['token'], unique=True) 39 | # ### end Alembic commands ### 40 | 41 | 42 | def downgrade(): 43 | # ### commands auto generated by Alembic - please adjust! ### 44 | op.drop_index(op.f('ix_tokens_token'), table_name='tokens') 45 | op.drop_table('tokens') 46 | op.drop_index(op.f('ix_users_email'), table_name='users') 47 | op.drop_table('users') 48 | # ### end Alembic commands ### 49 | -------------------------------------------------------------------------------- /app/utils/users.py: -------------------------------------------------------------------------------- 1 | import hashlib 2 | import random 3 | import string 4 | from datetime import datetime, timedelta 5 | from sqlalchemy import and_ 6 | 7 | from app.models.database import database 8 | from app.models.users import tokens_table, users_table 9 | from app.schemas import users as user_schema 10 | 11 | 12 | def get_random_string(length=12): 13 | return "".join(random.choice(string.ascii_letters) for _ in range(length)) 14 | 15 | 16 | def hash_password(password: str, salt: str = None): 17 | if salt is None: 18 | salt = get_random_string() 19 | enc = hashlib.pbkdf2_hmac("sha256", password.encode(), salt.encode(), 100_000) 20 | return enc.hex() 21 | 22 | 23 | def validate_password(password: str, hashed_password: str): 24 | salt, hashed = hashed_password.split("$") 25 | return hash_password(password, salt) == hashed 26 | 27 | 28 | async def get_user(user_id: int): 29 | query = users_table.select().where(users_table.c.id == user_id) 30 | return await database.fetch_one(query) 31 | 32 | 33 | async def get_user_by_email(email: str): 34 | query = users_table.select().where(users_table.c.email == email) 35 | return await database.fetch_one(query) 36 | 37 | 38 | async def create_user(user: user_schema.UserCreate): 39 | salt = get_random_string() 40 | hashed_password = hash_password(user.password, salt) 41 | query = users_table.insert().values( 42 | email=user.email, name=user.name, hashed_password=f"{salt}${hashed_password}" 43 | ) 44 | user_id = await database.execute(query) 45 | token = await create_user_token(user_id) 46 | token_dict = {"token": token["token"], "expires": token["expires"]} 47 | 48 | return {**user.dict(), "id": user_id, "is_active": True, "token": token_dict} 49 | 50 | 51 | async def create_user_token(user_id: int): 52 | query = ( 53 | tokens_table.insert() 54 | .values(expires=datetime.now() + timedelta(weeks=2), user_id=user_id) 55 | .returning(tokens_table.c.token, tokens_table.c.expires) 56 | ) 57 | 58 | return await database.fetch_one(query) 59 | 60 | 61 | async def get_user_by_token(token: str): 62 | query = tokens_table.join(users_table).select().where( 63 | and_( 64 | tokens_table.c.token == token, 65 | tokens_table.c.expires > datetime.now() 66 | ) 67 | ) 68 | return await database.fetch_one(query) 69 | -------------------------------------------------------------------------------- /alembic.ini: -------------------------------------------------------------------------------- 1 | # A generic, single database configuration. 2 | 3 | [alembic] 4 | # path to migration scripts 5 | script_location = migrations 6 | 7 | # template used to generate migration files 8 | # file_template = %%(rev)s_%%(slug)s 9 | 10 | # timezone to use when rendering the date 11 | # within the migration file as well as the filename. 12 | # string value is passed to dateutil.tz.gettz() 13 | # leave blank for localtime 14 | # timezone = 15 | 16 | # max length of characters to apply to the 17 | # "slug" field 18 | # truncate_slug_length = 40 19 | 20 | # set to 'true' to run the environment during 21 | # the 'revision' command, regardless of autogenerate 22 | # revision_environment = false 23 | 24 | # set to 'true' to allow .pyc and .pyo files without 25 | # a source .py file to be detected as revisions in the 26 | # versions/ directory 27 | # sourceless = false 28 | 29 | # version location specification; this defaults 30 | # to migrations/versions. When using multiple version 31 | # directories, initial revisions must be specified with --version-path 32 | # version_locations = %(here)s/bar %(here)s/bat migrations/versions 33 | 34 | # the output encoding used when revision files 35 | # are written from script.py.mako 36 | # output_encoding = utf-8 37 | 38 | sqlalchemy.url = postgresql://%(DB_USER)s:%(DB_PASS)s@%(DB_HOST)s:5432/%(DB_NAME)s 39 | 40 | 41 | [post_write_hooks] 42 | # post_write_hooks defines scripts or Python functions that are run 43 | # on newly generated revision scripts. See the documentation for further 44 | # detail and examples 45 | 46 | # format using "black" - use the console_scripts runner, against the "black" entrypoint 47 | # hooks=black 48 | # black.type=console_scripts 49 | # black.entrypoint=black 50 | # black.options=-l 79 51 | 52 | # Logging configuration 53 | [loggers] 54 | keys = root,sqlalchemy,alembic 55 | 56 | [handlers] 57 | keys = console 58 | 59 | [formatters] 60 | keys = generic 61 | 62 | [logger_root] 63 | level = WARN 64 | handlers = console 65 | qualname = 66 | 67 | [logger_sqlalchemy] 68 | level = WARN 69 | handlers = 70 | qualname = sqlalchemy.engine 71 | 72 | [logger_alembic] 73 | level = INFO 74 | handlers = 75 | qualname = alembic 76 | 77 | [handler_console] 78 | class = StreamHandler 79 | args = (sys.stderr,) 80 | level = NOTSET 81 | formatter = generic 82 | 83 | [formatter_generic] 84 | format = %(levelname)-5.5s [%(name)s] %(message)s 85 | datefmt = %H:%M:%S 86 | -------------------------------------------------------------------------------- /app/utils/posts.py: -------------------------------------------------------------------------------- 1 | from datetime import datetime 2 | 3 | from app.models.database import database 4 | from app.models.posts import posts_table 5 | from app.models.users import users_table 6 | from app.schemas import posts as post_schema 7 | from sqlalchemy import desc, func, select 8 | 9 | 10 | async def create_post(post: post_schema.PostModel, user): 11 | query = ( 12 | posts_table.insert() 13 | .values( 14 | title=post.title, 15 | content=post.content, 16 | created_at=datetime.now(), 17 | user_id=user["id"], 18 | ) 19 | .returning( 20 | posts_table.c.id, 21 | posts_table.c.title, 22 | posts_table.c.content, 23 | posts_table.c.created_at, 24 | ) 25 | ) 26 | post = await database.fetch_one(query) 27 | 28 | # Convert to dict and add user_name key to it 29 | post = dict(zip(post, post.values())) 30 | post["user_name"] = user["name"] 31 | return post 32 | 33 | 34 | async def get_post(post_id: int): 35 | query = ( 36 | select( 37 | [ 38 | posts_table.c.id, 39 | posts_table.c.created_at, 40 | posts_table.c.title, 41 | posts_table.c.content, 42 | posts_table.c.user_id, 43 | users_table.c.name.label("user_name"), 44 | ] 45 | ) 46 | .select_from(posts_table.join(users_table)) 47 | .where(posts_table.c.id == post_id) 48 | ) 49 | return await database.fetch_one(query) 50 | 51 | 52 | async def get_posts(page: int): 53 | max_per_page = 10 54 | offset1 = (page - 1) * max_per_page 55 | query = ( 56 | select( 57 | [ 58 | posts_table.c.id, 59 | posts_table.c.created_at, 60 | posts_table.c.title, 61 | posts_table.c.content, 62 | posts_table.c.user_id, 63 | users_table.c.name.label("user_name"), 64 | ] 65 | ) 66 | .select_from(posts_table.join(users_table)) 67 | .order_by(desc(posts_table.c.created_at)) 68 | .limit(max_per_page) 69 | .offset(offset1) 70 | ) 71 | return await database.fetch_all(query) 72 | 73 | 74 | async def get_posts_count(): 75 | query = select([func.count()]).select_from(posts_table) 76 | return await database.fetch_val(query) 77 | 78 | 79 | async def update_post(post_id: int, post: post_schema.PostModel): 80 | query = ( 81 | posts_table.update() 82 | .where(posts_table.c.id == post_id) 83 | .values(title=post.title, content=post.content) 84 | ) 85 | return await database.execute(query) 86 | -------------------------------------------------------------------------------- /migrations/env.py: -------------------------------------------------------------------------------- 1 | import os 2 | import sys 3 | from logging.config import fileConfig 4 | 5 | from sqlalchemy import engine_from_config 6 | from sqlalchemy import pool 7 | 8 | from alembic import context 9 | 10 | # add current path to PYTHONPATH, otherwise app module will not be found when alembic executing 11 | sys.path.append(os.getcwd()) 12 | 13 | from app.models import database, posts, users 14 | 15 | # this is the Alembic Config object, which provides 16 | # access to the values within the .ini file in use. 17 | config = context.config 18 | 19 | section = config.config_ini_section 20 | config.set_section_option(section, "DB_USER", database.DB_USER) 21 | config.set_section_option(section, "DB_PASS", database.DB_PASSWORD) 22 | config.set_section_option(section, "DB_NAME", database.DB_NAME) 23 | config.set_section_option(section, "DB_HOST", database.DB_HOST) 24 | 25 | # Interpret the config file for Python logging. 26 | # This line sets up loggers basically. 27 | fileConfig(config.config_file_name) 28 | 29 | # add your model's MetaData object here 30 | # for 'autogenerate' support 31 | # from myapp import mymodel 32 | # target_metadata = mymodel.Base.metadata 33 | target_metadata = [users.metadata, posts.metadata] 34 | 35 | # other values from the config, defined by the needs of env.py, 36 | # can be acquired: 37 | # my_important_option = config.get_main_option("my_important_option") 38 | # ... etc. 39 | 40 | 41 | def run_migrations_offline(): 42 | """Run migrations in 'offline' mode. 43 | 44 | This configures the context with just a URL 45 | and not an Engine, though an Engine is acceptable 46 | here as well. By skipping the Engine creation 47 | we don't even need a DBAPI to be available. 48 | 49 | Calls to context.execute() here emit the given string to the 50 | script output. 51 | 52 | """ 53 | url = config.get_main_option("sqlalchemy.url") 54 | context.configure( 55 | url=url, 56 | target_metadata=target_metadata, 57 | literal_binds=True, 58 | dialect_opts={"paramstyle": "named"}, 59 | ) 60 | 61 | with context.begin_transaction(): 62 | context.run_migrations() 63 | 64 | 65 | def run_migrations_online(): 66 | """Run migrations in 'online' mode. 67 | 68 | In this scenario we need to create an Engine 69 | and associate a connection with the context. 70 | 71 | """ 72 | connectable = engine_from_config( 73 | config.get_section(config.config_ini_section), 74 | prefix="sqlalchemy.", 75 | poolclass=pool.NullPool, 76 | ) 77 | 78 | with connectable.connect() as connection: 79 | context.configure( 80 | connection=connection, target_metadata=target_metadata 81 | ) 82 | 83 | with context.begin_transaction(): 84 | context.run_migrations() 85 | 86 | 87 | if context.is_offline_mode(): 88 | run_migrations_offline() 89 | else: 90 | run_migrations_online() 91 | -------------------------------------------------------------------------------- /app/tests/test_users.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | import pytest 3 | 4 | from app.main import app 5 | from app.schemas.users import UserCreate 6 | from app.utils.users import create_user, create_user_token 7 | from fastapi.testclient import TestClient 8 | 9 | 10 | def test_sign_up(temp_db): 11 | request_data = { 12 | "email": "vader@deathstar.com", 13 | "name": "Darth", 14 | "password": "rainbow" 15 | } 16 | with TestClient(app) as client: 17 | response = client.post("/sign-up", json=request_data) 18 | assert response.status_code == 200 19 | assert response.json()["id"] == 1 20 | assert response.json()["email"] == "vader@deathstar.com" 21 | assert response.json()["name"] == "Darth" 22 | assert response.json()["token"]["expires"] is not None 23 | assert response.json()["token"]["access_token"] is not None 24 | 25 | 26 | def test_login(temp_db): 27 | request_data = {"username": "vader@deathstar.com", "password": "rainbow"} 28 | with TestClient(app) as client: 29 | response = client.post("/auth", data=request_data) 30 | assert response.status_code == 200 31 | assert response.json()["token_type"] == "bearer" 32 | assert response.json()["expires"] is not None 33 | assert response.json()["access_token"] is not None 34 | 35 | 36 | def test_login_with_invalid_password(temp_db): 37 | request_data = {"username": "vader@deathstar.com", "password": "unicorn"} 38 | with TestClient(app) as client: 39 | response = client.post("/auth", data=request_data) 40 | assert response.status_code == 400 41 | assert response.json()["detail"] == "Incorrect email or password" 42 | 43 | 44 | def test_user_detail(temp_db): 45 | with TestClient(app) as client: 46 | # Create user token to see user info 47 | loop = asyncio.get_event_loop() 48 | token = loop.run_until_complete(create_user_token(user_id=1)) 49 | response = client.get( 50 | "/users/me", 51 | headers={"Authorization": f"Bearer {token['token']}"} 52 | ) 53 | assert response.status_code == 200 54 | assert response.json()["id"] == 1 55 | assert response.json()["email"] == "vader@deathstar.com" 56 | assert response.json()["name"] == "Darth" 57 | 58 | 59 | def test_user_detail_forbidden_without_token(temp_db): 60 | with TestClient(app) as client: 61 | response = client.get("/users/me") 62 | assert response.status_code == 401 63 | 64 | 65 | @pytest.mark.freeze_time("2015-10-21") 66 | def test_user_detail_forbidden_with_expired_token(temp_db, freezer): 67 | user = UserCreate( 68 | email="sidious@deathstar.com", 69 | name="Palpatine", 70 | password="unicorn" 71 | ) 72 | with TestClient(app) as client: 73 | # Create user and use expired token 74 | loop = asyncio.get_event_loop() 75 | user_db = loop.run_until_complete(create_user(user)) 76 | freezer.move_to("'2015-11-10'") 77 | response = client.get( 78 | "/users/me", 79 | headers={"Authorization": f"Bearer {user_db['token']['token']}"} 80 | ) 81 | assert response.status_code == 401 82 | -------------------------------------------------------------------------------- /app/tests/test_posts.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | 3 | from app.main import app 4 | from app.schemas.users import UserCreate 5 | from app.utils.users import create_user, create_user_token 6 | from fastapi.testclient import TestClient 7 | 8 | 9 | def test_create_post(temp_db): 10 | user = UserCreate( 11 | email="vader@deathstar.com", 12 | name="Darth", 13 | password="rainbow" 14 | ) 15 | request_data = { 16 | "title": "42", 17 | "content": "Don't panic!" 18 | } 19 | with TestClient(app) as client: 20 | # Create user and use his token to add new post 21 | loop = asyncio.get_event_loop() 22 | user_db = loop.run_until_complete(create_user(user)) 23 | response = client.post( 24 | "/posts", 25 | json=request_data, 26 | headers={"Authorization": f"Bearer {user_db['token']['token']}"} 27 | ) 28 | assert response.status_code == 201 29 | assert response.json()["id"] == 1 30 | assert response.json()["title"] == "42" 31 | assert response.json()["content"] == "Don't panic!" 32 | 33 | 34 | def test_create_post_forbidden_without_token(temp_db): 35 | request_data = { 36 | "title": "42", 37 | "content": "Don't panic!" 38 | } 39 | with TestClient(app) as client: 40 | response = client.post("/posts", json=request_data) 41 | assert response.status_code == 401 42 | 43 | 44 | def test_posts_list(temp_db): 45 | with TestClient(app) as client: 46 | response = client.get("/posts") 47 | assert response.status_code == 200 48 | assert response.json()["total_count"] == 1 49 | assert response.json()["results"][0]["id"] == 1 50 | assert response.json()["results"][0]["title"] == "42" 51 | assert response.json()["results"][0]["content"] == "Don't panic!" 52 | 53 | 54 | def test_post_detail(temp_db): 55 | post_id = 1 56 | with TestClient(app) as client: 57 | response = client.get(f"/posts/{post_id}") 58 | assert response.status_code == 200 59 | assert response.json()["id"] == 1 60 | assert response.json()["title"] == "42" 61 | assert response.json()["content"] == "Don't panic!" 62 | 63 | 64 | def test_update_post(temp_db): 65 | post_id = 1 66 | request_data = { 67 | "title": "42", 68 | "content": "Life? Don't talk to me about life." 69 | } 70 | with TestClient(app) as client: 71 | # Create user token to add new post 72 | loop = asyncio.get_event_loop() 73 | token = loop.run_until_complete(create_user_token(user_id=1)) 74 | response = client.put( 75 | f"/posts/{post_id}", 76 | json=request_data, 77 | headers={"Authorization": f"Bearer {token['token']}"} 78 | ) 79 | assert response.status_code == 200 80 | assert response.json()["id"] == 1 81 | assert response.json()["title"] == "42" 82 | assert response.json()["content"] == "Life? Don't talk to me about life." 83 | 84 | 85 | def test_update_post_forbidden_without_token(temp_db): 86 | post_id = 1 87 | request_data = { 88 | "title": "42", 89 | "content": "Life? Don't talk to me about life." 90 | } 91 | with TestClient(app) as client: 92 | response = client.put(f"/posts/{post_id}", json=request_data) 93 | assert response.status_code == 401 94 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------