endoflife_date 0.10.0 → 1.1.0

data/docs/DefaultApi.md

@@ -11,7 +11,7 @@ All URIs are relative to *https://endoflife.date*
 
 ## get_api_all_json
 
-> Object get_api_all_json
+> Array<String> get_api_all_json
 
 All Products
 
@@ -38,7 +38,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(Object, Integer, Hash)> get_api_all_json_with_http_info
+> <Array(Array&lt;String&gt;, Integer, Hash)> get_api_all_json_with_http_info
 
 ```ruby
 begin
@@ -46,7 +46,7 @@ begin
   data, status_code, headers = api_instance.get_api_all_json_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => Object
+  p data # => Array&lt;String&gt;
 rescue EndOfLifeDateApiClient::ApiError => e
   puts "Error when calling DefaultApi->get_api_all_json_with_http_info: #{e}"
 end
@@ -58,7 +58,7 @@ This endpoint does not need any parameter.
 
 ### Return type
 
-**Object**
+**Array&lt;String&gt;**
 
 ### Authorization
 
@@ -76,7 +76,7 @@ No authorization required
 
 Single cycle details
 
-Gets details of a single cycle
+Gets details of a single cycle.
 
 ### Examples
 
@@ -85,8 +85,8 @@ require 'time'
 require 'endoflife_date'
 
 api_instance = EndOfLifeDateApiClient::DefaultApi.new
-product = TODO # Object | Product URL as per the canonical URL on the endofife.date website
-cycle = TODO # Object | Release Cycle for which the details must be fetched
+product = 'product_example' # String | Product URL as per the canonical URL on the endofife.date website.
+cycle = 'cycle_example' # String | Release Cycle for which the details must be fetched. Any slash character in the cycle name will be replaced with dashes. For example FreeBSD's releng/14.0 becomes releng-14.0.
 
 begin
   # Single cycle details
@@ -119,8 +119,8 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **product** | [**Object**](.md) | Product URL as per the canonical URL on the endofife.date website |  |
-| **cycle** | [**Object**](.md) | Release Cycle for which the details must be fetched |  |
+| **product** | **String** | Product URL as per the canonical URL on the endofife.date website. |  |
+| **cycle** | **String** | Release Cycle for which the details must be fetched. Any slash character in the cycle name will be replaced with dashes. For example FreeBSD&#39;s releng/14.0 becomes releng-14.0. |  |
 
 ### Return type
 
@@ -138,7 +138,7 @@ No authorization required
 
 ## get_api_product_json
 
-> Object get_api_product_json(product)
+> <Array<Cycle>> get_api_product_json(product)
 
 Get All Details
 
@@ -151,7 +151,7 @@ require 'time'
 require 'endoflife_date'
 
 api_instance = EndOfLifeDateApiClient::DefaultApi.new
-product = TODO # Object | Product URL as per the canonical URL on the endofife.date website
+product = 'product_example' # String | Product URL as per the canonical URL on the endofife.date website.
 
 begin
   # Get All Details
@@ -166,7 +166,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(Object, Integer, Hash)> get_api_product_json_with_http_info(product)
+> <Array(<Array<Cycle>>, Integer, Hash)> get_api_product_json_with_http_info(product)
 
 ```ruby
 begin
@@ -174,7 +174,7 @@ begin
   data, status_code, headers = api_instance.get_api_product_json_with_http_info(product)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => Object
+  p data # => <Array<Cycle>>
 rescue EndOfLifeDateApiClient::ApiError => e
   puts "Error when calling DefaultApi->get_api_product_json_with_http_info: #{e}"
 end
@@ -184,11 +184,11 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **product** | [**Object**](.md) | Product URL as per the canonical URL on the endofife.date website |  |
+| **product** | **String** | Product URL as per the canonical URL on the endofife.date website. |  |
 
 ### Return type
 
-**Object**
+[**Array&lt;Cycle&gt;**](Cycle.md)
 
 ### Authorization
 

data/endoflife_date.gemspec

@@ -3,12 +3,12 @@
 =begin
 #endoflife.date
 
-#Documentation for the endoflife.date API. The API is currently in Alpha. Additional information about the API can be found on the [endoflife.date wiki](https://github.com/endoflife-date/endoflife.date/wiki)
+#The endoflife.date v0 API is currently deprecated, please [use the endoflife.date v1 API](https://endoflife.date/docs/api/v1/).
 
 The version of the OpenAPI document: 0.0.1
-Contact: blah@cliffano.com
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.0.0
+Generator version: 7.17.0
 
 =end
 
@@ -19,13 +19,14 @@ Gem::Specification.new do |s|
   s.name        = "endoflife_date"
   s.version     = EndOfLifeDateApiClient::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Cliffano Subagio"]
-  s.email       = ["blah@cliffano.com"]
-  s.homepage    = "https://github.com/cliffano/endoflife.date-api-clients"
+  s.authors     = ["OpenAPI Clients Factory"]
+  s.email       = ["blah+oapicf@cliffano.com"]
+  s.homepage    = "https://github.com/oapicf/endoflife.date-api-clients"
   s.summary     = "endoflife.date Ruby Gem"
