insights-approval-api-client 1.2.0

data/spec/api/action_api_spec.rb

@@ -0,0 +1,72 @@
+=begin
+#Insights Service Approval APIs
+
+#APIs to query approval service
+
+The version of the OpenAPI document: 1.2.0
+Contact: support@redhat.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.2
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ApprovalApiClient::ActionApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ActionApi' do
+  before do
+    # run before each test
+    @api_instance = ApprovalApiClient::ActionApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ActionApi' do
+    it 'should create an instance of ActionApi' do
+      expect(@api_instance).to be_instance_of(ApprovalApiClient::ActionApi)
+    end
+  end
+
+  # unit tests for create_action
+  # Add an action to a given request
+  # Add an action to a given request. Admin can do approve, deny, memo, and cancel operations; approver can do approve, deny and memo operations; while requester can do only cancel operation.
+  # @param request_id Id of request
+  # @param action Action object that will be added
+  # @param [Hash] opts the optional parameters
+  # @return [Action]
+  describe 'create_action 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_actions_by_request
+  # List all actions of a request
+  # Return actions in a given request, available for admin/approver
+  # @param request_id Id of request
+  # @param [Hash] opts the optional parameters
+  # @return [ActionCollection]
+  describe 'list_actions_by_request 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_action
+  # Return an user action by id
+  # Return an user action by id, available to all
+  # @param id Query by id
+  # @param [Hash] opts the optional parameters
+  # @return [Action]
+  describe 'show_action 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/graphql_api_spec.rb

@@ -0,0 +1,47 @@
+=begin
+#Insights Service Approval APIs
+
+#APIs to query approval service
+
+The version of the OpenAPI document: 1.2.0
+Contact: support@redhat.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.2
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ApprovalApiClient::GraphqlApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'GraphqlApi' do
+  before do
+    # run before each test
+    @api_instance = ApprovalApiClient::GraphqlApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of GraphqlApi' do
+    it 'should create an instance of GraphqlApi' do
+      expect(@api_instance).to be_instance_of(ApprovalApiClient::GraphqlApi)
+    end
+  end
+
+  # unit tests for post_graphql
+  # Perform a GraphQL Query
+  # Performs a GraphQL Query
+  # @param graphql_in GraphQL Query Request
+  # @param [Hash] opts the optional parameters
+  # @return [GraphqlOut]
+  describe 'post_graphql 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/request_api_spec.rb

@@ -0,0 +1,100 @@
+=begin
+#Insights Service Approval APIs
+
+#APIs to query approval service
+
+The version of the OpenAPI document: 1.2.0
+Contact: support@redhat.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.2
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ApprovalApiClient::RequestApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'RequestApi' do
+  before do
+    # run before each test
+    @api_instance = ApprovalApiClient::RequestApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of RequestApi' do
+    it 'should create an instance of RequestApi' do
+      expect(@api_instance).to be_instance_of(ApprovalApiClient::RequestApi)
+    end
+  end
+
+  # unit tests for create_request
+  # Add an approval request by given parameters
+  # Add an approval request by given parameters, available to anyone
+  # @param request_in Parameters need to create a request
+  # @param [Hash] opts the optional parameters
+  # @return [Request]
+  describe 'create_request 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_requests
+  # Return an array of requester made approval requests, available to anyone
+  # The result depends on the x-rh-persona header (approval/admin, approval/requseter, or approval/approver). Program generated child requests are not included.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_rh_persona Current login user's persona
+  # @option opts [Integer] :limit How many items to return at one time (max 1000)
+  # @option opts [Integer] :offset Starting Offset
+  # @option opts [Object] :filter Filter for querying collections.
+  # @option opts [String] :sort_by Parameter to sort collection
+  # @return [RequestCollection]
+  describe 'list_requests 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_requests_by_request
+  # Return an array of child requests of a given request id
+  # Return an array of child requests of a given request id. The result depends on the x-rh-persona header (approval/admin, approval/requseter, or approval/approver).
+  # @param request_id Id of request
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_rh_persona Current login user's persona
+  # @return [RequestCollection]
+  describe 'list_requests_by_request 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_request
+  # Return an approval request by given id
+  # Return an approval request by given id, available to anyone who can access the request
+  # @param id Query by id
+  # @param [Hash] opts the optional parameters
+  # @return [Request]
+  describe 'show_request 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_request_content
+  # Return request content of a given request id
+  # Return request content of a given request id, available to all
+  # @param request_id Id of request
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'show_request_content 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/template_api_spec.rb

@@ -0,0 +1,62 @@
+=begin
+#Insights Service Approval APIs
+
+#APIs to query approval service
+
+The version of the OpenAPI document: 1.2.0
+Contact: support@redhat.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.2
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ApprovalApiClient::TemplateApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'TemplateApi' do
+  before do
+    # run before each test
+    @api_instance = ApprovalApiClient::TemplateApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of TemplateApi' do
+    it 'should create an instance of TemplateApi' do
+      expect(@api_instance).to be_instance_of(ApprovalApiClient::TemplateApi)
+    end
+  end
+
+  # unit tests for list_templates
+  # Return all templates, only available for admin
+  # Return all templates
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit How many items to return at one time (max 1000)
+  # @option opts [Integer] :offset Starting Offset
+  # @option opts [Object] :filter Filter for querying collections.
+  # @option opts [String] :sort_by Parameter to sort collection
+  # @return [TemplateCollection]
+  describe 'list_templates 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_template
+  # Return a template by given id, only available for admin
+  # Return a template by given id
+  # @param id Query by id
+  # @param [Hash] opts the optional parameters
+  # @return [Template]
+  describe 'show_template 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/workflow_api_spec.rb

