soat-fiap / FIAP.TechChallenge.ByteMeBurger

Repository for FIAP SOAT post degree Tech Challenge
BSD 3-Clause "New" or "Revised" License
0 stars 1 forks source link

webhook integration add PaymentGatewayFactory #110

Closed italopessoa closed 4 days ago

coderabbitai[bot] commented 5 days ago

Walkthrough

The latest changes implement various improvements and refinements across the FIAP.TechChallenge.ByteMeBurger.Api project. Key updates include extending the Id column length in the Payments database table, renaming and annotating several controller methods for better HTTP semantics, introducing a new NotificationsController for handling payment webhooks, and enhancing the payment process by integrating a configurable payment gateway factory. Additionally, comprehensive updates are made to the unit tests to ensure alignment with these modifications.

Changes

Files Change Summary
database/init.sql Increased Id column length from char(36) to char(37) in Payments table.
...stomersController.cs, ...tionsController.cs, ...OrdersController.cs, ...PaymentsController.cs, ...ProductsController.cs Renamed methods and updated annotations for JSON produce/consume attributes, e.g., GetByCpf to Get, Create to Post, UpdateStatus to Put.
...ns/DefaultApiConventions.cs Added CancellationToken parameter to Post and Put methods.
...t/Controllers/NotificationsControllerTest.cs Added new test cases for NotificationsController related to payment event handling.
...t/Controllers/CustomersControllerTest.cs, ...dersControllerTest.cs, ...PaymentsControllerTest.cs Renamed method calls in test cases to reflect updated controller method names.
...ytions/IPaymentGatewayFactoryMethod.cs Introduced interface IPaymentGatewayFactoryMethod to create IPaymentGateway based on PaymentType.
...k/CreatePaymentRequest.cs New class defining properties OrderId and PaymentType.
...eBurger.Application/...PaymentService.cs, .../UseCases/.../CreatePaymentUseCase.cs, .../Interfaces/IPaymentService.cs Replaced IPaymentGateway with IPaymentGatewayFactoryMethod, added PaymentType parameter in methods.
...Pago.Gateway/...PaymentGatewayService.cs, ...atewayFactory.cs, ...t/PaymentGatewayFactoryTest.cs Introduced FakePaymentGatewayService and PaymentGatewayFactory for creating payment gateways, updated service configurations.
.../Program.cs Added lowercase URL configuration in routing options.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant CustomersController
    participant OrdersController
    participant PaymentsController
    participant NotificationsController
    participant IPaymentGatewayFactoryMethod
    participant FakePaymentGatewayService

    Client->>+CustomersController: Get/ Post JSON request
    CustomersController-->>-Client: JSON response

    Client->>+OrdersController: Post JSON request
    OrdersController-->>-Client: JSON response

    Client->>+PaymentsController: Post JSON request
    PaymentsController->>+IPaymentGatewayFactoryMethod: Create payment gateway
    IPaymentGatewayFactoryMethod->>-PaymentsController: Return payment gateway
    PaymentsController->>+FakePaymentGatewayService: Create payment
    FakePaymentGatewayService-->>-PaymentsController: Payment created
    PaymentsController-->>-Client: Payment response

    Client->>+NotificationsController: Post JSON request
    NotificationsController-->>-Client: JSON response

This diagram visualizes the primary interactions between the client and various controllers, highlighting the creation and handling of payments and notifications within the FIAP.TechChallenge.ByteMeBurger.Api project.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.