Examples use-cases - get collection

lealobanov commented 1 month ago

Description

Get collection :

Get collection by ID

For contributor use:

[ ] Targeted PR against master branch
[ ] Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
[ ] Code follows the standards mentioned here.
[ ] Updated relevant documentation
[ ] Re-reviewed Files changed in the Github PR explorer
[ ] Added appropriate labels

Summary by CodeRabbit

New Features
- Introduced GetCollectionAccessAPIConnector to access collections in the Flow blockchain.
- Added a test class GetCollectionAccessAPIConnectorTest to validate functionality of the new connector.
Bug Fixes
- Minor formatting changes across various connectors and tests to improve code readability.
Documentation
- Enhanced test capabilities for service account management in GetBlockAccessAPIConnectorTest.
Chores
- Cleaned up whitespace in multiple test classes to improve code clarity.

coderabbitai[bot] commented 1 month ago

Walkthrough

A series of minor formatting changes and the introduction of a new GetCollectionAccessAPIConnector class have been implemented across several Java and Kotlin files in the project. These changes include the removal of blank lines for improved code consistency and readability, as well as the addition of new tests for the collection access functionality within the Flow blockchain framework.

Changes

Files	Change Summary
`java-example/src/main/java/org/onflow/examples/java/getAccount/GetAccountAccessAPIConnector.java` `java-example/src/main/java/org/onflow/examples/java/getBlock/GetBlockAccessAPIConnector.java` `java-example/src/main/java/org/onflow/examples/java/getNetworkParams/GetNetworkParametersAccessAPIConnector.java` `java-example/src/main/java/org/onflow/examples/java/getTransaction/GetTransactionAccessAPIConnector.java`	Minor formatting changes with blank lines removed, no functional changes.
`java-example/src/main/java/org/onflow/examples/java/getCollection/GetCollectionAccessAPIConnector.java`	New class introduced to connect with Flow Access API for retrieving collections by ID.
`java-example/src/test/java/org/onflow/examples/java/AccessAPIConnectorTest.java`	Removed declarations for `serviceAccount` and `accessAPI`, indicating refactoring.
`java-example/src/test/java/org/onflow/examples/java/getAccount/GetAccountAccessAPIConnectorTest.java` `java-example/src/test/java/org/onflow/examples/java/getBlock/GetBlockAccessAPIConnectorTest.java` `java-example/src/test/java/org/onflow/examples/java/getCollection/GetCollectionAccessAPIConnectorTest.java` `java-example/src/test/java/org/onflow/examples/java/getEvent/GetEventAccessAPIConnectorTest.java` `java-example/src/test/java/org/onflow/examples/java/getNetworkParams/GetNetworkParametersAccessAPIConnectorTest.java` `java-example/src/test/java/org/onflow/examples/java/getTransaction/GetTransactionAccessAPIConnectorTest.java`	Minor whitespace adjustments for improved readability, with no functional changes.
`kotlin-example/src/main/kotlin/org/onflow/examples/kotlin/getCollection/GetCollectionAccessAPIConnector.kt`	New class introduced to connect with Flow Access API for retrieving collections by ID.
`kotlin-example/src/test/kotlin/org/onflow/examples/kotlin/getBlock/GetBlockAccessAPIConnectorTest.kt`	Added imports and a new `serviceAccount` property for managing service account credentials in tests.
`kotlin-example/src/test/kotlin/org/onflow/examples/kotlin/getCollection/GetCollectionAccessAPIConnectorTest.kt`	New test class created to validate functionality of `GetCollectionAccessAPIConnector`.

Sequence Diagram(s)

sequenceDiagram
    participant ServiceAccount
    participant FlowAccessApi
    participant GetCollectionAccessAPIConnector

    ServiceAccount->>+GetCollectionAccessAPIConnector: Initiate GetCollectionById
    GetCollectionAccessAPIConnector->>FlowAccessApi: Get collection data by ID
    FlowAccessApi-->>-GetCollectionAccessAPIConnector: Return collection data
    GetCollectionAccessAPIConnector-->>ServiceAccount: Return collection

🐇 "In fields of code where rabbits tread,
Whitespace gone, new paths we've spread.
A connector for collections now shines bright,
With tests to ensure everything's right.
Hop along, let's celebrate this feat,
In the world of Flow, our work is sweet!" 🐇

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 Configuration 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.

github-actions[bot] commented 1 month ago

Unit Test Results

  53 files +  53   53 suites +53 23s :stopwatch: +23s 310 tests +310 310 :heavy_check_mark: +310 0 :zzz: ±0 0 :x: ±0

Results for commit 514d9459. ± Comparison against base commit 0bc8410d.

:recycle: This comment has been updated with latest results.

github-actions[bot] commented 1 month ago

SDK Examples Unit Test Results

14 files 14 suites 3m 2s :stopwatch: 35 tests 35 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit 514d9459.

:recycle: This comment has been updated with latest results.

github-actions[bot] commented 1 month ago

Common Integration Test Results

1 files 1 suites 7s :stopwatch: 1 tests 1 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit 514d9459.

:recycle: This comment has been updated with latest results.

github-actions[bot] commented 1 month ago

Integration Test Results

  5 files +  5   5 suites +5 2m 29s :stopwatch: + 2m 29s 29 tests +29 29 :heavy_check_mark: +29 0 :zzz: ±0 0 :x: ±0

Results for commit 514d9459. ± Comparison against base commit 0bc8410d.

:recycle: This comment has been updated with latest results.

onflow / flow-jvm-sdk