dependency-tracker-client 1.0.0

data/lib/dependency-tracker-client.rb

@@ -0,0 +1,109 @@
+=begin
+#Dependency-Track API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 3.8.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+# Common files
+require 'dependency-tracker-client/api_client'
+require 'dependency-tracker-client/api_error'
+require 'dependency-tracker-client/version'
+require 'dependency-tracker-client/configuration'
+
+# Models
+require 'dependency-tracker-client/models/about'
+require 'dependency-tracker-client/models/analysis'
+require 'dependency-tracker-client/models/analysis_comment'
+require 'dependency-tracker-client/models/analysis_request'
+require 'dependency-tracker-client/models/api_key'
+require 'dependency-tracker-client/models/body_part'
+require 'dependency-tracker-client/models/bom_submit_request'
+require 'dependency-tracker-client/models/clone_project_request'
+require 'dependency-tracker-client/models/component'
+require 'dependency-tracker-client/models/component_metrics'
+require 'dependency-tracker-client/models/config_property'
+require 'dependency-tracker-client/models/content_disposition'
+require 'dependency-tracker-client/models/cwe'
+require 'dependency-tracker-client/models/dependency'
+require 'dependency-tracker-client/models/dependency_metrics'
+require 'dependency-tracker-client/models/dependency_request'
+require 'dependency-tracker-client/models/finding'
+require 'dependency-tracker-client/models/form_data_body_part'
+require 'dependency-tracker-client/models/form_data_content_disposition'
+require 'dependency-tracker-client/models/form_data_multi_part'
+require 'dependency-tracker-client/models/framework'
+require 'dependency-tracker-client/models/identifiable_object'
+require 'dependency-tracker-client/models/ldap_user'
+require 'dependency-tracker-client/models/license'
+require 'dependency-tracker-client/models/managed_user'
+require 'dependency-tracker-client/models/mapped_ldap_group'
+require 'dependency-tracker-client/models/mapped_ldap_group_request'
+require 'dependency-tracker-client/models/media_type'
+require 'dependency-tracker-client/models/multi_part'
+require 'dependency-tracker-client/models/notification_publisher'
+require 'dependency-tracker-client/models/notification_rule'
+require 'dependency-tracker-client/models/package_url'
+require 'dependency-tracker-client/models/parameterized_header'
+require 'dependency-tracker-client/models/permission'
+require 'dependency-tracker-client/models/portfolio_metrics'
+require 'dependency-tracker-client/models/project'
+require 'dependency-tracker-client/models/project_metrics'
+require 'dependency-tracker-client/models/project_property'
+require 'dependency-tracker-client/models/repository'
+require 'dependency-tracker-client/models/repository_meta_component'
+require 'dependency-tracker-client/models/score'
+require 'dependency-tracker-client/models/search_result'
+require 'dependency-tracker-client/models/tag'
+require 'dependency-tracker-client/models/team'
+require 'dependency-tracker-client/models/user_principal'
+require 'dependency-tracker-client/models/vulnerability'
+require 'dependency-tracker-client/models/vulnerability_metrics'
+require 'dependency-tracker-client/models/vulnerable_software'
+
+# APIs
+require 'dependency-tracker-client/api/analysis_api'
+require 'dependency-tracker-client/api/badge_api'
+require 'dependency-tracker-client/api/bom_api'
+require 'dependency-tracker-client/api/calculator_api'
+require 'dependency-tracker-client/api/component_api'
+require 'dependency-tracker-client/api/config_property_api'
+require 'dependency-tracker-client/api/cwe_api'
+require 'dependency-tracker-client/api/default_api'
+require 'dependency-tracker-client/api/dependency_api'
+require 'dependency-tracker-client/api/finding_api'
+require 'dependency-tracker-client/api/ldap_api'
+require 'dependency-tracker-client/api/license_api'
+require 'dependency-tracker-client/api/metrics_api'
+require 'dependency-tracker-client/api/permission_api'
+require 'dependency-tracker-client/api/project_api'
+require 'dependency-tracker-client/api/project_property_api'
+require 'dependency-tracker-client/api/repository_api'
+require 'dependency-tracker-client/api/search_api'
+require 'dependency-tracker-client/api/team_api'
+require 'dependency-tracker-client/api/user_api'
+require 'dependency-tracker-client/api/version_api'
+require 'dependency-tracker-client/api/vulnerability_api'
+
+module DependencyTracker
+  class << self
+    # Customize default settings for the SDK using block.
+    #   DependencyTracker.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/spec/api/analysis_api_spec.rb

