apimatic-semgrep-sdk 0.0.1

data/lib/semgrep_web_app/apis/triage_service_api.rb

@@ -0,0 +1,43 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # TriageServiceApi
+  class TriageServiceApi < BaseApi
+    # Bulk triage your findings. You can select the findings to triage by
+    # passing in a list of finding IDs as issue_ids, or by passing in filter
+    # query parameters. You must specify the issue_type of the findings you want
+    # to bulk triage. One of new_triage_state or new_note is required. If
+    # specifying a new_triage_reason, you must also use
+    # new_triage_state=ignored. Some filters only apply for findings associated
+    # with a given product.
+    # @param [String] deployment_slug Required parameter: TODO: type description
+    # here
+    # @param [BulkTriageRequest] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def triage_service_bulk_triage(deployment_slug,
+                                   body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/v1/deployments/{deploymentSlug}/triage',
+                                     Server::SEMGREP)
+                   .template_param(new_parameter(deployment_slug, key: 'deploymentSlug')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('SemgrepWebToken')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(BulkTriageResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/semgrep_web_app/client.rb

@@ -0,0 +1,136 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  #  semgrep_web_app client class.
+  class Client
+    include CoreLibrary
+    attr_reader :config, :auth_managers
+
+    def user_agent_detail
+      config.user_agent_detail
+    end
+
+    # Access to deployments_service controller.
+    # @return [DeploymentsServiceApi] Returns the controller instance.
+    def deployments_service
+      @deployments_service ||= DeploymentsServiceApi.new @global_configuration
+    end
+
+    # Access to findings_service controller.
+    # @return [FindingsServiceApi] Returns the controller instance.
+    def findings_service
+      @findings_service ||= FindingsServiceApi.new @global_configuration
+    end
+
+    # Access to misc_service controller.
+    # @return [MiscServiceApi] Returns the controller instance.
+    def misc_service
+      @misc_service ||= MiscServiceApi.new @global_configuration
+    end
+
+    # Access to policies_service controller.
+    # @return [PoliciesServiceApi] Returns the controller instance.
+    def policies_service
+      @policies_service ||= PoliciesServiceApi.new @global_configuration
+    end
+
+    # Access to projects_service controller.
+    # @return [ProjectsServiceApi] Returns the controller instance.
+    def projects_service
+      @projects_service ||= ProjectsServiceApi.new @global_configuration
+    end
+
+    # Access to scans_service controller.
+    # @return [ScansServiceApi] Returns the controller instance.
+    def scans_service
+      @scans_service ||= ScansServiceApi.new @global_configuration
+    end
+
+    # Access to secrets_service controller.
+    # @return [SecretsServiceApi] Returns the controller instance.
+    def secrets_service
+      @secrets_service ||= SecretsServiceApi.new @global_configuration
+    end
+
+    # Access to supply_chain_service controller.
+    # @return [SupplyChainServiceApi] Returns the controller instance.
+    def supply_chain_service
+      @supply_chain_service ||= SupplyChainServiceApi.new @global_configuration
+    end
+
+    # Access to ticketing_service controller.
+    # @return [TicketingServiceApi] Returns the controller instance.
+    def ticketing_service
+      @ticketing_service ||= TicketingServiceApi.new @global_configuration
+    end
+
+    # Access to triage_service controller.
+    # @return [TriageServiceApi] Returns the controller instance.
+    def triage_service
+      @triage_service ||= TriageServiceApi.new @global_configuration
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 30,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
+      logging_configuration: nil, environment: Environment::PRODUCTION,
+      semgrep_admin_jwt_credentials: nil, semgrep_jwt_credentials: nil,
+      semgrep_web_token_credentials: nil, config: nil
+    )
+      @config = if config.nil?
+                  Configuration.new(
+                    connection: connection, adapter: adapter, timeout: timeout,
+                    max_retries: max_retries, retry_interval: retry_interval,
+                    backoff_factor: backoff_factor,
+                    retry_statuses: retry_statuses,
+                    retry_methods: retry_methods, http_callback: http_callback,
+                    proxy_settings: proxy_settings,
+                    logging_configuration: logging_configuration,
+                    environment: environment,
+                    semgrep_admin_jwt_credentials: semgrep_admin_jwt_credentials,
+                    semgrep_jwt_credentials: semgrep_jwt_credentials,
+                    semgrep_web_token_credentials: semgrep_web_token_credentials
+                  )
+                else
+                  config
+                end
+      user_agent_params = BaseApi.user_agent_parameters
+
+      @global_configuration = GlobalConfiguration.new(client_configuration: @config)
+                                                 .base_uri_executor(@config.method(:get_base_uri))
+                                                 .global_errors(BaseApi::GLOBAL_ERRORS)
+                                                 .user_agent(BaseApi.user_agent,
+                                                             agent_parameters: user_agent_params)
+
+      initialize_auth_managers(@global_configuration)
+      @global_configuration = @global_configuration.auth_managers(@auth_managers)
+    end
+
+    # Initializes the auth managers hash used for authenticating API calls.
+    # @param [GlobalConfiguration] global_config The global configuration of the SDK)
+    def initialize_auth_managers(global_config)
+      @auth_managers = {}
+      http_client_config = global_config.client_configuration
+      %w[SemgrepAdminJWT SemgrepJWT SemgrepWebToken].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['SemgrepAdminJWT'] = SemgrepAdminJwt.new(
+        http_client_config.semgrep_admin_jwt_credentials
+      )
+      @auth_managers['SemgrepJWT'] = SemgrepJwt.new(http_client_config.semgrep_jwt_credentials)
+      @auth_managers['SemgrepWebToken'] = SemgrepWebToken.new(
+        http_client_config.semgrep_web_token_credentials
+      )
+    end
+
+    # Creates a client directly from environment variables.
+    def self.from_env(**overrides)
+      default_config = Configuration.build_default_config_from_env
+      new_config = default_config.clone_with(**overrides)
+      new(config: new_config)
+    end
+  end
+end

data/lib/semgrep_web_app/configuration.rb

@@ -0,0 +1,178 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # An enum for SDK environments.
+  class Environment
+    ENVIRONMENT = [
+      PRODUCTION = 'Production'.freeze
+    ].freeze
+
+    # Converts a string or symbol into a valid Environment constant.
+    def self.from_value(value, default_value = PRODUCTION)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+
+  # An enum for API servers.
+  class Server
+    SERVER = [
+      SEMGREP = 'semgrep'.freeze
+    ].freeze
+
+    # Converts a string or symbol into a valid Server constant.
+    def self.from_value(value, default_value = SEMGREP)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+
+  # All configuration including auth info and base URI for the API access
+  # are configured in this class.
+  class Configuration < CoreLibrary::HttpClientConfiguration
+    # The attribute readers for properties.
+    attr_reader :environment, :semgrep_admin_jwt_credentials,
+                :semgrep_jwt_credentials, :semgrep_web_token_credentials
+
+    class << self
+      attr_reader :environments
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 30,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
+      logging_configuration: nil, environment: Environment::PRODUCTION,
+      semgrep_admin_jwt_credentials: nil, semgrep_jwt_credentials: nil,
+      semgrep_web_token_credentials: nil
+    )
+      super connection: connection, adapter: adapter, timeout: timeout,
+            max_retries: max_retries, retry_interval: retry_interval,
+            backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+            retry_methods: retry_methods, http_callback: http_callback,
+            proxy_settings: proxy_settings,
+            logging_configuration: logging_configuration
+
+      # Current API environment
+      @environment = String(environment)
+
+      # The object holding OAuth 2 Bearer token credentials
+      @semgrep_admin_jwt_credentials = semgrep_admin_jwt_credentials
+
+      # The object holding OAuth 2 Bearer token credentials
+      @semgrep_jwt_credentials = semgrep_jwt_credentials
+
+      # The object holding OAuth 2 Bearer token credentials
+      @semgrep_web_token_credentials = semgrep_web_token_credentials
+
+      # The Http Client to use for making requests.
+      set_http_client CoreLibrary::FaradayClient.new(self)
+    end
+
+    def clone_with(connection: nil, adapter: nil, timeout: nil,
+                   max_retries: nil, retry_interval: nil, backoff_factor: nil,
+                   retry_statuses: nil, retry_methods: nil, http_callback: nil,
+                   proxy_settings: nil, logging_configuration: nil,
+                   environment: nil, semgrep_admin_jwt_credentials: nil,
+                   semgrep_jwt_credentials: nil,
+                   semgrep_web_token_credentials: nil)
+      connection ||= self.connection
+      adapter ||= self.adapter
+      timeout ||= self.timeout
+      max_retries ||= self.max_retries
+      retry_interval ||= self.retry_interval
+      backoff_factor ||= self.backoff_factor
+      retry_statuses ||= self.retry_statuses
+      retry_methods ||= self.retry_methods
+      http_callback ||= self.http_callback
+      proxy_settings ||= self.proxy_settings
+      logging_configuration ||= self.logging_configuration
+      environment ||= self.environment
+      semgrep_admin_jwt_credentials ||= self.semgrep_admin_jwt_credentials
+      semgrep_jwt_credentials ||= self.semgrep_jwt_credentials
+      semgrep_web_token_credentials ||= self.semgrep_web_token_credentials
+
+      Configuration.new(
+        connection: connection, adapter: adapter, timeout: timeout,
+        max_retries: max_retries, retry_interval: retry_interval,
+        backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+        retry_methods: retry_methods, http_callback: http_callback,
+        proxy_settings: proxy_settings,
+        logging_configuration: logging_configuration, environment: environment,
+        semgrep_admin_jwt_credentials: semgrep_admin_jwt_credentials,
+        semgrep_jwt_credentials: semgrep_jwt_credentials,
+        semgrep_web_token_credentials: semgrep_web_token_credentials
+      )
+    end
+
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::SEMGREP => 'https://semgrep.dev'
+      }
+    }.freeze
+
+    # Generates the appropriate base URI for the environment and the server.
+    # @param [Configuration::Server] server The server enum for which the base URI is
+    # required.
+    # @return [String] The base URI.
+    def get_base_uri(server = Server::SEMGREP)
+      ENVIRONMENTS[environment][server].clone
+    end
+
+    # Builds a Configuration instance using environment variables.
+    def self.build_default_config_from_env
+      # === Core environment ===
+      environment = Environment.from_value(ENV.fetch('ENVIRONMENT', 'production'))
+      timeout = (ENV['TIMEOUT'] || 30).to_f
+      max_retries = (ENV['MAX_RETRIES'] || 0).to_i
+      retry_interval = (ENV['RETRY_INTERVAL'] || 1).to_f
+      backoff_factor = (ENV['BACKOFF_FACTOR'] || 2).to_f
+      retry_statuses = ENV.fetch('RETRY_STATUSES',
+                                 '[408, 413, 429, 500, 502, 503, 504, 521, 522, 524]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+      retry_methods = ENV.fetch('RETRY_METHODS', '%i[get put]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+
+      # === Authentication credentials ===
+      semgrep_admin_jwt_credentials = SemgrepAdminJwtCredentials.from_env
+      semgrep_jwt_credentials = SemgrepJwtCredentials.from_env
+      semgrep_web_token_credentials = SemgrepWebTokenCredentials.from_env
+
+      # === Proxy settings ===
+      proxy_settings = ProxySettings.from_env
+      # === Logging Configuration ===
+      logging_configuration = LoggingConfiguration.from_env if LoggingConfiguration.any_logging_configured?
+
+      Configuration.new(
+        environment: environment,
+        timeout: timeout,
+        max_retries: max_retries,
+        retry_interval: retry_interval,
+        backoff_factor: backoff_factor,
+        retry_statuses: retry_statuses,
+        retry_methods: retry_methods,
+        semgrep_admin_jwt_credentials: semgrep_admin_jwt_credentials,
+        semgrep_jwt_credentials: semgrep_jwt_credentials,
+        semgrep_web_token_credentials: semgrep_web_token_credentials,
+        proxy_settings: proxy_settings,
+        logging_configuration: logging_configuration
+      )
+    end
+  end
+end

data/lib/semgrep_web_app/exceptions/api_exception.rb

@@ -0,0 +1,21 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Class for exceptions when there is a network error, status code error, etc.
+  class APIException < CoreLibrary::ApiException
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code}, reason: #{@reason}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code.inspect}, reason: #{@reason.inspect}>"
+    end
+  end
+end

