seatschart 0.2.0 → 0.3.0

data/lib/seatschart/models/put_internal_status_notices_request_notices_inner.rb

@@ -0,0 +1,445 @@
+=begin
+#SeatsChart API
+
+#Seat inventory and locking API for B2B2C integrations. Authenticate using `x-api-key` (partners) or `Authorization: Bearer` with an HS256 JWT.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.11.0
+
+=end
+
+require 'date'
+require 'time'
+
+module SeatsChart
+  class PutInternalStatusNoticesRequestNoticesInner
+    attr_accessor :id
+
+    attr_accessor :kind
+
+    attr_accessor :title
+
+    attr_accessor :message
+
+    attr_accessor :impact
+
+    attr_accessor :components
+
+    attr_accessor :starts_at
+
+    attr_accessor :ends_at
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'kind' => :'kind',
+        :'title' => :'title',
+        :'message' => :'message',
+        :'impact' => :'impact',
+        :'components' => :'components',
+        :'starts_at' => :'startsAt',
+        :'ends_at' => :'endsAt'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'kind' => :'String',
+        :'title' => :'String',
+        :'message' => :'String',
+        :'impact' => :'String',
+        :'components' => :'Array<String>',
+        :'starts_at' => :'Time',
+        :'ends_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'ends_at'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SeatsChart::PutInternalStatusNoticesRequestNoticesInner` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SeatsChart::PutInternalStatusNoticesRequestNoticesInner`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'kind')
+        self.kind = attributes[:'kind']
+      else
+        self.kind = nil
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      else
+        self.title = nil
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      end
+
+      if attributes.key?(:'impact')
+        self.impact = attributes[:'impact']
+      end
+
+      if attributes.key?(:'components')
+        if (value = attributes[:'components']).is_a?(Array)
+          self.components = value
+        end
+      end
+
+      if attributes.key?(:'starts_at')
+        self.starts_at = attributes[:'starts_at']
+      else
+        self.starts_at = nil
+      end
+
+      if attributes.key?(:'ends_at')
+        self.ends_at = attributes[:'ends_at']
+      end
+    end
+
+    # 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
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @id.to_s.length > 64
+        invalid_properties.push('invalid value for "id", the character length must be smaller than or equal to 64.')
+      end
+
+      if @id.to_s.length < 1
+        invalid_properties.push('invalid value for "id", the character length must be great than or equal to 1.')
+      end
+
+      pattern = Regexp.new(/^[A-Za-z0-9_-]+$/)
+      if @id !~ pattern
+        invalid_properties.push("invalid value for \"id\", must conform to the pattern #{pattern}.")
+      end
+
+      if @kind.nil?
+        invalid_properties.push('invalid value for "kind", kind cannot be nil.')
+      end
+
+      if @title.nil?
+        invalid_properties.push('invalid value for "title", title cannot be nil.')
+      end
+
+      if @title.to_s.length > 160
+        invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 160.')
+      end
+
+      if @title.to_s.length < 1
+        invalid_properties.push('invalid value for "title", the character length must be great than or equal to 1.')
+      end
+
+      if !@message.nil? && @message.to_s.length > 2000
+        invalid_properties.push('invalid value for "message", the character length must be smaller than or equal to 2000.')
+      end
+
+      if !@components.nil? && @components.length > 7
+        invalid_properties.push('invalid value for "components", number of items must be less than or equal to 7.')
+      end
+
+      if @starts_at.nil?
+        invalid_properties.push('invalid value for "starts_at", starts_at cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # 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'
+      return false if @id.nil?
+      return false if @id.to_s.length > 64
+      return false if @id.to_s.length < 1
+      return false if @id !~ Regexp.new(/^[A-Za-z0-9_-]+$/)
+      return false if @kind.nil?
+      kind_validator = EnumAttributeValidator.new('String', ["incident", "maintenance"])
+      return false unless kind_validator.valid?(@kind)
+      return false if @title.nil?
+      return false if @title.to_s.length > 160
+      return false if @title.to_s.length < 1
+      return false if !@message.nil? && @message.to_s.length > 2000
+      impact_validator = EnumAttributeValidator.new('String', ["none", "minor", "major"])
+      return false unless impact_validator.valid?(@impact)
+      return false if !@components.nil? && @components.length > 7
+      return false if @starts_at.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      if id.to_s.length > 64
+        fail ArgumentError, 'invalid value for "id", the character length must be smaller than or equal to 64.'
+      end
+
+      if id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "id", the character length must be great than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^[A-Za-z0-9_-]+$/)
+      if id !~ pattern
+        fail ArgumentError, "invalid value for \"id\", must conform to the pattern #{pattern}."
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] kind Object to be assigned
+    def kind=(kind)
+      validator = EnumAttributeValidator.new('String', ["incident", "maintenance"])
+      unless validator.valid?(kind)
+        fail ArgumentError, "invalid value for \"kind\", must be one of #{validator.allowable_values}."
+      end
+      @kind = kind
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] title Value to be assigned
+    def title=(title)
+      if title.nil?
+        fail ArgumentError, 'title cannot be nil'
+      end
+
+      if title.to_s.length > 160
+        fail ArgumentError, 'invalid value for "title", the character length must be smaller than or equal to 160.'
+      end
+
+      if title.to_s.length < 1
+        fail ArgumentError, 'invalid value for "title", the character length must be great than or equal to 1.'
+      end
+
+      @title = title
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] message Value to be assigned
+    def message=(message)
+      if message.nil?
+        fail ArgumentError, 'message cannot be nil'
+      end
+
+      if message.to_s.length > 2000
+        fail ArgumentError, 'invalid value for "message", the character length must be smaller than or equal to 2000.'
+      end
+
+      @message = message
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] impact Object to be assigned
+    def impact=(impact)
+      validator = EnumAttributeValidator.new('String', ["none", "minor", "major"])
+      unless validator.valid?(impact)
+        fail ArgumentError, "invalid value for \"impact\", must be one of #{validator.allowable_values}."
+      end
+      @impact = impact
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          kind == o.kind &&
+          title == o.title &&
+          message == o.message &&
+          impact == o.impact &&
+          components == o.components &&
+          starts_at == o.starts_at &&
+          ends_at == o.ends_at
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [id, kind, title, message, impact, components, starts_at, ends_at].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      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 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 = SeatsChart.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
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      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/seatschart/retry.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Retry and idempotency helpers for the SeatsChart Ruby client.
+# Retry, timeout and idempotency helpers for the SeatsChart Ruby client.
 # Copied into the generated gem (lib/seatschart/retry.rb) and required from lib/seatschart.rb by
 # scripts/generate-server-sdks.sh.
 #
