nodeum_sdk 1.85.1

data/spec/api/tasks_api_spec.rb

@@ -0,0 +1,226 @@
+=begin
+#Nodeum API
+
+## About  This document describes the Nodeum API version 2:  If you are looking for any information about the product itself, reach the product website https://www.nodeum.io. You can also contact us at this email address : info@nodeum.io  # Filter parameters When browsing a list of items, multiple filter parameters may be applied. Some operators can be added to the value as a prefix:  - `=` value is equal. Default operator, may be omitted  - `!=` value is different  - `>` greater than  - `>=` greater than or equal  - `<` lower than  - `>=` lower than or equal  - `><` included in list, items should be separated by `|`  - `!><` not included in list, items should be separated by `|`  - `~` pattern matching, may include `%` (any characters) and `_` (one character)  - `!~` pattern not matching, may include `%` (any characters) and `_` (one character)  
+
+The version of the OpenAPI document: 2.1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Nodeum::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 = Nodeum::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(Nodeum::TasksApi)
+    end
+  end
+
+  # unit tests for create_task
+  # Creates a new task.
+  # **API Key Scope**: tasks / create 
+  # @param task_body 
+  # @param [Hash] opts the optional parameters
+  # @return [Task]
+  describe 'create_task 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 destroy_task
+  # Destroys a specific task.
+  # **API Key Scope**: tasks / destroy
+  # @param task_id Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'destroy_task 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 index_tasks
+  # Lists all tasks.
+  # **API Key Scope**: tasks / index
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit The number of items to display for pagination.
+  # @option opts [Integer] :offset The number of items to skip for pagination.
+  # @option opts [Array<String>] :sort_by Sort results by attribute.  Can sort on multiple attributes, separated by &#x60;|&#x60;. Order direction can be suffixing the attribute by either &#x60;:asc&#x60; (default) or &#x60;:desc&#x60;.
+  # @option opts [String] :id Filter on id
+  # @option opts [String] :name Filter on name
+  # @option opts [String] :comment Filter on comment
+  # @option opts [String] :workflow_type Filter on task workflow type
+  # @option opts [String] :workflow_action Filter on task workflow action
+  # @option opts [String] :source_type Filter on task source type
+  # @option opts [String] :destination_type Filter on task destination type
+  # @option opts [String] :priority Filter on priority
+  # @option opts [String] :conflict_resolution Filter on conflict resolution
+  # @option opts [String] :action Filter on action
+  # @option opts [String] :activate Filter on activate
+  # @option opts [String] :creation_date Filter on creation date
+  # @option opts [String] :creation_username Filter on creation username
+  # @option opts [String] :modification_date Filter on modification date
+  # @option opts [String] :modification_username Filter on modification username
+  # @option opts [String] :job_started Filter on job started
+  # @option opts [String] :job_finished Filter on job finished
+  # @option opts [String] :status Filter on status
+  # @option opts [String] :processed_size Filter on processed size
+  # @option opts [String] :to_process_size Filter on to process size
+  # @option opts [String] :source_pool_id Filter on task source pool id
+  # @option opts [String] :source_pool_name Filter on task source pool name
+  # @option opts [String] :source_tape_id Filter on task source tape id
+  # @option opts [String] :source_tape_barcode Filter on task source tape barcode
+  # @option opts [String] :destination_pool_id Filter on task destination pool id
+  # @option opts [String] :destination_pool_name Filter on task destination pool name
+  # @option opts [String] :destination_tape_id Filter on task destination tape id
+  # @option opts [String] :destination_tape_barcode Filter on task destination tape barcode
+  # @return [TaskCollection]
+  describe 'index_tasks 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 pause_task
+  # Pause a task.
+  # **API Key Scope**: tasks / action
+  # @param task_id Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID.
+  # @param [Hash] opts the optional parameters
+  # @return [ActiveJobStatus]
+  describe 'pause_task 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 pause_task_result
+  # Check result of a task pause request.
+  # **API Key Scope**: tasks / action
+  # @param task_id Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID.
+  # @param job_id ID of active job
+  # @param [Hash] opts the optional parameters
+  # @return [ActiveJobStatus]
+  describe 'pause_task_result 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 resume_task
+  # Resume a task.
+  # **API Key Scope**: tasks / action
+  # @param task_id Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID.
+  # @param [Hash] opts the optional parameters
+  # @return [ActiveJobStatus]
+  describe 'resume_task 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 resume_task_result
+  # Check result of a task resume request.
+  # **API Key Scope**: tasks / action
+  # @param task_id Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID.
+  # @param job_id ID of active job
+  # @param [Hash] opts the optional parameters
+  # @return [ActiveJobStatus]
+  describe 'resume_task_result 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 run_task
+  # Run a task.
+  # **API Key Scope**: tasks / action
+  # @param task_id Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID.
+  # @param [Hash] opts the optional parameters
+  # @return [ActiveJobStatus]
+  describe 'run_task 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 run_task_result
+  # Check result of a task run request.
+  # **API Key Scope**: tasks / action
+  # @param task_id Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID.
+  # @param job_id ID of active job
+  # @param [Hash] opts the optional parameters
+  # @return [ActiveJobStatus]
+  describe 'run_task_result 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 show_task
+  # Displays a specific task.
+  # **API Key Scope**: tasks / show
+  # @param task_id Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID.
+  # @param [Hash] opts the optional parameters
+  # @return [Task]
+  describe 'show_task 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 stop_task
+  # Stop a task.
+  # **API Key Scope**: tasks / action
+  # @param task_id Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID.
+  # @param [Hash] opts the optional parameters
+  # @return [ActiveJobStatus]
+  describe 'stop_task 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 stop_task_result
+  # Check result of a task stop request.
+  # **API Key Scope**: tasks / action
+  # @param task_id Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID.
+  # @param job_id ID of active job
+  # @param [Hash] opts the optional parameters
+  # @return [ActiveJobStatus]
+  describe 'stop_task_result 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_task
+  # Updates a specific task.
+  # **API Key Scope**: tasks / update
+  # @param task_id Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID.
+  # @param task_body 
+  # @param [Hash] opts the optional parameters
+  # @return [Task]
+  describe 'update_task 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/users_api_spec.rb