-  s.description = "Documentation for the endoflife.date API. The API is currently in Alpha. Additional information about the API can be found on the [endoflife.date wiki](https://github.com/endoflife-date/endoflife.date/wiki)"
+  s.description = "The endoflife.date v0 API is currently deprecated, please [use the endoflife.date v1 API](https://endoflife.date/docs/api/v1/)."
   s.license     = "MIT"
   s.required_ruby_version = ">= 2.0"
+  s.metadata    = {}
 
   s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
 

data/git_push.sh

@@ -14,7 +14,7 @@ if [ "$git_host" = "" ]; then
 fi
 
 if [ "$git_user_id" = "" ]; then
-    git_user_id="cliffano"
+    git_user_id="oapicf"
     echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
 fi
 

data/lib/endoflife_date/api/default_api.rb

@@ -1,12 +1,12 @@
 =begin
 #endoflife.date
 
-#Documentation for the endoflife.date API. The API is currently in Alpha. Additional information about the API can be found on the [endoflife.date wiki](https://github.com/endoflife-date/endoflife.date/wiki)
+#The endoflife.date v0 API is currently deprecated, please [use the endoflife.date v1 API](https://endoflife.date/docs/api/v1/).
 
 The version of the OpenAPI document: 0.0.1
-Contact: blah@cliffano.com
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.0.0
+Generator version: 7.17.0
 
 =end
 
@@ -22,7 +22,7 @@ module EndOfLifeDateApiClient
     # All Products
     # Return a list of all products. Each of these can be used for the other API endpoints.
     # @param [Hash] opts the optional parameters
-    # @return [Object]
+    # @return [Array<String>]
     def get_api_all_json(opts = {})
       data, _status_code, _headers = get_api_all_json_with_http_info(opts)
       data
@@ -31,7 +31,7 @@ module EndOfLifeDateApiClient
     # All Products
     # Return a list of all products. Each of these can be used for the other API endpoints.
     # @param [Hash] opts the optional parameters
-    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    # @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
     def get_api_all_json_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: DefaultApi.get_api_all_json ...'
@@ -45,7 +45,7 @@ module EndOfLifeDateApiClient
       # 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] || {}
@@ -54,7 +54,7 @@ module EndOfLifeDateApiClient
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'Object'
+      return_type = opts[:debug_return_type] || 'Array<String>'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || []
@@ -77,9 +77,9 @@ module EndOfLifeDateApiClient
     end
 
     # Single cycle details
-    # Gets details of a single cycle
-    # @param product [Object] Product URL as per the canonical URL on the endofife.date website
-    # @param cycle [Object] Release Cycle for which the details must be fetched
+    # Gets details of a single cycle.
+    # @param product [String] Product URL as per the canonical URL on the endofife.date website.
+    # @param cycle [String] Release Cycle for which the details must be fetched. Any slash character in the cycle name will be replaced with dashes. For example FreeBSD&#39;s releng/14.0 becomes releng-14.0.
     # @param [Hash] opts the optional parameters
     # @return [Cycle]
     def get_api_product_cycle_json(product, cycle, opts = {})
@@ -88,9 +88,9 @@ module EndOfLifeDateApiClient
     end
 
     # Single cycle details
-    # Gets details of a single cycle
-    # @param product [Object] Product URL as per the canonical URL on the endofife.date website
-    # @param cycle [Object] Release Cycle for which the details must be fetched
+    # Gets details of a single cycle.
+    # @param product [String] Product URL as per the canonical URL on the endofife.date website.
+    # @param cycle [String] Release Cycle for which the details must be fetched. Any slash character in the cycle name will be replaced with dashes. For example FreeBSD&#39;s releng/14.0 becomes releng-14.0.
     # @param [Hash] opts the optional parameters
     # @return [Array<(Cycle, Integer, Hash)>] Cycle data, response status code and response headers
     def get_api_product_cycle_json_with_http_info(product, cycle, opts = {})
@@ -114,7 +114,7 @@ module EndOfLifeDateApiClient
       # 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] || {}
@@ -147,9 +147,9 @@ module EndOfLifeDateApiClient
 
     # Get All Details
     # Get EoL dates of all cycles of a given product.
-    # @param product [Object] Product URL as per the canonical URL on the endofife.date website
+    # @param product [String] Product URL as per the canonical URL on the endofife.date website.
     # @param [Hash] opts the optional parameters
-    # @return [Object]
+    # @return [Array<Cycle>]
     def get_api_product_json(product, opts = {})
       data, _status_code, _headers = get_api_product_json_with_http_info(product, opts)
       data
@@ -157,9 +157,9 @@ module EndOfLifeDateApiClient
 
     # Get All Details
     # Get EoL dates of all cycles of a given product.
-    # @param product [Object] Product URL as per the canonical URL on the endofife.date website
+    # @param product [String] Product URL as per the canonical URL on the endofife.date website.
     # @param [Hash] opts the optional parameters
