dependency-tracker-client 1.0.0

data/spec/api/user_api_spec.rb

@@ -0,0 +1,183 @@
+=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::UserApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'UserApi' do
+  before do
+    # run before each test
+    @api_instance = DependencyTacker::UserApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of UserApi' do
+    it 'should create an instance of UserApi' do
+      expect(@api_instance).to be_instance_of(DependencyTacker::UserApi)
+    end
+  end
+
+  # unit tests for add_team_to_user
+  # Adds the username to the specified team.
+  # @param username A valid username
+  # @param body The UUID of the team to associate username with
+  # @param [Hash] opts the optional parameters
+  # @return [UserPrincipal]
+  describe 'add_team_to_user 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_ldap_user
+  # Creates a new user that references an existing LDAP object.
+  # @param [Hash] opts the optional parameters
+  # @option opts [LdapUser] :body 
+  # @return [LdapUser]
+  describe 'create_ldap_user 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_managed_user
+  # Creates a new user.
+  # @param [Hash] opts the optional parameters
+  # @option opts [ManagedUser] :body 
+  # @return [ManagedUser]
+  describe 'create_managed_user 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_ldap_user
+  # Deletes a user.
+  # @param [Hash] opts the optional parameters
+  # @option opts [LdapUser] :body 
+  # @return [nil]
+  describe 'delete_ldap_user 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_managed_user
+  # Deletes a user.
+  # @param [Hash] opts the optional parameters
+  # @option opts [ManagedUser] :body 
+  # @return [nil]
+  describe 'delete_managed_user 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 force_change_password
+  # Asserts login credentials and upon successful authentication, verifies passwords match and changes users password
+  # Upon a successful login, a JSON Web Token will be returned in the response body. This functionality requires authentication to be enabled.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :username 
+  # @option opts [String] :password 
+  # @option opts [String] :new_password 
+  # @option opts [String] :confirm_password 
+  # @return [String]
+  describe 'force_change_password 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_ldap_users
+  # Returns a list of all LDAP users
+  # @param [Hash] opts the optional parameters
+  # @return [Array<LdapUser>]
+  describe 'get_ldap_users 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_managed_users
+  # Returns a list of all managed users
+  # @param [Hash] opts the optional parameters
+  # @return [Array<ManagedUser>]
+  describe 'get_managed_users 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_self
+  # Returns information about the current logged in user.
+  # @param [Hash] opts the optional parameters
+  # @return [UserPrincipal]
+  describe 'get_self 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_team_from_user
+  # Removes the username from the specified team.
+  # @param username A valid username
+  # @param body The UUID of the team to un-associate username from
+  # @param [Hash] opts the optional parameters
+  # @return [UserPrincipal]
+  describe 'remove_team_from_user 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_managed_user
+  # Updates a managed user.
+  # @param [Hash] opts the optional parameters
+  # @option opts [ManagedUser] :body 
+  # @return [ManagedUser]
+  describe 'update_managed_user 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_self
+  # Updates information about the current logged in user.
+  # @param [Hash] opts the optional parameters
+  # @option opts [ManagedUser] :body 
+  # @return [UserPrincipal]
+  describe 'update_self 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 validate_credentials
+  # Assert login credentials
+  # Upon a successful login, a JSON Web Token will be returned in the response body. This functionality requires authentication to be enabled.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :username 
+  # @option opts [String] :password 
+  # @return [String]
+  describe 'validate_credentials 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/version_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::VersionApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'VersionApi' do
+  before do
+    # run before each test
+    @api_instance = DependencyTacker::VersionApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of VersionApi' do
+    it 'should create an instance of VersionApi' do
+      expect(@api_instance).to be_instance_of(DependencyTacker::VersionApi)
+    end
+  end
+
+  # unit tests for get_version
+  # Returns application version information
+  # Returns a simple json object containing the name of the application and the version
+  # @param [Hash] opts the optional parameters
+  # @return [About]
+  describe 'get_version 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/vulnerability_api_spec.rb

