gitlab-cloud-connector 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 770d5e1b4415c2544e4fb0be3d99fa19b05ab8f7969fc0f6c2c1fc5ea6fb0fb9
-  data.tar.gz: 04e860d904164310a5cabce27bea3896f0d93e6bd66a24fae7e56610f5eaef0e
+  metadata.gz: 631ee0be48c3afe5732dcdd2cbf8f1f2bfb081ac40783a3790981072c80ab57d
+  data.tar.gz: b22b16aaf5e29d67081cd4ee03e83f572daeed2db9ab15962c0e82ed192676ab
 SHA512:
-  metadata.gz: 1a355ece375da0c859f01cddea2adbd9e1a94800b314e1fc649358c607b1f1b109aa38552c36afd341d02e6aff10f1fb86cf48242fecb068edf47119d59d5f62
-  data.tar.gz: 4b2e636501b08c3a2ba6d4dee1eb9599d73e9da252035ada0c7c5ae4aa6b7aa843c2119d5f7db2afdfb908ee3fab8b96648784ec0e28bd3a5c569699fb96f895
+  metadata.gz: c4cb3e67ea39fb9b7db24a5fe6b9375d8e1b8278c27bd91b929d11dd8bec180adbfb7a182d9f175a744ac3e7f2e490bd05bc888b7770d01b4b30dfe7f2aa3aff
+  data.tar.gz: 01ce43956fe3a3fc248757294520cf220dbc00b25b7d5f3774fc5320f467874f0f1ac1f43bbe91efcf07d1d9c80df7dbbfe21ce1ca429f3c5719a045396ebdd8

data/CONTRIBUTING.md

@@ -1,8 +1,8 @@
-## Making changes to this repository
+# Making changes to this repository
 
 We welcome contributions. When making changes:
 
