pulpcore_client 3.0.0rc2

data/spec/api/status_api_spec.rb

@@ -0,0 +1,46 @@
+=begin
+#Pulp 3 API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.1-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for PulpcoreClient::StatusApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'StatusApi' do
+  before do
+    # run before each test
+    @api_instance = PulpcoreClient::StatusApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of StatusApi' do
+    it 'should create an instance of StatusApi' do
+      expect(@api_instance).to be_instance_of(PulpcoreClient::StatusApi)
+    end
+  end
+
+  # unit tests for status_list
+  # Inspect status of Pulp
+  # Returns app information including the version of pulpcore and loaded pulp plugins, known workers, database connection status, and messaging connection status
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'status_list 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/tasks_api_spec.rb

@@ -0,0 +1,102 @@
+=begin
+#Pulp 3 API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.1-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for PulpcoreClient::TasksApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'TasksApi' do
+  before do
+    # run before each test
+    @api_instance = PulpcoreClient::TasksApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of TasksApi' do
+    it 'should create an instance of TasksApi' do
+      expect(@api_instance).to be_instance_of(PulpcoreClient::TasksApi)
+    end
+  end
+
+  # unit tests for tasks_cancel
+  # Cancel a task
+  # This operation cancels a task.
+  # @param task_href URI of Task. e.g.: /pulp/api/v3/tasks/1/
+  # @param data 
+  # @param [Hash] opts the optional parameters
+  # @return [Task]
+  describe 'tasks_cancel 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 tasks_delete
+  # Delete a task
+  # @param task_href URI of Task. e.g.: /pulp/api/v3/tasks/1/
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'tasks_delete 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 tasks_list
+  # List tasks
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :ordering Which field to use when ordering the results.
+  # @option opts [String] :state 
+  # @option opts [String] :state__in Filter results where state is in a comma-separated list of values
+  # @option opts [String] :worker Foreign Key referenced by HREF
+  # @option opts [String] :worker__in Filter results where worker is in a comma-separated list of values
+  # @option opts [String] :name__contains Filter results where name contains value
+  # @option opts [String] :started_at__lt Filter results where started_at is less than value
+  # @option opts [String] :started_at__lte Filter results where started_at is less than or equal to value
+  # @option opts [String] :started_at__gt Filter results where started_at is greater than value
+  # @option opts [String] :started_at__gte Filter results where started_at is greater than or equal to value
+  # @option opts [String] :started_at__range Filter results where started_at is between two comma separated values
+  # @option opts [String] :finished_at__lt Filter results where finished_at is less than value
+  # @option opts [String] :finished_at__lte Filter results where finished_at is less than or equal to value
+  # @option opts [String] :finished_at__gt Filter results where finished_at is greater than value
+  # @option opts [String] :finished_at__gte Filter results where finished_at is greater than or equal to value
+  # @option opts [String] :finished_at__range Filter results where finished_at is between two comma separated values
+  # @option opts [String] :parent Foreign Key referenced by HREF
+  # @option opts [String] :name 
+  # @option opts [String] :started_at ISO 8601 formatted dates are supported
+  # @option opts [String] :finished_at ISO 8601 formatted dates are supported
+  # @option opts [Integer] :page A page number within the paginated result set.
+  # @option opts [Integer] :page_size Number of results to return per page.
+  # @return [InlineResponse2003]
+  describe 'tasks_list 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 tasks_read
+  # Inspect a task
+  # @param task_href URI of Task. e.g.: /pulp/api/v3/tasks/1/
+  # @param [Hash] opts the optional parameters
+  # @return [Task]
+  describe 'tasks_read 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/uploads_api_spec.rb

@@ -0,0 +1,123 @@
+=begin
+#Pulp 3 API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.1-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for PulpcoreClient::UploadsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'UploadsApi' do
+  before do
+    # run before each test
+    @api_instance = PulpcoreClient::UploadsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of UploadsApi' do
+    it 'should create an instance of UploadsApi' do
+      expect(@api_instance).to be_instance_of(PulpcoreClient::UploadsApi)
+    end
+  end
+
+  # unit tests for uploads_create
+  # Start Upload
+  # Start a chunked upload by uploading the first chunk.
+  # @param file A chunk of a file to upload.
+  # @param [Hash] opts the optional parameters
+  # @return [Upload]
+  describe 'uploads_create 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 uploads_create_and_check
+  # Create an Upload
+  # Create an upload from a entire file as one chunk.
+  # @param file The full file to upload.
+  # @param md5 The expected MD5 checksum of the file.
+  # @param [Hash] opts the optional parameters
+  # @return [Upload]
+  describe 'uploads_create_and_check 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 uploads_delete
+  # Delete an upload
+  # View for chunked uploads.
+  # @param upload_href URI of Upload. e.g.: /pulp/api/v3/uploads/1/
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'uploads_delete 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 uploads_finish
+  # Finish an Upload
+  # Mark the Upload as \"complete\".  The md5 checksum is used to validate the integrity of the upload.
+  # @param upload_href URI of Upload. e.g.: /pulp/api/v3/uploads/1/
+  # @param md5 The expected MD5 checksum of the file.
+  # @param [Hash] opts the optional parameters
+  # @return [Upload]
+  describe 'uploads_finish 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 uploads_list
+  # List uploads
+  # List all the uploads.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page A page number within the paginated result set.
+  # @option opts [Integer] :page_size Number of results to return per page.
+  # @return [InlineResponse2004]
+  describe 'uploads_list 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 uploads_read
+  # Inspect an upload
+  # View for chunked uploads.
+  # @param upload_href URI of Upload. e.g.: /pulp/api/v3/uploads/1/
+  # @param [Hash] opts the optional parameters
+  # @return [Upload]
+  describe 'uploads_read 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 uploads_update
+  # Continue an Upload
+  # Continue the upload by uploading the next file chunk.
+  # @param upload_href URI of Upload. e.g.: /pulp/api/v3/uploads/1/
+  # @param file A chunk of a file to upload.
+  # @param [Hash] opts the optional parameters
+  # @return [Upload]
+  describe 'uploads_update 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/workers_api_spec.rb