@@ -0,0 +1,177 @@
+=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::VulnerabilityApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'VulnerabilityApi' do
+  before do
+    # run before each test
+    @api_instance = DependencyTacker::VulnerabilityApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of VulnerabilityApi' do
+    it 'should create an instance of VulnerabilityApi' do
+      expect(@api_instance).to be_instance_of(DependencyTacker::VulnerabilityApi)
+    end
+  end
+
+  # unit tests for assign_vulnerability
+  # Assigns a vulnerability to a component
+  # @param source The vulnerability source
+  # @param vuln_id The vulnId
+  # @param component The UUID of the component
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'assign_vulnerability 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 assign_vulnerability1
+  # Assigns a vulnerability to a component
+  # @param uuid The UUID of the vulnerability
+  # @param component The UUID of the component
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'assign_vulnerability1 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_vulnerability
+  # Creates a new vulnerability
+  # @param [Hash] opts the optional parameters
+  # @option opts [Vulnerability] :body 
+  # @return [Vulnerability]
+  describe 'create_vulnerability 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_affected_project
+  # Returns a list of all projects affected by a specific vulnerability
+  # @param source 
+  # @param vuln 
+  # @param [Hash] opts the optional parameters
+  # @return [Array<Project>]
+  describe 'get_affected_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_all_vulnerabilities
+  # Returns a list of all vulnerabilities
+  # @param [Hash] opts the optional parameters
+  # @return [Array<Vulnerability>]
+  describe 'get_all_vulnerabilities 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_vulnerabilities_by_component
+  # Returns a list of all vulnerabilities for a specific component
+  # A valid UUID of the component may be specified, or the MD5 or SHA1 hash of the component
+  # @param ident 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :suppressed Optionally includes suppressed vulnerabilities
+  # @return [Array<Vulnerability>]
+  describe 'get_vulnerabilities_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_vulnerabilities_by_project
+  # Returns a list of all vulnerabilities for a specific project
+  # @param uuid 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :suppressed Optionally includes suppressed vulnerabilities
+  # @return [Array<Vulnerability>]
+  describe 'get_vulnerabilities_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_vulnerability_by_uuid
+  # Returns a specific vulnerability
+  # @param uuid The UUID of the vulnerability
+  # @param [Hash] opts the optional parameters
+  # @return [Vulnerability]
+  describe 'get_vulnerability_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 get_vulnerability_by_vuln_id
+  # Returns a specific vulnerability
+  # @param source 
+  # @param vuln 
+  # @param [Hash] opts the optional parameters
+  # @return [Vulnerability]
+  describe 'get_vulnerability_by_vuln_id 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 unassign_vulnerability
+  # Removes assignment of a vulnerability from a component
+  # @param source The vulnerability source
+  # @param vuln_id The vulnId
+  # @param component The UUID of the component
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'unassign_vulnerability 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 unassign_vulnerability1
+  # Removes assignment of a vulnerability from a component
+  # @param uuid The UUID of the vulnerability
+  # @param component The UUID of the component
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'unassign_vulnerability1 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_vulnerability
+  # Updates an internal vulnerability
+  # @param [Hash] opts the optional parameters
+  # @option opts [Vulnerability] :body 
+  # @return [Project]
+  describe 'update_vulnerability 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_client_spec.rb

