diff --git a/README.md b/README.md index e9ef11dd455093c6698b24ebcb0262ece87e2cb0..ff27729acfc4dc481bf7d03cccc490cc7f9b05d9 100644 --- a/README.md +++ b/README.md @@ -1,128 +1,54 @@ # SOAP Service -## Getting started - -To make it easy for you to get started with GitLab, here's a list of recommended next steps. - -Already a pro? Just edit this README.md and make it your own. Want to make it -easy? [Use the template at the bottom](#editing-this-readme)! - -## Add your files - -- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) - or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files -- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) - or push an existing Git repository with the following command: - -``` -cd existing_repo -git remote add origin https://gitlab.informatika.org/if3110-2023-02-j/soap-service.git -git branch -M main -git push -uf origin main -``` - -## Integrate with your tools - -- [ ] [Set up project integrations](https://gitlab.informatika.org/if3110-2023-02-j/soap-service/-/settings/integrations) - -## Collaborate with your team - -- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) -- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) -- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) -- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) -- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) - -## Test and Deploy - -Use the built-in continuous integration in GitLab. - -- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) -- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) -- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) -- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) -- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) - -*** - -# Editing this README - -When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to -structure it however you want - this is just a starting point!). Thank you -to [makeareadme.com](https://www.makeareadme.com/) for this template. - -## Suggestions for a good README - -Every project is different, so consider which of these sections apply to yours. The sections used in the template are -suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long -is better than too short. If you think your README is too long, consider utilizing another form of documentation rather -than cutting out information. - -## Name - -Choose a self-explaining name for your project. +# SOAP Service Documentation ## Description +This repository is dedicated to a SOAP-based web service designed primarily for facilitating point top-up functionality. Users can increase their points via this service. Additionally, this SOAP service incorporates a feature enabling users to purchase merchandise using their accumulated points. -Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be -unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your -project, this is a good place to list differentiating factors. - -## Badges - -On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the -project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. - -## Visuals - -Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see -GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. - -## Installation - -Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. -However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing -specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a -specific context like a particular programming language version or operating system or has dependencies that have to be -installed manually, also add a Requirements subsection. - -## Usage - -Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of -usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably -include in the README. - -## Support - -Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, -etc. - -## Roadmap +## Database + +The above scheme consists of 3 tables. The history table is used to store merch purchase history on rest. The soap log table is used to do logging if a feature on soap is used. The soap connector table is used to store several attributes related to rest, soap and php. Examples are code and points. -If you have ideas for releases in the future, it is a good idea to list them in the README. +## Endpoint +1. /topup +2. /code +3. /buyProduct +4. /checkCode +5. /getCurrency +6. /getHistory +7. /uangConverter +8. /getCode +9. /updatePoint -## Contributing +## Explanation +/topup: This endpoint facilitates the process of adding points or credits to a user's account. It typically accepts requests containing user identification and the amount of points to be added. Upon successful execution, it updates the user's points balance. -State if you are open to contributions and what your requirements are for accepting them. +/code: The endpoint handles a specific action related to generating or managing authentication or access codes. It involve functionalities like generating unique codes. -For people who want to make changes to your project, it's helpful to have some documentation on how to get started. -Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps -explicit. These instructions could also be useful to your future self. +/buyProduct: The '/buyProduct' endpoint allows users to purchase products or items offered by the service. It usually expects a request with details regarding the product ID, quantity, and possibly user authentication for completing the purchase transaction. -You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce -the likelihood that the changes inadvertently break something. Having instructions for running tests is especially -helpful if it requires external setup, such as starting a Selenium server for testing in a browser. +/checkCode: This endpoint is responsible for validating or verifying a register code. -## Authors and acknowledgment +/getCurrency: The endpoint retrieves information related to currency details, such as point and money. -Show your appreciation to those who have contributed to the project. +/getHistory: The '/getHistory' endpoint retrieves the transaction or usage history associated with a user's account. It could provide details like past purchases, points usage, or transaction logs based on user identification. -## License +/uangConverter: This endpoint handles currency conversion functionalities. It convert money to point. -For open source projects, say how it is licensed. +/getCode: The '/getCode' endpoint retrieves specific codes or access tokens based on provided criteria or identifiers. It return codes required for authentication register code. -## Project status +/updatePoint: The '/updatePoint' endpoint is responsible for modifying or updating a user's points or credit balance. It typically receives requests with details like user identification and the amount of points to be added, deducted, or adjusted. -If you have run out of energy or time for your project, put a note at the top of the README saying that development has -slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or -owner, allowing your project to keep going. You can also make an explicit request for maintainers. +### Assignment +|Feature|13521015|13521025| +|-------|--------|--------| +|topup||✔ï¸| +|code||✔ï¸| +|buyProduct||✔ï¸| +|checkCode||✔ï¸| +|getCurrency||✔ï¸| +|getHistory||✔ï¸| +|uangConverter||✔ï¸| +|getCode||✔ï¸| +|updatePoint||✔ï¸| +|testing|✔ï¸|✔ï¸| diff --git a/img/image.png b/img/image.png new file mode 100644 index 0000000000000000000000000000000000000000..3187f121e8d0330a95b71c0678faea40c2ca2c20 Binary files /dev/null and b/img/image.png differ diff --git a/pom.xml b/pom.xml index 5885804ea4f387a935f5dfe0cba383be6b843e96..6cb63a9be16f704c26156eaeccc819b33718056d 100644 --- a/pom.xml +++ b/pom.xml @@ -50,6 +50,14 @@ <version>2.18</version> </dependency> + <!-- https://mvnrepository.com/artifact/javax.mail/javax.mail-api --> + <dependency> + <groupId>com.sun.mail</groupId> + <artifactId>javax.mail</artifactId> + <version>1.6.2</version> <!-- Use the appropriate version --> + </dependency> + + </dependencies> <build>