api_particulier 0.1.0

data/lib/api_particulier/commons/middleware/error_handler.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+# DO NOT EDIT — generated from clients/ruby/commons/ (source digest: 903f3b3aca1a59a6cb1a53ab98f72c365486fc1f).
+# Regenerate via clients/ruby/bin/sync_commons.
+
+require 'faraday'
+require 'json'
+
+module ApiParticulier::Commons
+  module Middleware
+    class ErrorHandler < Faraday::Middleware
+      AUTH_CODES = %w[00101 00103 00105].freeze
+      AUTHORIZATION_CODES = %w[00100].freeze
+
+      def on_complete(env)
+        status = env.status
+        return if status.between?(200, 299)
+
+        exception = map_exception(status, env)
+        raise exception if exception
+      end
+
+      def call(env)
+        super
+      rescue Faraday::TimeoutError, Faraday::ConnectionFailed => e
+        raise ApiParticulier::Commons::TransportError.new(
+          e.message,
+          method: env.method,
+          url: env.url.to_s
+        )
+      end
+
+      private
+
+      def map_exception(status, env)
+        errors = extract_errors(env.body)
+        klass = klass_for(status)
+        return nil unless klass
+
+        kwargs = {
+          http_status: status,
+          errors: errors,
+          method: env.method,
+          url: env.url.to_s
+        }
+
+        if klass == ApiParticulier::Commons::RateLimitError
+          kwargs[:retry_after] = compute_retry_after(env, errors)
+        elsif klass == ApiParticulier::Commons::ProviderError
+          kwargs[:retry_after] = provider_retry(errors)
+        end
+
+        klass.new(nil, **kwargs)
+      end
+
+      def klass_for(status)
+        case status
+        when 401 then ApiParticulier::Commons::AuthenticationError
+        when 403 then ApiParticulier::Commons::AuthorizationError
+        when 404 then ApiParticulier::Commons::NotFoundError
+        when 409 then ApiParticulier::Commons::ConflictError
+        when 422 then ApiParticulier::Commons::ValidationError
+        when 429 then ApiParticulier::Commons::RateLimitError
+        when 400..499 then ApiParticulier::Commons::ClientError
+        when 502 then ApiParticulier::Commons::ProviderError
+        when 503, 504 then ApiParticulier::Commons::ProviderUnavailableError
+        when 500..599 then ApiParticulier::Commons::ServerError
+        end
+      end
+
+      def extract_errors(body)
+        parsed = body
+        parsed = safely_parse(body) if body.is_a?(String)
+        return [] unless parsed.is_a?(Hash)
+
+        Array(parsed['errors'] || parsed[:errors])
+      end
+
+      def safely_parse(body)
+        JSON.parse(body)
+      rescue JSON::ParserError
+        nil
+      end
+
+      def compute_retry_after(env, errors)
+        from_headers = ApiParticulier::Commons::RateLimit.from_headers(env.response_headers)&.retry_after
+        return from_headers if from_headers && from_headers.positive?
+
+        provider_retry(errors) || from_headers
+      end
+
+      def provider_retry(errors)
+        first = errors.first || {}
+        meta = first['meta'] || first[:meta] || {}
+        value = meta['retry_in'] || meta[:retry_in]
+        return nil if value.nil?
+
+        Integer(value)
+      rescue ArgumentError, TypeError
+        nil
+      end
+    end
+  end
+end
+# No Faraday.register_middleware: symbols are process-global and collide when
+# multiple gouv.fr gems are loaded in the same process. Clients pass the class
+# directly to conn.response / conn.use.

