swaggy_jenkins 2.0.1.pre.pre.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64c7775cc1b5bf9da916dd0d6fc1b1d438dc07417d7ea0cc80e0521ff9462724
-  data.tar.gz: ec57c5f43fc7bf30466feefed1b370a576c8173f7a1db2421913612118338d99
+  metadata.gz: 47eb72a5b56c1425a651c2e344cb23c2f719c62bb58befbde279908e1a75e6b8
+  data.tar.gz: 31c178f76fe170bc4eee8806daffe76324e9ecdd64a0d1defa668f9521c459a6
 SHA512:
-  metadata.gz: a46121b38f86ba8e50319e2e1eb00adfc98aa55e327d1fb4c0ab83734cc5321de2cdceee7ee15392c9bc56bae84608952393e241b85ddb55ac1983d7f7c21a82
-  data.tar.gz: 23cc8eb4fc920d1bc78b608cfd6a631f535c6fb377deb67e5fa833f0290715780fd312d96521906598f192ecabde441339db1d29838dc1828d36f91de214262a
+  metadata.gz: 75f7295bece94c4684d656bf7bd9571ee303369cf5790ac67b6a5a08ec0fe1f711db26fed27d9188487ad791055a6c37152dec1762adf8e899d9cb8f185ce7c4
+  data.tar.gz: 5f1ed9ab001659a78f0597dc80181ad40c3356ba984841ae39b8fe617eed5ac1e8a1fd7495c2f854ff92a3bf47f838d30b989313ab33ed39777772d75c556979

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    swaggy_jenkins (2.0.1.pre.pre.0)
+    swaggy_jenkins (3.0.1)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
@@ -10,38 +10,40 @@ GEM
     ast (2.4.2)
     byebug (11.1.3)
     coderay (1.1.3)
-    diff-lcs (1.5.0)
-    ethon (0.15.0)
+    diff-lcs (1.5.1)
+    ethon (0.16.0)
       ffi (>= 1.15.0)
-    ffi (1.15.5)
-    jaro_winkler (1.5.4)
+    ffi (1.16.3)
+    jaro_winkler (1.5.6)
     method_source (1.0.0)