data/lib/semgrep_web_app/http/api_response.rb

@@ -0,0 +1,19 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Http response received.
+  class ApiResponse < CoreLibrary::ApiResponse
+    # The constructor
+    # @param [HttpResponse] http_response The original, raw response from the api.
+    # @param [Object] data The data field specified for the response.
+    # @param [Array<String>] errors Any errors returned by the server.
+    def initialize(http_response,
+                   data: nil,
+                   errors: nil)
+      super
+    end
+  end
+end

data/lib/semgrep_web_app/http/auth/semgrep_admin_jwt.rb

@@ -0,0 +1,53 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Utility class for OAuth 2 authorization and token management.
+  class SemgrepAdminJwt < CoreLibrary::HeaderAuth
+    include CoreLibrary
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'SemgrepAdminJwt: access_token is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(semgrep_admin_jwt_credentials)
+      auth_params = {}
+      @_access_token = semgrep_admin_jwt_credentials.access_token unless
+        semgrep_admin_jwt_credentials.nil? || semgrep_admin_jwt_credentials.access_token.nil?
+      auth_params[:Authorization] = "Bearer #{@_access_token}" unless @_access_token.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for SemgrepAdminJwtCredentials.
+  class SemgrepAdminJwtCredentials
+    attr_reader :access_token
+
+    def initialize(access_token:)
+      raise ArgumentError, 'access_token cannot be nil' if access_token.nil?
+
+      @access_token = access_token
+    end
+
+    def self.from_env
+      access_token = ENV['SEMGREP_ADMIN_JWT_ACCESS_TOKEN']
+      all_nil = [
+        access_token
+      ].all?(&:nil?)
+      return nil if all_nil
+
+      new(access_token: access_token)
+    end
+
+    def clone_with(access_token: nil)
+      access_token ||= self.access_token
+
+      SemgrepAdminJwtCredentials.new(access_token: access_token)
+    end
+  end
+end