data/lib/api_particulier/commons/middleware/logging.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+# DO NOT EDIT — generated from clients/ruby/commons/ (source digest: 903f3b3aca1a59a6cb1a53ab98f72c365486fc1f).
+# Regenerate via clients/ruby/bin/sync_commons.
+
+require 'faraday'
+
+module ApiParticulier::Commons
+  module Middleware
+    class Logging < Faraday::Middleware
+      def initialize(app, logger: nil, redact_query: false)
+        super(app)
+        @logger = logger
+        @redact_query = redact_query
+      end
+
+      def call(env)
+        started = monotonic_now
+        response = @app.call(env)
+        log(env, response, monotonic_now - started) if @logger
+        response
+      rescue StandardError => e
+        log_error(env, e, monotonic_now - started) if @logger
+        raise
+      end
+
+      private
+
+      def log(env, response, duration_ms)
+        @logger.info(
+          method: env.method.to_s.upcase,
+          url: safe_url(env.url),
+          status: response.status,
+          duration_ms: duration_ms.round(1),
+          rate_limit_remaining: extract_remaining(response.env.response_headers)
+        )
+      end
+
+      def log_error(env, exception, duration_ms)
+        @logger.error(
+          method: env.method.to_s.upcase,
+          url: safe_url(env.url),
+          error: exception.class.name,
+          message: exception.message,
+          duration_ms: duration_ms.round(1)
+        )
+      end
+
+      def safe_url(url)
+        return url.to_s unless @redact_query
+
+        dup = url.dup
+        dup.query = nil
+        "#{dup}?[REDACTED]"
+      end
+
+      def extract_remaining(headers)
+        return nil unless headers
+
+        headers.each do |k, v|
+          return v.to_i if k.to_s.downcase == 'ratelimit-remaining' && !v.nil? && !v.to_s.empty?
+        end
+        nil
+      end
+
+      def monotonic_now
+        Process.clock_gettime(Process::CLOCK_MONOTONIC) * 1000.0
+      end
+    end
+  end
+end

data/lib/api_particulier/commons/middleware/rate_limit.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+# DO NOT EDIT — generated from clients/ruby/commons/ (source digest: 903f3b3aca1a59a6cb1a53ab98f72c365486fc1f).
+# Regenerate via clients/ruby/bin/sync_commons.
+
+require 'faraday'
+
+module ApiParticulier::Commons
+  module Middleware
+    class RateLimitParser < Faraday::Middleware
+      ENV_KEY = :api_gouv_rate_limit
+
+      def on_complete(env)
+        env[ENV_KEY] = ApiParticulier::Commons::RateLimit.from_headers(env.response_headers)
+      end
+    end
+  end
+end

data/lib/api_particulier/commons/rate_limit.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+# DO NOT EDIT — generated from clients/ruby/commons/ (source digest: 903f3b3aca1a59a6cb1a53ab98f72c365486fc1f).
+# Regenerate via clients/ruby/bin/sync_commons.
+
+module ApiParticulier::Commons
+  class RateLimit
+    attr_reader :limit, :remaining, :reset_at
+
+    def self.from_headers(headers)
+      return nil if headers.nil?
+
+      normalized = headers.transform_keys { |k| k.to_s.downcase }
+      limit = parse_int(normalized['ratelimit-limit'])
+      remaining = parse_int(normalized['ratelimit-remaining'])
+      reset_at = parse_reset(normalized['ratelimit-reset'])
+
+      return nil if limit.nil? && remaining.nil? && reset_at.nil?
+
+      new(limit: limit, remaining: remaining, reset_at: reset_at)
+    end
+
+    def self.parse_int(value)
+      return nil if value.nil? || value.to_s.strip.empty?
+
+      Integer(value.to_s, 10)
+    rescue ArgumentError
+      nil
+    end
+
+    def self.parse_reset(value)
+      ts = parse_int(value)
+      return nil if ts.nil?
+
+      Time.at(ts).utc
+    end
+
+    def initialize(limit:, remaining:, reset_at:)
+      @limit = limit
+      @remaining = remaining
+      @reset_at = reset_at
+    end
+
+    def retry_after(now: Time.now)
+      return nil if reset_at.nil?
+
+      diff = reset_at.to_i - now.to_i
+      diff.negative? ? 0 : diff
+    end
+
+    def to_h
+      { limit: limit, remaining: remaining, reset_at: reset_at }
+    end
+  end
+end

