nordlet 0.0.0 → 0.2.0

data/lib/nordlet/internal/multipart/multipart_encoder.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module Nordlet
+  module Internal
+    module Multipart
+      # Encodes parameters into a `multipart/form-data` payload as described by RFC
+      # 2388:
+      #
+      #     https://tools.ietf.org/html/rfc2388
+      #
+      # This is most useful for transferring file-like objects.
+      #
+      # Parameters should be added with `#encode`. When ready, use `#body` to get
+      # the encoded result and `#content_type` to get the value that should be
+      # placed in the `Content-Type` header of a subsequent request (which includes
+      # a boundary value).
+      #
+      # This abstraction is heavily inspired by Stripe's multipart/form-data implementation,
+      # which can be found here:
+      #
+      #     https://github.com/stripe/stripe-ruby/blob/ca00b676f04ac421cf5cb5ff0325f243651677b6/lib/stripe/multipart_encoder.rb#L18
+      #
+      # @api private
+      class Encoder
+        CONTENT_TYPE = "multipart/form-data"
+        CRLF = "\r\n"
+
+        attr_reader :boundary, :body
+
+        def initialize
+          # Chose the same number of random bytes that Go uses in its standard
+          # library implementation. Easily enough entropy to ensure that it won't
+          # be present in a file we're sending.
+          @boundary = SecureRandom.hex(30)
+
+          @body = String.new
+          @closed = false
+          @first_field = true
+        end
+
+        # Gets the content type string including the boundary.
+        #
+        # @return [String] The content type with boundary
+        def content_type
+          "#{CONTENT_TYPE}; boundary=#{@boundary}"
+        end
+
+        # Encode the given FormData object into a multipart/form-data payload.
+        #
+        # @param form_data [FormData] The form data to encode
+        # @return [String] The encoded body.
+        def encode(form_data)
+          return "" if form_data.parts.empty?
+
+          form_data.parts.each do |part|
+            write_part(part)
+          end
+          close
+
+          @body
+        end
+
+        # Writes a FormDataPart to the encoder.
+        #
+        # @param part [FormDataPart] The part to write
+        # @return [nil]
+        def write_part(part)
+          raise "Cannot write to closed encoder" if @closed
+
+          write_field(
+            name: part.name,
+            data: part.contents,
+            filename: part.filename,
+            headers: part.headers
+          )
+
+          nil
+        end
+
+        # Writes a field to the encoder.
+        #
+        # @param name [String] The field name
+        # @param data [String] The field data
+        # @param filename [String, nil] Optional filename
+        # @param headers [Hash<String, String>, nil] Optional additional headers
+        # @return [nil]
+        def write_field(name:, data:, filename: nil, headers: nil)
+          raise "Cannot write to closed encoder" if @closed
+
+          if @first_field
+            @first_field = false
+          else
+            @body << CRLF
+          end
+
+          @body << "--#{@boundary}#{CRLF}"
+          @body << %(Content-Disposition: form-data; name="#{escape(name.to_s)}")
+          @body << %(; filename="#{escape(filename)}") if filename
+          @body << CRLF
+
+          if headers
+            headers.each do |key, value|
+              @body << "#{key}: #{value}#{CRLF}"
+            end
+          elsif filename
+            # Default content type for files.
+            @body << "Content-Type: application/octet-stream#{CRLF}"
+          end
+
+          @body << CRLF
+          @body << data.to_s
+
+          nil
+        end
+
+        # Finalizes the encoder by writing the final boundary.
+        #
+        # @return [nil]
+        def close
+          raise "Encoder already closed" if @closed
+
+          @body << CRLF
+          @body << "--#{@boundary}--"
+          @closed = true
+
+          nil
+        end
+
+        private
+
+        # Escapes quotes for use in header values and replaces line breaks with spaces.
+        #
+        # @param str [String] The string to escape
+        # @return [String] The escaped string
+        def escape(str)
+          str.to_s.gsub('"', "%22").tr("\n", " ").tr("\r", " ")
+        end
+      end
+    end
+  end
+end