@@ -9,8 +9,13 @@
 # OPTIONS, PUT, DELETE) and requests carrying an Idempotency-Key header, which is resent unchanged so the
 # API replays the stored outcome instead of applying it twice.
 #
+# Every attempt is bounded, as in seats.io's SDKs: 10 s to connect and 30 s in total (Typhoeus
+# connecttimeout_ms / timeout_ms, set on every request whose configuration has no timeout of its own;
+# nil or 0 disables one). A timed-out attempt is retried like a 503 when it is safe to repeat; the last
+# one raises SeatsChart::Retry::TimeoutError (an ApiError whose error_code is 'timeout').
+#
 #   SeatsChart.configure { |c| c.api_key['x-api-key'] = ENV['SEATSCHART_KEY'] }
-#   SeatsChart::Retry.policy = SeatsChart::Retry::Policy.new(max_attempts: 5)   # optional
+#   SeatsChart::Retry.policy = SeatsChart::Retry::Policy.new(max_attempts: 5, timeout: 20) # optional
 #   api.reserve(body, header_params: SeatsChart::Retry.idempotency_headers('order-42'))
 require 'securerandom'
 require 'time'
@@ -19,6 +24,54 @@ module SeatsChart
   module Retry
     IDEMPOTENCY_KEY_HEADER = 'Idempotency-Key'
     IDEMPOTENT_METHODS = %w[GET HEAD OPTIONS PUT DELETE].freeze
+    DEFAULT_CONNECT_TIMEOUT = 10.0
+    DEFAULT_TIMEOUT = 30.0
+
+    # A request whose last attempt timed out. The outcome on the server is unknown: retry writes with the same
+    # Idempotency-Key. An ApiError (when the generated client defines it), so existing rescue clauses still apply.
+    class TimeoutError < (SeatsChart.const_defined?(:ApiError) ? SeatsChart::ApiError : StandardError)
+      attr_reader :http_method, :path, :timeout, :attempts
+
+      def initialize(http_method, path, timeout, attempts)
+        @http_method = http_method.to_s.upcase
+        @path = path
+        @timeout = timeout
+        @attempts = attempts
+        @message = "SeatsChart API request timed out (#{@http_method} #{path}, timeout #{timeout.inspect} s, #{attempts} attempt(s))"
+        # Bypass the parent's constructor: its signature belongs to the generated client.
+        StandardError.instance_method(:initialize).bind(self).call(@message)
+      end
+
+      # Stable error code.
+      def error_code
+        'timeout'
+      end
+
+      def timeout?
+        true
+      end
+
+      # No HTTP status: there was no response.
+      def code
+        nil
+      end
+
+      def response_headers
+        {}
+      end
+
+      def response_body
+        nil
+      end
+
+      def message
+        @message
+      end
+
+      def to_s
+        @message
+      end
+    end
 
     # A fresh key for one logical operation; reuse it for every retry of that operation.
     def self.new_idempotency_key