data/lib/api_particulier/commons/response.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+# DO NOT EDIT — generated from clients/ruby/commons/ (source digest: 903f3b3aca1a59a6cb1a53ab98f72c365486fc1f).
+# Regenerate via clients/ruby/bin/sync_commons.
+
+module ApiParticulier::Commons
+  class Response
+    attr_reader :raw, :http_status, :headers, :rate_limit
+
+    def initialize(raw:, http_status:, headers:, rate_limit: nil)
+      @raw = raw.is_a?(Hash) ? raw : {}
+      @http_status = http_status
+      @headers = headers || {}
+      @rate_limit = rate_limit
+    end
+
+    def data
+      raw['data']
+    end
+
+    def links
+      raw['links'] || {}
+    end
+
+    def meta
+      raw['meta'] || {}
+    end
+
+    def success?
+      http_status.to_i.between?(200, 299)
+    end
+  end
+end

data/lib/api_particulier/commons/siren.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+# DO NOT EDIT — generated from clients/ruby/commons/ (source digest: 903f3b3aca1a59a6cb1a53ab98f72c365486fc1f).
+# Regenerate via clients/ruby/bin/sync_commons.
+
+module ApiParticulier::Commons
+  module Siren
+    module_function
+
+    DIGITS_9 = /\A\d{9}\z/.freeze
+    LA_POSTE_PATTERN = /\A356000000\z/.freeze
+
+    def valid?(value)
+      return false if value.nil?
+      return false unless value.to_s.match?(DIGITS_9)
+      return true if value.to_s.match?(LA_POSTE_PATTERN)
+
+      (luhn_checksum(value.to_s) % 10).zero?
+    end
+
+    def validate!(value, parameter:)
+      return if valid?(value)
+
+      raise InvalidSirenError,
+            "#{parameter.inspect} must be a 9-digit SIREN passing the Luhn checksum; got #{value.inspect}"
+    end
+
+    def luhn_checksum(value)
+      accum = 0
+      value.reverse.each_char.map(&:to_i).each_with_index do |digit, index|
+        t = index.even? ? digit : digit * 2
+        t -= 9 if t >= 10
+        accum += t
+      end
+      accum
+    end
+  end
+end

data/lib/api_particulier/commons/siret.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+# DO NOT EDIT — generated from clients/ruby/commons/ (source digest: 903f3b3aca1a59a6cb1a53ab98f72c365486fc1f).
+# Regenerate via clients/ruby/bin/sync_commons.
+
+module ApiParticulier::Commons
+  module Siret
+    module_function
+
+    LA_POSTE_PATTERN = /\A356000000\d{5}\z/.freeze
+    DIGITS_14 = /\A\d{14}\z/.freeze
+
+    def valid?(value)
+      return false if value.nil?
+      return false unless value.to_s.match?(DIGITS_14)
+      return true if value.to_s.match?(LA_POSTE_PATTERN)
+
+      (luhn_checksum(value.to_s) % 10).zero?
+    end
+
+    def validate!(value, parameter:)
+      return if valid?(value)
+
+      raise InvalidSiretError,
+            "#{parameter.inspect} must be a 14-digit SIRET passing the Luhn checksum (or a La Poste SIRET); got #{value.inspect}"
+    end
+
+    def luhn_checksum(value)
+      accum = 0
+      value.reverse.each_char.map(&:to_i).each_with_index do |digit, index|
+        t = index.even? ? digit : digit * 2
+        t -= 9 if t >= 10
+        accum += t
+      end
+      accum
+    end
+  end
+end

data/lib/api_particulier/commons/user_agent.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+# DO NOT EDIT — generated from clients/ruby/commons/ (source digest: 903f3b3aca1a59a6cb1a53ab98f72c365486fc1f).
+# Regenerate via clients/ruby/bin/sync_commons.
+
+module ApiParticulier::Commons
+  module UserAgent
+    URL = 'https://github.com/datagouv/apistration'.freeze
+
+    module_function
+
+    def build(product:, version:, suffix: nil)
+      base = "#{product}/#{version} (+#{URL})"
+      suffix ? "#{base} #{suffix}" : base
+    end
+  end
+end

