harbor2_client 0.1.0

data/spec/api/project_api_spec.rb

@@ -0,0 +1,160 @@
+=begin
+#Harbor API
+
+#These APIs provide services for manipulating Harbor project.
+
+OpenAPI spec version: 2.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.17
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Harbor2Client::ProjectApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'ProjectApi' do
+  before do
+    # run before each test
+    @instance = Harbor2Client::ProjectApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ProjectApi' do
+    it 'should create an instance of ProjectApi' do
+      expect(@instance).to be_instance_of(Harbor2Client::ProjectApi)
+    end
+  end
+
+  # unit tests for create_project
+  # Create a new project.
+  # This endpoint is for user to create a new project.
+  # @param project New created project.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @return [nil]
+  describe 'create_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 delete_project
+  # Delete project by projectID
+  # This endpoint is aimed to delete project by project ID.
+  # @param project_id The ID of the project
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @return [nil]
+  describe 'delete_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_logs
+  # Get recent logs of the projects
+  # Get recent logs of the projects
+  # @param project_name The name of the project
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @option opts [String] :q Query string to query resources. Supported query patterns are \"exact match(k=v)\", \"fuzzy match(k=~v)\", \"range(k=[min~max])\", \"list with union releationship(k={v1 v2 v3})\" and \"list with intersetion relationship(k=(v1 v2 v3))\". The value of range and list can be string(enclosed by \" or '), integer or time(in format \"2020-04-09 02:36:00\"). All of these query patterns should be put in the query string \"q=xxx\" and splitted by \",\". e.g. q=k1=v1,k2=~v2,k3=[min~max]
+  # @option opts [Integer] :page The page number
+  # @option opts [Integer] :page_size The size of per page
+  # @return [Array<AuditLog>]
+  describe 'get_logs 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
+  # Return specific project detail information
+  # This endpoint returns specific project information by project ID.
+  # @param project_id The ID of the project
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @return [Project]
+  describe 'get_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_project_deletable
+  # Get the deletable status of the project
+  # Get the deletable status of the project
+  # @param project_id The ID of the project
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @return [ProjectDeletable]
+  describe 'get_project_deletable 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_summary
+  # Get summary of the project.
+  # Get summary of the project.
+  # @param project_id The ID of the project
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @return [ProjectSummary]
+  describe 'get_project_summary 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 head_project
+  # Check if the project name user provided already exists.
+  # This endpoint is used to check if the project name provided already exist.
+  # @param project_name Project name for checking exists.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @return [nil]
+  describe 'head_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 list_projects
+  # List projects
+  # This endpoint returns projects created by Harbor.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @option opts [Integer] :page The page number
+  # @option opts [Integer] :page_size The size of per page
+  # @option opts [String] :name The name of project.
+  # @option opts [BOOLEAN] :public The project is public or private.
+  # @option opts [String] :owner The name of project owner.
+  # @return [Array<Project>]
+  describe 'list_projects 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_project
+  # Update properties for a selected project.
+  # This endpoint is aimed to update the properties of a project.
+  # @param project_id The ID of the project
+  # @param project Updates of project.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @return [nil]
+  describe 'update_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/repository_api_spec.rb

@@ -0,0 +1,94 @@
+=begin
+#Harbor API
+
+#These APIs provide services for manipulating Harbor project.
+
+OpenAPI spec version: 2.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.17
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Harbor2Client::RepositoryApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'RepositoryApi' do
+  before do
+    # run before each test
+    @instance = Harbor2Client::RepositoryApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of RepositoryApi' do
+    it 'should create an instance of RepositoryApi' do
+      expect(@instance).to be_instance_of(Harbor2Client::RepositoryApi)
+    end
+  end
+
+  # unit tests for delete_repository
+  # Delete repository
+  # Delete the repository specified by name
+  # @param project_name The name of the project
+  # @param repository_name The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @return [nil]
+  describe 'delete_repository 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_repository
+  # Get repository
+  # Get the repository specified by name
+  # @param project_name The name of the project
+  # @param repository_name The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @return [Repository]
+  describe 'get_repository 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 list_repositories
+  # List repositories
+  # List repositories of the specified project
+  # @param project_name The name of the project
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @option opts [String] :q Query string to query resources. Supported query patterns are \"exact match(k=v)\", \"fuzzy match(k=~v)\", \"range(k=[min~max])\", \"list with union releationship(k={v1 v2 v3})\" and \"list with intersetion relationship(k=(v1 v2 v3))\". The value of range and list can be string(enclosed by \" or '), integer or time(in format \"2020-04-09 02:36:00\"). All of these query patterns should be put in the query string \"q=xxx\" and splitted by \",\". e.g. q=k1=v1,k2=~v2,k3=[min~max]
+  # @option opts [Integer] :page The page number
+  # @option opts [Integer] :page_size The size of per page
+  # @return [Array<Repository>]
+  describe 'list_repositories 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_repository
+  # Update repository
+  # Update the repository specified by name
+  # @param project_name The name of the project
+  # @param repository_name The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -&gt; a%252Fb
+  # @param repository The JSON object of repository.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @return [nil]
+  describe 'update_repository 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/scan_api_spec.rb