data/lib/nordlet/internal/multipart/multipart_form_data.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Nordlet
+  module Internal
+    module Multipart
+      # @api private
+      class FormData
+        # @return [Array<FormDataPart>] The parts in this multipart form data.
+        attr_reader :parts
+
+        # @return [Encoder] The encoder for this multipart form data.
+        private attr_reader :encoder
+
+        def initialize
+          @encoder = Encoder.new
+          @parts = []
+        end
+
+        # Adds a new part to the multipart form data.
+        #
+        # @param name [String] The name of the form field
+        # @param value [String, Integer, Float, Boolean, #read] The value of the field
+        # @param content_type [String, nil] Optional content type
+        # @return [self] Returns self for chaining
+        def add(name:, value:, content_type: nil)
+          headers = content_type ? { "Content-Type" => content_type } : nil
+          add_part(FormDataPart.new(name:, value:, headers:))
+        end
+
+        # Adds a file to the multipart form data.
+        #
+        # @param name [String] The name of the form field
+        # @param file [#read] The file or readable object
+        # @param filename [String, nil] Optional filename (defaults to basename of path for File objects)
+        # @param content_type [String, nil] Optional content type (e.g. "image/png")
+        # @return [self] Returns self for chaining
+        def add_file(name:, file:, filename: nil, content_type: nil)
+          headers = content_type ? { "Content-Type" => content_type } : nil
+          filename ||= filename_for(file)
+          add_part(FormDataPart.new(name:, value: file, filename:, headers:))
+        end
+
+        # Adds a pre-created part to the multipart form data.
+        #
+        # @param part [FormDataPart] The part to add
+        # @return [self] Returns self for chaining
+        def add_part(part)
+          @parts << part
+          self
+        end
+
+        # Gets the content type string including the boundary.
+        #
+        # @return [String] The content type with boundary.
+        def content_type
+          @encoder.content_type
+        end
+
+        # Encode the multipart form data into a multipart/form-data payload.
+        #
+        # @return [String] The encoded body.
+        def encode
+          @encoder.encode(self)
+        end
+
+        private
+
+        def filename_for(file)
+          if file.is_a?(::File) || file.respond_to?(:path)
+            ::File.basename(file.path)
+          elsif file.respond_to?(:name)
+            file.name
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nordlet/internal/multipart/multipart_form_data_part.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "securerandom"
+
+module Nordlet
+  module Internal
+    module Multipart
+      # @api private
+      class FormDataPart
+        attr_reader :name, :contents, :filename, :headers
+
+        # @param name [String] The name of the form field
+        # @param value [String, Integer, Float, Boolean, File, #read] The value of the field
+        # @param filename [String, nil] Optional filename for file uploads
+        # @param headers [Hash<String, String>, nil] Optional additional headers
+        def initialize(name:, value:, filename: nil, headers: nil)
+          @name = name
+          @contents = convert_to_content(value)
+          @filename = filename
+          @headers = headers
+        end
+
+        # Converts the part to a hash suitable for serialization.
+        #
+        # @return [Hash] A hash representation of the part
+        def to_hash
+          result = {
+            name: @name,
+            contents: @contents
+          }
+          result[:filename] = @filename if @filename
+          result[:headers] = @headers if @headers
+          result
+        end
+
+        private
+
+        # Converts various types of values to a content representation
+        # @param value [String, Integer, Float, Boolean, #read] The value to convert
+        # @return [String] The string representation of the value
+        def convert_to_content(value)
+          if value.respond_to?(:read)
+            value.read
+          else
+            value.to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nordlet/internal/multipart/multipart_request.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Nordlet
+  module Internal
+    module Multipart
+      # @api private
+      class Request < Nordlet::Internal::Http::BaseRequest
+        attr_reader :body
+
+        # @param base_url [String] The base URL for the request
+        # @param path [String] The path for the request
+        # @param method [Symbol] The HTTP method for the request (:get, :post, etc.)
+        # @param headers [Hash] Additional headers for the request (optional)
+        # @param query [Hash] Query parameters for the request (optional)
+        # @param body [MultipartFormData, nil] The multipart form data for the request (optional)
+        # @param request_options [Nordlet::RequestOptions, Hash{Symbol=>Object}, nil]
+        def initialize(base_url:, path:, method:, headers: {}, query: {}, body: nil, request_options: {})
+          super(base_url:, path:, method:, headers:, query:, request_options:)
+
+          @body = body
+        end
+
+        # @return [Hash] The encoded HTTP request headers.
+        # @param protected_keys [Array<String>] Header keys set by the SDK client (e.g. auth, metadata)
+        #   that must not be overridden by additional_headers from request_options.
+        def encode_headers(protected_keys: [])
+          sdk_headers = {
+            "Content-Type" => @body.content_type
+          }.merge(@headers)
+          merge_additional_headers(sdk_headers, protected_keys:)
+        end
+
+        # @return [String, nil] The encoded HTTP request body.
+        def encode_body
+          @body&.encode
+        end
+      end
+    end
+  end
+end