@@ -0,0 +1,70 @@
+=begin
+#Dependency-Track API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 3.8.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for DependencyTacker::AnalysisApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'AnalysisApi' do
+  before do
+    # run before each test
+    @api_instance = DependencyTacker::AnalysisApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AnalysisApi' do
+    it 'should create an instance of AnalysisApi' do
+      expect(@api_instance).to be_instance_of(DependencyTacker::AnalysisApi)
+    end
+  end
+
+  # unit tests for retrieve_analysis
+  # Retrieves an analysis trail
+  # @param component The UUID of the component
+  # @param vulnerability The UUID of the vulnerability
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :project The UUID of the project
+  # @return [Analysis]
+  describe 'retrieve_analysis test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_analysis
+  # Records an analysis decision
+  # @param [Hash] opts the optional parameters
+  # @option opts [AnalysisRequest] :body 
+  # @return [Analysis]
+  describe 'update_analysis test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_global_analysis
+  # Records an analysis decision
+  # @param [Hash] opts the optional parameters
+  # @option opts [AnalysisRequest] :body 
+  # @return [Analysis]
+  describe 'update_global_analysis test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/badge_api_spec.rb

@@ -0,0 +1,58 @@
+=begin
+#Dependency-Track API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 3.8.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for DependencyTacker::BadgeApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'BadgeApi' do
+  before do
+    # run before each test
+    @api_instance = DependencyTacker::BadgeApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of BadgeApi' do
+    it 'should create an instance of BadgeApi' do
+      expect(@api_instance).to be_instance_of(DependencyTacker::BadgeApi)
+    end
+  end
+
+  # unit tests for get_project_vulnerabilities_badge
+  # Returns current metrics for a specific project
+  # @param name The name of the project to query on
+  # @param version The version of the project to query on
+  # @param [Hash] opts the optional parameters
+  # @return [ProjectMetrics]
+  describe 'get_project_vulnerabilities_badge test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_project_vulnerabilities_badge1
+  # Returns current metrics for a specific project
+  # @param uuid The UUID of the project to retrieve metrics for
+  # @param [Hash] opts the optional parameters
+  # @return [ProjectMetrics]
+  describe 'get_project_vulnerabilities_badge1 test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/bom_api_spec.rb

@@ -0,0 +1,106 @@
+=begin
+#Dependency-Track API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 3.8.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for DependencyTacker::BomApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'BomApi' do
+  before do
+    # run before each test
+    @api_instance = DependencyTacker::BomApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of BomApi' do
+    it 'should create an instance of BomApi' do
+      expect(@api_instance).to be_instance_of(DependencyTacker::BomApi)
+    end
+  end
+
+  # unit tests for export_component_as_cyclone_dx
+  # Returns dependency metadata for a specific component in CycloneDX format
+  # @param uuid The UUID of the project to export
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'export_component_as_cyclone_dx test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for export_components_as_cyclone_dx
+  # Returns dependency metadata for all components in CycloneDX format
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'export_components_as_cyclone_dx test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for export_project_as_cyclone_dx
+  # Returns dependency metadata for a project in CycloneDX format
+  # @param uuid The UUID of the project to export
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'export_project_as_cyclone_dx test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for is_token_being_processed
+  # Determines if there are any tasks associated with the token that are being processed, or in the queue to be processed.
+  # This endpoint is intended to be used in conjunction with uploading a supported BOM document. Upon upload, a token will be returned. The token can then be queried using this endpoint to determine if any tasks (such as vulnerability analysis) is being performed on the BOM. A value of true indicates processing is occurring. A value of false indicates that no processing is occurring for the specified token. However, a value of false also does not confirm the token is valid, only that no processing is associated with the specified token.
+  # @param uuid The UUID of the token to query
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'is_token_being_processed test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for upload_bom
+  # Upload a supported bill of material format document
+  # Expects CycloneDX or SPDX (text or RDF) along and a valid project UUID. If a UUID is not specified, than the projectName and projectVersion must be specified. Optionally, if autoCreate is specified and 'true' and the project does not exist, the project will be created. In this scenario, the principal making the request will additionally need the PORTFOLIO_MANAGEMENT or PROJECT_CREATION_UPLOAD permission.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :project 
+  # @option opts [Boolean] :auto_create 
+  # @option opts [String] :project_name 
+  # @option opts [String] :project_version 
+  # @return [nil]
+  describe 'upload_bom test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for upload_bom1
+  # Upload a supported bill of material format document
+  # Expects CycloneDX or SPDX (text or RDF) along and a valid project UUID. If a UUID is not specified, than the projectName and projectVersion must be specified. Optionally, if autoCreate is specified and 'true' and the project does not exist, the project will be created. In this scenario, the principal making the request will additionally need the PORTFOLIO_MANAGEMENT or PROJECT_CREATION_UPLOAD permission.
+  # @param [Hash] opts the optional parameters
+  # @option opts [BomSubmitRequest] :body 
+  # @return [nil]
+  describe 'upload_bom1 test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/calculator_api_spec.rb

