Main branch release

.env.example

@@ -0,0 +1,43 @@
+# Database Configuration
+DB_URL=
+DB_USERNAME=
+DB_PASSWORD=
+
+# Application Configurations
+APP_VERSION=
+APP_REPOSITORY_URL=
+
+# Front end links
+FRONTEND_BASE_URL=
+
+# Vendor Configuration
+VENDOR_INSTAGRAM=
+VENDOR_EMAIL=
+VENDOR_PHONE=
+VENDOR_ADDRESS=
+VENDOR_LATITUDE=
+VENDOR_LONGITUDE=
+VENDOR_PAYMENT_FEE=
+VENDOR_FEE_PER_KM=
+
+# Endpoint Authorization
+JWT_SECRET=
+JWT_ACCESS_EXP_SECONDS=
+REFRESH_TOKEN_EXP_DAYS=
+
+# One Time Password Configuration
+OTP_PHONE_NUMBER=
+OTP_LENGTH=
+OTP_EXPIRE_SECONDS=
+FONNTE_API_TOKEN=
+
+# Midtrans Configuration
+#MIDTRANS_CLIENT_KEY=
+MIDTRANS_MERCHANT_ID=
+MIDTRANS_SERVER_KEY=
+MIDTRANS_BASE_URL_APP=
+MIDTRANS_BASE_URL_API=
+MIDTRANS_NOTIFICATION_URL=
+MIDTRANS_FINISH_URL=
+MIDTRANS_UNFINISH_URL=
+MIDTRANS_ERROR_URL=

.github/workflows/maven.yml

@@ -0,0 +1,53 @@
+# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-maven
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Java CI with Maven
+
+on:
+  push:
+    branches: 
+      - "develop"
+      - "main"
+      - "release/*"
+      - "feature/*"
+      - "hotfix/*"
+  pull_request:
+    branches: 
+      - "develop"
+      - "main"
+      - "release/*"
+
+permissions:
+  contents: write
+  deployments: write
+  security-events: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up JDK 21
+      uses: actions/setup-java@v4
+      with:
+        java-version: '21'
+        distribution: 'temurin'
+        cache: maven
+    - name: Build and Test with Maven
+      run: mvn -B verify --file pom.xml
+    - name: Cache Maven packages
+      uses: actions/cache@v3
+      with:
+        path: ~/.m2
+        key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
+        restore-keys: ${{ runner.os }}-m2
+    # IDK: Uploads the full dependency graph to GitHub to improve the quality of Dependabot alerts this repository can receive
+    - name: Update dependency graph
+      if: github.event_name == 'push'
+      uses: advanced-security/maven-dependency-submission-action@571e99aab1055c2e71a1e2309b9691de18d6b7d6

.gitignore

@@ -4,6 +4,9 @@ target/
 !**/src/main/**/target/
 !**/src/test/**/target/
 
+### Saved By Program ###
+src/main/resources/uploads/*
+
 ### STS ###
 .apt_generated
 .classpath
@@ -31,3 +34,6 @@ build/
 
 ### VS Code ###
 .vscode/
+
+### ENVIRONMENT ###
+.env

LICENSE

@@ -1,21 +1,122 @@
-MIT License
-
-Copyright (c) 2024 Nara
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+This software is released under CC0 1.0 Universal.
+KuenyaWZ and KuenyaWZ API are trademarks of KuenyaWZ.
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

README.md

@@ -1,33 +1,33 @@
-# WZ Snack And Bites API
+# KuenyaWZ API
 
-Spring Boot API for WZ Snack And Bites project.
+Spring Boot API for KuenyaWZ project.
 
 ## Main Repository
 
-This project is to be implemented for our **[WZ Snack N Bites](https://github.com/vianneynara/wz-snack-n-bites)**
-project.
+This project is to be implemented for our **[KuenyaWZ](https://github.com/vianneynara/kuenyawz)** site.
 
 ## Features/checklist
 
 - [ ] Entities - Controllers - Services - Repositories
     - [x] Account
-    - [ ] Product
-    - [ ] Variant (subset of Product)
-    - [ ] Order
-    - [ ] Order Item (subset of Order)
-    - [ ] Transaction
-    - [ ] Likes
-    - [ ] CustomSchedule
-- [ ] Authentication/Authorization
-    - [ ] Basic
-    - [ ] JWT
+    - [x] Product
+    - [x] Variant (subset of Product)
+    - [x] Product Images
+    - [x] Order
+    - [x] Order Item (subset of Order)
+    - [x] Transaction
+    - [ ] ~~Likes~~
+    - [x] CustomSchedule
+- [x] Authentication/Authorization
+    - [ ] ~~Basic~~
+    - [x] JWT Authentication
 
 Should be noted that we'll need to implement integration of methods
 for the actual website business logic.
 
 ## API documentation
 
-Refer to this **[Swagger Documentation](https://app.swaggerhub.com/apis-docs/NaraNarwandaru/wz-snack_and_bites_api/1.0.0)**
+Refer to this **[Swagger Documentation](https://app.swaggerhub.com/apis/Nara-ff7/kuenyawz-api/1.0.0#/)**
 
 ## Prerequisites
 
@@ -40,10 +40,37 @@ Refer to this **[Swagger Documentation](https://app.swaggerhub.com/apis-docs/Nar
 
 - Database: H2 in memory
 - Port: 8081
-- Base URL: `http://localhost:8081/api/v1`
+- Base URL: `http://localhost:8081/api`
 
 ## Installing and running application
 
 1. Clone this repository
 2. Change directory to the cloned repository
-3. Run `mvn spring-boot:run`
+3. Run `mvn spring-boot:run`
+
+### Running with specific profile
+
+Make sure the profile requirement is met. For example, to run with postgres profile,
+please make sure you have PostgreSQL installed and running with the provided `.ENV`.
+
+1. Add profile to environment variable: `set SPRING_PROFILES_ACTIVE=postgres`
+2. Run `mvn spring-boot:run`
+
+## Authenticating
+
+Environment requirements:
+
+|key|description|
+|-|-|
+|JWT_SECRET|Base 64 secret key|
+JWT_ACCESS_EXP_SECONDS|Token availability until expiration (in seconds), default=3600|
+REFRESH_TOKEN_EXP_DAYS|Refresh token availability until expiration (in days), default=7|
+
+Authentication process:
+1. `POST /api/auth/register` Registration to create new account and retrieve authententication response
+2. `POST /api/auth/login` Login to authenticate to an account and retrieve authententication response
+3. `GET /api/auth/me` Me to retrieve current access token's user details/account/owner
+4. `POST /api/auth/refresh` Refresh to get new access token (JWT token)
+5. `POST /api/auth/revoke` Revoke to invalidate a refresh tokenn (used when logging out)
+
+The refresh token is generated using Java's `SecureRandom` and ancoded using Base64.