korona-entry-client 1.0.0

data/spec/api/external_ticket_configurations_api_spec.rb

@@ -0,0 +1,95 @@
+=begin
+#KORONA.entry API v1
+
+#Our api provides access to our entry services
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for KoronaEntryClient::ExternalTicketConfigurationsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ExternalTicketConfigurationsApi' do
+  before do
+    # run before each test
+    @api_instance = KoronaEntryClient::ExternalTicketConfigurationsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ExternalTicketConfigurationsApi' do
+    it 'should create an instance of ExternalTicketConfigurationsApi' do
+      expect(@api_instance).to be_instance_of(KoronaEntryClient::ExternalTicketConfigurationsApi)
+    end
+  end
+
+  # unit tests for create_external_ticket_configurations
+  # Creates a new external ticket configuration. If an unkown ticket number will be checked and the pattern of the ticket number will be equals to a pattern of a external ticket configuration, a new ticket will be created. The TicketEntry of the external ticket configuration will be copied and adjusted to the new ticket. The newly created ticket is then checked for validity.
+  # @param client Identification of executing client.
+  # @param body Properties to update of the external ticket configuration.
+  # @param [Hash] opts the optional parameters
+  # @return [ModelReference]
+  describe 'create_external_ticket_configurations 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_external_ticket_configuration
+  # Deletes the single external ticket configuration.
+  # @param client Identification of executing client.
+  # @param external_ticket_configuration_id ID to identify the external ticket configuration.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_external_ticket_configuration 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_external_ticket_configuration
+  # Returns the external ticket configuration.
+  # @param client Identification of executing client.
+  # @param external_ticket_configuration_id ID to identify the external ticket configuration.
+  # @param [Hash] opts the optional parameters
+  # @return [ExternalTicketConfiguration]
+  describe 'get_external_ticket_configuration 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_external_ticket_configurations
+  # Returns all external ticket configurations
+  # @param client Identification of executing client.
+  # @param [Hash] opts the optional parameters
+  # @return [ExternalTicketConfigurationList]
+  describe 'get_external_ticket_configurations 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_external_ticket_configuration
+  # Updates the single external ticket configuration.
+  # @param client Identification of executing client.
+  # @param external_ticket_configuration_id ID to identify the external ticket configuration.
+  # @param body Properties to update of the external ticket configuration.
+  # @param [Hash] opts the optional parameters
+  # @return [ModelReference]
+  describe 'update_external_ticket_configuration 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/organizational_units_api_spec.rb

@@ -0,0 +1,95 @@
+=begin
+#KORONA.entry API v1
+
+#Our api provides access to our entry services
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for KoronaEntryClient::OrganizationalUnitsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'OrganizationalUnitsApi' do
+  before do
+    # run before each test
+    @api_instance = KoronaEntryClient::OrganizationalUnitsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of OrganizationalUnitsApi' do
+    it 'should create an instance of OrganizationalUnitsApi' do
+      expect(@api_instance).to be_instance_of(KoronaEntryClient::OrganizationalUnitsApi)
+    end
+  end
+
+  # unit tests for create_organizational_unit
+  # Creates a new organizational unit.
+  # @param client Identification of executing client.
+  # @param body Properties to update of the organizational unit.
+  # @param [Hash] opts the optional parameters
+  # @return [ModelReference]
+  describe 'create_organizational_unit 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_organizational_unit
+  # Deletes the single organizational unit.
+  # @param client Identification of executing client.
+  # @param organizational_unit_id ID to identify the organizational unit.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_organizational_unit 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_organizational_unit
+  # Returns the single organizational unit.
+  # @param client Identification of executing client.
+  # @param organizational_unit_id ID to identify the organizational unit.
+  # @param [Hash] opts the optional parameters
+  # @return [OrganizationalUnit]
+  describe 'get_organizational_unit 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_organizational_units
+  # Returns all organizational unit
+  # @param client Identification of executing client.
+  # @param [Hash] opts the optional parameters
+  # @return [OrganizationalUnitList]
+  describe 'get_organizational_units 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_organizational_unit
+  # Updates the single organizational unit.
+  # @param client Identification of executing client.
+  # @param organizational_unit_id ID to identify the organizational unit.
+  # @param body Properties to update of the organizational unit.
+  # @param [Hash] opts the optional parameters
+  # @return [ModelReference]
+  describe 'update_organizational_unit 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/tickets_api_spec.rb