data/lib/api_particulier/commons/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+# DO NOT EDIT — generated from clients/ruby/commons/ (source digest: 903f3b3aca1a59a6cb1a53ab98f72c365486fc1f).
+# Regenerate via clients/ruby/bin/sync_commons.
+
+module ApiParticulier::Commons
+  VERSION = '0.1.0'.freeze
+end

data/lib/api_particulier/commons.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+# DO NOT EDIT — generated from clients/ruby/commons/ (source digest: 903f3b3aca1a59a6cb1a53ab98f72c365486fc1f).
+# Regenerate via clients/ruby/bin/sync_commons.
+
+module ApiParticulier; end
+module ApiParticulier::Commons; end
+
+require_relative 'commons/version'
+require_relative 'commons/errors'
+require_relative 'commons/siret'
+require_relative 'commons/siren'
+require_relative 'commons/rate_limit'
+require_relative 'commons/response'
+require_relative 'commons/user_agent'
+require_relative 'commons/auth/strategy'
+require_relative 'commons/auth/bearer_token'
+require_relative 'commons/middleware/authentication'
+require_relative 'commons/middleware/envelope'
+require_relative 'commons/middleware/error_handler'
+require_relative 'commons/middleware/rate_limit'
+require_relative 'commons/middleware/logging'
+require_relative 'commons/configuration'
+require_relative 'commons/client_base'

data/lib/api_particulier/resources/ants.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+# DO NOT EDIT — generated from commons/swagger/openapi-*.yaml by
+# clients/ruby/bin/scaffold_resources. Edit the OpenAPI spec or the scaffold
+# script instead.
+
+module ApiParticulier
+  module Resources
+    class Ants
+      def initialize(client)
+        @client = client
+      end
+
+      # [FranceConnect] Extrait d'immatriculation véhicule
+      # Logical endpoint: /ants/extrait_immatriculation_vehicule/france_connect
+      # Versions available: [3] — default: 3
+      def extrait_immatriculation_vehicule(version: nil, recipient: nil, immatriculation:)
+        path =
+          case version || 3
+          when 3
+          "/v3/ants/extrait_immatriculation_vehicule/france_connect"
+          else
+            raise ArgumentError, "version #{version.inspect} not available for /ants/extrait_immatriculation_vehicule/france_connect; supported: [3]"
+          end
+        @client.get(path, params: { "recipient" => recipient, "immatriculation" => immatriculation }.compact)
+      end
+    end
+  end
+end