-    parallel (1.22.1)
-    parser (3.1.2.0)
+    parallel (1.24.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
-    pry (0.13.1)
+      racc
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    pry-byebug (3.9.0)
+    pry-byebug (3.10.1)
       byebug (~> 11.0)
-      pry (~> 0.13.0)
-    psych (4.0.4)
+      pry (>= 0.13, < 0.15)
+    psych (5.1.2)
       stringio
+    racc (1.7.3)
     rainbow (3.1.1)
     rake (13.0.6)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
     rubocop (0.66.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -50,9 +52,9 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.6)
-    ruby-progressbar (1.11.0)
-    stringio (3.0.2)
-    typhoeus (1.4.0)
+    ruby-progressbar (1.13.0)
+    stringio (3.1.0)
+    typhoeus (1.4.1)
       ethon (>= 0.9.0)
     unicode-display_width (1.5.0)
 
@@ -67,4 +69,4 @@ DEPENDENCIES
   swaggy_jenkins!
 
 BUNDLED WITH
-   2.3.11
+   2.4.22

data/README.md

@@ -6,10 +6,11 @@ Jenkins API clients generated from Swagger / Open API specification
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 2.0.1-pre.0
-- Package version: 2.0.1-pre.0
+- API version: 3.0.1
+- Package version: 3.0.1
+- Generator version: 7.4.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
-For more information, please visit [http://github.com/cliffano/swaggy-jenkins](http://github.com/cliffano/swaggy-jenkins)
+For more information, please visit [https://github.com/oapicf/swaggy-jenkins](https://github.com/oapicf/swaggy-jenkins)
 
 ## Installation
 
@@ -24,16 +25,16 @@ gem build swaggy_jenkins.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./swaggy_jenkins-2.0.1-pre.0.gem
+gem install ./swaggy_jenkins-3.0.1.gem
 ```
 
-(for development, run `gem install --dev ./swaggy_jenkins-2.0.1-pre.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./swaggy_jenkins-3.0.1.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'swaggy_jenkins', '~> 2.0.1-pre.0'
+    gem 'swaggy_jenkins', '~> 3.0.1'
 
 ### Install from Git
 
@@ -228,6 +229,7 @@ Class | Method | HTTP request | Description
 ## Documentation for Authorization
 
 
+Authentication schemes defined for the API:
 ### jenkins_auth
 
 - **Type**: HTTP basic authentication

data/bin/bundle

@@ -47,7 +47,7 @@ m = Module.new do
   def lockfile
     lockfile =
       case File.basename(gemfile)
-      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, ".locked")
       else "#{gemfile}.lock"
       end
     File.expand_path(lockfile)
@@ -62,8 +62,9 @@ m = Module.new do
 
   def bundler_requirement
     @bundler_requirement ||=
-      env_var_version || cli_arg_version ||
-        bundler_requirement_for(lockfile_version)
+      env_var_version ||
+      cli_arg_version ||
+      bundler_requirement_for(lockfile_version)
   end
 
   def bundler_requirement_for(version)
@@ -71,13 +72,7 @@ m = Module.new do
 
     bundler_gem_version = Gem::Version.new(version)
 
-    requirement = bundler_gem_version.approximate_recommendation
-
-    return requirement unless Gem.rubygems_version < Gem::Version.new("2.7.0")
-
-    requirement += ".a" if bundler_gem_version.prerelease?
-
-    requirement
+    bundler_gem_version.approximate_recommendation
   end
 
   def load_bundler!

data/bin/byebug

@@ -13,7 +13,7 @@ ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
 bundle_binstub = File.expand_path("bundle", __dir__)
 
 if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
     load(bundle_binstub)
   else
     abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.

data/bin/coderay

@@ -13,7 +13,7 @@ ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
 bundle_binstub = File.expand_path("bundle", __dir__)
 
 if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
     load(bundle_binstub)
   else
     abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.

data/bin/htmldiff

@@ -13,7 +13,7 @@ ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
 bundle_binstub = File.expand_path("bundle", __dir__)
 
 if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
     load(bundle_binstub)
   else
     abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.

data/bin/ldiff

@@ -13,7 +13,7 @@ ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
 bundle_binstub = File.expand_path("bundle", __dir__)
 
 if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
     load(bundle_binstub)
   else
     abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.

data/bin/pry

@@ -13,7 +13,7 @@ ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
 bundle_binstub = File.expand_path("bundle", __dir__)
 
 if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
     load(bundle_binstub)
   else
     abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.

data/bin/racc

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby2.7
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'racc' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("racc", "racc")

data/bin/rake

@@ -13,7 +13,7 @@ ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
 bundle_binstub = File.expand_path("bundle", __dir__)
 
 if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
     load(bundle_binstub)
   else
     abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.

data/bin/rspec

@@ -13,7 +13,7 @@ ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
 bundle_binstub = File.expand_path("bundle", __dir__)
 
 if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
     load(bundle_binstub)
   else
     abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.

data/bin/rubocop

@@ -13,7 +13,7 @@ ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
 bundle_binstub = File.expand_path("bundle", __dir__)
 
 if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
     load(bundle_binstub)
   else
     abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.

data/bin/ruby-parse

@@ -13,7 +13,7 @@ ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
 bundle_binstub = File.expand_path("bundle", __dir__)
 
 if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
     load(bundle_binstub)
   else
     abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.

data/bin/ruby-rewrite

@@ -13,7 +13,7 @@ ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
 bundle_binstub = File.expand_path("bundle", __dir__)
 
 if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
     load(bundle_binstub)
   else
     abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.

data/lib/swaggy_jenkins/api/base_api.rb

@@ -3,10 +3,10 @@
 
 #Jenkins API clients generated from Swagger / Open API specification
 
-The version of the OpenAPI document: 2.0.1-pre.0
-Contact: blah@cliffano.com
+The version of the OpenAPI document: 3.0.1
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.0.0
+Generator version: 7.4.0
 
 =end
 

data/lib/swaggy_jenkins/api/blue_ocean_api.rb

@@ -3,10 +3,10 @@
 
 #Jenkins API clients generated from Swagger / Open API specification
 
-The version of the OpenAPI document: 2.0.1-pre.0
-Contact: blah@cliffano.com
+The version of the OpenAPI document: 3.0.1
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.0.0
+Generator version: 7.4.0
 
 =end
 

data/lib/swaggy_jenkins/api/remote_access_api.rb

@@ -3,10 +3,10 @@
 
 #Jenkins API clients generated from Swagger / Open API specification
 
-The version of the OpenAPI document: 2.0.1-pre.0
-Contact: blah@cliffano.com
+The version of the OpenAPI document: 3.0.1
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.0.0
+Generator version: 7.4.0
 
 =end
 

data/lib/swaggy_jenkins/api_client.rb

@@ -3,10 +3,10 @@
 
 #Jenkins API clients generated from Swagger / Open API specification
 
-The version of the OpenAPI document: 2.0.1-pre.0
-Contact: blah@cliffano.com
+The version of the OpenAPI document: 3.0.1
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.0.0
+Generator version: 7.4.0
 
 =end
 
@@ -17,6 +17,7 @@ require 'tempfile'
 require 'time'
 require 'typhoeus'
 
+
 module SwaggyJenkinsClient
   class ApiClient
     # The Configuration object holding settings to be used in the API client.
@@ -45,9 +46,10 @@ module SwaggyJenkinsClient
     # Call an API with given options.
     #
     # @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
-    #   the data deserialized from response body (could be nil), response status code and response headers.
+    #   the data deserialized from response body (may be a Tempfile or nil), response status code and response headers.
     def call_api(http_method, path, opts = {})
       request = build_request(http_method, path, opts)
+      tempfile = download_file(request) if opts[:return_type] == 'File'
       response = request.run
 
       if @config.debugging
@@ -69,7 +71,9 @@ module SwaggyJenkinsClient
         end
       end
 
-      if opts[:return_type]
+      if opts[:return_type] == 'File'
+        data = tempfile
+      elsif opts[:return_type]
         data = deserialize(response, opts[:return_type])
       else
         data = nil
@@ -125,9 +129,7 @@ module SwaggyJenkinsClient
         end
       end
 
-      request = Typhoeus::Request.new(url, req_opts)
-      download_file(request) if opts[:return_type] == 'File'
-      request
+      Typhoeus::Request.new(url, req_opts)
     end
 
     # Builds the HTTP request body
@@ -165,6 +167,8 @@ module SwaggyJenkinsClient
     # process can use.
     #
     # @see Configuration#temp_folder_path
+    #
+    # @return [Tempfile] the tempfile generated
     def download_file(request)
       tempfile = nil
       encoding = nil
@@ -179,21 +183,24 @@ module SwaggyJenkinsClient
         prefix = prefix + '-' unless prefix.end_with?('-')
         encoding = response.body.encoding
         tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
-        @tempfile = tempfile
       end
       request.on_body do |chunk|
         chunk.force_encoding(encoding)
         tempfile.write(chunk)
       end
-      request.on_complete do |response|
-        if tempfile
-          tempfile.close
-          @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
-                              "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
-                              "will be deleted automatically with GC. It's also recommended to delete the temp file "\
-                              "explicitly with `tempfile.delete`"
-        end
+      # run the request to ensure the tempfile is created successfully before returning it
+      request.run
+      if tempfile
+        tempfile.close
+        @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
+                            "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
+                            "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+                            "explicitly with `tempfile.delete`"
+      else
+        fail ApiError.new("Failed to create the tempfile based on the HTTP response from the server: #{request.inspect}") 
       end
+
+      tempfile
     end
 
     # Check if the given MIME is a JSON MIME.
@@ -214,15 +221,10 @@ module SwaggyJenkinsClient
     # @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
     def deserialize(response, return_type)
       body = response.body
-
-      # handle file downloading - return the File instance processed in request callbacks
-      # note that response body is empty when the file is written in chunks in request on_body callback
-      return @tempfile if return_type == 'File'
-
       return nil if body.nil? || body.empty?
 
       # return response body directly for String return type
-      return body if return_type == 'String'
+      return body.to_s if return_type == 'String'
 
       # ensuring a default content type
       content_type = response.headers['Content-Type'] || 'application/json'

data/lib/swaggy_jenkins/api_error.rb

@@ -3,10 +3,10 @@
 
 #Jenkins API clients generated from Swagger / Open API specification
 
-The version of the OpenAPI document: 2.0.1-pre.0
-Contact: blah@cliffano.com
+The version of the OpenAPI document: 3.0.1
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.0.0
+Generator version: 7.4.0
 
 =end
 
@@ -32,6 +32,7 @@ module SwaggyJenkinsClient
         end
       else
         super arg
+        @message = arg
       end
     end
 

data/lib/swaggy_jenkins/configuration.rb

@@ -3,10 +3,10 @@
 
 #Jenkins API clients generated from Swagger / Open API specification
 
-The version of the OpenAPI document: 2.0.1-pre.0
-Contact: blah@cliffano.com
+The version of the OpenAPI document: 3.0.1
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.0.0
+Generator version: 7.4.0
 
 =end
 
@@ -62,6 +62,16 @@ module SwaggyJenkinsClient
     # Defines the access token (Bearer) used with OAuth2.
     attr_accessor :access_token
 
+    # Defines a Proc used to fetch or refresh access tokens (Bearer) used with OAuth2.
+    # Overrides the access_token if set
+    # @return [Proc]
+    attr_accessor :access_token_getter
+
+    # Set this to return data as binary instead of downloading a temp file. When enabled (set to true)
+    # HTTP responses with return type `File` will be returned as a stream of binary data.
+    # Default to false.
+    attr_accessor :return_binary_data
+
     # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
     # details will be logged with `logger.debug` (see the `logger` attribute).
     # Default to false.
@@ -142,7 +152,7 @@ module SwaggyJenkinsClient
       @scheme = 'http'
       @host = 'localhost'
       @base_path = ''
-      @server_index = 0
+      @server_index = nil
       @server_operation_index = {}
       @server_variables = {}
       @server_operation_variables = {}
@@ -190,10 +200,12 @@ module SwaggyJenkinsClient
 
     # Returns base URL for specified operation based on server settings
     def base_url(operation = nil)
-      index = server_operation_index.fetch(operation, server_index)
-      return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if index == nil
-
-      server_url(index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
+      if operation_server_settings.key?(operation) then
+        index = server_operation_index.fetch(operation, server_index)
+        server_url(index.nil? ? 0 : index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
+      else
+        server_index.nil? ? "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') : server_url(server_index, server_variables, nil)
+      end
     end
 
     # Gets API key (with prefix if set).
@@ -208,6 +220,12 @@ module SwaggyJenkinsClient
       end
     end
 
+    # Gets access_token using access_token_getter or uses the static access_token
+    def access_token_with_refresh
+      return access_token if access_token_getter.nil?
+      access_token_getter.call
+    end
+
     # Gets Basic Auth token string
     def basic_auth_token
       'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
@@ -256,8 +274,8 @@ module SwaggyJenkinsClient
       servers = server_settings if servers == nil
 
       # check array index out of bound
-      if (index < 0 || index >= servers.size)
-        fail ArgumentError, "Invalid index #{index} when selecting the server. Must be less than #{servers.size}"
+      if (index.nil? || index < 0 || index >= servers.size)
+        fail ArgumentError, "Invalid index #{index} when selecting the server. Must not be nil and must be less than #{servers.size}"
       end
 
       server = servers[index]
@@ -282,5 +300,6 @@ module SwaggyJenkinsClient
       url
     end
 
+
   end
 end