@@ -0,0 +1,66 @@
+=begin
+#Harbor API
+
+#These APIs provide services for manipulating Harbor project.
+
+OpenAPI spec version: 2.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.17
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Harbor2Client::ScanApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'ScanApi' do
+  before do
+    # run before each test
+    @instance = Harbor2Client::ScanApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ScanApi' do
+    it 'should create an instance of ScanApi' do
+      expect(@instance).to be_instance_of(Harbor2Client::ScanApi)
+    end
+  end
+
+  # unit tests for get_report_log
+  # Get the log of the scan report
+  # Get the log of the scan report
+  # @param project_name The name of the project
+  # @param repository_name The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb
+  # @param reference The reference of the artifact, can be digest or tag
+  # @param report_id The report id to get the log
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @return [String]
+  describe 'get_report_log 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 scan_artifact
+  # Scan the artifact
+  # Scan the specified artifact
+  # @param project_name The name of the project
+  # @param repository_name The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb
+  # @param reference The reference of the artifact, can be digest or tag
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_request_id An unique ID for the request
+  # @return [nil]
+  describe 'scan_artifact 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,243 @@
+=begin
+#Harbor API
+
+#These APIs provide services for manipulating Harbor project.
+
+OpenAPI spec version: 2.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.17
+
+=end
+
+require 'spec_helper'
+
+describe Harbor2Client::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          Harbor2Client.configure { |c| c.host = 'http://example.com' }
+          expect(Harbor2Client::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          Harbor2Client.configure { |c| c.host = 'https://wookiee.com' }
+          expect(Harbor2Client::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          Harbor2Client.configure { |c| c.host = 'hobo.com/v4' }
+          expect(Harbor2Client::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          Harbor2Client.configure { |c| c.base_path = 'v4/dog' }
+          expect(Harbor2Client::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          Harbor2Client.configure { |c| c.base_path = '/v4/dog' }
+          expect(Harbor2Client::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          Harbor2Client.configure { |c| c.base_path = nil }
+          expect(Harbor2Client::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe 'params_encoding in #build_request' do
+    let(:config) { Harbor2Client::Configuration.new }
+    let(:api_client) { Harbor2Client::ApiClient.new(config) }
+
+    it 'defaults to nil' do
+      expect(Harbor2Client::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) { Harbor2Client::Configuration.new }
+    let(:api_client) { Harbor2Client::ApiClient.new(config) }
+
+    it 'defaults to 0' do
+      expect(Harbor2Client::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 '#build_request' do
+    let(:config) { Harbor2Client::Configuration.new }
+    let(:api_client) { Harbor2Client::ApiClient.new(config) }
+
+    it 'does not send multipart to request' do
+      expect(Typhoeus::Request).to receive(:new).with(anything, hash_not_including(:multipart))
+      api_client.build_request(:get, '/test')
+    end
+
+    context 'when the content type is multipart' do
+      it 'sends multipart to request' do
+        expect(Typhoeus::Request).to receive(:new).with(anything, hash_including(multipart: true))
+        api_client.build_request(:get, '/test', {header_params: { 'Content-Type' => 'multipart/form-data'}})
+      end
+    end
+  end
+
+  describe '#deserialize' do
+    it "handles Array<Integer>" do
+      api_client = Harbor2Client::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 = Harbor2Client::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 = Harbor2Client::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 = Harbor2Client::ApiClient.new
+      # _model = Harbor2Client::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) { Harbor2Client::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(proc { api_client.build_collection_param(param, :INVALID) }).to raise_error(RuntimeError, 'unknown collection format: :INVALID')
+    end
+  end
+
+  describe '#json_mime?' do
+    let(:api_client) { Harbor2Client::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) { Harbor2Client::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) { Harbor2Client::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) { Harbor2Client::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