@@ -0,0 +1,46 @@
+=begin
+#Dependency-Track API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 3.8.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for DependencyTacker::CalculatorApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'CalculatorApi' do
+  before do
+    # run before each test
+    @api_instance = DependencyTacker::CalculatorApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CalculatorApi' do
+    it 'should create an instance of CalculatorApi' do
+      expect(@api_instance).to be_instance_of(DependencyTacker::CalculatorApi)
+    end
+  end
+
+  # unit tests for get_cvss_scores
+  # Returns the CVSS base score, impact sub-score and exploitability sub-score
+  # @param vector A valid CVSSv2 or CVSSv3 vector
+  # @param [Hash] opts the optional parameters
+  # @return [Score]
+  describe 'get_cvss_scores test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/component_api_spec.rb

@@ -0,0 +1,110 @@
+=begin
+#Dependency-Track API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 3.8.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for DependencyTacker::ComponentApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ComponentApi' do
+  before do
+    # run before each test
+    @api_instance = DependencyTacker::ComponentApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ComponentApi' do
+    it 'should create an instance of ComponentApi' do
+      expect(@api_instance).to be_instance_of(DependencyTacker::ComponentApi)
+    end
+  end
+
+  # unit tests for create_component
+  # Creates a new component
+  # @param [Hash] opts the optional parameters
+  # @option opts [Component] :body 
+  # @return [Component]
+  describe 'create_component test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_component
+  # Deletes a component
+  # @param uuid The UUID of the component to delete
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_component test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_all_components
+  # Returns a list of all components
+  # @param [Hash] opts the optional parameters
+  # @return [Array<Component>]
+  describe 'get_all_components test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_component_by_hash
+  # Returns a specific component
+  # @param hash The MD5, SHA-1, SHA-256, SHA-512, SHA3-256, or SHA3-512 hash of the component to retrieve
+  # @param [Hash] opts the optional parameters
+  # @return [Component]
+  describe 'get_component_by_hash test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_component_by_uuid
+  # Returns a specific component
+  # @param uuid The UUID of the component to retrieve
+  # @param [Hash] opts the optional parameters
+  # @return [Component]
+  describe 'get_component_by_uuid test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for identify_internal_components
+  # Requests the identification of internal components in the portfolio
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'identify_internal_components test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_component
+  # Updates a component
+  # @param [Hash] opts the optional parameters
+  # @option opts [Component] :body 
+  # @return [Component]
+  describe 'update_component test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/config_property_api_spec.rb

@@ -0,0 +1,67 @@
+=begin
+#Dependency-Track API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 3.8.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for DependencyTacker::ConfigPropertyApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ConfigPropertyApi' do
+  before do
+    # run before each test
+    @api_instance = DependencyTacker::ConfigPropertyApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ConfigPropertyApi' do
+    it 'should create an instance of ConfigPropertyApi' do
+      expect(@api_instance).to be_instance_of(DependencyTacker::ConfigPropertyApi)
+    end
+  end
+
+  # unit tests for get_config_properties
+  # Returns a list of all ConfigProperties for the specified groupName
+  # @param [Hash] opts the optional parameters
+  # @return [Array<ConfigProperty>]
+  describe 'get_config_properties test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_config_property
+  # Updates a config property
+  # @param [Hash] opts the optional parameters
+  # @option opts [ConfigProperty] :body 
+  # @return [ConfigProperty]
+  describe 'update_config_property test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_config_property1
+  # Updates an array of config properties
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<ConfigProperty>] :body 
+  # @return [Array<ConfigProperty>]
+  describe 'update_config_property1 test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/cwe_api_spec.rb

@@ -0,0 +1,56 @@
+=begin
+#Dependency-Track API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 3.8.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for DependencyTacker::CweApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'CweApi' do
+  before do
+    # run before each test
+    @api_instance = DependencyTacker::CweApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CweApi' do
+    it 'should create an instance of CweApi' do
+      expect(@api_instance).to be_instance_of(DependencyTacker::CweApi)
+    end
+  end
+
+  # unit tests for get_cwe
+  # Returns a specific CWE
+  # @param cwe_id The CWE ID of the CWE to retrieve
+  # @param [Hash] opts the optional parameters
+  # @return [Cwe]
+  describe 'get_cwe test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_cwes
+  # Returns a list of all CWEs
+  # @param [Hash] opts the optional parameters
+  # @return [Array<Cwe>]
+  describe 'get_cwes test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end