batuhanbay / bitirmeprojesi-batuhanbay

bitirmeprojesi-batuhanbay created by GitHub Classroom

Bootcamp Graduation Project

Requried Technologies:

• JDK 11.0.13
• Maven 4
• IntelliJ IDEA (Optional IDE)
• MySql Workbranch
• Jasper Studio (version 6.19.0) (Optional)

How Do I Setup Project?

• Run bitirme_ddl_script.sql and bitirme_dml_script.sql respectively which are located under the scripts folder on MySql server.

└───bitirmeprojesi-batuhanbay
         └───scripts
               └──bitirme_ddl_script.sql
               └──bitirme_dml_script.sql
 

• Open the project in the IDE.
• Set spring.datasource.password to your database server password in the application.properties

└───bitirmeprojesi-batuhanbay
        └───bitirme
              └───src
                    └───main
                          ├───resources
                                  ├───application.properties

• Assign your own database server password to the password variable in the getMySQLConnection method of MySQLConnUtils.java class under the Utils package.

└───bitirmeprojesi-batuhanbay
                   └───bitirme
                           └───src
                                 └──main
                                       ├──java
                                             ├──com
                                                 ├──softtechbootcamp
                                                               ├──bitirme
                                                                       ├──app
                                                                            ├──utils
                                                                                 ├──MySQLConnUtils

• Run the project
• Visit the http://localhost:8080/api/v1/swagger-ui/index.html#/ path in your browser.
• Sign up the with new account.
• Login with your user and get your token.
• Authorize with this token as shown at below.

Security

• JWT

Test

• Unit
• Integration

81% of the classes in the project were tested and 62% of the rows were covered in the entire project. A total of 121 tests, 44 integration tests and 77 unit tests, were successfully running. Also, H2 database has been used for integration test.

How to Run Test?

• Before run all test be ensure resources package where under the test package, is pointed as test resources in the project structure. (Ctrl + Alt + Shift + S for open project structere in the IntelliJ)

 └───bitirmeprojesi-batuhanbay
    └───bitirme
          └───src
                └──main
                └──test
                     └──resources
  

Project Features

• Base model implemented for all entiy and service classes.
• Errors, warnings, and information received while running the project locally are logged. As information, all entities are logged as information in the log file before saving, updating and deleting. Reflection was used to get the entity names while logging these informations. You can find log file under the logs folder with softtech_bitirme_logger.log file. For logging logback.xml file is used.

 └───bitirmeprojesi-batuhanbay
    └───bitirme
          └───logs
                └──softtech_bitirme_logger.log
  

└───bitirmeprojesi-batuhanbay
          └───bitirme
                └───src
                      └───main
                            ├───resources
                                    ├───logback.xml

 > Example of logs:

• Log tables were created for user, product, product types and settings tables in the database. Scripts are in the bitirme_ddl_script.sql file. The created log tables are filled by triggers after the update and delete operation in the records of user, product, product types and settings tables. You can find triggers in the bitirme_dml_script.sql file.

 └───bitirmeprojesi-batuhanbay
          └───scripts
                └──bitirme_ddl_script.sql
                └──bitirme_dml_script.sql
  

• For the process that returns the details of the product type according to the desired product type in the project requirements, an additional pdf file which is generated by service, showing the product type details was generated and dowlanded your copmtuter.

Note: The generated pdf template was designed using Jasper Studio.

Note: To create the detail pdf file of the desired product type, a request should be sent to the http://localhost:8080/api/v1/products/types/{productTypeId}/detail/pdf enpoint.

Note: You can find the generated and downloaded pdf file under the default D:\jasper_reports\ folder. The folder given in this file path will be created automatically by the service. To update the file path, you can update the savedDirectoryPath value in the settings using the service.

 > Template of Report

 > Example of Generated Pdf By Service

• Swagger used for Open API Specification.

Projenin Konusu: Bir marketteki ürünlerin satış fiyatlarına göre son fiyatlarını belirleyen servisin Spring Boot Framework kullanılarak yazılması ve isteğe bağlı olarak önyüzünün yazılması.

Gereksinimler:

Backend:

• Kullanıcıdan kullanıcı adı, şifre, isim, soy isim bilgilerini alarak sisteme kayıt yapılır.
• Sisteme kayıtlı kullanıcılar market ürünlerinin veri girişini yapabilir.
• Ürün türlerine göre KDV oranları değişiklik göstermektedir. Bu oranlar aşağıdaki tabloda belirtilmiştir. Zaman zaman KDV oranları değişiklik gösterebilmektedir.

• Ürün için veri girişi yapacak kullanıcı; ürünün adı, ürünün türü ve vergisiz satış fiyatı alanlarını doldurur. Her bir ürün için KDV Tutarı ve ürünün son fiyatı da hesaplanarak sisteme kaydedilir.

Kurallar ve gereksinimler:

• Sisteme yeni kullanıcı tanımlanabilir, güncellenebilir ve silinebilir.
• Sisteme yeni ürünler tanımlanabilir, güncellenebilir ve silinebilir.
• Ürünlerin fiyatları güncellenebilir.
• KDV oranları değiştiğinde sistemdeki ürünlere de bu değişiklik yansıtılmalıdır. Herhangi bir hata durumunda tüm işlemler geri alınmalıdır.
• Tüm ürünler listelenebilmelidir.
• Ürün türlerine göre ürünler listelenebilmelidir.
• Belirli bir fiyat aralığındaki ürünler listelenebilmelidir.
• Ürün türlerine göre aşağıdaki gibi detay veri içeren bir bilgilendirme alınabilmelidir.

Validasyonlar:

• Aynı kullanıcı adı ile kullanıcı tanımı yapılamaz.
• Kullanıcı girişi kullanıcı adı & şifre kombinasyonu ile yapılır.
• Ürün türü, fiyatı, adı gibi alanlar boş olamaz.
• Ürün fiyatı sıfır ya da negatif olamaz.
• KDV oranı negatif olamaz.

Authentication:

• Güvenli endpointler kullanınız. (jwt, bearer vs. )

Response:

• Başarılı ve başarısız responselar için modeller tanımlayın ve bunları kullanın.

Dökümantasyon:

• Open API Specification (Swagger tercih sebebi)

Exception Handling:

• Hatalı işlemler için doğru hata kodlarının dönüldüğünden emin olunuz.

Test:

• Unit ve integration testleri yazınız.