data/lib/api_particulier/resources/cnous.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+# DO NOT EDIT — generated from commons/swagger/openapi-*.yaml by
+# clients/ruby/bin/scaffold_resources. Edit the OpenAPI spec or the scaffold
+# script instead.
+
+module ApiParticulier
+  module Resources
+    class Cnous
+      def initialize(client)
+        @client = client
+      end
+
+      # [FranceConnect] Statut étudiant boursier
+      # Logical endpoint: /cnous/etudiant_boursier/france_connect
+      # Versions available: [3, 4] — default: 4
+      def etudiant_boursier(version: nil, recipient: nil)
+        path =
+          case version || 4
+          when 3
+          warn "[DEPRECATED] /v3/cnous/etudiant_boursier/france_connect (#etudiant_boursier): marked deprecated in the OpenAPI spec.", uplevel: 1
+          "/v3/cnous/etudiant_boursier/france_connect"
+          when 4
+          "/v4/cnous/etudiant_boursier/france_connect"
+          else
+            raise ArgumentError, "version #{version.inspect} not available for /cnous/etudiant_boursier/france_connect; supported: [3, 4]"
+          end
+        @client.get(path, params: { "recipient" => recipient }.compact)
+      end
+
+      # [Identité] Statut étudiant boursier
+      # Logical endpoint: /cnous/etudiant_boursier/identite
+      # Versions available: [3, 4] — default: 4
+      def etudiant_boursier_identite(version: nil, recipient: nil, nom_naissance:, prenoms:, annee_date_naissance:, mois_date_naissance:, jour_date_naissance:, sexe_etat_civil: nil, code_cog_insee_commune_naissance: nil, nom_commune_naissance: nil, code_cog_insee_departement_naissance: nil)
+        path =
+          case version || 4
+          when 3
+          warn "[DEPRECATED] /v3/cnous/etudiant_boursier/identite (#etudiant_boursier_identite): marked deprecated in the OpenAPI spec.", uplevel: 1
+          "/v3/cnous/etudiant_boursier/identite"
+          when 4
+          "/v4/cnous/etudiant_boursier/identite"
+          else
+            raise ArgumentError, "version #{version.inspect} not available for /cnous/etudiant_boursier/identite; supported: [3, 4]"
+          end
+        @client.get(path, params: { "recipient" => recipient, "nomNaissance" => nom_naissance, "prenoms" => prenoms, "anneeDateNaissance" => annee_date_naissance, "moisDateNaissance" => mois_date_naissance, "jourDateNaissance" => jour_date_naissance, "sexeEtatCivil" => sexe_etat_civil, "codeCogInseeCommuneNaissance" => code_cog_insee_commune_naissance, "nomCommuneNaissance" => nom_commune_naissance, "codeCogInseeDepartementNaissance" => code_cog_insee_departement_naissance }.compact)
+      end
+
+      # [INE] Statut étudiant boursier
+      # Logical endpoint: /cnous/etudiant_boursier/ine
+      # Versions available: [3, 4] — default: 4
+      def ine(version: nil, recipient: nil, ine:)
+        path =
+          case version || 4
+          when 3
+          warn "[DEPRECATED] /v3/cnous/etudiant_boursier/ine (#ine): marked deprecated in the OpenAPI spec.", uplevel: 1
+          "/v3/cnous/etudiant_boursier/ine"
+          when 4
+          "/v4/cnous/etudiant_boursier/ine"
+          else
+            raise ArgumentError, "version #{version.inspect} not available for /cnous/etudiant_boursier/ine; supported: [3, 4]"
+          end
+        @client.get(path, params: { "recipient" => recipient, "ine" => ine }.compact)
+      end
+    end
+  end
+end

data/lib/api_particulier/resources/dsnj.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+# DO NOT EDIT — generated from commons/swagger/openapi-*.yaml by
+# clients/ruby/bin/scaffold_resources. Edit the OpenAPI spec or the scaffold
+# script instead.
+
+module ApiParticulier
+  module Resources
+    class Dsnj
+      def initialize(client)
+        @client = client
+      end
+
+      # [FranceConnect] API Service national
+      # Logical endpoint: /dsnj/service_national/france_connect
+      # Versions available: [3] — default: 3
+      def service_national(version: nil, recipient: nil)
+        path =
+          case version || 3
+          when 3
+          "/v3/dsnj/service_national/france_connect"
+          else
+            raise ArgumentError, "version #{version.inspect} not available for /dsnj/service_national/france_connect; supported: [3]"
+          end
+        @client.get(path, params: { "recipient" => recipient }.compact)
+      end
+
+      # [Identité] API Service national
+      # Logical endpoint: /dsnj/service_national/identite
+      # Versions available: [3] — default: 3
+      def service_national_identite(version: nil, recipient: nil, nom_naissance:, prenoms:, annee_date_naissance:, mois_date_naissance:, jour_date_naissance:, sexe_etat_civil:, code_cog_insee_commune_naissance: nil, code_cog_insee_pays_naissance:)
+        path =
+          case version || 3
+          when 3
+          "/v3/dsnj/service_national/identite"
+          else
+            raise ArgumentError, "version #{version.inspect} not available for /dsnj/service_national/identite; supported: [3]"
+          end
+        @client.get(path, params: { "recipient" => recipient, "nomNaissance" => nom_naissance, "prenoms" => prenoms, "anneeDateNaissance" => annee_date_naissance, "moisDateNaissance" => mois_date_naissance, "jourDateNaissance" => jour_date_naissance, "sexeEtatCivil" => sexe_etat_civil, "codeCogInseeCommuneNaissance" => code_cog_insee_commune_naissance, "codeCogInseePaysNaissance" => code_cog_insee_pays_naissance }.compact)
+      end
+    end
+  end
+end