insights-approval-api-client 1.2.0

data/docs/WorkflowCollection.md

@@ -0,0 +1,21 @@
+# ApprovalApiClient::WorkflowCollection
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**CollectionMetadata**](CollectionMetadata.md) |  | [optional] 
+**links** | [**CollectionLinks**](CollectionLinks.md) |  | [optional] 
+**data** | [**Array<Workflow>**](Workflow.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'ApprovalApiClient'
+
+instance = ApprovalApiClient::WorkflowCollection.new(meta: null,
+                                 links: null,
+                                 data: null)
+```
+
+

data/generate.sh

@@ -0,0 +1,9 @@
+#! /bin/sh
+
+rm -rf openapi.json
+curl https://raw.githubusercontent.com/RedHatInsights/approval-api/master/public/doc/openapi-3-v1.2.json -o openapi.json
+openapi-generator validate -i openapi.json
+rm -rf ./lib
+rm -rf ./spec
+rm -rf ./docs
+openapi-generator generate -g ruby -i openapi.json -c client-meta.json -o .

data/git_push.sh

@@ -0,0 +1,58 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/insights-approval-api-client.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+=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
+
+$:.push File.expand_path("../lib", __FILE__)
+require "insights-approval-api-client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "insights-approval-api-client"
+  s.version     = ApprovalApiClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Insights Authors"]
+  s.email       = ["support@redhat.com"]
+  s.homepage    = "https://github.com/RedHatInsights/approval-api-client-ruby"
+  s.summary     = "Insights Service Approval APIs Ruby Gem"
+  s.description = "Ruby client gem to connect to Insights Approval Service"
+  s.license     = 'Apache-2.0'
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/lib/insights-approval-api-client.rb

@@ -0,0 +1,63 @@
+=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
+
+# Common files
+require 'insights-approval-api-client/api_client'
+require 'insights-approval-api-client/api_error'
+require 'insights-approval-api-client/version'
+require 'insights-approval-api-client/configuration'
+
+# Models
+require 'insights-approval-api-client/models/action'
+require 'insights-approval-api-client/models/action_collection'
+require 'insights-approval-api-client/models/collection_links'
+require 'insights-approval-api-client/models/collection_metadata'
+require 'insights-approval-api-client/models/graphql_in'
+require 'insights-approval-api-client/models/graphql_out'
+require 'insights-approval-api-client/models/group_ref'
+require 'insights-approval-api-client/models/http_api_error'
+require 'insights-approval-api-client/models/http_api_error_collection'
+require 'insights-approval-api-client/models/request'
+require 'insights-approval-api-client/models/request_collection'
+require 'insights-approval-api-client/models/request_in'
+require 'insights-approval-api-client/models/resource_object'
+require 'insights-approval-api-client/models/tag'
+require 'insights-approval-api-client/models/tag_resource'
+require 'insights-approval-api-client/models/template'
+require 'insights-approval-api-client/models/template_collection'
+require 'insights-approval-api-client/models/workflow'
+require 'insights-approval-api-client/models/workflow_collection'
+
+# APIs
+require 'insights-approval-api-client/api/action_api'
+require 'insights-approval-api-client/api/graphql_api'
+require 'insights-approval-api-client/api/request_api'
+require 'insights-approval-api-client/api/template_api'
+require 'insights-approval-api-client/api/workflow_api'
+
+module ApprovalApiClient
+  class << self
+    # Customize default settings for the SDK using block.
+    #   ApprovalApiClient.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/insights-approval-api-client/api/action_api.rb

@@ -0,0 +1,231 @@
+=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 'cgi'
+
+module ApprovalApiClient
+  class ActionApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # 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 [String] Id of request
+    # @param action [Action] Action object that will be added
+    # @param [Hash] opts the optional parameters
+    # @return [Action]
+    def create_action(request_id, action, opts = {})
+      data, _status_code, _headers = create_action_with_http_info(request_id, action, opts)
+      data
+    end
+
+    # 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 [String] Id of request
+    # @param action [Action] Action object that will be added
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Action, Integer, Hash)>] Action data, response status code and response headers
+    def create_action_with_http_info(request_id, action, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ActionApi.create_action ...'
+      end
+      # verify the required parameter 'request_id' is set
+      if @api_client.config.client_side_validation && request_id.nil?
+        fail ArgumentError, "Missing the required parameter 'request_id' when calling ActionApi.create_action"
+      end
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && request_id !~ pattern
+        fail ArgumentError, "invalid value for 'request_id' when calling ActionApi.create_action, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'action' is set
+      if @api_client.config.client_side_validation && action.nil?
+        fail ArgumentError, "Missing the required parameter 'action' when calling ActionApi.create_action"
+      end
+      # resource path
+      local_var_path = '/requests/{request_id}/actions'.sub('{' + 'request_id' + '}', CGI.escape(request_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(action) 
+
+      # return_type
+      return_type = opts[:return_type] || 'Action' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['Basic_auth']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ActionApi#create_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List all actions of a request
+    # Return actions in a given request, available for admin/approver
+    # @param request_id [String] Id of request
+    # @param [Hash] opts the optional parameters
+    # @return [ActionCollection]
+    def list_actions_by_request(request_id, opts = {})
+      data, _status_code, _headers = list_actions_by_request_with_http_info(request_id, opts)
+      data
+    end
+
+    # List all actions of a request
+    # Return actions in a given request, available for admin/approver
+    # @param request_id [String] Id of request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ActionCollection, Integer, Hash)>] ActionCollection data, response status code and response headers
+    def list_actions_by_request_with_http_info(request_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ActionApi.list_actions_by_request ...'
+      end
+      # verify the required parameter 'request_id' is set
+      if @api_client.config.client_side_validation && request_id.nil?
+        fail ArgumentError, "Missing the required parameter 'request_id' when calling ActionApi.list_actions_by_request"
+      end
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && request_id !~ pattern
+        fail ArgumentError, "invalid value for 'request_id' when calling ActionApi.list_actions_by_request, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/requests/{request_id}/actions'.sub('{' + 'request_id' + '}', CGI.escape(request_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'ActionCollection' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['Basic_auth']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ActionApi#list_actions_by_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Return an user action by id
+    # Return an user action by id, available to all
+    # @param id [String] Query by id
+    # @param [Hash] opts the optional parameters
+    # @return [Action]
+    def show_action(id, opts = {})
+      data, _status_code, _headers = show_action_with_http_info(id, opts)
+      data
+    end
+
+    # Return an user action by id
+    # Return an user action by id, available to all
+    # @param id [String] Query by id
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Action, Integer, Hash)>] Action data, response status code and response headers
+    def show_action_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ActionApi.show_action ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ActionApi.show_action"
+      end
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && id !~ pattern
+        fail ArgumentError, "invalid value for 'id' when calling ActionApi.show_action, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/actions/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'Action' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['Basic_auth']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ActionApi#show_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/insights-approval-api-client/api/graphql_api.rb

@@ -0,0 +1,86 @@
+=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 'cgi'
+
+module ApprovalApiClient
+  class GraphqlApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Perform a GraphQL Query
+    # Performs a GraphQL Query
+    # @param graphql_in [GraphqlIn] GraphQL Query Request
+    # @param [Hash] opts the optional parameters
+    # @return [GraphqlOut]
+    def post_graphql(graphql_in, opts = {})
+      data, _status_code, _headers = post_graphql_with_http_info(graphql_in, opts)
+      data
+    end
+
+    # Perform a GraphQL Query
+    # Performs a GraphQL Query
+    # @param graphql_in [GraphqlIn] GraphQL Query Request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GraphqlOut, Integer, Hash)>] GraphqlOut data, response status code and response headers
+    def post_graphql_with_http_info(graphql_in, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GraphqlApi.post_graphql ...'
+      end
+      # verify the required parameter 'graphql_in' is set
+      if @api_client.config.client_side_validation && graphql_in.nil?
+        fail ArgumentError, "Missing the required parameter 'graphql_in' when calling GraphqlApi.post_graphql"
+      end
+      # resource path
+      local_var_path = '/graphql'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(graphql_in) 
+
+      # return_type
+      return_type = opts[:return_type] || 'GraphqlOut' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['Basic_auth']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GraphqlApi#post_graphql\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end