@@ -0,0 +1,226 @@
+=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'
+
+describe DependencyTacker::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          DependencyTacker.configure { |c| c.host = 'http://example.com' }
+          expect(DependencyTacker::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          DependencyTacker.configure { |c| c.host = 'https://wookiee.com' }
+          expect(DependencyTacker::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          DependencyTacker.configure { |c| c.host = 'hobo.com/v4' }
+          expect(DependencyTacker::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          DependencyTacker.configure { |c| c.base_path = 'v4/dog' }
+          expect(DependencyTacker::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          DependencyTacker.configure { |c| c.base_path = '/v4/dog' }
+          expect(DependencyTacker::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          DependencyTacker.configure { |c| c.base_path = nil }
+          expect(DependencyTacker::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe 'params_encoding in #build_request' do
+    let(:config) { DependencyTacker::Configuration.new }
+    let(:api_client) { DependencyTacker::ApiClient.new(config) }
+
+    it 'defaults to nil' do
+      expect(DependencyTacker::Configuration.default.params_encoding).to eq(nil)
+      expect(config.params_encoding).to eq(nil)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:params_encoding]).to eq(nil)
+    end
+
+    it 'can be customized' do
+      config.params_encoding = :multi
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:params_encoding]).to eq(:multi)
+    end
+  end
+
+  describe 'timeout in #build_request' do
+    let(:config) { DependencyTacker::Configuration.new }
+    let(:api_client) { DependencyTacker::ApiClient.new(config) }
+
+    it 'defaults to 0' do
+      expect(DependencyTacker::Configuration.default.timeout).to eq(0)
+      expect(config.timeout).to eq(0)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(0)
+    end
+
+    it 'can be customized' do
+      config.timeout = 100
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(100)
+    end
+  end
+
+  describe '#deserialize' do
+    it "handles Array<Integer>" do
+      api_client = DependencyTacker::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '[12, 34]')
+      data = api_client.deserialize(response, 'Array<Integer>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([12, 34])
+    end
+
+    it 'handles Array<Array<Integer>>' do
+      api_client = DependencyTacker::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '[[12, 34], [56]]')
+      data = api_client.deserialize(response, 'Array<Array<Integer>>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([[12, 34], [56]])
+    end
+
+    it 'handles Hash<String, String>' do
+      api_client = DependencyTacker::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '{"message": "Hello"}')
+      data = api_client.deserialize(response, 'Hash<String, String>')
+      expect(data).to be_instance_of(Hash)
+      expect(data).to eq(:message => 'Hello')
+    end
+  end
+
+  describe "#object_to_hash" do
+    it 'ignores nils and includes empty arrays' do
+      # uncomment below to test object_to_hash for model
+      # api_client = DependencyTacker::ApiClient.new
+      # _model = DependencyTacker::ModelName.new
+      # update the model attribute below
+      # _model.id = 1
+      # update the expected value (hash) below
+      # expected = {id: 1, name: '', tags: []}
+      # expect(api_client.object_to_hash(_model)).to eq(expected)
+    end
+  end
+
+  describe '#build_collection_param' do
+    let(:param) { ['aa', 'bb', 'cc'] }
+    let(:api_client) { DependencyTacker::ApiClient.new }
+
+    it 'works for csv' do
+      expect(api_client.build_collection_param(param, :csv)).to eq('aa,bb,cc')
+    end
+
+    it 'works for ssv' do
+      expect(api_client.build_collection_param(param, :ssv)).to eq('aa bb cc')
+    end
+
+    it 'works for tsv' do
+      expect(api_client.build_collection_param(param, :tsv)).to eq("aa\tbb\tcc")
+    end
+
+    it 'works for pipes' do
+      expect(api_client.build_collection_param(param, :pipes)).to eq('aa|bb|cc')
+    end
+
+    it 'works for multi' do
+      expect(api_client.build_collection_param(param, :multi)).to eq(['aa', 'bb', 'cc'])
+    end
+
+    it 'fails for invalid collection format' do
+      expect { api_client.build_collection_param(param, :INVALID) }.to raise_error(RuntimeError, 'unknown collection format: :INVALID')
+    end
+  end
+
+  describe '#json_mime?' do
+    let(:api_client) { DependencyTacker::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.json_mime?(nil)).to eq false
+      expect(api_client.json_mime?('')).to eq false
+
+      expect(api_client.json_mime?('application/json')).to eq true
+      expect(api_client.json_mime?('application/json; charset=UTF8')).to eq true
+      expect(api_client.json_mime?('APPLICATION/JSON')).to eq true
+
+      expect(api_client.json_mime?('application/xml')).to eq false
+      expect(api_client.json_mime?('text/plain')).to eq false
+      expect(api_client.json_mime?('application/jsonp')).to eq false
+    end
+  end
+
+  describe '#select_header_accept' do
+    let(:api_client) { DependencyTacker::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.select_header_accept(nil)).to be_nil
+      expect(api_client.select_header_accept([])).to be_nil
+
+      expect(api_client.select_header_accept(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_accept(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_accept(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+
+      expect(api_client.select_header_accept(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_accept(['text/html', 'application/xml'])).to eq('text/html,application/xml')
+    end
+  end
+
+  describe '#select_header_content_type' do
+    let(:api_client) { DependencyTacker::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.select_header_content_type(nil)).to eq('application/json')
+      expect(api_client.select_header_content_type([])).to eq('application/json')
+
+      expect(api_client.select_header_content_type(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_content_type(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_content_type(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+      expect(api_client.select_header_content_type(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_content_type(['text/plain', 'application/xml'])).to eq('text/plain')
+    end
+  end
+
+  describe '#sanitize_filename' do
+    let(:api_client) { DependencyTacker::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.sanitize_filename('sun')).to eq('sun')
+      expect(api_client.sanitize_filename('sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('../sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('/var/tmp/sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('./sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('..\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('c:\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('.\sun.gif')).to eq('sun.gif')
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,42 @@
+=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'
+
+describe DependencyTacker::Configuration do
+  let(:config) { DependencyTacker::Configuration.default }
+
+  before(:each) do
+    # uncomment below to setup host and base_path
+    # require 'URI'
+    # uri = URI.parse("http://localhost/api")
+    # DependencyTacker.configure do |c|
+    #   c.host = uri.host
+    #   c.base_path = uri.path
+    # end
+  end
+
+  describe '#base_url' do
+    it 'should have the default value' do
+      # uncomment below to test default value of the base path
+      # expect(config.base_url).to eq("http://localhost/api")
+    end
+
+    it 'should remove trailing slashes' do
+      [nil, '', '/', '//'].each do |base_path|
+        config.base_path = base_path
+        # uncomment below to test trailing slashes
+        # expect(config.base_url).to eq("http://localhost/api")
+      end
+    end
+  end
+end