@@ -0,0 +1,191 @@
+=begin
+#KORONA.entry API v1
+
+#Our api provides access to our entry services
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for KoronaEntryClient::TicketsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'TicketsApi' do
+  before do
+    # run before each test
+    @api_instance = KoronaEntryClient::TicketsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of TicketsApi' do
+    it 'should create an instance of TicketsApi' do
+      expect(@api_instance).to be_instance_of(KoronaEntryClient::TicketsApi)
+    end
+  end
+
+  # unit tests for check_ticket
+  # Checks a ticket. The entry can optionally also be committed.
+  # @param client Identification of executing client.
+  # @param ticket_number Ticket number to be checked.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :commit_entry True if entry should be committed.
+  # @option opts [String] :commit_type 
+  # @option opts [String] :organizational_unit_number Number of organizational unit.
+  # @option opts [DateTime] :time The time to be checked. *Now* if not specified further.
+  # @option opts [Integer] :number_of_uses Number of uses. *1* if not specified further.
+  # @return [EntryResponse]
+  describe 'check_ticket 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_ticket
+  # Creates a new ticket.
+  # @param client Identification of executing client.
+  # @param body Properties to update of the ticket.
+  # @param [Hash] opts the optional parameters
+  # @return [ModelReference]
+  describe 'create_ticket 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_image
+  # Deletes the owners image of the ticket.
+  # @param client Identification of executing client.
+  # @param ticket_id ID to identify the ticket.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_image 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_ticket
+  # Deletes the single ticket.
+  # @param client Identification of executing client.
+  # @param ticket_id ID to identify the ticket.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_ticket 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_image
+  # Returns the owners image of the ticket
+  # @param client Identification of executing client.
+  # @param ticket_id ID to identify the ticket.
+  # @param [Hash] opts the optional parameters
+  # @return [TicketImage]
+  describe 'get_image 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
+  # Returns the log for a optional single ticket and/or organizational unit
+  # @param client Identification of executing client.
+  # @param time_from Log time from.
+  # @param time_to Log time to.
+  # @param log_types Restrict the logs to specific log events.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :ticket_number Optional filter to restrict the logs to actions to the specified ticket.
+  # @option opts [String] :organizational_unit_number Optional filter to restrict the logs to actions within the specified organizational unit.
+  # @return [TicketEntryLogList]
+  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_ticket
+  # Returns the single ticket.
+  # @param client Identification of executing client.
+  # @param ticket_id ID to identify the ticket.
+  # @param [Hash] opts the optional parameters
+  # @return [Ticket]
+  describe 'get_ticket 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_ticket_entry
+  # Returns a single ticket entry.
+  # @param client Identification of executing client.
+  # @param ticket_id ID to identify the ticket.
+  # @param ticket_entry_id ID to identify the ticket entry of the ticket.
+  # @param [Hash] opts the optional parameters
+  # @return [TicketEntry]
+  describe 'get_ticket_entry 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_tickets
+  # Lists all tickets.
+  # @param client Identification of executing client.
+  # @param offset Position in the dataset to start to retrieve.
+  # @param page_size Amount of objects to return per page.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :ticket_number Restrict the list for a specific ticket number
+  # @option opts [DateTime] :create_date_from Restrict the list for begin of creation date.
+  # @option opts [DateTime] :create_date_to Restrict the list for end of creation date.
+  # @option opts [DateTime] :deactivation_date_from Restrict the list for start of deactivation date.
+  # @option opts [DateTime] :deactivation_date_to Restrict the list for end of deactivation date.
+  # @option opts [Boolean] :locked Restrict the list for locked tickets.
+  # @option opts [DateTime] :locked_to_date_from Restrict the list for for locked tickets.
+  # @option opts [DateTime] :locked_to_date_to Restrict the list for for locked tickets.
+  # @option opts [String] :personalization_customer_number Restrict the list for tickets owned by customers with specific customer number.
+  # @option opts [String] :personalization_lastname Restrict the list for tickets owned by customers with specific last name.
+  # @option opts [String] :personalization_firstname Restrict the list for tickets owned by customers with specific first name.
+  # @return [TicketList]
+  describe 'get_tickets 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_image
+  # Updates the owners image of the ticket
+  # @param client Identification of executing client.
+  # @param ticket_id ID to identify the ticket.
+  # @param body Properties to update of the image.
+  # @param [Hash] opts the optional parameters
+  # @return [ModelReference]
+  describe 'update_image 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_ticket
+  # Updates the single ticket.
+  # @param client Identification of executing client.
+  # @param ticket_id ID to identify the ticket.
+  # @param body Properties to update of the ticket.
+  # @param [Hash] opts the optional parameters
+  # @return [ModelReference]
+  describe 'update_ticket 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
+#KORONA.entry API v1
+
+#Our api provides access to our entry services
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.0
+
+=end
+
+require 'spec_helper'
+
+describe KoronaEntryClient::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          KoronaEntryClient.configure { |c| c.host = 'http://example.com' }
+          expect(KoronaEntryClient::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          KoronaEntryClient.configure { |c| c.host = 'https://wookiee.com' }
+          expect(KoronaEntryClient::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          KoronaEntryClient.configure { |c| c.host = 'hobo.com/v4' }
+          expect(KoronaEntryClient::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          KoronaEntryClient.configure { |c| c.base_path = 'v4/dog' }
+          expect(KoronaEntryClient::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          KoronaEntryClient.configure { |c| c.base_path = '/v4/dog' }
+          expect(KoronaEntryClient::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          KoronaEntryClient.configure { |c| c.base_path = nil }
+          expect(KoronaEntryClient::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe 'params_encoding in #build_request' do
+    let(:config) { KoronaEntryClient::Configuration.new }
+    let(:api_client) { KoronaEntryClient::ApiClient.new(config) }
+
+    it 'defaults to nil' do
+      expect(KoronaEntryClient::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) { KoronaEntryClient::Configuration.new }
+    let(:api_client) { KoronaEntryClient::ApiClient.new(config) }
+
+    it 'defaults to 0' do
+      expect(KoronaEntryClient::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 = KoronaEntryClient::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 = KoronaEntryClient::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 = KoronaEntryClient::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 = KoronaEntryClient::ApiClient.new
+      # _model = KoronaEntryClient::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) { KoronaEntryClient::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) { KoronaEntryClient::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) { KoronaEntryClient::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) { KoronaEntryClient::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) { KoronaEntryClient::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