search

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

feat: get payment status #73 #105

Closed italopessoa closed 1 week ago

coderabbitai[bot] commented 1 week ago

Walkthrough

The updates introduce significant modifications to the payment module of the ByteMeBurger API. Major changes include the removal of paymentType from the PaymentViewModel, the addition of GetStatus method in PaymentController, adjustments to the PaymentStatus and PaymentType enums, and updates to corresponding repository and service methods. These updates streamline payment data handling and improve functionality such as fetching payment statuses and details.

Changes

Files/Paths Change Summary
src/.../PaymentController.cs Removed paymentType from CreateOrderPaymentAsync, added GetStatus method.
src/.../PaymentStatusViewModel.cs Introduced PaymentStatusViewModel enum for representing payment statuses.
src/.../PaymentTypeViewModel.cs Added PaymentTypeViewModel enum with Test and MercadoPago members.
src/.../PaymentViewModel.cs Removed PaymentType field from PaymentViewModel.
src/.../PaymentService.cs Added GetPaymentAsync method to retrieve payment details by payment ID.
src/.../Payment.cs Changed PaymentType property to a custom enum, adjusted constructor signatures.
src/.../IPaymentRepository.cs Modified GetPaymentStatusAsync method to return Task<Payment?>.
src/.../IPaymentService.cs Added GetPaymentAsync method to IPaymentService interface.
src/.../PaymentStatus.cs Updated PaymentStatus enum values and added Paid status.
src/.../PaymentType.cs Introduced PaymentType enum with Test and MercadoPago members.
src/.../MercadoPagoService.cs Updated PaymentType assignment, removed some unused properties, added a new constant.
src/.../Constants.cs Changed Constants class and InsertPaymentQuery constant accessibility to internal, added a new constant.
src/.../PaymentRepositoryDapper.cs Updated SaveAsync method for PaymentType casting, modified GetPaymentAsync to return nullable Payment.
tests/.../PaymentControllerTest.cs Modified test method to remove assertion related to PaymentType, added new test for GetStatus.
tests/.../FIAP.TechChallenge.ByteMeBurger.Api.Test.csproj Added Folder item group including Repository\ folder.
tests/.../PaymentServiceTests.cs Added new test GetPaymentAsync_Success to test GetPaymentAsync functionality.
tests/.../FIAP.TechChallenge.ByteMeBurger.Persistence.Test.csproj Added a new package reference to AutoFixture version 4.18.1.

Sequence Diagrams

sequenceDiagram
    participant User
    participant API
    participant PaymentController
    participant PaymentService
    participant PaymentRepository

    User->>API: POST CreateOrderPayment
    API->>PaymentController: CreateOrderPaymentAsync
    PaymentController->>PaymentService: CreateOrderPaymentAsync
    PaymentService->>PaymentRepository: SavePayment
    PaymentRepository-->>PaymentService: Payment (saved)
    PaymentService-->>PaymentController: PaymentViewModel (without PaymentType)
    PaymentController-->>API: PaymentViewModel (without PaymentType)
    API-->>User: PaymentDetails

    User->>API: GET GetStatus
    API->>PaymentController: GetStatus
    PaymentController->>PaymentService: GetPaymentAsync
    PaymentService->>PaymentRepository: GetPaymentAsync
    PaymentRepository-->>PaymentService: Payment (nullable)
    PaymentService-->>PaymentController: Payment (nullable)
    PaymentController-->>API: PaymentStatusViewModel
    API-->>User: PaymentStatusViewModel

This sequence diagram outlines the main interactions for creating an order payment and retrieving payment status in the updated system.

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.