Dev to Test Draft

.github/workflows/docker-image.yml

@@ -2,17 +2,29 @@ name: Docker Image CI
 
 on:
   push:
-    branches: [ "main" ]
+    branches: 
+      - "main"
+      - "test"
+      - "dev"
   pull_request:
-    branches: [ "main" ]
+    branches:
+      - "main"
+      - "test"
+      - "dev"
 
 jobs:
 
   build:
-
     runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v3
+
     - name: Build the Docker image
-      run: docker build . --file Dockerfile --tag natiq-api:$(date +%s)
+      run: |
+        if [[ "${GITHUB_REF}" == "refs/heads/main" ]]; then
+          TAG="latest"
+        else
+          TAG="${GITHUB_REF##*/}"
+        fi
+        docker build . --file Dockerfile --tag natiq-api:$TAG

.github/workflows/docker-publish.yml

@@ -2,30 +2,42 @@ name: docker-publish
 
 on:
   push:
-    branches:
+    branches: 
       - "main"
+      - "test"
+      - "dev"
 
 jobs:
   build:
     runs-on: ubuntu-latest
+
     steps:
-      -
-        name: Checkout
+      - name: Checkout
         uses: actions/checkout@v3
-      -
-        name: Login to Docker Hub
+
+      - name: Login to Docker Hub
         uses: docker/login-action@v2
         with:
           username: ${{ secrets.DOCKER_HUB_USERNAME }}
           password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
-      -
-        name: Set up Docker Buildx
+
+      - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v2
-      -
-        name: Build and push
+
+      - name: Set Docker tags
+        id: set_tags
+        run: |
+          base_tag="${{ secrets.DOCKER_HUB_USERNAME }}/nq-api"
+          if [[ "${GITHUB_REF##*/}" == "main" ]]; then
+            echo "tags=${base_tag}:latest" >> $GITHUB_ENV
+          else
+            echo "tags=${base_tag}:${GITHUB_REF##*/}" >> $GITHUB_ENV
+          fi
+
+      - name: Build and push
         uses: docker/build-push-action@v3
         with:
           context: .
           file: ./Dockerfile
           push: true
-          tags: ${{ secrets.DOCKER_HUB_USERNAME }}/nq-api:latest
+          tags: ${{ env.tags }}

.github/workflows/rust.yml

@@ -2,9 +2,15 @@ name: Rust
 
 on:
   push:
-    branches: [ "main" ]
+    branches: 
+      - "main"
+      - "test"
+      - "dev"
   pull_request:
-    branches: [ "main" ]
+    branches: 
+      - "main"
+      - "test"
+      - "dev"
 
 env:
   CARGO_TERM_COLOR: always

README.md