@@ -35,6 +88,14 @@ module SeatsChart
       (headers || {}).any? { |name, value| name.to_s.casecmp?('idempotency-key') && !value.to_s.strip.empty? }
     end
 
+    # True for TimeoutError and for the generated client's timeout ApiError ("Connection timed out", no status).
+    def self.timeout_error?(error)
+      return true if error.is_a?(TimeoutError)
+      return false unless error.respond_to?(:code)
+
+      (error.code.nil? || error.code.to_i.zero?) && error.message.to_s.match?(/timed out|timeout was reached/i)
+    end
+
     # Retry-After in seconds (delta-seconds or HTTP date); nil when absent or invalid.
     def self.parse_retry_after(value, now = Time.now)
       return nil if value.nil? || value.to_s.strip.empty?
@@ -56,11 +117,14 @@ module SeatsChart
     end
 
     class Policy
-      attr_reader :max_attempts, :base_delay, :max_delay, :max_retry_after, :statuses
+      attr_reader :max_attempts, :base_delay, :max_delay, :max_retry_after, :statuses, :timeout, :connect_timeout,
+                  :retry_on_timeout
 
       def initialize(max_attempts: 4, base_delay: 0.25, max_delay: 8.0, max_retry_after: 30.0, statuses: [429, 503],
-                     sleeper: ->(seconds) { sleep(seconds) }, random: -> { rand })
+                     sleeper: ->(seconds) { sleep(seconds) }, random: -> { rand },
+                     timeout: DEFAULT_TIMEOUT, connect_timeout: DEFAULT_CONNECT_TIMEOUT, retry_on_timeout: true)
         raise ArgumentError, 'max_attempts must be >= 1' if max_attempts < 1
+        raise ArgumentError, 'timeouts must be >= 0' if [timeout, connect_timeout].any? { |t| t && t.negative? }
 
         @max_attempts = max_attempts
         @base_delay = base_delay
@@ -69,6 +133,9 @@ module SeatsChart
         @statuses = statuses
         @sleeper = sleeper
         @random = random
+        @timeout = timeout.nil? || timeout.zero? ? nil : timeout
+        @connect_timeout = connect_timeout.nil? || connect_timeout.zero? ? nil : connect_timeout
+        @retry_on_timeout = retry_on_timeout
       end
 
       # Seconds to wait before retry number attempt (1-based); nil when Retry-After is too long.
@@ -82,6 +149,22 @@ module SeatsChart
       def wait(seconds)
         @sleeper.call(seconds)
       end
+
+      # Sets the default timeouts on Typhoeus request options that have none (a positive :timeout of the
+      # configuration wins). Returns the options.
+      def apply_timeouts(options)
+        return options unless options.is_a?(Hash)
+
+        own_total = options[:timeout].to_f.positive? || options.key?(:timeout_ms)
+        if timeout && !own_total
+          options.delete(:timeout)
+          options[:timeout_ms] = (timeout * 1000).round
+        end
+        if connect_timeout && !options.key?(:connecttimeout) && !options.key?(:connecttimeout_ms)
+          options[:connecttimeout_ms] = (connect_timeout * 1000).round
+        end
+        options
+      end
     end
 
     class << self
@@ -92,16 +175,32 @@ module SeatsChart
       end
     end
 
-    # Prepended to the generated ApiClient: repeats call_api on retryable ApiErrors.
+    # Prepended to the generated ApiClient: default timeouts on each request, and call_api repeated on retryable
+    # ApiErrors and timed-out attempts.
     module ApiClientExtension
+      def build_request(http_method, path, opts = {})
+        request = super
+        SeatsChart::Retry.policy.apply_timeouts(request.options) if request.respond_to?(:options)
+        request
+      end
+
       def call_api(http_method, path, opts = {})
         policy = SeatsChart::Retry.policy
         attempt = 1
         begin
           super
         rescue SeatsChart::ApiError => e
-          raise unless attempt < policy.max_attempts && policy.statuses.include?(e.code.to_i) &&
-                       SeatsChart::Retry.retry_safe?(http_method, opts[:header_params])
+          safe = SeatsChart::Retry.retry_safe?(http_method, opts[:header_params])
+          if SeatsChart::Retry.timeout_error?(e)
+            unless attempt < policy.max_attempts && policy.retry_on_timeout && safe
+              raise SeatsChart::Retry::TimeoutError.new(http_method, path, policy.timeout, attempt)
+            end
+
+            policy.wait(policy.delay(attempt, nil))
+            attempt += 1
+            retry
+          end
+          raise unless attempt < policy.max_attempts && policy.statuses.include?(e.code.to_i) && safe
 
           wait = policy.delay(attempt, SeatsChart::Retry.parse_retry_after(SeatsChart::Retry.header(e.response_headers, 'Retry-After')))
           raise if wait.nil?

data/lib/seatschart/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.11.0
 =end
 
 module SeatsChart
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end