@@ -0,0 +1,145 @@
+=begin
+#Insights Service Approval APIs
+
+#APIs to query approval service
+
+The version of the OpenAPI document: 1.2.0
+Contact: support@redhat.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.2
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ApprovalApiClient::WorkflowApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'WorkflowApi' do
+  before do
+    # run before each test
+    @api_instance = ApprovalApiClient::WorkflowApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of WorkflowApi' do
+    it 'should create an instance of WorkflowApi' do
+      expect(@api_instance).to be_instance_of(ApprovalApiClient::WorkflowApi)
+    end
+  end
+
+  # unit tests for add_workflow_to_template
+  # Add a workflow by given template id, only available for admin
+  # Add a workflow by given template id
+  # @param template_id Id of template
+  # @param workflow Parameters need to create workflow
+  # @param [Hash] opts the optional parameters
+  # @return [Workflow]
+  describe 'add_workflow_to_template 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_workflow
+  # Delete approval workflow by given id, only available for admin
+  # Delete approval workflow by given id
+  # @param id Query by id
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'destroy_workflow 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 link_workflow
+  # Create a resource link to a given workflow
+  # Link a resource object to a given workflow
+  # @param id Query by id
+  # @param resource_object Parameters needed to create a link
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'link_workflow 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_workflows
+  # Return all approval workflows, only available for admin
+  # Depends on the query parameters, either return all workflows in ascending sequence order when no parameters are provided; or return the workflows linking to the resource object whose app_name, object_type and object_id are specified by query parameters
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :app_name Name of the application
+  # @option opts [String] :object_id Id of the resource object
+  # @option opts [String] :object_type Type of the resource object
+  # @option opts [Integer] :limit How many items to return at one time (max 1000)
+  # @option opts [Integer] :offset Starting Offset
+  # @option opts [Object] :filter Filter for querying collections.
+  # @option opts [String] :sort_by Parameter to sort collection
+  # @return [WorkflowCollection]
+  describe 'list_workflows 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_workflows_by_template
+  # Return an array of workflows by given template id, only available for admin
+  # Return an array of workflows by given template id
+  # @param template_id Id of template
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit How many items to return at one time (max 1000)
+  # @option opts [Integer] :offset Starting Offset
+  # @option opts [Object] :filter Filter for querying collections.
+  # @option opts [String] :sort_by Parameter to sort collection
+  # @return [WorkflowCollection]
+  describe 'list_workflows_by_template 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_workflow
+  # Return an approval workflow by given id, only available for admin
+  # Return an approval workflow by given id
+  # @param id Query by id
+  # @param [Hash] opts the optional parameters
+  # @return [Workflow]
+  describe 'show_workflow 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 unlink_workflow
+  # Break the link between a resource object and selected workflow
+  # Break the link between a resource object and selected workflow
+  # @param id Query by id
+  # @param resource_object Parameters needed to remove a link
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'unlink_workflow 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_workflow
+  # Update an approval workflow by given id, only available for admin
+  # Update an approval workflow by given id
+  # @param id Query by id
+  # @param workflow Parameters need to update approval workflow
+  # @param [Hash] opts the optional parameters
+  # @return [Workflow]
+  describe 'update_workflow 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
+#Insights Service Approval APIs
+
+#APIs to query approval service
+
+The version of the OpenAPI document: 1.2.0
+Contact: support@redhat.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.2
+
+=end
+
+require 'spec_helper'
+
+describe ApprovalApiClient::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          ApprovalApiClient.configure { |c| c.host = 'http://example.com' }
+          expect(ApprovalApiClient::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          ApprovalApiClient.configure { |c| c.host = 'https://wookiee.com' }
+          expect(ApprovalApiClient::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          ApprovalApiClient.configure { |c| c.host = 'hobo.com/v4' }
+          expect(ApprovalApiClient::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          ApprovalApiClient.configure { |c| c.base_path = 'v4/dog' }
+          expect(ApprovalApiClient::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          ApprovalApiClient.configure { |c| c.base_path = '/v4/dog' }
+          expect(ApprovalApiClient::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          ApprovalApiClient.configure { |c| c.base_path = nil }
+          expect(ApprovalApiClient::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe 'params_encoding in #build_request' do
+    let(:config) { ApprovalApiClient::Configuration.new }
+    let(:api_client) { ApprovalApiClient::ApiClient.new(config) }
+
+    it 'defaults to nil' do
+      expect(ApprovalApiClient::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) { ApprovalApiClient::Configuration.new }
+    let(:api_client) { ApprovalApiClient::ApiClient.new(config) }
+
+    it 'defaults to 0' do
+      expect(ApprovalApiClient::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 = ApprovalApiClient::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 = ApprovalApiClient::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 = ApprovalApiClient::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 = ApprovalApiClient::ApiClient.new
+      # _model = ApprovalApiClient::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) { ApprovalApiClient::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) { ApprovalApiClient::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) { ApprovalApiClient::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) { ApprovalApiClient::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) { ApprovalApiClient::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