dependency-tracker-client 1.0.0

data/spec/api/default_api_spec.rb

@@ -0,0 +1,123 @@
+=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::DefaultApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'DefaultApi' do
+  before do
+    # run before each test
+    @api_instance = DependencyTacker::DefaultApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of DefaultApi' do
+    it 'should create an instance of DefaultApi' do
+      expect(@api_instance).to be_instance_of(DependencyTacker::DefaultApi)
+    end
+  end
+
+  # unit tests for add_project_to_rule
+  # Adds a project to a notification rule
+  # @param rule_uuid The UUID of the rule to add a project to
+  # @param project_uuid The UUID of the project to add to the rule
+  # @param [Hash] opts the optional parameters
+  # @return [NotificationRule]
+  describe 'add_project_to_rule 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 create_notification_rule
+  # Creates a new notification rule
+  # @param [Hash] opts the optional parameters
+  # @option opts [NotificationRule] :body 
+  # @return [NotificationRule]
+  describe 'create_notification_rule 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_notification_rule
+  # Deletes a notification rule
+  # @param [Hash] opts the optional parameters
+  # @option opts [NotificationRule] :body 
+  # @return [nil]
+  describe 'delete_notification_rule 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_notification_publishers
+  # Returns a list of all notification publishers
+  # @param [Hash] opts the optional parameters
+  # @return [Array<NotificationPublisher>]
+  describe 'get_all_notification_publishers 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_notification_rules
+  # Returns a list of all notification rules
+  # @param [Hash] opts the optional parameters
+  # @return [Array<NotificationRule>]
+  describe 'get_all_notification_rules 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 remove_project_from_rule
+  # Removes a project from a notification rule
+  # @param rule_uuid The UUID of the rule to remove the project from
+  # @param project_uuid The UUID of the project to remove from the rule
+  # @param [Hash] opts the optional parameters
+  # @return [NotificationRule]
+  describe 'remove_project_from_rule 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 test_smtp_publisher_config
+  # Dispatches a SMTP notification test
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :destination 
+  # @return [nil]
+  describe 'test_smtp_publisher_config 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_notification_rule
+  # Updates a notification rule
+  # @param [Hash] opts the optional parameters
+  # @option opts [NotificationRule] :body 
+  # @return [NotificationRule]
+  describe 'update_notification_rule 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/dependency_api_spec.rb

@@ -0,0 +1,79 @@
+=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::DependencyApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'DependencyApi' do
+  before do
+    # run before each test
+    @api_instance = DependencyTacker::DependencyApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of DependencyApi' do
+    it 'should create an instance of DependencyApi' do
+      expect(@api_instance).to be_instance_of(DependencyTacker::DependencyApi)
+    end
+  end
+
+  # unit tests for add_dependency
+  # Adds one or more components as a dependency to a project
+  # @param [Hash] opts the optional parameters
+  # @option opts [DependencyRequest] :body 
+  # @return [nil]
+  describe 'add_dependency 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_dependencies_by_component
+  # Returns a list of all dependencies for a specific component
+  # @param uuid 
+  # @param [Hash] opts the optional parameters
+  # @return [Array<Dependency>]
+  describe 'get_dependencies_by_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_dependencies_by_project
+  # Returns a list of all dependencies for a specific project
+  # @param uuid 
+  # @param [Hash] opts the optional parameters
+  # @return [Array<Dependency>]
+  describe 'get_dependencies_by_project 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 remove_dependency
+  # Removes a component as a dependency from a project
+  # @param [Hash] opts the optional parameters
+  # @option opts [DependencyRequest] :body 
+  # @return [nil]
+  describe 'remove_dependency 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/finding_api_spec.rb

