Build Project with Generated Client, Update package.md, Test and Vali…

…date Functionality (#3) * Add generated client code and documentation * Add mock service and tests for feedback submissions * Update README.md Co-authored-by: Thisaru Guruge <[email protected]> * [Automated] Update the toml files * Refactor README.md for clarity and formatting improvements * Refactor mock service documentation and clean up test cases * Update distribution version and change package organization for feedback review * Add copyright notice and license information. * Sanitized API endpoints in tests and utils for consistency * [Automated] Update the toml files * [Automated] Update the toml files * Refactor README and module documentation * Update keywords in Ballerina.toml for improved discoverability * Refactor README and Module documentation * Add auto-generated file notice to client, types, and utils modules * Fix missing newlines at the end of several files in tests and examples * Update README and Module documentation for HubSpot CRM connector * Refactor client configuration * Fix typo * Update sanitation documentation for OpenAPI specification. * Update README and Module documentation * Refactor feedback review example mock tests * Remove unused HTTP import from test file * Remove commented-out BearerTokenConfig from test file * Enhance feedback review example with detailed comments and update test IDs * Update copyright year in license file * Update OpenAPI client generation command to include license file * Update README and module documentation to reflect pagination in feedback submissions * Fix feedback submission type reference in documentation * Sanitized feedback submissions API endpoints and update related tests and documentation * Refactor README and module documentation * Add configuration template and update tests for live and mock server seperately. * Update module references in documentation to use 'hubspot.crm.obj.feedback' * Format code for consistency in mock service and test files * [Automated] Update the toml files * Add icon * Refactor client initialization and update test configurations for live and mock servers * Update README and module documentation to include refresh token in authentication steps * Simplify API paths by removing common prefix from endpoints for improved readability * Update sanitations.md * Add test groups for mock and live service tests in configuration * Rename baseClient to feedbackClient for clarity in feedback submission operations * Apply suggestions from code review --------- Co-authored-by: Thisaru Guruge <[email protected]>
ballerina-platform · Jan 17, 2025 · d56a51c · d56a51c
1 parent e03756a
commit d56a51c
Show file tree

Hide file tree

Showing 34 changed files with 4,115 additions and 79 deletions.
diff --git a/.gitignore b/.gitignore
@@ -56,3 +56,5 @@ build
 
 # Ignore Docker env file
 docker.env
+
+openapi-spec
diff --git a/README.md b/README.md
@@ -8,45 +8,207 @@
 
 ## Overview
 
-[//]: # (TODO: Add overview mentioning the purpose of the module, supported REST API versions, and other high-level details.)
+[HubSpot](https://developers.hubspot.com) is an AI-powered customer relationship management (CRM) platform.
+
+The `ballerinax/hubspot.crm.obj.feedback` offers APIs to connect and interact with the [HubSpot Feedback Submission API](https://developers.hubspot.com/docs/reference/api/crm/objects/feedback-submissions) endpoints, specifically based on the [HubSpot REST API](https://developers.hubspot.com/docs/reference/api).
+
+> **Note:** This package may be changed in the future based on the HubSpot API changes, since it is currently under development and is subject to change based on testing and feedback. By using this package, you are agreeing to accept any future changes that might occur and understand the risk associated with testing an unstable API. Refer to the [HubSpot Developer Terms](https://legal.hubspot.com/developer-terms) & [Developer Beta Terms](https://legal.hubspot.com/developerbetaterms) for more information.
+>
+> The feedback submissions endpoints are currently read only. Feedback submissions cannot be submitted or edited through the API.
 
 ## Setup guide
 
-[//]: # (TODO: Add detailed steps to obtain credentials and configure the module.)
+To use the HubSpot Feedback connector, you must have access to the HubSpot API through a HubSpot developer account and a HubSpot App under it. Therefore you need to register for a developer account at HubSpot if you don't have one already.
+
+### Step 1: Create/Login to a HubSpot Developer Account
+
+If you have an account already, go to the [HubSpot developer portal](https://app.hubspot.com/)
+
+If you don't have a HubSpot Developer Account you can sign up to a free account [here](https://developers.hubspot.com/get-started)
+
+### Step 2 (Optional): Create a Developer Test Account
+
+Within app developer accounts, you can create a [developer test account](https://developers.hubspot.com/beta-docs/getting-started/account-types#developer-test-accounts) under your account to test apps and integrations without affecting any real HubSpot data.
+
+> **Note:** These accounts are only for development and testing purposes. In production you should not use Developer Test Accounts.
+
+
+1. Go to the Test accounts section from the left sidebar.
+   ![Test accounts section](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.object.feedback/main/docs/resources/test-account.png)
+
+2. Click on the `Create developer test account` button on the top right corner.
+   ![Create developer test account](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.object.feedback/main/docs/resources/create-test-account.png)
+
+3. In the pop-up window, provide a name for the test account and click on the `Create` button.
+   ![Create test account](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.object.feedback/main/docs/resources/create-account.png)
+   You will see the newly created test account in the list of test accounts.
+   ![Test account portal](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.object.feedback/main/docs/resources/test-account-portal.png)
+
+### Step 3: Create a HubSpot App
+
+1. Now navigate to the `Apps` section from the left sidebar and click on the `Create app` button on the top right corner.
+   ![Create app](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.object.feedback/main/docs/resources/create-app.png)
+
+2. Provide a public app name and description for your app.
+   ![App name and description](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.object.feedback/main/docs/resources/app-name-desc.png)
+
+### Step 4: Setup Authentication
+
+1. Move to the `Auth` tab.
+   ![Configure authentication](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.object.feedback/main/docs/resources/config-auth.png)
+
+2. In the `Scopes` section, add the following scopes for your app using the `Add new scopes` button.
+   - `e-commerce`
+   - `tickets`
+   - `crm.objects.goals.read`
+   - `media_bridge.read`
+   - `crm.objects.custom.read`
+   - `crm.objects.custom.write`
+   - `crm.objects.feedback_submissions.read`
+
+   ![Add scopes](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.object.feedback/main/docs/resources/add-scopes.png)
+
+3. In the `Redirect URL` section, add the redirect URL for your app. This is the URL where the user will be redirected after the authentication process. You can use `localhost` for testing purposes. Then click the `Create App` button.
+
+   ![Redirect URL](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.object.feedback/main/docs/resources/redirect-url.png)
+
+### Step 5: Get the Client ID and Client Secret
+
+Navigate to the `Auth` tab and you will see the `Client ID` and `Client Secret` for your app. Make sure to save these values.
+![Client ID and Client Secret](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.object.feedback/main/docs/resources/client-id-secret.png)
+
+### Step 6: Setup Authentication Flow
+
+Before proceeding with the Quickstart, ensure you have obtained the Access Token or Refresh Token using the following steps:
+
+1. Create an authorization URL using the following format:
+
+   ```
+   https://app.hubspot.com/oauth/authorize?client_id=<YOUR_CLIENT_ID>&scope=<YOUR_SCOPES>&redirect_uri=<YOUR_REDIRECT_URI>
+   ```
+
+   Replace the `<YOUR_CLIENT_ID>`, `<YOUR_REDIRECT_URI>` and `<YOUR_SCOPES>` with your specific value.
+2. Paste it in the browser and select your developer test account to install the app when prompted.
+   ![Account select](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.object.feedback/main/docs/resources/account-select.png)
+
+3. A code will be displayed in the browser. Copy the code.
+
+4. Run the following curl command. Replace the `<YOUR_CLIENT_ID>`, `<YOUR_REDIRECT_URI`> and `<YOUR_CLIENT_SECRET>` with your specific value. Use the code you received in the above step 3 as the `<CODE>`.
+
+   - Linux/macOS
+
+     ```bash
+     curl --request POST \
+     --url https://api.hubapi.com/oauth/v1/token \
+     --header 'content-type: application/x-www-form-urlencoded' \
+     --data 'grant_type=authorization_code&code=<CODE>&redirect_uri=<YOUR_REDIRECT_URI>&client_id=<YOUR_CLIENT_ID>&client_secret=<YOUR_CLIENT_SECRET>'
+     ```
+   - Windows
+
+     ```bash
+     curl --request POST ^
+     --url https://api.hubapi.com/oauth/v1/token ^
+     --header 'content-type: application/x-www-form-urlencoded' ^
+     --data 'grant_type=authorization_code&code=<CODE>&redirect_uri=<YOUR_REDIRECT_URI>&client_id=<YOUR_CLIENT_ID>&client_secret=<YOUR_CLIENT_SECRET>'
+     ```
+
+   This command will return the access token and refresh token which are necessary for API calls.
+
+   ```json
+   {
+     "token_type": "bearer",
+     "refresh_token": "<Refresh Token>",
+     "access_token": "<Access Token>",
+     "expires_in": 1800
+   }
+   ```
+5. Store the refresh token securely for use in your application.
 
 ## Quickstart
 
-[//]: # (TODO: Add a quickstart guide to demonstrate a basic functionality of the module, including sample code snippets.)
+To use the `Hubspot CRM Feedback Submission` connector in your Ballerina application, update the `.bal` file as follows:
+
+### Step 1: Import the module
+
+Import the `hubspot.crm.obj.feedback` module and `oauth2` module.
+
+```ballerina
+import ballerinax/hubspot.crm.obj.feedback as hsfeedback;
+import ballerina/oauth2;
+```
+
+### Step 2: Instantiate a new connector
+
+1. Create a `Config.toml` file and, configure the obtained credentials in the above steps as follows:
+
+   ```toml
+    clientId = <Client Id>
+    clientSecret = <Client Secret>
+    refreshToken = <Refresh Token>
+   ```
+
+2. Instantiate a `hsfeedback:ConnectionConfig` with the obtained credentials and initialize the connector with it.
+
+    ```ballerina
+    configurable string clientId = ?;
+    configurable string clientSecret = ?;
+    configurable string refreshToken = ?;
+
+    hsfeedback:ConnectionConfig config = {
+        auth: {
+            clientId,
+            clientSecret,
+            refreshToken,
+            credentialBearer: oauth2:POST_BODY_BEARER
+        }
+    };
+
+    final hsfeedback:Client baseClient = check new (config);
+    ```
+
+### Step 3: Invoke the connector operation
+
+Now, utilize the available connector operations. A sample usecase is shown below.
+
+#### View Submitted Feedbacks
+
+```ballerina
+public function main() returns error? {
+   hsfeedback:CollectionResponseSimplePublicObjectWithAssociationsForwardPaging getPageOfFeedbackSubmissions = check baseClient->/feedback_submissions('limit = 10);
+   io:println("Feedback submissions: ", getPageOfFeedbackSubmissions);
+}
+```
 
 ## Examples
 
-The `HubSpot CRM Feedback` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/module-ballerinax-hubspot.crm.object.feedback/tree/main/examples/), covering the following use cases:
+The `HubSpot CRM Feedback` connector provides practical examples illustrating usage in various scenarios.
 
-[//]: # (TODO: Add examples)
+[Feedback Reviewing](https://github.com/module-ballerinax-hubspot.crm.object.feedback/tree/main/examples/) - This example demonstrates the usage of the HubSpot CRM Feedback connector to read a page of feedback submissions, read an object identified by `{feedbackSubmissionId}`, read a batch of feedback submissions by internal ID, or unique property values, and search feedback submissions.
+
+> **Note**: The feedback submissions endpoints are currently read only. Feedback submissions cannot be submitted or edited through the API. You can only create properties in the [feedback surveys tool within HubSpot](https://knowledge.hubspot.com/customer-feedback/create-a-custom-survey), and the properties cannot be edited after creation.
 
 ## Build from the source
 
 ### Setting up the prerequisites
 
 1. Download and install Java SE Development Kit (JDK) version 21. You can download it from either of the following sources:
 
-    * [Oracle JDK](https://www.oracle.com/java/technologies/downloads/)
-    * [OpenJDK](https://adoptium.net/)
+   * [Oracle JDK](https://www.oracle.com/java/technologies/downloads/)
+   * [OpenJDK](https://adoptium.net/)
 
    > **Note:** After installation, remember to set the `JAVA_HOME` environment variable to the directory where JDK was installed.
-
+   >
 2. Download and install [Ballerina Swan Lake](https://ballerina.io/).
-
 3. Download and install [Docker](https://www.docker.com/get-started).
 
    > **Note**: Ensure that the Docker daemon is running before executing any tests.
-
+   >
 4. Export Github Personal access token with read package permissions as follows,
 
-    ```bash
-    export packageUser=<Username>
-    export packagePAT=<Personal access token>
-    ```
+   ```bash
+   export packageUser=<Username>
+   export packagePAT=<Personal access token>
+   ```
 
 ### Build options
 
@@ -57,43 +219,36 @@ Execute the commands below to build from the source.
    ```bash
    ./gradlew clean build
    ```
-
 2. To run the tests:
 
    ```bash
    ./gradlew clean test
    ```
-
 3. To build the without the tests:
 
    ```bash
    ./gradlew clean build -x test
    ```
-
 4. To run tests against different environments:
 
    ```bash
    ./gradlew clean test -Pgroups=<Comma separated groups/test cases>
    ```
-
 5. To debug the package with a remote debugger:
 
    ```bash
    ./gradlew clean build -Pdebug=<port>
    ```
-
 6. To debug with the Ballerina language:
 
    ```bash
    ./gradlew clean build -PbalJavaDebug=<port>
    ```
-
 7. Publish the generated artifacts to the local Ballerina Central repository:
 
-    ```bash
-    ./gradlew clean build -PpublishToLocalCentral=true
-    ```
-
+   ```bash
+   ./gradlew clean build -PpublishToLocalCentral=true
+   ```
 8. Publish the generated artifacts to the Ballerina Central repository:
 
    ```bash
@@ -112,7 +267,7 @@ All the contributors are encouraged to read the [Ballerina Code of Conduct](http
 
 ## Useful links
 
-* For more information go to the [`hubspot.crm.object.feedback` package](https://central.ballerina.io/ballerinax/hubspot.crm.object.feedback/latest).
+* For more information go to the [`hubspot.crm.obj.feedback` package](https://central.ballerina.io/ballerinax/hubspot.crm.object.feedback/latest).
 * For example demonstrations of the usage, go to [Ballerina By Examples](https://ballerina.io/learn/by-example/).
 * Chat live with us via our [Discord server](https://discord.gg/ballerinalang).
-* Post all technical questions on Stack Overflow with the [#ballerina](https://stackoverflow.com/questions/tagged/ballerina) tag.
+* Post all technical questions on Stack Overflow with the [#ballerina](https://stackoverflow.com/questions/tagged/ballerina) tag.
diff --git a/ballerina/Ballerina.toml b/ballerina/Ballerina.toml
@@ -1,16 +1,16 @@
 [package]
 distribution = "2201.10.0"
 org = "ballerinax"
-name = "hubspot.crm.object.feedback"
-version = "1.0.0"
+name = "hubspot.crm.obj.feedback"
+version = "0.1.0"
 license = ["Apache-2.0"]
 authors = ["Ballerina"]
-keywords = []
-# icon = "icon.png" # TODO: update icon.png
+keywords = ["hubspot", "crm", "feedback"]
+icon = "icon.png" 
 repository = "https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.object.feedback"
 
 [build-options]
 observabilityIncluded = true
 
-[platform.java21]
+[platform.java17]
 graalvmCompatible = true
Original file line number	Diff line number	Diff line change
Expand Up		@@ -56,3 +56,5 @@ build

		# Ignore Docker env file
		docker.env

		openapi-spec