data/lib/semgrep_web_app/http/auth/semgrep_jwt.rb

@@ -0,0 +1,53 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Utility class for OAuth 2 authorization and token management.
+  class SemgrepJwt < CoreLibrary::HeaderAuth
+    include CoreLibrary
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'SemgrepJwt: access_token is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(semgrep_jwt_credentials)
+      auth_params = {}
+      @_access_token = semgrep_jwt_credentials.access_token unless
+        semgrep_jwt_credentials.nil? || semgrep_jwt_credentials.access_token.nil?
+      auth_params[:Authorization] = "Bearer #{@_access_token}" unless @_access_token.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for SemgrepJwtCredentials.
+  class SemgrepJwtCredentials
+    attr_reader :access_token
+
+    def initialize(access_token:)
+      raise ArgumentError, 'access_token cannot be nil' if access_token.nil?
+
+      @access_token = access_token
+    end
+
+    def self.from_env
+      access_token = ENV['SEMGREP_JWT_ACCESS_TOKEN']
+      all_nil = [
+        access_token
+      ].all?(&:nil?)
+      return nil if all_nil
+
+      new(access_token: access_token)
+    end
+
+    def clone_with(access_token: nil)
+      access_token ||= self.access_token
+
+      SemgrepJwtCredentials.new(access_token: access_token)
+    end
+  end
+end