@@ -0,0 +1,57 @@
+=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::FindingApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'FindingApi' do
+  before do
+    # run before each test
+    @api_instance = DependencyTacker::FindingApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of FindingApi' do
+    it 'should create an instance of FindingApi' do
+      expect(@api_instance).to be_instance_of(DependencyTacker::FindingApi)
+    end
+  end
+
+  # unit tests for export_findings_by_project
+  # Returns a the findings for the specified project as FPF
+  # @param uuid 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'export_findings_by_project 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_findings_by_project
+  # Returns a list of all findings for a specific project
+  # @param uuid 
+  # @param [Hash] opts the optional parameters
+  # @return [Array<Finding>]
+  describe 'get_findings_by_project 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/ldap_api_spec.rb

@@ -0,0 +1,79 @@
+=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::LdapApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'LdapApi' do
+  before do
+    # run before each test
+    @api_instance = DependencyTacker::LdapApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of LdapApi' do
+    it 'should create an instance of LdapApi' do
+      expect(@api_instance).to be_instance_of(DependencyTacker::LdapApi)
+    end
+  end
+
+  # unit tests for add_mapping
+  # Adds a mapping
+  # @param [Hash] opts the optional parameters
+  # @option opts [MappedLdapGroupRequest] :body 
+  # @return [MappedLdapGroup]
+  describe 'add_mapping 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_mapping
+  # Removes a mapping
+  # @param uuid The UUID of the mapping to delete
+  # @param [Hash] opts the optional parameters
+  # @return [MappedLdapGroup]
+  describe 'delete_mapping 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 retrieve_ldap_groups
+  # Returns the DNs of all accessible groups within the directory
+  # This API performs a pass-thru query to the configured LDAP server. Search criteria results are cached using default Alpine CacheManager policy
+  # @param [Hash] opts the optional parameters
+  # @return [Array<String>]
+  describe 'retrieve_ldap_groups 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 retrieve_ldap_groups1
+  # Returns the DNs of all groups mapped to the specified team
+  # @param uuid The UUID of the team to retrieve mappings for
+  # @param [Hash] opts the optional parameters
+  # @return [Array<String>]
+  describe 'retrieve_ldap_groups1 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/license_api_spec.rb

@@ -0,0 +1,66 @@
+=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::LicenseApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'LicenseApi' do
+  before do
+    # run before each test
+    @api_instance = DependencyTacker::LicenseApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of LicenseApi' do
+    it 'should create an instance of LicenseApi' do
+      expect(@api_instance).to be_instance_of(DependencyTacker::LicenseApi)
+    end
+  end
+
+  # unit tests for get_license
+  # Returns a specific license
+  # @param license_id The SPDX License ID of the license to retrieve
+  # @param [Hash] opts the optional parameters
+  # @return [License]
+  describe 'get_license 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_license_listing
+  # Returns a concise listing of all licenses
+  # @param [Hash] opts the optional parameters
+  # @return [Array<License>]
+  describe 'get_license_listing 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_licenses
+  # Returns a list of all licenses with complete metadata for each license
+  # @param [Hash] opts the optional parameters
+  # @return [Array<License>]
+  describe 'get_licenses 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/metrics_api_spec.rb

