ory-hydra-client 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 248c7a706a6b74dd28ff9260599dd13ab6c6a2023a03fd55017a2f724d4a3808
-  data.tar.gz: fc52bcc2cfc5fe1b82536ac15f4f1dceb734b18a43aa6dad9d60500f1f99a07c
+  metadata.gz: a71dbe98f7753f1cc78d2ea3a22cdd582d1f422686845b573f6490f0ae9752d3
+  data.tar.gz: 37bb075affd11596ead3e9c89960a733851dcc2c4196f629b7db797ef6592d5f
 SHA512:
-  metadata.gz: 208ac6859dd0563536e88718dfdeccdefc785b2314cd3fbe77284d5cd8571dd4a7f1921513faefa1cfe77bd8042abeffeac67b8a0f89d0e123f9c62028707ced
-  data.tar.gz: 3e4ab2224a3924d739ff0bb95d0ed2db848e72347bc2cf55ab06c6739fe8a098b7d856780519add4499e94c93e954966fd493355cd90e65d9e02d4f20a36fcbf
+  metadata.gz: a0f703d1e371845563a3b69a876a2de6e9c596394b7a8785b508db79850a5d47103d2bcdecf2375130356593aff6a5430df8bc5a3cc7d292e95de893d52ab498
+  data.tar.gz: 913313ceae94be37a8747f7851a6b44a1bddf3465549ddea7b23f9e6023063a321a01ceffe29a6e574ca8ea0b6a1b1e422a8689a3906202a64baf72feb9269c6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ory-hydra-client (2.2.0)
+    ory-hydra-client (2.2.1)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
@@ -13,22 +13,22 @@ GEM
     diff-lcs (1.5.1)
     ethon (0.16.0)
       ffi (>= 1.15.0)
-    ffi (1.16.3)
+    ffi (1.17.0)
     jaro_winkler (1.5.6)
-    method_source (1.0.0)
-    parallel (1.24.0)
-    parser (3.3.0.5)
+    method_source (1.1.0)
+    parallel (1.25.1)
+    parser (3.3.3.0)
       ast (~> 2.4.1)
       racc
-    pry (0.13.1)
+    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)
+      pry (>= 0.13, < 0.15)
     psych (4.0.6)
       stringio
-    racc (1.7.3)
+    racc (1.8.0)
     rainbow (3.1.1)
     rake (13.0.6)
     rspec (3.13.0)
@@ -37,13 +37,13 @@ GEM
       rspec-mocks (~> 3.13.0)
     rspec-core (3.13.0)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.0)
+    rspec-expectations (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.0)
+    rspec-support (3.13.1)
     rubocop (0.66.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -53,7 +53,7 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.6)
     ruby-progressbar (1.13.0)
-    stringio (3.0.6)
+    stringio (3.1.1)
     typhoeus (1.4.1)
       ethon (>= 0.9.0)
     unicode-display_width (1.5.0)

data/README.md

@@ -7,8 +7,9 @@ Documentation for all of Ory Hydra's APIs.
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: v2.2.0
-- Package version: v2.2.0
+- API version: v2.2.1
+- Package version: v2.2.1
+- Generator version: 7.7.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -24,16 +25,16 @@ gem build ory-hydra-client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ory-hydra-client-v2.2.0.gem
+gem install ./ory-hydra-client-v2.2.1.gem
 ```
 
-(for development, run `gem install --dev ./ory-hydra-client-v2.2.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ory-hydra-client-v2.2.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 'ory-hydra-client', '~> v2.2.0'
+    gem 'ory-hydra-client', '~> v2.2.1'
 
 ### Install from Git
 
@@ -177,6 +178,7 @@ Class | Method | HTTP request | Description
 ## Documentation for Authorization
 
 
+Authentication schemes defined for the API:
 ### basic
 
 - **Type**: HTTP basic authentication

data/lib/ory-hydra-client/api/jwk_api.rb

@@ -3,10 +3,10 @@
 
 #Documentation for all of Ory Hydra's APIs. 
 
-The version of the OpenAPI document: v2.2.0
+The version of the OpenAPI document: v2.2.1
 Contact: hi@ory.sh
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.0.1
+Generator version: 7.7.0
 
 =end
 

data/lib/ory-hydra-client/api/metadata_api.rb

@@ -3,10 +3,10 @@
 
 #Documentation for all of Ory Hydra's APIs. 
 