@@ -0,0 +1,119 @@
+=begin
+#Nodeum API
+
+## About  This document describes the Nodeum API version 2:  If you are looking for any information about the product itself, reach the product website https://www.nodeum.io. You can also contact us at this email address : info@nodeum.io  # Filter parameters When browsing a list of items, multiple filter parameters may be applied. Some operators can be added to the value as a prefix:  - `=` value is equal. Default operator, may be omitted  - `!=` value is different  - `>` greater than  - `>=` greater than or equal  - `<` lower than  - `>=` lower than or equal  - `><` included in list, items should be separated by `|`  - `!><` not included in list, items should be separated by `|`  - `~` pattern matching, may include `%` (any characters) and `_` (one character)  - `!~` pattern not matching, may include `%` (any characters) and `_` (one character)  
+
+The version of the OpenAPI document: 2.1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Nodeum::UsersApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'UsersApi' do
+  before do
+    # run before each test
+    @api_instance = Nodeum::UsersApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of UsersApi' do
+    it 'should create an instance of UsersApi' do
+      expect(@api_instance).to be_instance_of(Nodeum::UsersApi)
+    end
+  end
+
+  # unit tests for create_api_key
+  # Creates a new API Key for current user.
+  # **API Key Scope**: api_keys / create
+  # @param api_key_body 
+  # @param [Hash] opts the optional parameters
+  # @return [ApiKeyFull]
+  describe 'create_api_key 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 destroy_api_key
+  # Destroys a specific API Key.
+  # **API Key Scope**: api_keys / destroy
+  # @param api_key_id Numeric ID of API Key.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'destroy_api_key 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 index_api_keys
+  # Lists all API keys of current user.
+  # **API Key Scope**: api_keys / index
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit The number of items to display for pagination.
+  # @option opts [Integer] :offset The number of items to skip for pagination.
+  # @return [ApiKeyCollection]
+  describe 'index_api_keys 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 index_system_groups
+  # List all system groups.
+  # **API Key Scope**: groups / systems
+  # @param [Hash] opts the optional parameters
+  # @return [SystemGroupCollection]
+  describe 'index_system_groups test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for index_system_users
+  # List all system users.
+  # **API Key Scope**: users / systems
+  # @param [Hash] opts the optional parameters
+  # @return [SystemUserCollection]
+  describe 'index_system_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 show_api_key
+  # Displays a specific API Key with its scopes.
+  # **API Key Scope**: api_keys / show
+  # @param api_key_id Numeric ID of API Key.
+  # @param [Hash] opts the optional parameters
+  # @return [ApiKeyFull]
+  describe 'show_api_key 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_api_key
+  # Updates a specific API Key.
+  # **API Key Scope**: api_keys / update
+  # @param api_key_id Numeric ID of API Key.
+  # @param api_key_body 
+  # @param [Hash] opts the optional parameters
+  # @return [ApiKeyFull]
+  describe 'update_api_key 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
+#Nodeum API
+
+## About  This document describes the Nodeum API version 2:  If you are looking for any information about the product itself, reach the product website https://www.nodeum.io. You can also contact us at this email address : info@nodeum.io  # Filter parameters When browsing a list of items, multiple filter parameters may be applied. Some operators can be added to the value as a prefix:  - `=` value is equal. Default operator, may be omitted  - `!=` value is different  - `>` greater than  - `>=` greater than or equal  - `<` lower than  - `>=` lower than or equal  - `><` included in list, items should be separated by `|`  - `!><` not included in list, items should be separated by `|`  - `~` pattern matching, may include `%` (any characters) and `_` (one character)  - `!~` pattern not matching, may include `%` (any characters) and `_` (one character)  
+
+The version of the OpenAPI document: 2.1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.0
+
+=end
+
+require 'spec_helper'
+
+describe Nodeum::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          Nodeum.configure { |c| c.host = 'http://example.com' }
+          expect(Nodeum::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          Nodeum.configure { |c| c.host = 'https://wookiee.com' }
+          expect(Nodeum::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          Nodeum.configure { |c| c.host = 'hobo.com/v4' }
+          expect(Nodeum::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          Nodeum.configure { |c| c.base_path = 'v4/dog' }
+          expect(Nodeum::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          Nodeum.configure { |c| c.base_path = '/v4/dog' }
+          expect(Nodeum::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          Nodeum.configure { |c| c.base_path = nil }
+          expect(Nodeum::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe 'params_encoding in #build_request' do
+    let(:config) { Nodeum::Configuration.new }
+    let(:api_client) { Nodeum::ApiClient.new(config) }
+
+    it 'defaults to nil' do
+      expect(Nodeum::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) { Nodeum::Configuration.new }
+    let(:api_client) { Nodeum::ApiClient.new(config) }
+
+    it 'defaults to 0' do
+      expect(Nodeum::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 = Nodeum::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 = Nodeum::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 = Nodeum::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 = Nodeum::ApiClient.new
+      # _model = Nodeum::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) { Nodeum::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) { Nodeum::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) { Nodeum::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) { Nodeum::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) { Nodeum::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