-1. Follow good git commit practices. Summarize the change concisely in the commit title,
+1. Follow good Git commit practices. Summarize the change concisely in the commit title,
    and add relevant details in the commit body.
 1. Add a [changelog trailer](https://docs.gitlab.com/ee/user/project/changelogs.html) where it applies.
 1. Open a merge request.
@@ -44,7 +44,6 @@ This code of conduct applies both within project spaces and in public spaces
 when an individual is representing the project or its community.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior can be
-reported by emailing contact@gitlab.com.
+reported by emailing <contact@gitlab.com>.
 
-This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org), version 1.1.0,
-available at [https://contributor-covenant.org/version/1/1/0/](https://contributor-covenant.org/version/1/1/0/).
+This Code of Conduct is adapted from the [Contributor Covenant, version 1.1.0](https://contributor-covenant.org/version/1/1/0/).

data/README.md

@@ -10,6 +10,54 @@ We expect Bundler is used to manage dependencies. To add the dependency, add it
 gem "gitlab-cloud-connector", "~> 0.1.1", require: 'cloud_connector'
 ```
 
+## Usage
+
+### Data Storage
+
+Cloud Connector uses YAML files stored in the project's `/config` directory. The data is organized by model type:
+
+```yaml
+# config/backend_services/ai_gateway.yml
+name: ai_gateway
+description: "AI Gateway"
+jwt_aud: gitlab-ai-gateway
+
+# config/add_ons/duo_pro.yml
+name: duo_pro
+description: "Duo Pro"
+
+# config/unit_primitives/duo_chat.yml
+name: duo_chat
+description: "Duo Chat"
+backend_services:
+  - ai_gateway
+add_ons:
+  - duo_pro
+  - duo_enterprise
+```
+
+### Working with DataModels
+
+`DataModels` are the core data structures in the Cloud Connector. Each model inherits from `DataModel::Base`. The data is loaded from YAML files into memory at runtime, making it efficient for read operations and relationship traversal.
+
+```ruby
+require 'cloud_connector'
+
+# Find unit primitive by name
+# Note:  value should be a symbol (e.g., `:duo_chat` instead of `'duo_chat'`).
+duo_chat = Gitlab::CloudConnector::DataModels::UnitPrimitive.find_by_name(:duo_chat)
+duo_chat.description
+duo_chat.cut_off_date
+
+# access associations
+duo_chat.add_ons
+duo_chat.license_types
+duo_chat.backend_services
+
+# read duo_chat audiences
+duo_chat.backend_services.map(&:jwt_aud)
+```
+
 ## Release Process
 
 See [Release Process](../../README.md#release-process)
@@ -18,4 +66,3 @@ Once the new gem version is visible on [RubyGems.org](https://rubygems.org/gems/
 it is recommended to update [GitLab's `Gemfile`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/Gemfile)
 and [Customers Dot's `Gemfile`](https://gitlab.com/gitlab-org/customers-gitlab-com/-/blob/main/Gemfile) to bump the `gitlab-cloud-connector`
 Ruby gem to the new version also. See [Usage](#usage) for how to do this.
-

data/config/backend_services/ai_gateway_agent.yml

@@ -0,0 +1,5 @@
+---
+name: ai_gateway_agent
+project_url: unknown
+group: group::ai framework
+jwt_aud: gitlab-ai-gateway-agent

data/config/schemas/service_schema.json

@@ -0,0 +1,38 @@
+{
+  "$schema": "http://json-schema.org/draft-06/schema#",
+  "type": "object",
+  "description": "This is the legacy format for the service object that is being deprecated. Consider transitioning to the new format.",
+  "required": ["name"],
+  "properties": {
+    "name": {
+      "type": "string",
+      "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$",
+      "description": "The unique name of the service, consisting of lowercase alphanumeric characters and underscores."
+    },
+    "basic_unit_primitive": {
+      "type": "string",
+      "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$",
+      "description": "The basic unit primitive identifier."
+    },
+    "gitlab_realm": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": ["gitlab-com", "self-managed"]
+      },
+      "description": "An array of unit primitives associated with the service."
+    },
+    "description": {
+      "type": "string",
+      "description": "A brief description of the service."
+    },
+    "unit_primitives": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "An array of unit primitives associated with the service."
+    }
+  },
+  "additionalProperties": false
+}

data/config/schemas/unit_primitive_schema.json

@@ -1,96 +1,86 @@
 {
   "$schema": "http://json-schema.org/draft-06/schema#",
   "type": "object",
-  "required": ["name", "description", "group", "feature_category", "backend_services", "license_types"],
+  "required": [
+    "name",
+    "description",
+    "group",
+    "feature_category",
+    "backend_services"
+  ],
   "properties": {
-    "name": {
-      "description": "Name of the unit primitive",
-      "type": "string",
-      "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$"
+    "add_ons": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "backend_services": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "cut_off_date": {
+      "description": "After this date, unit primitive has no free access",
+      "type": "time", "format": "date-time"
+    },
+    "deprecated_by_url": {
+      "description": "URL of merge request where the unit primitive was deprecated",
+      "type": "string"
+    },
+    "deprecation_message": {
+      "description": "Message explaining why the unit primitive is deprecated and any additional context",
+      "type": "string"
     },
     "description": {
       "description": "Description of the unit primitive",
-      "type": ["string", "null"]
+      "type": "string"
     },
-    "group": {
-      "description": "The group that introduced the unit primitive",
-      "type": ["string", "null"]
+    "documentation_url": {
+      "description": "URL of documentation for introduced Unit Primitive",
+      "type": "string"
     },
     "feature_category": {
       "description": "The feature category that introduced the unit primitive",
-      "type": ["string", "null"]
+      "type": "string"
     },
-    "unit_primitive_issue_url": {
-      "description": "Url of original unit primitive issue",
-      "type": ["string", "null"]
+    "group": {
+      "description": "The group that introduced the unit primitive, e.g. \"group::cloud connector\"",
+      "type": "string"
     },
     "introduced_by_url": {
       "description": "URL of merge request introducing the Unit Primitive",
-      "type": ["string", "null"]
+      "type": "string"
     },
-    "documentation_url": {
-      "description": "URL of documentation for introduced Unit Primitive",
-      "type": ["string", "null"]
+    "license_types": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
     },
     "milestone": {
       "description": "Milestone in which the Unit Primitive was introduced",
-      "type": ["string", "null"]
-    },
-    "cut_off_date": {
-      "description": "After this date, unit primitive has no free access",
-      "anyOf": [
-        {
-          "type": "null"
-        },
-        {
-          "type": "time",
-          "format": "date-time"
-        }
-      ]
+      "type": "string"
     },
     "min_gitlab_version": {
       "description": "Minimum gitlab version required to use this Unit Primitive",
-      "type": ["string", "null"],
+      "type": "string",
       "pattern": "\\A(\\d+\\.\\d+)"
     },
     "min_gitlab_version_for_free_access": {
       "description": "Minimum gitlab version required to use this Unit Primitive while it has free access",
-      "type": ["string", "null"],
+      "type": "string",
       "pattern": "\\A(\\d+\\.\\d+)"
     },
-    "backend_services": {
-      "type": "array",
-      "items": {
-        "type": "string"
-      }
-    },
-    "add_ons": {
-      "anyOf": [
-        {
-          "type": "array",
-          "items": {
-            "type": "string"
-          }
-        },
-        {
-          "type": "null"
-        }
-      ]
-    },
-    "license_types": {
-      "type": "array",
-      "items": {
-        "type": "string"
-      }
-    },
-    "deprecated": {
-      "description": "Indicates if the unit primitive is deprecated",
-      "type": "boolean",
-      "default": false
+    "name": {
+      "description": "Name of the unit primitive",
+      "type": "string",
+      "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$"
     },
-    "deprecation_message": {
-      "description": "Message explaining why the unit primitive is deprecated and any additional context",
-      "type": ["string", "null"]
+    "unit_primitive_issue_url": {
+      "description": "Url of original unit primitive issue",
+      "type": "string"
     }
   },
   "additionalProperties": false

data/config/services/agent_quick_actions.yml

@@ -0,0 +1,6 @@
+---
+name: agent_quick_actions
+gitlab_realm:
+  - self-managed
+unit_primitives:
+  - agent_quick_actions

data/config/services/anthropic_proxy.yml

@@ -0,0 +1,11 @@
+---
+name: anthropic_proxy
+unit_primitives:
+  - categorize_duo_chat_question
+  - generate_commit_message
+  - generate_issue_description
+  - glab_ask_git_command
+  - resolve_vulnerability
+  - review_merge_request
+  - summarize_issue_discussions
+  - summarize_review

data/config/services/code_suggestions.yml

@@ -0,0 +1,5 @@
+---
+name: code_suggestions
+unit_primitives:
+  - complete_code
+  - generate_code

data/config/services/duo_chat.yml

@@ -0,0 +1,21 @@
+---
+name: duo_chat
+basic_unit_primitive: duo_chat
+unit_primitives:
+  - ask_build
+  - ask_commit
+  - ask_epic
+  - ask_issue
+  - ask_merge_request
+  - documentation_search
+  - duo_chat
+  - explain_code
+  - fix_code
+  - include_dependency_context
+  - include_file_context
+  - include_issue_context
+  - include_local_git_context
+  - include_merge_request_context
+  - include_snippet_context
+  - refactor_code
+  - write_tests

data/config/services/duo_workflow.yml

@@ -0,0 +1,4 @@
+---
+name: duo_workflow
+unit_primitives:
+  - duo_workflow_execute_workflow

data/config/services/generate_description.yml

@@ -0,0 +1,4 @@
+---
+name: generate_description
+unit_primitives:
+  - generate_issue_description

data/config/services/sast.yml

@@ -0,0 +1,6 @@
+---
+name: sast
+gitlab_realm:
+  - gitlab-com
+unit_primitives:
+  - security_scans

data/config/services/self_hosted_models.yml

@@ -0,0 +1,24 @@
+---
+name: self_hosted_models
+gitlab_realm:
+  - gitlab-com
+unit_primitives:
+  - ask_build
+  - ask_commit
+  - ask_epic
+  - ask_issue
+  - ask_merge_request
+  - complete_code
+  - generate_code
+  - documentation_search
+  - duo_chat
+  - explain_code
+  - fix_code
+  - include_dependency_context
+  - include_file_context
+  - include_issue_context
+  - include_local_git_context
+  - include_merge_request_context
+  - include_snippet_context
+  - refactor_code
+  - write_tests

data/config/services/summarize_new_merge_request.yml

@@ -0,0 +1,4 @@
+---
+name: summarize_new_merge_request
+unit_primitives:
+  - summarize_merge_request

data/config/services/vertex_ai_proxy.yml

@@ -0,0 +1,9 @@
+---
+name: vertex_ai_proxy
+unit_primitives:
+  - generate_commit_message
+  - generate_cube_query
+  - glab_ask_git_command
+  - semantic_search_issue
+  - summarize_issue_discussions
+  - summarize_merge_request

data/config/unit_primitives/agent_quick_actions.yml

@@ -0,0 +1,9 @@
+---
+name: agent_quick_actions
+description: 'Quick actions for agent.'
+group: group::duo_chat
+feature_category: duo_chat
+backend_services:
+  - ai_gateway_agent
+license_types:
+  - ultimate

data/config/unit_primitives/ask_build.yml

@@ -2,14 +2,10 @@
 name: ask_build
 description: Ask questions about GitLab builds.
 cut_off_date: 2024-10-17T00:00:00+00:00
-unit_primitive_issue_url:
-introduced_by_url:
-documentation_url:
 group: group::duo_chat
 feature_category: duo_chat
+documentation_url: https://docs.gitlab.com/ee/user/gitlab_duo_chat/examples.html#ask-about-cicd
 backend_services:
   - ai_gateway
 add_ons:
   - duo_enterprise
-license_types:
-  - ultimate

data/config/unit_primitives/ask_commit.yml

@@ -2,14 +2,10 @@
 name: ask_commit
 description: Ask questions about GitLab commits.
 cut_off_date: 2024-10-17T00:00:00+00:00
-unit_primitive_issue_url:
-introduced_by_url:
-documentation_url:
 group: group::duo_chat
 feature_category: duo_chat
+documentation_url: https://docs.gitlab.com/ee/user/gitlab_duo_chat/examples.html#ask-about-a-specific-commit
 backend_services:
   - ai_gateway
 add_ons:
   - duo_enterprise
-license_types:
-  - ultimate

data/config/unit_primitives/ask_epic.yml

@@ -2,14 +2,11 @@
 name: ask_epic
 description: Ask questions about GitLab epics.
 cut_off_date: 2024-10-17T00:00:00+00:00
-unit_primitive_issue_url:
-introduced_by_url:
-documentation_url:
 group: group::duo_chat
 feature_category: duo_chat
+documentation_url: https://docs.gitlab.com/ee/user/gitlab_duo_chat/examples.html#ask-about-a-specific-epic
+introduced_by_url: https://gitlab.com/gitlab-org/customers-gitlab-com/-/merge_requests/10890/diffs
 backend_services:
   - ai_gateway
 add_ons:
   - duo_enterprise
-license_types:
-  - ultimate

data/config/unit_primitives/ask_issue.yml

@@ -2,14 +2,11 @@
 name: ask_issue
 description: Ask questions about GitLab issues.
 cut_off_date: 2024-10-17T00:00:00+00:00
-unit_primitive_issue_url:
-introduced_by_url:
-documentation_url:
 group: group::duo_chat
 feature_category: duo_chat
+documentation_url: https://docs.gitlab.com/ee/user/gitlab_duo_chat/examples.html#ask-about-a-specific-issue
+introduced_by_url: https://gitlab.com/gitlab-org/customers-gitlab-com/-/merge_requests/10890/diffs
 backend_services:
   - ai_gateway
 add_ons:
   - duo_enterprise
-license_types:
-  - ultimate

data/config/unit_primitives/ask_merge_request.yml

@@ -0,0 +1,13 @@
+---
+name: ask_merge_request
+description: Ask questions about GitLab merge reuest.
+cut_off_date: 2024-10-17T00:00:00+00:00
+group: group::duo_chat
+feature_category: duo_chat
+introduced_by_url: https://gitlab.com/gitlab-org/customers-gitlab-com/-/merge_requests/10899
+documentation_url: https://docs.gitlab.com/ee/user/gitlab_duo_chat/examples.html#ask-about-a-specific-merge-request
+unit_primitive_issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/485499
+backend_services:
+  - ai_gateway
+add_ons:
+  - duo_enterprise

data/config/unit_primitives/categorize_duo_chat_question.yml

@@ -0,0 +1,10 @@
+---
+name: categorize_duo_chat_question
+description: This should not be an unit primitive
+cut_off_date: 2024-10-17T00:00:00+00:00
+group: group::project management
+feature_category: team_planning
+backend_services:
+  - ai_gateway
+add_ons:
+  - duo_enterprise

data/config/unit_primitives/code_suggestions.yml

@@ -2,18 +2,14 @@
 name: code_suggestions
 description: Helps you write code more efficiently by generating code and showing suggestions as you type.
 cut_off_date: 2024-02-15T00:00:00+00:00
-min_gitlab_version_for_free_access:
 min_gitlab_version: '16.8'
-unit_primitive_issue_url:
-introduced_by_url:
-documentation_url:
 group: group::code suggestions
 feature_category: code_suggestions
+documentation_url: https://docs.gitlab.com/ee/user/gitlab_duo/#code-suggestions
+deprecated_by_url: https://gitlab.com/gitlab-org/cloud-connector/gitlab-cloud-connector/-/merge_requests/47
+deprecation_message: This unit primitive is deprecated, please use code_create or code_generate unit primitives.
 backend_services:
   - ai_gateway
 add_ons:
   - duo_pro
   - duo_enterprise
-license_types:
-  - premium
-  - ultimate

data/config/unit_primitives/complete_code.yml

@@ -2,7 +2,6 @@
 name: complete_code
 description: Helps you write code more efficiently by showing code suggestions as you type.
 cut_off_date: 2024-02-15T00:00:00+00:00
-min_gitlab_version_for_free_access:
 min_gitlab_version: "16.8"
 unit_primitive_issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/497813
 introduced_by_url: https://gitlab.com/gitlab-org/cloud-connector/gitlab-cloud-connector/-/merge_requests/46
@@ -14,6 +13,3 @@ backend_services:
 add_ons:
   - duo_pro
   - duo_enterprise
-license_types:
-  - premium
-  - ultimate

data/config/unit_primitives/documentation_search.yml

@@ -2,11 +2,6 @@
 name: documentation_search
 description: Perform semantic search on gitlab documentations for a given query.
 cut_off_date: 2024-10-17T00:00:00+00:00
-min_gitlab_version_for_free_access: '16.8'
-min_gitlab_version: '16.9'
-unit_primitive_issue_url:
-introduced_by_url:
-documentation_url:
 group: group::duo_chat
 feature_category: duo_chat
 backend_services:
@@ -14,6 +9,3 @@ backend_services:
 add_ons:
   - duo_pro
   - duo_enterprise
-license_types:
-  - premium
-  - ultimate

data/config/unit_primitives/duo_chat.yml

@@ -4,16 +4,11 @@ description: Ask various GitLab-related questions and tasks.
 cut_off_date: 2024-10-17T00:00:00+00:00
 min_gitlab_version_for_free_access: '16.8'
 min_gitlab_version: '16.9'
-unit_primitive_issue_url:
-introduced_by_url:
-documentation_url:
 group: group::duo_chat
 feature_category: duo_chat
+documentation_url: https://docs.gitlab.com/ee/user/gitlab_duo/#gitlab-duo-chat
 backend_services:
   - ai_gateway
 add_ons:
   - duo_pro
   - duo_enterprise
-license_types:
-  - premium
-  - ultimate

data/config/unit_primitives/duo_workflow_execute_workflow.yml

@@ -1,13 +1,10 @@
 ---
 name: duo_workflow_execute_workflow
 description: Automate tasks and help increase productivity in your development workflow by using GitLab Duo Workflow.
-cut_off_date:
-unit_primitive_issue_url:
-introduced_by_url:
-documentation_url:
 group: group::duo workflow
 feature_category: duo_workflow
+documentation_url: https://docs.gitlab.com/ee/user/gitlab_duo/#gitlab-duo-workflow
+introduced_by_url: https://gitlab.com/gitlab-org/customers-gitlab-com/-/merge_requests/10734
+unit_primitive_issue_url: https://gitlab.com/gitlab-org/duo-workflow/duo-workflow-service/-/issues/17
 backend_services:
   - duo_workflow_service
-license_types:
-  - ultimate

data/config/unit_primitives/explain_code.yml

@@ -2,16 +2,11 @@
 name: explain_code
 description: Explain function or method of the selected code.
 cut_off_date: 2024-10-17T00:00:00+00:00
-unit_primitive_issue_url:
-introduced_by_url:
-documentation_url:
 group: group::source code
 feature_category: source_code_management
+documentation_url: https://docs.gitlab.com/ee/user/gitlab_duo/#code-explanation
 backend_services:
   - ai_gateway
 add_ons:
-  - duo_enterprise
   - duo_pro
-license_types:
-  - premium
-  - ultimate
+  - duo_enterprise

data/config/unit_primitives/explain_vulnerability.yml

@@ -2,16 +2,12 @@
 name: explain_vulnerability
 description: Explain a security vulnerability of the given CVE or code.
 cut_off_date: 2024-10-17T00:00:00+00:00
-min_gitlab_version_for_free_access: '17.2'
-min_gitlab_version: '17.2'
-unit_primitive_issue_url:
-introduced_by_url:
-documentation_url:
 group: group::threat insights
 feature_category: vulnerability_management
+documentation_url: https://docs.gitlab.com/ee/user/gitlab_duo/#vulnerability-explanation
+introduced_by_url: https://gitlab.com/gitlab-org/customers-gitlab-com/-/merge_requests/10344
+unit_primitive_issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/470958
 backend_services:
   - ai_gateway
 add_ons:
   - duo_enterprise
-license_types:
-  - ultimate

data/config/unit_primitives/fix_code.yml

@@ -2,16 +2,11 @@
 name: fix_code
 description: Fix the selected code.
 cut_off_date: 2024-10-17T00:00:00+00:00
-unit_primitive_issue_url:
-introduced_by_url:
-documentation_url:
 group: group::duo_chat
 feature_category: duo_chat
+documentation_url: https://docs.gitlab.com/ee/user/gitlab_duo/#fix-code
 backend_services:
   - ai_gateway
 add_ons:
   - duo_enterprise
   - duo_pro
-license_types:
-  - premium
-  - ultimate