-The version of the OpenAPI document: v2.2.0
+The version of the OpenAPI document: v2.2.1
 Contact: hi@ory.sh
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.0.1
+Generator version: 7.7.0
 
 =end
 

data/lib/ory-hydra-client/api/o_auth2_api.rb

@@ -3,10 +3,10 @@
 
 #Documentation for all of Ory Hydra's APIs. 
 
-The version of the OpenAPI document: v2.2.0
+The version of the OpenAPI document: v2.2.1
 Contact: hi@ory.sh
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.0.1
+Generator version: 7.7.0
 
 =end
 

data/lib/ory-hydra-client/api/oidc_api.rb

@@ -3,10 +3,10 @@
 
 #Documentation for all of Ory Hydra's APIs. 
 
-The version of the OpenAPI document: v2.2.0
+The version of the OpenAPI document: v2.2.1
 Contact: hi@ory.sh
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.0.1
+Generator version: 7.7.0
 
 =end
 

data/lib/ory-hydra-client/api/wellknown_api.rb

@@ -3,10 +3,10 @@
 
 #Documentation for all of Ory Hydra's APIs. 
 
-The version of the OpenAPI document: v2.2.0
+The version of the OpenAPI document: v2.2.1
 Contact: hi@ory.sh
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.0.1
+Generator version: 7.7.0
 
 =end
 

data/lib/ory-hydra-client/api_client.rb

@@ -3,10 +3,10 @@
 
 #Documentation for all of Ory Hydra's APIs. 
 
-The version of the OpenAPI document: v2.2.0
+The version of the OpenAPI document: v2.2.1
 Contact: hi@ory.sh
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.0.1
+Generator version: 7.7.0
 
 =end
 
@@ -17,6 +17,7 @@ require 'tempfile'
 require 'time'
 require 'typhoeus'
 
+
 module OryHydraClient
   class ApiClient
     # The Configuration object holding settings to be used in the API client.
@@ -45,9 +46,10 @@ module OryHydraClient
     # 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 OryHydraClient
         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 OryHydraClient
         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 OryHydraClient
     # 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 OryHydraClient
         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.
@@ -205,7 +212,7 @@ module OryHydraClient
     # @param [String] mime MIME
     # @return [Boolean] True if the MIME is application/json
     def json_mime?(mime)
-      (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
+      (mime == '*/*') || !(mime =~ /^Application\/.*json(?!p)(;.*)?/i).nil?
     end
 
     # Deserialize the response to the given return type.
@@ -214,15 +221,10 @@ module OryHydraClient
     # @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'
@@ -289,7 +291,7 @@ module OryHydraClient
     # @param [String] filename the filename to be sanitized
     # @return [String] the sanitized filename
     def sanitize_filename(filename)
-      filename.gsub(/.*[\/\\]/, '')
+      filename.split(/[\/\\]/).last
     end
 
     def build_request_url(path, opts = {})

data/lib/ory-hydra-client/api_error.rb

@@ -3,10 +3,10 @@
 
 #Documentation for all of Ory Hydra's APIs. 
 
-The version of the OpenAPI document: v2.2.0
+The version of the OpenAPI document: v2.2.1
 Contact: hi@ory.sh
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.0.1
+Generator version: 7.7.0
 
 =end
 
@@ -32,6 +32,7 @@ module OryHydraClient
         end
       else
         super arg
+        @message = arg
       end
     end
 

data/lib/ory-hydra-client/configuration.rb

@@ -3,10 +3,10 @@
 
 #Documentation for all of Ory Hydra's APIs. 
 
-The version of the OpenAPI document: v2.2.0
+The version of the OpenAPI document: v2.2.1
 Contact: hi@ory.sh
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.0.1
+Generator version: 7.7.0
 
 =end
 
@@ -62,6 +62,16 @@ module OryHydraClient
     # 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.
@@ -69,6 +79,14 @@ module OryHydraClient
     # @return [true, false]
     attr_accessor :debugging
 
+    # Set this to ignore operation servers for the API client. This is useful when you need to
+    # send requests to a different server than the one specified in the OpenAPI document.
+    # Will default to the base url defined in the spec but can be overridden by setting
+    # `scheme`, `host`, `base_path` directly.
+    # Default to false.
+    # @return [true, false]
+    attr_accessor :ignore_operation_servers
+
     # Defines the logger used for debugging.
     # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
     #
@@ -142,7 +160,7 @@ module OryHydraClient
       @scheme = 'http'
       @host = 'localhost'
       @base_path = ''
-      @server_index = 0
+      @server_index = nil
       @server_operation_index = {}
       @server_variables = {}
       @server_operation_variables = {}
@@ -156,6 +174,7 @@ module OryHydraClient
       @timeout = 0
       @params_encoding = nil
       @debugging = false
+      @ignore_operation_servers = false
       @inject_format = false
       @force_ending_format = false
       @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
@@ -190,10 +209,13 @@ module OryHydraClient
 
     # 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])
+      return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if ignore_operation_servers
+      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 +230,12 @@ module OryHydraClient
       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")
@@ -228,14 +256,14 @@ module OryHydraClient
             type: 'bearer',
             in: 'header',
             key: 'Authorization',
-            value: "Bearer #{access_token}"
+            value: "Bearer #{access_token_with_refresh}"
           },
         'oauth2' =>
           {
             type: 'oauth2',
             in: 'header',
             key: 'Authorization',
-            value: "Bearer #{access_token}"
+            value: "Bearer #{access_token_with_refresh}"
           },
       }
     end