@@ -0,0 +1,68 @@
+=begin
+#Pulp 3 API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.1-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for PulpcoreClient::WorkersApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'WorkersApi' do
+  before do
+    # run before each test
+    @api_instance = PulpcoreClient::WorkersApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of WorkersApi' do
+    it 'should create an instance of WorkersApi' do
+      expect(@api_instance).to be_instance_of(PulpcoreClient::WorkersApi)
+    end
+  end
+
+  # unit tests for workers_list
+  # List workers
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :name 
+  # @option opts [String] :name__in Filter results where name is in a comma-separated list of values
+  # @option opts [String] :last_heartbeat__lt Filter results where last_heartbeat is less than value
+  # @option opts [String] :last_heartbeat__lte Filter results where last_heartbeat is less than or equal to value
+  # @option opts [String] :last_heartbeat__gt Filter results where last_heartbeat is greater than value
+  # @option opts [String] :last_heartbeat__gte Filter results where last_heartbeat is greater than or equal to value
+  # @option opts [String] :last_heartbeat__range Filter results where last_heartbeat is between two comma separated values
+  # @option opts [String] :online 
+  # @option opts [String] :missing 
+  # @option opts [String] :last_heartbeat ISO 8601 formatted dates are supported
+  # @option opts [Integer] :page A page number within the paginated result set.
+  # @option opts [Integer] :page_size Number of results to return per page.
+  # @return [InlineResponse2005]
+  describe 'workers_list 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 workers_read
+  # Inspect a worker
+  # @param worker_href URI of Worker. e.g.: /pulp/api/v3/workers/1/
+  # @param [Hash] opts the optional parameters
+  # @return [Worker]
+  describe 'workers_read 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
+#Pulp 3 API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.1-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+
+describe PulpcoreClient::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          PulpcoreClient.configure { |c| c.host = 'http://example.com' }
+          expect(PulpcoreClient::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          PulpcoreClient.configure { |c| c.host = 'https://wookiee.com' }
+          expect(PulpcoreClient::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          PulpcoreClient.configure { |c| c.host = 'hobo.com/v4' }
+          expect(PulpcoreClient::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          PulpcoreClient.configure { |c| c.base_path = 'v4/dog' }
+          expect(PulpcoreClient::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          PulpcoreClient.configure { |c| c.base_path = '/v4/dog' }
+          expect(PulpcoreClient::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          PulpcoreClient.configure { |c| c.base_path = nil }
+          expect(PulpcoreClient::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe 'params_encoding in #build_request' do
+    let(:config) { PulpcoreClient::Configuration.new }
+    let(:api_client) { PulpcoreClient::ApiClient.new(config) }
+
+    it 'defaults to nil' do
+      expect(PulpcoreClient::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) { PulpcoreClient::Configuration.new }
+    let(:api_client) { PulpcoreClient::ApiClient.new(config) }
+
+    it 'defaults to 0' do
+      expect(PulpcoreClient::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 = PulpcoreClient::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 = PulpcoreClient::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 = PulpcoreClient::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 = PulpcoreClient::ApiClient.new
+      # _model = PulpcoreClient::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) { PulpcoreClient::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) { PulpcoreClient::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) { PulpcoreClient::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) { PulpcoreClient::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) { PulpcoreClient::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
+#Pulp 3 API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.1-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+
+describe PulpcoreClient::Configuration do
+  let(:config) { PulpcoreClient::Configuration.default }
+
+  before(:each) do
+    # uncomment below to setup host and base_path
+    # require 'URI'
+    # uri = URI.parse("http://localhost:24817")
+    # PulpcoreClient.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:24817")
+    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:24817")
+      end
+    end
+  end
+end