datadog_api_client 2.42.0 → 2.44.0

data/.generator/src/generator/formatter.py

@@ -275,6 +275,16 @@ def format_data_with_schema_list(
     return f"[\n{parameters}]"
 
 
+def _is_valid_ruby_symbol(key):
+    """Check if a key can be used as a Ruby symbol without quotes."""
+    if not key:
+        return False
+    # Ruby symbols can start with letter or underscore, contain alphanumeric and underscores
+    if not (key[0].isalpha() or key[0] == '_'):
+        return False
+    return all(c.isalnum() or c == '_' for c in key)
+
+
 @format_data_with_schema.register(dict)
 def format_data_with_schema_dict(
     data,
@@ -318,7 +328,11 @@ def format_data_with_schema_dict(
                 name_prefix=name_prefix,
                 replace_values=replace_values,
             )
-            parameters += f"{k}: {value}, "
+            # Use hash rocket syntax for keys with special characters
+            if _is_valid_ruby_symbol(k):
+                parameters += f"{k}: {value}, "
+            else:
+                parameters += f'"{k}" => {value}, '
         if not has_properties:
             name = None
 

data/.generator/src/generator/templates/api.j2

@@ -36,11 +36,11 @@ module {{ module_name }}::{{ version|upper }}
     #
     {%- endif %}
     {%- for name, parameter in operation|parameters if parameter.required %}
-    # @param {{ name|attribute_name }} [{{ get_type_for_parameter(parameter) }}] {{ parameter.get("description", "").replace('\n', ' ') }}
+    # @param {{ name|attribute_name }} [{{ get_type_for_parameter(parameter) }}] {{ (parameter.get("description") or "").replace('\n', ' ') }}
     {%- endfor %}
     # @param opts [Hash] the optional parameters
     {%- for name, parameter in operation|parameters if not parameter.required %}
-    # @option opts [{{ get_type_for_parameter(parameter) }}] :{{ name|attribute_name }} {{ parameter.get("description", "").replace('\n', ' ') }}{% if "default" in parameter%} (default to {{ parameter.default|json }}) {% endif %}
+    # @option opts [{{ get_type_for_parameter(parameter) }}] :{{ name|attribute_name }} {{ (parameter.get("description") or "").replace('\n', ' ') }}{% if "default" in parameter%} (default to {{ parameter.default|json }}) {% endif %}
     {%- endfor %}
     # @return [Array<({% if returnType %}{{ returnType }}{% else %}nil{% endif %}, Integer, Hash)>] {% if returnType %}{{ returnType }} data{% else %}nil{% endif %}, response status code and response headers
     def {{ operation.operationId|snake_case }}_with_http_info({% for name, parameter in operation|parameters if parameter.required %}{{ name|attribute_name }}, {% endfor %}opts = {})

data/.generator/src/generator/templates/model.j2

@@ -6,7 +6,7 @@ require 'date'
 require 'time'
 
 module {{ module_name }}::{{ version|upper }}
-  # {{ model.description.rstrip()|replace('\n', '\n# ')|indent(2) }}
+  # {{ (model.description or "").rstrip()|replace('\n', '\n# ')|indent(2) }}
 {%- if model.deprecated %}
   #
   # @deprecated This model is deprecated.

data/.generator/src/generator/templates/model_generic.j2

@@ -16,7 +16,7 @@
      or
       definition.enum is defined #}
 
-    {{ definition.description|block_comment|indent(4) }}
+    {{ (definition.description or "")|block_comment|indent(4) }}
     {%- if has_validation %}
     attr_reader :{{ attr|attribute_name }}
     {%- else %}

data/.generator/tests/test_formatter.rb

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+
+def assert(condition, message = "Assertion failed")
+  raise message unless condition
+  print "."
+end
+
+def assert_equal(expected, actual, message = nil)
+  msg = message || "Expected #{expected.inspect}, got #{actual.inspect}"
+  raise msg unless expected == actual
+  print "."
+end
+
+def assert_includes(collection, item, message = nil)
+  msg = message || "Expected #{collection.inspect} to include #{item.inspect}"
+  raise msg unless collection.include?(item)
+  print "."
+end
+
+test_cases = [
+  ['valid_key', true],
+  ['_valid_key', true],
+  ['ValidKey123', true],
+  ['key123', true],
+  ['key.with.dots', false],
+  ['123invalid', false],
+  ['.starts_with_dot', false],
+  ['', false],
+  ['key-with-dash', false],
+  ['key with space', false],
+  ['key@special', false]
+]
+
+test_cases.each do |key, expected|
+  begin
+    eval("{#{key}: 'value'}")
+    assert(expected, "Expected '#{key}' to fail but it succeeded")
+  rescue SyntaxError
+    assert(!expected, "Expected '#{key}' to succeed but it failed")
+  end
+end
+
+hash = {
+  "ocsf.activity_name" => 'Other',
+  "ocsf.activity_id" => '99'
+}
+
+assert(hash.is_a?(Hash))
+assert_equal('Other', hash["ocsf.activity_name"])
+assert_equal('99', hash["ocsf.activity_id"])
+assert_includes(hash.inspect, '"ocsf.activity_name"=>"Other"')
+assert_includes(hash.inspect, '"ocsf.activity_id"=>"99"')
+
+hash = {
+  "ocsf.activity_name" => ['eventName']
+}
+
+assert(hash.is_a?(Hash))
+assert_equal(['eventName'], hash["ocsf.activity_name"])
+assert_includes(hash.inspect, '"ocsf.activity_name"=>["eventName"]')
+
+hash = {
+  normal_key: 'value1',
+  another_key: 'value2'
+}
+
+assert(hash.is_a?(Hash))
+assert_equal('value1', hash[:normal_key])
+assert_equal('value2', hash[:another_key])

data/.github/CODEOWNERS

@@ -6,7 +6,7 @@
 *                       @DataDog/web-frameworks-approvers @DataDog/web-frameworks
 
 # Documentation
-*.md                    @DataDog/documentation @DataDog/web-frameworks-approvers @DataDog/web-frameworks
-LICENSE                 @DataDog/documentation @DataDog/web-frameworks-approvers @DataDog/web-frameworks
-NOTICE                  @DataDog/documentation @DataDog/web-frameworks-approvers @DataDog/web-frameworks
-LICENSE-3rdparty.csv    @DataDog/documentation @DataDog/web-frameworks-approvers @DataDog/web-frameworks
+*.md                    @DataDog/web-frameworks-approvers @DataDog/web-frameworks
+LICENSE                 @DataDog/web-frameworks-approvers @DataDog/web-frameworks
+NOTICE                  @DataDog/web-frameworks-approvers @DataDog/web-frameworks
+LICENSE-3rdparty.csv    @DataDog/web-frameworks-approvers @DataDog/web-frameworks

data/.github/workflows/reusable-ci.yml

@@ -0,0 +1,71 @@
+name: Reusable Complete CI Workflow
+
+on:
+  workflow_call:
+    inputs:
+      target-branch:
+        description: 'Branch to checkout and test (defaults to the calling branch)'
+        required: false
+        type: string
+        default: ''
+      cache-version:
+        description: 'Cache version for gem dependencies'
+        required: false
+        type: string
+        default: ''
+
+    secrets:
+      PIPELINE_GITHUB_APP_ID:
+        required: false
+      PIPELINE_GITHUB_APP_PRIVATE_KEY:
+        required: false
+      # Integration test secrets
+      DD_API_KEY:
+        required: false
+      DD_CLIENT_API_KEY:
+        required: false
+      DD_CLIENT_APP_KEY:
+        required: false
+      SLEEP_AFTER_REQUEST:
+        required: false
+
+jobs:
+  pre-commit:
+    uses: ./.github/workflows/reusable-pre-commit.yml
+    with:
+      target-branch: ${{ inputs.target-branch }}
+      enable-commit-changes: false  # Don't auto-commit in external CI
+    secrets:
+      PIPELINE_GITHUB_APP_ID: ${{ secrets.PIPELINE_GITHUB_APP_ID }}
+      PIPELINE_GITHUB_APP_PRIVATE_KEY: ${{ secrets.PIPELINE_GITHUB_APP_PRIVATE_KEY }}
+
+  test:
+    uses: ./.github/workflows/reusable-ruby-test.yml
+    with:
+      target-branch: ${{ inputs.target-branch }}
+      cache-version: ${{ inputs.cache-version }}
+    secrets:
+      PIPELINE_GITHUB_APP_ID: ${{ secrets.PIPELINE_GITHUB_APP_ID }}
+      PIPELINE_GITHUB_APP_PRIVATE_KEY: ${{ secrets.PIPELINE_GITHUB_APP_PRIVATE_KEY }}
+      DD_API_KEY: ${{ secrets.DD_API_KEY }}
+
+  examples:
+    uses: ./.github/workflows/reusable-examples.yml
+    with:
+      target-branch: ${{ inputs.target-branch }}
+      cache-version: ${{ inputs.cache-version }}
+
+  integration:
+    uses: ./.github/workflows/reusable-integration-test.yml
+    with:
+      target-branch: ${{ inputs.target-branch }}
+      cache-version: ${{ inputs.cache-version }}
+      has-integration-label: ${{ contains(github.event.pull_request.labels.*.name, 'ci/integrations') }}
+    secrets:
+      PIPELINE_GITHUB_APP_ID: ${{ secrets.PIPELINE_GITHUB_APP_ID }}
+      PIPELINE_GITHUB_APP_PRIVATE_KEY: ${{ secrets.PIPELINE_GITHUB_APP_PRIVATE_KEY }}
+      DD_API_KEY: ${{ secrets.DD_API_KEY }}
+      DD_CLIENT_API_KEY: ${{ secrets.DD_CLIENT_API_KEY }}
+      DD_CLIENT_APP_KEY: ${{ secrets.DD_CLIENT_APP_KEY }}
+      SLEEP_AFTER_REQUEST: ${{ secrets.SLEEP_AFTER_REQUEST }}
+

data/.github/workflows/reusable-examples.yml

@@ -0,0 +1,40 @@
+name: Reusable Examples Workflow
+
+on:
+  workflow_call:
+    inputs:
+      target-branch:
+        description: 'Branch to checkout and test (defaults to the calling branch)'
+        required: false
+        type: string
+        default: ''
+      examples-script:
+        description: 'Examples script to execute'
+        required: false
+        type: string
+        default: './check-examples.sh'
+      cache-version:
+        description: 'Cache version for gem dependencies'
+        required: false
+        type: string
+        default: ''
+
+jobs:
+  examples:
+    runs-on: ubuntu-latest
+    env:
+      DD_PROFILING_NO_EXTENSION: true
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          repository: DataDog/datadog-api-client-ruby
+          ref: ${{ inputs.target-branch || github.ref }}
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "2.7"
+          bundler-cache: true
+          cache-version: ${{ inputs.cache-version }}
+      - name: Check examples
+        run: ${{ inputs.examples-script }}
+        shell: bash

data/.github/workflows/{test_integration.yml → reusable-integration-test.yml}

@@ -1,10 +1,12 @@
-name: Run Integration Tests
+name: Reusable Integration Test Workflow
 
 permissions:
   contents: read
 
 on:
   pull_request:
+    branches:
+      - master
     types:
       - opened
       - reopened
@@ -12,13 +14,56 @@ on:
       - synchronize
       - labeled
       - unlabeled
-    branches:
-      - master
   schedule:
     - cron: "0 2 * * *"
+  workflow_call:
+    inputs:
+      target-branch:
+        description: 'Branch to checkout and test (defaults to the calling branch)'
+        required: false
+        type: string
+        default: ''
+      enable-status-reporting:
+        description: 'Whether to post status checks to datadog-api-spec repo'
+        required: false
+        type: boolean
+        default: false
+      status-context:
+        description: 'Context for status checks'
+        required: false
+        type: string
+        default: 'integration'
+      target-repo:
+        description: 'Repository to post status to'
+        required: false
+        type: string
+        default: 'datadog-api-spec'
+      cache-version:
+        description: 'Cache version for gem dependencies'
+        required: false
+        type: string
+        default: ''
+      has-integration-label:
+        description: 'Whether the calling PR has ci/integrations label'
+        required: false
+        type: boolean
+        default: false
+    secrets:
+      PIPELINE_GITHUB_APP_ID:
+        required: false
+      PIPELINE_GITHUB_APP_PRIVATE_KEY:
+        required: false
+      DD_API_KEY:
+        required: true
+      DD_CLIENT_API_KEY:
+        required: true
+      DD_CLIENT_APP_KEY:
+        required: true
+      SLEEP_AFTER_REQUEST:
+        required: false
 
 concurrency:
-  group: integration-${{ github.head_ref }}
+  group: integration-ruby-${{ inputs.target-branch || github.head_ref }}
   cancel-in-progress: true
 
 jobs:
@@ -30,7 +75,8 @@ jobs:
       !contains(github.event.pull_request.labels.*.name, 'ci/skip') &&
       !contains(github.event.pull_request.head.ref, 'datadog-api-spec/test/') &&
       contains(github.event.pull_request.labels.*.name, 'ci/integrations')) ||
-      github.event_name == 'schedule'
+      github.event_name == 'schedule' ||
+      (github.event_name == 'workflow_call' && inputs.has-integration-label)
     services:
       datadog-agent:
         image: gcr.io/datadoghq/agent:latest
@@ -48,17 +94,20 @@ jobs:
         with:
           app-id: ${{ secrets.PIPELINE_GITHUB_APP_ID }}
           private-key: ${{ secrets.PIPELINE_GITHUB_APP_PRIVATE_KEY }}
-          repositories: datadog-api-spec
+          repositories: ${{ inputs.target-repo || 'datadog-api-spec' }}
       - name: Checkout code
         uses: actions/checkout@v3
+        with:
+          repository: DataDog/datadog-api-client-ruby
+          ref: ${{ inputs.target-branch || github.ref }}
       - name: Post pending status check
-        if: github.event_name == 'pull_request' && contains(github.event.pull_request.head.ref, 'datadog-api-spec/generated/')
+        if: github.event_name == 'pull_request' && contains(github.event.pull_request.head.ref, 'datadog-api-spec/generated/') && (inputs.enable-status-reporting || github.event_name != 'workflow_call')
         uses: DataDog/github-actions/post-status-check@v2
         with:
           github-token: ${{ steps.get_token.outputs.token }}
-          repo: datadog-api-spec
+          repo: ${{ inputs.target-repo || 'datadog-api-spec' }}
           status: pending
-          context: integration
+          context: ${{ inputs.status-context || 'integration' }}
       - name: Install system zstd
         run: |
           sudo apt-get -y install zstd
@@ -68,7 +117,7 @@ jobs:
         with:
           ruby-version: "3.2"
           bundler-cache: true
-          cache-version: ${{ secrets.CACHE_VERSION }}
+          cache-version: ${{ inputs.cache-version }}
       - name: Install deps
         run: bundle install
       - name: Run integration tests
@@ -84,20 +133,20 @@ jobs:
           DD_TEST_CLIENT_APP_KEY: ${{ secrets.DD_CLIENT_APP_KEY }}
           DD_TRACE_ANALYTICS_ENABLED: "true"
           RECORD: "none"
-          SLEEP_AFTER_REQUEST: "${{ vars.SLEEP_AFTER_REQUEST }}"
+          SLEEP_AFTER_REQUEST: ${{ secrets.SLEEP_AFTER_REQUEST || vars.SLEEP_AFTER_REQUEST }}
       - name: Post failure status check
-        if: failure() && github.event_name == 'pull_request' && contains(github.event.pull_request.head.ref, 'datadog-api-spec/generated/')
+        if: failure() && github.event_name == 'pull_request' && contains(github.event.pull_request.head.ref, 'datadog-api-spec/generated/') && (inputs.enable-status-reporting || github.event_name != 'workflow_call')
         uses: DataDog/github-actions/post-status-check@v2
         with:
           github-token: ${{ steps.get_token.outputs.token }}
-          repo: datadog-api-spec
+          repo: ${{ inputs.target-repo || 'datadog-api-spec' }}
           status: failure
-          context: integration
+          context: ${{ inputs.status-context || 'integration' }}
       - name: Post success status check
-        if: "!failure() && github.event_name == 'pull_request' && contains(github.event.pull_request.head.ref, 'datadog-api-spec/generated/')"
+        if: "!failure() && github.event_name == 'pull_request' && contains(github.event.pull_request.head.ref, 'datadog-api-spec/generated/') && (inputs.enable-status-reporting || github.event_name != 'workflow_call')"
         uses: DataDog/github-actions/post-status-check@v2
         with:
           github-token: ${{ steps.get_token.outputs.token }}
-          repo: datadog-api-spec
+          repo: ${{ inputs.target-repo || 'datadog-api-spec' }}
           status: success
-          context: integration
+          context: ${{ inputs.status-context || 'integration' }}

data/.github/workflows/reusable-pre-commit.yml

@@ -0,0 +1,84 @@
+name: Reusable Pre-commit Workflow
+
+on:
+  workflow_call:
+    inputs:
+      target-branch:
+        description: 'Branch to checkout and test (defaults to the calling branch)'
+        required: false
+        type: string
+        default: ''
+      enable-commit-changes:
+        description: 'Whether to commit and push pre-commit fixes'
+        required: false
+        type: boolean
+        default: true
+    secrets:
+      PIPELINE_GITHUB_APP_ID:
+        required: false
+      PIPELINE_GITHUB_APP_PRIVATE_KEY:
+        required: false
+
+env:
+  GIT_AUTHOR_EMAIL: "packages@datadoghq.com"
+  GIT_AUTHOR_NAME: "ci.datadog-api-spec"
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get GitHub App token
+        id: get_token
+        if: inputs.enable-commit-changes
+        uses: actions/create-github-app-token@v1
+        with:
+          app-id: ${{ secrets.PIPELINE_GITHUB_APP_ID }}
+          private-key: ${{ secrets.PIPELINE_GITHUB_APP_PRIVATE_KEY }}
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          repository: DataDog/datadog-api-client-ruby
+          ref: ${{ inputs.target-branch || github.event.pull_request.head.sha || github.ref }}
+          token: ${{ inputs.enable-commit-changes && steps.get_token.outputs.token || github.token }}
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+      - name: Install pre-commit
+        run: python -m pip install pre-commit
+      - name: set PY
+        run: echo "PY=$(python -c 'import platform;print(platform.python_version())')" >> $GITHUB_ENV
+      - uses: actions/cache@v3
+        with:
+          path: ~/.cache/pre-commit
+          key: pre-commit|${{ env.PY }}|${{ hashFiles('.pre-commit-config.yaml') }}
+      - name: Determine pre-commit range
+        id: commit_range
+        run: |
+          FROM_REF=$(git merge-base HEAD origin/master)
+          echo "from_ref=$FROM_REF" >> $GITHUB_OUTPUT
+          echo "to_ref=HEAD" >> $GITHUB_OUTPUT
+          echo "Pre-commit will check from $FROM_REF to HEAD"
+      - id: pre_commit
+        name: Run pre-commit
+        if: github.event.action != 'closed' && github.event.pull_request.merged != true
+        run: |
+          pre-commit run --from-ref "${FROM_REF}" --to-ref "${TO_REF}" --show-diff-on-failure --color=always
+        env:
+          FROM_REF: ${{ steps.commit_range.outputs.from_ref }}
+          TO_REF: ${{ steps.commit_range.outputs.to_ref }}
+      - name: Commit changes
+        if: ${{ failure() && inputs.enable-commit-changes }}
+        run: |-
+          git add -A
+          git config user.name "${GIT_AUTHOR_NAME}"
+          git config user.email "${GIT_AUTHOR_EMAIL}"
+          git commit -m "pre-commit fixes"
+          git push origin "HEAD:${HEAD_REF}"
+          exit 1
+        env:
+          HEAD_REF: ${{ github.event.pull_request.head.ref }}
+      - id: pre_commit_schedule
+        name: Run pre-commit in schedule
+        if: github.event_name == 'schedule'
+        run: |
+          pre-commit run --all-files --show-diff-on-failure --color=always

data/.github/workflows/reusable-ruby-test.yml

@@ -0,0 +1,65 @@
+name: Reusable Ruby Testing Workflow
+
+on:
+  workflow_call:
+    inputs:
+      target-branch:
+        description: 'Branch to checkout and test (defaults to the calling branch)'
+        required: false
+        type: string
+        default: ''
+      ruby-versions:
+        description: 'JSON array of Ruby versions to test against'
+        required: false
+        type: string
+        default: '["2.7", "3.2", "jruby-9.4.12.0"]'
+      platforms:
+        description: 'JSON array of platforms to run tests on'
+        required: false
+        type: string
+        default: '["ubuntu-latest"]'
+      test-script:
+        description: 'Test script to execute'
+        required: false
+        type: string
+        default: './run-tests.sh'
+      cache-version:
+        description: 'Cache version for gem dependencies'
+        required: false
+        type: string
+        default: ''
+    secrets:
+      PIPELINE_GITHUB_APP_ID:
+        required: false
+      PIPELINE_GITHUB_APP_PRIVATE_KEY:
+        required: false
+      DD_API_KEY:
+        required: false
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        ruby-version: ${{ fromJSON(inputs.ruby-versions) }}
+        platform: ${{ fromJSON(inputs.platforms) }}
+    runs-on: ${{ matrix.platform }}
+    env:
+      BUNDLE_WITHOUT: docs
+      DD_PROFILING_NO_EXTENSION: true
+      DD_CIVISIBILITY_AGENTLESS_ENABLED: true
+      DD_ENV: prod
+      DD_API_KEY: ${{ secrets.DD_API_KEY }}
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          repository: DataDog/datadog-api-client-ruby
+          ref: ${{ inputs.target-branch || github.ref }}
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+          cache-version: ${{ inputs.cache-version }}
+      - name: Test
+        run: ${{ inputs.test-script }}
+        shell: bash