@@ -263,8 +291,8 @@ module OryHydraClient
       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]
@@ -289,5 +317,6 @@ module OryHydraClient
       url
     end
 
+
   end
 end

data/lib/ory-hydra-client/models/accept_o_auth2_consent_request.rb

@@ -3,10 +3,10 @@
 
 #Documentation for all of Ory Hydra's APIs. 
 
-The version of the OpenAPI document: v2.2.0
+The version of the OpenAPI document: v2.2.1
 Contact: hi@ory.sh
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.0.1
+Generator version: 7.7.0
 
 =end
 
@@ -120,6 +120,7 @@ module OryHydraClient
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
       invalid_properties
     end
@@ -127,6 +128,7 @@ module OryHydraClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
       true
     end
 
@@ -160,37 +162,30 @@ module OryHydraClient
     # @param [Hash] attributes Model attributes in the form of hash
     # @return [Object] Returns the model itself
     def self.build_from_hash(attributes)
-      new.build_from_hash(attributes)
-    end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
       attributes = attributes.transform_keys(&:to_sym)
-      self.class.openapi_types.each_pair do |key, type|
-        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
         elsif type =~ /\AArray<(.*)>/i
           # check to ensure the input is an array given that the attribute
           # is documented as an array but the input is not
-          if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
           end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
         end
       end
-
-      self
+      new(transformed_hash)
     end
 
     # Deserializes the data based on type
     # @param string type Data type
     # @param string value Value to be deserialized
     # @return [Object] Deserialized data
-    def _deserialize(type, value)
+    def self._deserialize(type, value)
       case type.to_sym
       when :Time
         Time.parse(value)
@@ -225,7 +220,7 @@ module OryHydraClient
       else # model
         # models (e.g. Pet) or oneOf
         klass = OryHydraClient.const_get(type)
-        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 

data/lib/ory-hydra-client/models/accept_o_auth2_consent_request_session.rb

@@ -3,10 +3,10 @@
 
 #Documentation for all of Ory Hydra's APIs. 
 
-The version of the OpenAPI document: v2.2.0
+The version of the OpenAPI document: v2.2.1
 Contact: hi@ory.sh
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.0.1
+Generator version: 7.7.0
 
 =end
 
@@ -77,6 +77,7 @@ module OryHydraClient
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
       invalid_properties
     end
@@ -84,6 +85,7 @@ module OryHydraClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
       true
     end
 
@@ -112,37 +114,30 @@ module OryHydraClient
     # @param [Hash] attributes Model attributes in the form of hash
     # @return [Object] Returns the model itself
     def self.build_from_hash(attributes)
-      new.build_from_hash(attributes)
-    end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
       attributes = attributes.transform_keys(&:to_sym)
-      self.class.openapi_types.each_pair do |key, type|
-        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
         elsif type =~ /\AArray<(.*)>/i
           # check to ensure the input is an array given that the attribute
           # is documented as an array but the input is not
-          if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
           end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
         end
       end
-
-      self
+      new(transformed_hash)
     end
 
     # Deserializes the data based on type
     # @param string type Data type
     # @param string value Value to be deserialized
     # @return [Object] Deserialized data
-    def _deserialize(type, value)
+    def self._deserialize(type, value)
       case type.to_sym
       when :Time
         Time.parse(value)
@@ -177,7 +172,7 @@ module OryHydraClient
       else # model
         # models (e.g. Pet) or oneOf
         klass = OryHydraClient.const_get(type)
-        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end