kleister 1.14.1 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8313b77a03c082f918a63f618849f7f161fc5553c84ee0eeb1f7bf372aebaf9
-  data.tar.gz: 13f655469ee857cc752660b2c4231876a5172130bd4f39548999c40b5fefe40c
+  metadata.gz: ded2b3b1545ef31743e51b2916d2e8dc442f55962e20e921e04d93c9bc1115d4
+  data.tar.gz: 83493e3bf32af26084acec62acf9f6e3ed24eb66c40f8c10637097bf0f4d201b
 SHA512:
-  metadata.gz: 5d9f92a1855df6cfd3b23c3d7d11a46f1d0de03b8b3c059cc8d320f1b60daa73e22616ef7bb9b808aa6925a2442a96bd8e00466df29f68bfb169837ede71064d
-  data.tar.gz: db5a587d79dc54b66ddf09d6ee34765542310dc06343300c1700bb1c6e435f9fe52cc9a38e87de8bab111edf97be3b059bdda98117f0e01e580d366dbfa0036f
+  metadata.gz: 69756f6034d958812582e6c3d5730649520c82fd9ce447547424f3a9cd961f00ef68368a558da8ccaac651f754ea27931c0bbddfda7d510065476ec2163cf183
+  data.tar.gz: 7222fbb51447a27cb3749e81cb4ace2166b39acca29f926c4157964846324c60031991cc2083764c85df766d8b312d39c386bf415634f426f57bc1b59d3b0eb4

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## [1.15.0](https://github.com/kleister/kleister-ruby/compare/v1.14.1...v1.15.0) (2025-03-31)
+
+
+### Features
+
+* automated openapi client update ([2a81ac3](https://github.com/kleister/kleister-ruby/commit/2a81ac385ddd2c854a530c545192733b50857908))
+* **deps:** update dependency pry-byebug to v3.11.0 ([7fe1a83](https://github.com/kleister/kleister-ruby/commit/7fe1a8338b00a2c4ea8514abad26352d717f06b7))
+* **deps:** update dependency rubocop to '~> 1.74.0' ([#96](https://github.com/kleister/kleister-ruby/issues/96)) ([91d13fd](https://github.com/kleister/kleister-ruby/commit/91d13fda3044d30e322d41dc7616c383231d6253))
+* **deps:** update dependency rubocop to '~> 1.75.0' ([#97](https://github.com/kleister/kleister-ruby/issues/97)) ([488d85b](https://github.com/kleister/kleister-ruby/commit/488d85b8a81ca53f0576b5c54b280fb835b80892))
+
+
+### Bugfixes
+
+* **deps:** update dependency rubocop to v1.75.1 ([#98](https://github.com/kleister/kleister-ruby/issues/98)) ([4a59c58](https://github.com/kleister/kleister-ruby/commit/4a59c58be202cff27bc10796d47b9d2319b747ee))
+* use correct spec and update definition ([2fe1b8a](https://github.com/kleister/kleister-ruby/commit/2fe1b8ab42dd98302b3d0d8d510682fd6922ca30))
+
 ## [1.14.1](https://github.com/kleister/kleister-ruby/compare/v1.14.0...v1.14.1) (2025-03-10)
 
 

data/README.md

@@ -6,7 +6,7 @@ This repository provides a client SDK for Ruby. This SDK is automatically
 generated by the [OpenAPI Generator][generator] project:
 
 -   API version: 1.0.0-alpha1
--   Package version: 1.14.1
+-   Package version: 1.15.0
 -   Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 For more information, please visit [https://kleister.eu](https://kleister.eu)
@@ -21,7 +21,7 @@ the built gem:
 
 ```console
 gem build kleister.gemspec
-gem install ./kleister-1.14.1.gem
+gem install ./kleister-1.15.0.gem
 ```
 
 ### Install from Rubygems
@@ -30,7 +30,7 @@ If you want to use a a properly released version hosted Rubygems you just need
 to add the following line to your Gemfile:
 
 ```ruby
-gem 'kleister', '~> 1.14.1'
+gem 'kleister', '~> 1.15.0'
 ```
 
 ### Install from Git

data/lib/kleister/api/auth_api.rb

@@ -5,7 +5,7 @@
 # The version of the OpenAPI document: 1.0.0-alpha1
 # Contact: kleister@webhippie.de
 # Generated by: https://openapi-generator.tech
-# Generator version: 7.6.0
+# Generator version: 7.12.0
 #
 
 require 'cgi'
@@ -18,30 +18,30 @@ module Kleister
       @api_client = api_client
     end
 
-    # Callback for external authentication
+    # Callback to parse the defined provider
     # @param provider [String] An identifier for the auth provider
     # @param [Hash] opts the optional parameters
     # @option opts [String] :state Auth state
     # @option opts [String] :code Auth code
-    # @return [Notification]
-    def external_callback(provider, opts = {})
-      data, _status_code, _headers = external_callback_with_http_info(provider, opts)
-      data
+    # @return [nil]
+    def callback_provider(provider, opts = {})
+      callback_provider_with_http_info(provider, opts)
+      nil
     end
 
-    # Callback for external authentication
+    # Callback to parse the defined provider
     # @param provider [String] An identifier for the auth provider
     # @param [Hash] opts the optional parameters
     # @option opts [String] :state Auth state
     # @option opts [String] :code Auth code
-    # @return [Array<(Notification, Integer, Hash)>] Notification data, response status code and response headers
-    def external_callback_with_http_info(provider, opts = {})
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def callback_provider_with_http_info(provider, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AuthApi.external_callback ...'
+        @api_client.config.logger.debug 'Calling API: AuthApi.callback_provider ...'
       end
       # verify the required parameter 'provider' is set
       if @api_client.config.client_side_validation && provider.nil?
-        raise ArgumentError, "Missing the required parameter 'provider' when calling AuthApi.external_callback"
+        raise ArgumentError, "Missing the required parameter 'provider' when calling AuthApi.callback_provider"
       end
 
       # resource path
@@ -55,7 +55,7 @@ module Kleister
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['text/html']) unless header_params['Accept']
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -64,13 +64,13 @@ module Kleister
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'Notification'
+      return_type = opts[:debug_return_type]
 
       # auth_names
       auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
-        operation: :'AuthApi.external_callback',
+        operation: :'AuthApi.callback_provider',
         header_params: header_params,
         query_params: query_params,
         form_params: form_params,
@@ -81,46 +81,36 @@ module Kleister
 
       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: AuthApi#external_callback\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: AuthApi#callback_provider\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       [data, status_code, headers]
     end
 
-    # Initialize the external authentication
-    # @param provider [String] An identifier for the auth provider
+    # Fetch the available auth providers
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :state Auth state
-    # @return [Notification]
-    def external_initialize(provider, opts = {})
-      data, _status_code, _headers = external_initialize_with_http_info(provider, opts)
+    # @return [ListProviders200Response]
+    def list_providers(opts = {})
+      data, _status_code, _headers = list_providers_with_http_info(opts)
       data
     end
 
-    # Initialize the external authentication
-    # @param provider [String] An identifier for the auth provider
+    # Fetch the available auth providers
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :state Auth state
-    # @return [Array<(Notification, Integer, Hash)>] Notification data, response status code and response headers
-    def external_initialize_with_http_info(provider, opts = {})
+    # @return [Array<(ListProviders200Response, Integer, Hash)>] ListProviders200Response data, response status code and response headers
+    def list_providers_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AuthApi.external_initialize ...'
+        @api_client.config.logger.debug 'Calling API: AuthApi.list_providers ...'
       end
-      # verify the required parameter 'provider' is set
-      if @api_client.config.client_side_validation && provider.nil?
-        raise ArgumentError, "Missing the required parameter 'provider' when calling AuthApi.external_initialize"
-      end
-
       # resource path
-      local_var_path = '/auth/{provider}/initialize'.sub('{' + 'provider' + '}', CGI.escape(provider.to_s))
+      local_var_path = '/auth/providers'
 
       # query parameters
       query_params = opts[:query_params] || {}
-      query_params[:state] = opts[:state] unless opts[:state].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -129,13 +119,13 @@ module Kleister
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'Notification'
+      return_type = opts[:debug_return_type] || 'ListProviders200Response'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
-        operation: :'AuthApi.external_initialize',
+        operation: :'AuthApi.list_providers',
         header_params: header_params,
         query_params: query_params,
         form_params: form_params,
@@ -146,28 +136,35 @@ module Kleister
 
       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: AuthApi#external_initialize\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: AuthApi#list_providers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       [data, status_code, headers]
     end
 
-    # Fetch the available auth providers
+    # Authenticate an user by credentials
+    # @param login_auth_request [LoginAuthRequest] The credentials to authenticate
     # @param [Hash] opts the optional parameters
-    # @return [Providers]
-    def external_providers(opts = {})
-      data, _status_code, _headers = external_providers_with_http_info(opts)
+    # @return [AuthToken]
+    def login_auth(login_auth_request, opts = {})
+      data, _status_code, _headers = login_auth_with_http_info(login_auth_request, opts)
       data
     end
 
-    # Fetch the available auth providers
+    # Authenticate an user by credentials
+    # @param login_auth_request [LoginAuthRequest] The credentials to authenticate
     # @param [Hash] opts the optional parameters
-    # @return [Array<(Providers, Integer, Hash)>] Providers data, response status code and response headers
-    def external_providers_with_http_info(opts = {})
+    # @return [Array<(AuthToken, Integer, Hash)>] AuthToken data, response status code and response headers
+    def login_auth_with_http_info(login_auth_request, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AuthApi.external_providers ...'
+        @api_client.config.logger.debug 'Calling API: AuthApi.login_auth ...'
       end
+      # verify the required parameter 'login_auth_request' is set
+      if @api_client.config.client_side_validation && login_auth_request.nil?
+        raise ArgumentError, "Missing the required parameter 'login_auth_request' when calling AuthApi.login_auth"
+      end
+
       # resource path
-      local_var_path = '/auth/providers'
+      local_var_path = '/auth/login'
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -175,22 +172,27 @@ module Kleister
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      unless content_type.nil?
+        header_params['Content-Type'] = content_type
+      end
 
       # form parameters
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body]
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(login_auth_request)
 
       # return_type
-      return_type = opts[:debug_return_type] || 'Providers'
+      return_type = opts[:debug_return_type] || 'AuthToken'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
-        operation: :'AuthApi.external_providers',
+        operation: :'AuthApi.login_auth',
         header_params: header_params,
         query_params: query_params,
         form_params: form_params,
@@ -199,37 +201,37 @@ module Kleister
         return_type: return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      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: AuthApi#external_providers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: AuthApi#login_auth\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       [data, status_code, headers]
     end
 
-    # Authenticate an user by credentials
-    # @param auth_login [AuthLogin] The credentials to authenticate
+    # Retrieve real token after redirect
+    # @param redirect_auth_request [RedirectAuthRequest] The redirect token to authenticate
     # @param [Hash] opts the optional parameters
     # @return [AuthToken]
-    def login_auth(auth_login, opts = {})
-      data, _status_code, _headers = login_auth_with_http_info(auth_login, opts)
+    def redirect_auth(redirect_auth_request, opts = {})
+      data, _status_code, _headers = redirect_auth_with_http_info(redirect_auth_request, opts)
       data
     end
 
-    # Authenticate an user by credentials
-    # @param auth_login [AuthLogin] The credentials to authenticate
+    # Retrieve real token after redirect
+    # @param redirect_auth_request [RedirectAuthRequest] The redirect token to authenticate
     # @param [Hash] opts the optional parameters
     # @return [Array<(AuthToken, Integer, Hash)>] AuthToken data, response status code and response headers
-    def login_auth_with_http_info(auth_login, opts = {})
+    def redirect_auth_with_http_info(redirect_auth_request, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AuthApi.login_auth ...'
+        @api_client.config.logger.debug 'Calling API: AuthApi.redirect_auth ...'
       end
-      # verify the required parameter 'auth_login' is set
-      if @api_client.config.client_side_validation && auth_login.nil?
-        raise ArgumentError, "Missing the required parameter 'auth_login' when calling AuthApi.login_auth"
+      # verify the required parameter 'redirect_auth_request' is set
+      if @api_client.config.client_side_validation && redirect_auth_request.nil?
+        raise ArgumentError, "Missing the required parameter 'redirect_auth_request' when calling AuthApi.redirect_auth"
       end
 
       # resource path
-      local_var_path = '/auth/login'
+      local_var_path = '/auth/redirect'
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -237,7 +239,7 @@ module Kleister
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
       # HTTP header 'Content-Type'
       content_type = @api_client.select_header_content_type(['application/json'])
       unless content_type.nil?
@@ -248,7 +250,7 @@ module Kleister
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(auth_login)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(redirect_auth_request)
 
       # return_type
       return_type = opts[:debug_return_type] || 'AuthToken'
@@ -257,7 +259,7 @@ module Kleister
       auth_names = opts[:debug_auth_names] || []
 
       new_options = opts.merge(
-        operation: :'AuthApi.login_auth',
+        operation: :'AuthApi.redirect_auth',
         header_params: header_params,
         query_params: query_params,
         form_params: form_params,
@@ -268,7 +270,7 @@ module Kleister
 
       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: AuthApi#login_auth\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: AuthApi#redirect_auth\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       [data, status_code, headers]
     end
@@ -297,7 +299,7 @@ module Kleister
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -309,7 +311,7 @@ module Kleister
       return_type = opts[:debug_return_type] || 'AuthToken'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]
+      auth_names = opts[:debug_auth_names] || %w[Basic Header Bearer]
 
       new_options = opts.merge(
         operation: :'AuthApi.refresh_auth',
@@ -328,6 +330,68 @@ module Kleister
       [data, status_code, headers]
     end
 
+    # Request the redirect to defined provider
+    # @param provider [String] An identifier for the auth provider
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def request_provider(provider, opts = {})
+      request_provider_with_http_info(provider, opts)
+      nil
+    end
+
+    # Request the redirect to defined provider
+    # @param provider [String] An identifier for the auth provider
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def request_provider_with_http_info(provider, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthApi.request_provider ...'
+      end
+      # verify the required parameter 'provider' is set
+      if @api_client.config.client_side_validation && provider.nil?
+        raise ArgumentError, "Missing the required parameter 'provider' when calling AuthApi.request_provider"
+      end
+
+      # resource path
+      local_var_path = '/auth/{provider}/request'.sub('{' + 'provider' + '}', CGI.escape(provider.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(['text/html']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        operation: :'AuthApi.request_provider',
+        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: AuthApi#request_provider\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
     # Verify validity for an authentication token
     # @param [Hash] opts the optional parameters
     # @return [AuthVerify]
@@ -352,7 +416,7 @@ module Kleister
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -364,7 +428,7 @@ module Kleister
       return_type = opts[:debug_return_type] || 'AuthVerify'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]
+      auth_names = opts[:debug_auth_names] || %w[Basic Header Bearer]
 
       new_options = opts.merge(
         operation: :'AuthApi.verify_auth',