data/lib/semgrep_web_app/http/auth/semgrep_web_token.rb

@@ -0,0 +1,53 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Utility class for OAuth 2 authorization and token management.
+  class SemgrepWebToken < CoreLibrary::HeaderAuth
+    include CoreLibrary
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'SemgrepWebToken: access_token is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(semgrep_web_token_credentials)
+      auth_params = {}
+      @_access_token = semgrep_web_token_credentials.access_token unless
+        semgrep_web_token_credentials.nil? || semgrep_web_token_credentials.access_token.nil?
+      auth_params[:Authorization] = "Bearer #{@_access_token}" unless @_access_token.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for SemgrepWebTokenCredentials.
+  class SemgrepWebTokenCredentials
+    attr_reader :access_token
+
+    def initialize(access_token:)
+      raise ArgumentError, 'access_token cannot be nil' if access_token.nil?
+
+      @access_token = access_token
+    end
+
+    def self.from_env
+      access_token = ENV['SEMGREP_WEB_TOKEN_ACCESS_TOKEN']
+      all_nil = [
+        access_token
+      ].all?(&:nil?)
+      return nil if all_nil
+
+      new(access_token: access_token)
+    end
+
+    def clone_with(access_token: nil)
+      access_token ||= self.access_token
+
+      SemgrepWebTokenCredentials.new(access_token: access_token)
+    end
+  end
+end

data/lib/semgrep_web_app/http/http_call_back.rb

@@ -0,0 +1,10 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # HttpCallBack allows defining callables for pre and post API calls.
+  class HttpCallBack < CoreLibrary::HttpCallback
+  end
+end

data/lib/semgrep_web_app/http/http_method_enum.rb

@@ -0,0 +1,10 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # HTTP Methods Enumeration.
+  class HttpMethodEnum < CoreLibrary::HttpMethod
+  end
+end

data/lib/semgrep_web_app/http/http_request.rb

@@ -0,0 +1,10 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Represents a single Http Request.
+  class HttpRequest < CoreLibrary::HttpRequest
+  end
+end

data/lib/semgrep_web_app/http/http_response.rb

@@ -0,0 +1,10 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  # Http response received.
+  class HttpResponse < CoreLibrary::HttpResponse
+  end
+end

data/lib/semgrep_web_app/http/proxy_settings.rb

@@ -0,0 +1,22 @@
+# semgrep_web_app
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SemgrepWebApp
+  ##
+  # ProxySettings encapsulates HTTP proxy configuration for Faraday,
+  # including optional basic authentication.
+  #
+  class ProxySettings < CoreLibrary::ProxySettings
+    def self.from_env
+      address = ENV['PROXY_ADDRESS']
+      port = ENV['PROXY_PORT']
+      username = ENV['PROXY_USERNAME']
+      password = ENV['PROXY_PASSWORD']
+      return nil if address.nil? || address.strip.empty?
+
+      new(address: address, port: port, username: username, password: password)
+    end
+  end
+end