-    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    # @return [Array<(Array<Cycle>, Integer, Hash)>] Array<Cycle> data, response status code and response headers
     def get_api_product_json_with_http_info(product, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: DefaultApi.get_api_product_json ...'
@@ -177,7 +177,7 @@ module EndOfLifeDateApiClient
       # 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] || {}
@@ -186,7 +186,7 @@ module EndOfLifeDateApiClient
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'Object'
+      return_type = opts[:debug_return_type] || 'Array<Cycle>'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || []

data/lib/endoflife_date/api_client.rb

@@ -1,12 +1,12 @@
 =begin
 #endoflife.date
 
-#Documentation for the endoflife.date API. The API is currently in Alpha. Additional information about the API can be found on the [endoflife.date wiki](https://github.com/endoflife-date/endoflife.date/wiki)
+#The endoflife.date v0 API is currently deprecated, please [use the endoflife.date v1 API](https://endoflife.date/docs/api/v1/).
 
 The version of the OpenAPI document: 0.0.1
-Contact: blah@cliffano.com
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.0.0
+Generator version: 7.17.0
 
 =end
 
@@ -17,6 +17,7 @@ require 'tempfile'
 require 'time'
 require 'typhoeus'
 
+
 module EndOfLifeDateApiClient
   class ApiClient
     # The Configuration object holding settings to be used in the API client.
@@ -45,9 +46,11 @@ module EndOfLifeDateApiClient
     # 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 = nil
+      (download_file(request) { tempfile = _1 }) if opts[:return_type] == 'File'
       response = request.run
 
       if @config.debugging
@@ -69,7 +72,9 @@ module EndOfLifeDateApiClient
         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
@@ -124,9 +129,7 @@ module EndOfLifeDateApiClient
         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
@@ -164,6 +167,8 @@ module EndOfLifeDateApiClient
     # process can use.
     #
     # @see Configuration#temp_folder_path
+    #
+    # @return [Tempfile] the tempfile generated
     def download_file(request)
       tempfile = nil
       encoding = nil
@@ -178,20 +183,21 @@ module EndOfLifeDateApiClient
         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`"
+      request.on_complete do
+        if !tempfile
+          fail ApiError.new("Failed to create the tempfile based on the HTTP response from the server: #{request.inspect}")
         end
+        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`"
+        yield tempfile if block_given?
       end
     end
 
@@ -204,7 +210,7 @@ module EndOfLifeDateApiClient
     # @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.
@@ -213,15 +219,10 @@ module EndOfLifeDateApiClient
     # @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'
@@ -288,7 +289,7 @@ module EndOfLifeDateApiClient
     # @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/endoflife_date/api_error.rb

@@ -1,12 +1,12 @@
 =begin
 #endoflife.date
 
-#Documentation for the endoflife.date API. The API is currently in Alpha. Additional information about the API can be found on the [endoflife.date wiki](https://github.com/endoflife-date/endoflife.date/wiki)
+#The endoflife.date v0 API is currently deprecated, please [use the endoflife.date v1 API](https://endoflife.date/docs/api/v1/).
 
 The version of the OpenAPI document: 0.0.1
-Contact: blah@cliffano.com
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.0.0
+Generator version: 7.17.0
 
 =end
 

data/lib/endoflife_date/api_model_base.rb

@@ -0,0 +1,88 @@
+=begin
+#endoflife.date
+
+#The endoflife.date v0 API is currently deprecated, please [use the endoflife.date v1 API](https://endoflife.date/docs/api/v1/).
+
+The version of the OpenAPI document: 0.0.1
+Contact: blah+oapicf@cliffano.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.17.0
+
+=end
+
+module EndOfLifeDateApiClient
+  class ApiModelBase
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = EndOfLifeDateApiClient.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/endoflife_date/configuration.rb

@@ -1,12 +1,12 @@
 =begin
 #endoflife.date
 
-#Documentation for the endoflife.date API. The API is currently in Alpha. Additional information about the API can be found on the [endoflife.date wiki](https://github.com/endoflife-date/endoflife.date/wiki)
+#The endoflife.date v0 API is currently deprecated, please [use the endoflife.date v1 API](https://endoflife.date/docs/api/v1/).
 
 The version of the OpenAPI document: 0.0.1
-Contact: blah@cliffano.com
+Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.0.0
+Generator version: 7.17.0
 
 =end
 
@@ -79,6 +79,14 @@ module EndOfLifeDateApiClient
     # @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.
     #
@@ -166,6 +174,7 @@ module EndOfLifeDateApiClient
       @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)
@@ -200,6 +209,7 @@ module EndOfLifeDateApiClient
 
     # Returns base URL for specified operation based on server settings
     def base_url(operation = nil)
+      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])
@@ -222,8 +232,8 @@ module EndOfLifeDateApiClient
 
     # 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
+      return access_token if access_token_getter.nil?
+      access_token_getter.call
     end
 
     # Gets Basic Auth token string
@@ -286,5 +296,6 @@ module EndOfLifeDateApiClient
       url
     end
 
+
   end
 end