data/lib/nordlet/internal/types/array.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Nordlet
+  module Internal
+    module Types
+      # An array of a specific type
+      class Array
+        include Nordlet::Internal::Types::Type
+
+        attr_reader :type
+
+        class << self
+          # Instantiates a new `Array` of a given type
+          #
+          # @param type [Object] The member type of this array
+          #
+          # @return [Nordlet::Internal::Types::Array]
+          def [](type)
+            new(type)
+          end
+        end
+
+        # @api private
+        def initialize(type)
+          @type = type
+        end
+
+        # Coerces a value into this array
+        #
+        # @param value [Object]
+        # @option strict [Boolean]
+        # @return [::Array]
+        def coerce(value, strict: strict?)
+          unless value.is_a?(::Array)
+            raise Errors::TypeError, "cannot coerce `#{value.class}` to Array<#{type}>" if strict
+
+            return value
+          end
+
+          value.map do |element|
+            Utils.coerce(type, element, strict: strict)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nordlet/internal/types/boolean.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Nordlet
+  module Internal
+    module Types
+      module Boolean
+        extend Nordlet::Internal::Types::Union
+
+        member TrueClass
+        member FalseClass
+
+        # Overrides the base coercion method for enums to allow integer and string values to become booleans
+        #
+        # @param value [Object]
+        # @option strict [Boolean]
+        # @return [Object]
+        def self.coerce(value, strict: strict?)
+          case value
+          when TrueClass, FalseClass
+            return value
+          when Integer
+            return value == 1
+          when String
+            return %w[1 true].include?(value)
+          end
+
+          raise Errors::TypeError, "cannot coerce `#{value.class}` to Boolean" if strict
+
+          value
+        end
+      end
+    end
+  end
+end

data/lib/nordlet/internal/types/enum.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Nordlet
+  module Internal
+    module Types
+      # Module for defining enums
+      module Enum
+        include Type
+
+        # @api private
+        #
+        # @return [Array<Object>]
+        def values
+          @values ||= constants.map { |c| const_get(c) }
+        end
+
+        # @api private
+        def finalize!
+          values
+        end
+
+        # @api private
+        def strict?
+          @strict ||= false
+        end
+
+        # @api private
+        def strict!
+          @strict = true
+        end
+
+        def coerce(value, strict: strict?)
+          coerced_value = Utils.coerce(Symbol, value)
+
+          return coerced_value if values.include?(coerced_value)
+
+          raise Errors::TypeError, "`#{value}` not in enum #{self}" if strict
+
+          value
+        end
+
+        # Parse JSON string and coerce to the enum value
+        #
+        # @param str [String] JSON string to parse
+        # @return [String] The enum value
+        def load(str)
+          coerce(::JSON.parse(str))
+        end
+
+        def inspect
+          "#{name}[#{values.join(", ")}]"
+        end
+      end
+    end
+  end
+end

data/lib/nordlet/internal/types/hash.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Nordlet
+  module Internal
+    module Types
+      class Hash
+        include Type
+
+        attr_reader :key_type, :value_type
+
+        class << self
+          def [](key_type, value_type)
+            new(key_type, value_type)
+          end
+        end
+
+        def initialize(key_type, value_type)
+          @key_type = key_type
+          @value_type = value_type
+        end
+
+        def coerce(value, strict: strict?)
+          unless value.is_a?(::Hash)
+            raise Errors::TypeError, "not hash" if strict
+
+            return value
+          end
+
+          value.to_h do |k, v|
+            [Utils.coerce(key_type, k, strict: strict), Utils.coerce(value_type, v, strict: strict)]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nordlet/internal/types/model/field.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Nordlet
+  module Internal
+    module Types
+      class Model
+        # Definition of a field on a model
+        class Field
+          SENSITIVE_FIELD_NAMES = %i[
+            password secret token api_key apikey access_token refresh_token
+            client_secret client_id credential bearer authorization
+          ].freeze
+
+          attr_reader :name, :type, :optional, :nullable, :api_name, :value, :default
+
+          def initialize(name:, type:, optional: false, nullable: false, api_name: nil, value: nil, default: nil)
+            @name = name.to_sym
+            @type = type
+            @optional = optional
+            @nullable = nullable
+            @api_name = api_name || name.to_s
+            @value = value
+            @default = default
+          end
+
+          def literal?
+            !value.nil?
+          end
+
+          def sensitive?
+            SENSITIVE_FIELD_NAMES.include?(@name) ||
+              SENSITIVE_FIELD_NAMES.any? { |sensitive| @name.to_s.include?(sensitive.to_s) }
+          end
+        end
+      end
+    end
+  end
+end