@@ -0,0 +1,233 @@
+=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::MetricsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'MetricsApi' do
+  before do
+    # run before each test
+    @api_instance = DependencyTacker::MetricsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of MetricsApi' do
+    it 'should create an instance of MetricsApi' do
+      expect(@api_instance).to be_instance_of(DependencyTacker::MetricsApi)
+    end
+  end
+
+  # unit tests for get_component_current_metrics
+  # Returns current metrics for a specific component
+  # @param uuid The UUID of the component to retrieve metrics for
+  # @param [Hash] opts the optional parameters
+  # @return [ComponentMetrics]
+  describe 'get_component_current_metrics 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_metrics_since
+  # Returns historical metrics for a specific component from a specific date
+  # Date format must be YYYYMMDD
+  # @param uuid The UUID of the component to retrieve metrics for
+  # @param date The start date to retrieve metrics for
+  # @param [Hash] opts the optional parameters
+  # @return [Array<ComponentMetrics>]
+  describe 'get_component_metrics_since 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_metrics_x_days
+  # Returns X days of historical metrics for a specific component
+  # @param uuid The UUID of the component to retrieve metrics for
+  # @param days The number of days back to retrieve metrics for
+  # @param [Hash] opts the optional parameters
+  # @return [Array<ComponentMetrics>]
+  describe 'get_component_metrics_x_days 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_dependency_current_metrics
+  # Returns current metrics for a specific dependency
+  # @param project_uuid The UUID of the project to retrieve metrics for
+  # @param component_uuid The UUID of the component to retrieve metrics for
+  # @param [Hash] opts the optional parameters
+  # @return [DependencyMetrics]
+  describe 'get_dependency_current_metrics 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_dependency_metrics_since
+  # Returns historical metrics for a specific dependency from a specific date
+  # Date format must be YYYYMMDD
+  # @param project_uuid The UUID of the project to retrieve metrics for
+  # @param component_uuid The UUID of the component to retrieve metrics for
+  # @param date The start date to retrieve metrics for
+  # @param [Hash] opts the optional parameters
+  # @return [Array<DependencyMetrics>]
+  describe 'get_dependency_metrics_since 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_dependency_metrics_x_days
+  # Returns X days of historical metrics for a specific dependency
+  # @param project_uuid The UUID of the project to retrieve metrics for
+  # @param component_uuid The UUID of the component to retrieve metrics for
+  # @param days The number of days back to retrieve metrics for
+  # @param [Hash] opts the optional parameters
+  # @return [Array<DependencyMetrics>]
+  describe 'get_dependency_metrics_x_days 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_portfolio_current_metrics
+  # Returns current metrics for the entire portfolio
+  # @param [Hash] opts the optional parameters
+  # @return [PortfolioMetrics]
+  describe 'get_portfolio_current_metrics 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_portfolio_metrics_since
+  # Returns historical metrics for the entire portfolio from a specific date
+  # Date format must be YYYYMMDD
+  # @param date The start date to retrieve metrics for
+  # @param [Hash] opts the optional parameters
+  # @return [Array<PortfolioMetrics>]
+  describe 'get_portfolio_metrics_since 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_portfolio_metrics_x_days
+  # Returns X days of historical metrics for the entire portfolio
+  # @param days The number of days back to retrieve metrics for
+  # @param [Hash] opts the optional parameters
+  # @return [Array<PortfolioMetrics>]
+  describe 'get_portfolio_metrics_x_days 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_current_metrics
+  # 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_current_metrics 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_metrics_since
+  # Returns historical metrics for a specific project from a specific date
+  # Date format must be YYYYMMDD
+  # @param uuid The UUID of the project to retrieve metrics for
+  # @param date The start date to retrieve metrics for
+  # @param [Hash] opts the optional parameters
+  # @return [Array<ProjectMetrics>]
+  describe 'get_project_metrics_since 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_metrics_x_days
+  # Returns X days of historical metrics for a specific project
+  # @param uuid The UUID of the project to retrieve metrics for
+  # @param days The number of days back to retrieve metrics for
+  # @param [Hash] opts the optional parameters
+  # @return [Array<ProjectMetrics>]
+  describe 'get_project_metrics_x_days 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_vulnerability_metrics
+  # Returns the sum of all vulnerabilities in the database by year and month
+  # @param [Hash] opts the optional parameters
+  # @return [Array<VulnerabilityMetrics>]
+  describe 'get_vulnerability_metrics 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 refresh_component_metrics
+  # Requests a refresh of a specific components metrics
+  # @param uuid The UUID of the component to refresh metrics on
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'refresh_component_metrics 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 refresh_dependency_metrics
+  # Requests a refresh of a specific dependency metrics
+  # @param project_uuid The UUID of the project to retrieve metrics for
+  # @param component_uuid The UUID of the component to retrieve metrics for
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'refresh_dependency_metrics 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 refresh_portfolio_metrics
+  # Requests a refresh of the portfolio metrics
+  # @param [Hash] opts the optional parameters
+  # @return [PortfolioMetrics]
+  describe 'refresh_portfolio_metrics 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 refresh_project_metrics
+  # Requests a refresh of a specific projects metrics
+  # @param uuid The UUID of the project to refresh metrics on
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'refresh_project_metrics test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end