@@ -1,13 +1,14 @@
-# nq-api
-[![docker-publish](https://github.com/NatiqQuran/nq-api/actions/workflows/docker-publish.yml/badge.svg)](https://github.com/NatiqQuran/nq-api/actions/workflows/docker-publish.yml)
-[![Docker Image CI](https://github.com/NatiqQuran/nq-api/actions/workflows/docker-image.yml/badge.svg)](https://github.com/NatiqQuran/nq-api/actions/workflows/docker-image.yml)
-[![Rust](https://github.com/NatiqQuran/nq-api/actions/workflows/rust.yml/badge.svg)](https://github.com/NatiqQuran/nq-api/actions/workflows/rust.yml)
+# nq-api-rust
 
-Natiq Quran open API
+[![docker-publish](https://github.com/NatiqQuran/nq-api-rust/actions/workflows/docker-publish.yml/badge.svg)](https://github.com/NatiqQuran/nq-api-rust/actions/workflows/docker-publish.yml)
+[![Docker Image CI](https://github.com/NatiqQuran/nq-api-rust/actions/workflows/docker-image.yml/badge.svg)](https://github.com/NatiqQuran/nq-api-rust/actions/workflows/docker-image.yml)
+[![Rust](https://github.com/NatiqQuran/nq-api-rust/actions/workflows/rust.yml/badge.svg)](https://github.com/NatiqQuran/nq-api-rust/actions/workflows/rust.yml)
+
+Natiq Quran open API \
 
 # Docker
 
-Start nq-api with docker-compose
+Start nq-api-rust with docker-compose
 
 ```bash
 sudo docker compose up
@@ -22,7 +23,7 @@ cargo build --release
 # Run
 
 ```bash
-./target/release/nq-api
+./target/release/nq-api-rust
 ```
 
-Api will listen to 0.0.0.0:8080
+API will listen to 0.0.0.0:8080

error_codes.json

@@ -1,86 +1,90 @@
 {
-    "INTERNAL_ERROR": {
-        "status_code": 500,
-        "message": "Internal Error!"
-    },
-    "NOT_FOUND": {
-        "status_code": 404,
-        "message": "Not found!"
-    },
-    "ACTION_NOT_FOUND": {
-        "status_code": 404,
-        "message": "Not found!"
-    },
-    "SEND_CODE_INTERNAL_ERROR": {
-        "status_code": 500,
-        "message": "Internal error when sending verification code!"
-    },
-    "VERIFY_CODE_NOT_SENDED": {
-        "status_code": 410,
-        "message": "No verification code is sended to this email!"
-    },
-    "VERIFY_CODE_NOT_VALID": {
-        "status_code": 400,
-        "message": "Verification code is not valid!"
-    },
-    "VERIFY_CODE_ALREADY_USED": {
-        "status_code": 410,
-        "message": "Verification code is already used!"
-    },
-    "VERIFY_CODE_EXPIRED": {
-        "status_code": 410,
-        "message": "Verification code is expired!"
-    },
-    "CANT_GENERATE_TOKEN": {
-        "status_code": 500,
-        "message": "Can't generate token!"
-    },
-    "ORGANIZATION_NAME_NOT_AVAILABLE": {
-        "status_code": 404,
-        "message": "Organization name is already in use by another account!"
-    },
-    "PERMISSION_CONDITION_VALUE_NOT_VALID": {
-        "status_code": 400,
-        "message": "Permission condition value is not valid!"
-    },
-    "AUTHZ_CONDITION_VALUE_NOT_DEFINED": {
-        "status_code": 404,
-        "message": "Authz condition value is not defined!"
-    },
-    "MODEL_ATTRIBUTE_NOT_DEFINED": {
-        "status_code": 404,
-        "message": "Model attribute value is not defined!"
-    },
-    "VALIDATION_ERROR": {
-        "status_code": 400,
-        "message": "Request data is not valid"
-    },
-    "FILTER_SORT_VALUE_NOT_DEFINED": {
-        "status_code": 404,
-        "message": "Filter sort value is not defined!"
-    },
-    "AUTHN_TOKEN_NOT_FOUND": {
-        "status_code": 401,
-        "message": "Token required!"
-    },
-    "AUTHN_TOKEN_INVALID": {
-        "status_code": 401,
-        "message": "Token invalid!"
-    },
-    "AUTHZ_PERMISSION_DENIED": {
-        "status_code": 403,
-        "message": "Permission denied!"
-    },
-    "UUID_ERROR": {
-        "status_code": 400,
-        "message": "Invalid UUID!"
-    },
-    "PHRASE_NOT_FOUND": {
-        "status_code": 404,
-        "message": "Phrase not found!"
-    },
-    "BAD_PATH": {
-        "status_code": 400,
-        "message": "Path format is not correct!"
-    }
+  "INTERNAL_ERROR": {
+    "status_code": 500,
+    "message": "Internal Error!"
+  },
+  "NOT_FOUND": {
+    "status_code": 404,
+    "message": "Not found!"
+  },
+  "ACTION_NOT_FOUND": {
+    "status_code": 404,
+    "message": "Not found!"
+  },
+  "SEND_CODE_INTERNAL_ERROR": {
+    "status_code": 500,
+    "message": "Internal error when sending verification code!"
+  },
+  "VERIFY_CODE_NOT_SENDED": {
+    "status_code": 410,
+    "message": "No verification code is sended to this email!"
+  },
+  "VERIFY_CODE_NOT_VALID": {
+    "status_code": 400,
+    "message": "Verification code is not valid!"
+  },
+  "VERIFY_CODE_ALREADY_USED": {
+    "status_code": 410,
+    "message": "Verification code is already used!"
+  },
+  "VERIFY_CODE_EXPIRED": {
+    "status_code": 410,
+    "message": "Verification code is expired!"
+  },
+  "CANT_GENERATE_TOKEN": {
+    "status_code": 500,
+    "message": "Can't generate token!"
+  },
+  "ORGANIZATION_NAME_NOT_AVAILABLE": {
+    "status_code": 404,
+    "message": "Organization name is already in use by another account!"
+  },
+  "PERMISSION_CONDITION_VALUE_NOT_VALID": {
+    "status_code": 400,
+    "message": "Permission condition value is not valid!"
+  },
+  "AUTHZ_CONDITION_VALUE_NOT_DEFINED": {
+    "status_code": 404,
+    "message": "Authz condition value is not defined!"
+  },
+  "MODEL_ATTRIBUTE_NOT_DEFINED": {
+    "status_code": 404,
+    "message": "Model attribute value is not defined!"
+  },
+  "VALIDATION_ERROR": {
+    "status_code": 400,
+    "message": "Request data is not valid"
+  },
+  "FILTER_SORT_VALUE_NOT_DEFINED": {
+    "status_code": 404,
+    "message": "Filter sort value is not defined!"
+  },
+  "AUTHN_TOKEN_NOT_FOUND": {
+    "status_code": 401,
+    "message": "Token required!"
+  },
+  "AUTHN_TOKEN_INVALID": {
+    "status_code": 401,
+    "message": "Token invalid!"
+  },
+  "AUTHZ_PERMISSION_DENIED": {
+    "status_code": 403,
+    "message": "Permission denied!"
+  },
+  "UUID_ERROR": {
+    "status_code": 400,
+    "message": "Invalid UUID!"
+  },
+  "PHRASE_NOT_FOUND": {
+    "status_code": 404,
+    "message": "Phrase not found!"
+  },
+  "BAD_PATH": {
+    "status_code": 400,
+    "message": "Path format is not correct!"
+  },
+  "NO_BISMILLAH": {
+    "status_code": 400,
+    "message": "Doesn't have bismillah!"
+  }
 }

migrations/00000000000001_create_app_accounts/up.sql

@@ -1,8 +1,7 @@
 CREATE TABLE app_accounts (
-    id serial NOT NULL,
+    id serial PRIMARY KEY,
     uuid uuid DEFAULT uuid_generate_v4 () NOT NULL,
     username VARCHAR(30) NOT NULL,
     account_type TEXT NOT NULL,
-    CONSTRAINT app_accounts_id PRIMARY KEY (id),
-    UNIQUE(username)
+    UNIQUE (username)
 );

migrations/00000000000003_create_mushaf/up.sql

@@ -5,7 +5,6 @@ CREATE TABLE quran_mushafs (
     short_name VARCHAR(200),
     name VARCHAR(400),
     source VARCHAR(300),
-    bismillah_text TEXT,
     created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
     updated_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
     CONSTRAINT mushaf_fk_user_id_rel FOREIGN KEY(creator_user_id) REFERENCES app_users(id),

migrations/00000000000005_create_quran_surahs/up.sql

@@ -5,12 +5,11 @@ CREATE TABLE quran_surahs (
     name VARCHAR(50) NOT NULL,
     period VARCHAR(50),
     number serial NOT NULL,
-    bismillah_status BOOLEAN NOT NULL,
-    bismillah_as_first_ayah BOOLEAN NOT NULL,
     mushaf_id serial NOT NULL,
     name_pronunciation TEXT,
     name_translation_phrase TEXT,
     name_transliteration TEXT,
+    search_terms TEXT ARRAY,
     created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
     updated_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
     CONSTRAINT quran_surahs_id PRIMARY KEY (id),

migrations/2023-02-19-100955_create_quran_ayahs/up.sql

@@ -5,6 +5,8 @@ CREATE TABLE quran_ayahs (
     surah_id serial NOT NULL,
     ayah_number serial NOT NULL,
     sajdah VARCHAR(20),
+    is_bismillah BOOLEAN NOT NULL,
+    bismillah_text TEXT,
     created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
     updated_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
     CONSTRAINT quran_ayahs_id PRIMARY KEY (id),

migrations/2023-03-12-100253_create_translation/up.sql

@@ -8,7 +8,6 @@ CREATE TABLE quran_translations (
     release_date DATE,
     source VARCHAR(300),
     approved BOOLEAN DEFAULT FALSE NOT NULL,
-    bismillah TEXT NOT NULL,
     created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
     updated_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
     CONSTRAINT translation_fk_user_id_rel FOREIGN KEY(creator_user_id) REFERENCES app_users(id),

migrations/2023-03-12-100301_create_translation_ayahs/down.sql

@@ -0,0 +1 @@
+DROP TABLE quran_translations_ayahs;

migrations/2023-03-12-100301_create_translation_text/up.sql → migrations/2023-03-12-100301_create_translation_ayahs/up.sql

@@ -1,14 +1,15 @@
-CREATE TABLE quran_translations_text (
+CREATE TABLE quran_translations_ayahs (
     id serial NOT NULL,
     uuid uuid DEFAULT uuid_generate_v4 () NOT NULL,
     creator_user_id serial NOT NULL,
     translation_id serial NOT NULL,
     ayah_id serial NOT NULL,
     text TEXT NOT NULL,
+    bismillah TEXT,
     created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
     updated_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
-    CONSTRAINT translation_text_id PRIMARY KEY (id),
+    CONSTRAINT translation_ayah_id PRIMARY KEY (id),
     CONSTRAINT fk_translation FOREIGN KEY(translation_id) REFERENCES quran_translations(id) on delete cascade,
-    CONSTRAINT translation_text_fk_user_id_rel FOREIGN KEY(creator_user_id) REFERENCES app_users(id),
+    CONSTRAINT translation_ayah_fk_user_id_rel FOREIGN KEY(creator_user_id) REFERENCES app_users(id),
     CONSTRAINT fk_ayah FOREIGN KEY(ayah_id) REFERENCES quran_ayahs(id) on delete cascade
 );

migrations/2024-12-05-083921_create_quran_ayahs_breakers/down.sql

@@ -0,0 +1 @@
+DROP TABLE quran_ayahs_breakers;

migrations/2024-12-05-083921_create_quran_ayahs_breakers/up.sql

@@ -0,0 +1,13 @@
+CREATE TABLE quran_ayahs_breakers (
+    id serial,
+    uuid uuid DEFAULT uuid_generate_v4 () NOT NULL,
+    creator_user_id serial NOT NULL,
+    ayah_id serial NOT NULL,
+    owner_account_id INT REFERENCES app_accounts (id),
+    name VARCHAR(256) NOT NULL,
+    created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
+    updated_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
+    CONSTRAINT ayah_break_id PRIMARY KEY (id),
+    CONSTRAINT fk_quran_ayah_break_creator_user_id FOREIGN KEY (creator_user_id) REFERENCES app_users (id),
+    CONSTRAINT fk_break_ayah FOREIGN KEY (ayah_id) REFERENCES quran_ayahs (id) on delete cascade
+);