zitadel-client 1.3.2

data/lib/zitadel-client/models/zitadelorgv2_organization.rb

@@ -0,0 +1,283 @@
+=begin
+#Zitadel SDK
+
+#The Zitadel SDK is a convenience wrapper around the Zitadel APIs to assist you in integrating with your Zitadel environment. This SDK enables you to handle resources, settings, and configurations within the Zitadel platform.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.12.0
+
+=end
+
+require 'date'
+require 'time'
+
+module ZitadelClient
+  class Zitadelorgv2Organization
+    # Unique identifier of the organization.
+    attr_accessor :id
+
+    attr_accessor :details
+
+    attr_accessor :state
+
+    # Name of the organization.
+    attr_accessor :name
+
+    # Primary domain used in the organization.
+    attr_accessor :primary_domain
+
+    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',
+        :'details' => :'details',
+        :'state' => :'state',
+        :'name' => :'name',
+        :'primary_domain' => :'primaryDomain'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'details' => :'OrganizationServiceDetails',
+        :'state' => :'OrganizationServiceOrganizationState',
+        :'name' => :'String',
+        :'primary_domain' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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 `ZitadelClient::Zitadelorgv2Organization` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `ZitadelClient::Zitadelorgv2Organization`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'details')
+        self.details = attributes[:'details']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      else
+        self.state = 'ORGANIZATION_STATE_UNSPECIFIED'
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'primary_domain')
+        self.primary_domain = attributes[:'primary_domain']
+      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
+      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'
+      true
+    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 &&
+          details == o.details &&
+          state == o.state &&
+          name == o.name &&
+          primary_domain == o.primary_domain
+    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, details, state, name, primary_domain].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 = ZitadelClient.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/zitadel-client/utils/url_util.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+module ZitadelClient
+  # Utility module for URL related operations.
+  # This is a placeholder for URLUtil, which provides URL utility methods.
+  class UrlUtil
+    ##
+    # Builds the hostname for the provided host.
+    #
+    # @param host [String] the base URL for the service.
+    # @return [String] the fully qualified hostname (defaults to HTTPS if no scheme is provided).
+    #
+    def self.build_hostname(host)
+      uri = URI.parse(host)
+      host = "https://#{host}" unless uri.scheme
+      host
+    end
+  end
+end

data/lib/zitadel-client/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ZitadelClient
+  VERSION = '1.3.2'
+end

data/lib/zitadel-client/zitadel.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module ZitadelClient
+  # Main entry point for the Zitadel SDK.
+  #
+  # Initializes and configures the SDK with the provided authentication strategy.
+  # Sets up service APIs for interacting with various Zitadel features.
+  class Zitadel
+    attr_reader :features,
+                :idps,
+                :oidc,
+                :organizations,
+                :sessions,
+                :settings,
+                :users,
+                :saml
+
+    # Initialize the Zitadel SDK.
+    #
+    # @param authenticator [Authenticator] the authentication strategy to use
+    # rubocop:disable Metrics/MethodLength
+    def initialize(authenticator)
+      # noinspection RubyArgCount
+      @configuration = Configuration.new(authenticator)
+      yield @configuration if block_given?
+
+      client = ApiClient.new(@configuration)
+
+      @features = ZitadelClient::FeatureServiceApi.new(client)
+      @idps = ZitadelClient::IdentityProviderServiceApi.new(client)
+      @oidc = ZitadelClient::OIDCServiceApi.new(client)
+      @organizations = ZitadelClient::OrganizationServiceApi.new(client)
+      @sessions = ZitadelClient::SessionServiceApi.new(client)
+      @settings = ZitadelClient::SettingsServiceApi.new(client)
+      @users = ZitadelClient::UserServiceApi.new(client)
+      @saml = ZitadelClient::SAMLServiceApi.new(client)
+    end
+
+    # rubocop:enable Metrics/MethodLength
+
+    class << self
+      # @!group Authentication Entry Points
+
+      # Initialize the SDK with a Personal Access Token (PAT).
+      #
+      # @param host [String] API URL (e.g. "https://api.zitadel.example.com").
+      # @param access_token [String] Personal Access Token for Bearer authentication.
+      # @return [Zitadel] SDK client configured with PAT authentication.
+      # @see https://zitadel.com/docs/guides/integrate/service-users/personal-access-token
+      def with_access_token(host, access_token)
+        new(PersonalAccessTokenAuthenticator.new(host, access_token))
+      end
+
+      # Initialize the SDK using OAuth2 Client Credentials flow.
+      #
+      # @param host [String] API URL.
+      # @param client_id [String] OAuth2 client identifier.
+      # @param client_secret [String] OAuth2 client secret.
+      # @return [Zitadel] SDK client with automatic token acquisition & refresh.
+      # @see https://zitadel.com/docs/guides/integrate/service-users/client-credentials
+      def with_client_credentials(host, client_id, client_secret)
+        new(
+          ClientCredentialsAuthenticator
+            .builder(host, client_id, client_secret)
+            .build
+        )
+      end
+
+      # Initialize the SDK via Private Key JWT assertion.
+      #
+      # @param host [String] API URL.
+      # @param key_file [String] Path to service account JSON/PEM key file.
+      # @return [Zitadel] SDK client using JWT assertion for secure, secret-less auth.
+      # @see https://zitadel.com/docs/guides/integrate/service-users/private-key-jwt
+      def with_private_key(host, key_file)
+        new(WebTokenAuthenticator.from_json(host, key_file))
+      end
+
+      # @!endgroup
+    end
+  end
+end

data/lib/zitadel-client/zitadel_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module ZitadelClient
+  ##
+  # Base error for all Zitadel client exceptions.
+  class ZitadelError < StandardError
+  end
+end

data/lib/zitadel_client.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'zeitwerk'
+require 'oauth2'
+require 'warning'
+require_relative 'patch'
+
+Warning.ignore(:method_redefined, __dir__)
+
+# Main entrypoint for the ZitadelClient Ruby SDK.
+#
+# This module encapsulates all functionality for authenticating with and accessing
+# Zitadel's identity and access management APIs.
+#
+# Usage:
+#   require 'zitadel-client'
+#
+#   client = ZitadelClient::SomeService.new(...)
+#
+# For more details, see: https://github.com/zitadel/zitadel-client-ruby
+#
+module ZitadelClient
+end
+
+loader = Zeitwerk::Loader.new
+loader.inflector.inflect('version' => 'VERSION')
+loader.tag = File.basename(__FILE__, '.rb')
+loader.collapse("#{__dir__}/zitadel-client/api/")
+loader.collapse("#{__dir__}/zitadel-client/auth/")
+loader.collapse("#{__dir__}/zitadel-client/models/")
+loader.collapse("#{__dir__}/zitadel-client/utils/")
+loader.push_dir("#{__dir__}/zitadel-client", namespace: ZitadelClient)
+loader.setup

data/sig/lib/oauth2/oauth2.rbs

@@ -0,0 +1,101 @@
+module OAuth2
+  class AccessToken
+
+    # Attributes
+    attr_reader client: Client
+    attr_reader token: String
+    attr_reader expires_in: untyped
+    attr_reader expires_at: Integer?
+    attr_reader expires_latency: untyped
+    attr_reader params: Hash[untyped, untyped]
+    attr_accessor options: Hash[Symbol, untyped]
+    attr_accessor refresh_token: String?
+    attr_accessor response: untyped
+
+    # Instance Methods
+    def initialize: (Client, String, ?Hash[Symbol, untyped]) -> void
+
+    def []: (String) -> untyped
+
+    def expires?: () -> bool
+
+    def expired?: () -> bool
+
+    def refresh: (?Hash[Symbol, untyped], ?Hash[Symbol, untyped]) -> AccessToken
+
+    def to_hash: () -> Hash[untyped, untyped]
+
+    def request: (Symbol, String, ?Hash[Symbol, untyped]) { (untyped) -> untyped } -> untyped
+
+    def get: (String, ?Hash[Symbol, untyped]) { (untyped) -> untyped } -> untyped
+
+    def post: (String, ?Hash[Symbol, untyped]) { (untyped) -> untyped } -> untyped
+
+    def put: (String, ?Hash[Symbol, untyped]) { (untyped) -> untyped } -> untyped
+
+    def patch: (String, ?Hash[Symbol, untyped]) { (untyped) -> untyped } -> untyped
+
+    def delete: (String, ?Hash[Symbol, untyped]) { (untyped) -> untyped } -> untyped
+
+    def headers: () -> Hash[String, String]
+
+  end
+
+  module Strategy
+    class Base
+      def initialize: (Client) -> void
+    end
+
+    class Assertion < Base
+      def authorize_url: () -> untyped
+
+      def get_token: (Hash[Symbol, untyped], Hash[Symbol, untyped], ?Hash[Symbol, untyped], ?Hash[Symbol, untyped]) -> untyped
+    end
+
+    class ClientCredentials < Base
+      def authorize_url: () -> untyped
+
+      def get_token: (?Hash[untyped, untyped], ?Hash[untyped, untyped]) -> untyped
+    end
+
+    class Password < Strategy::Base
+      def authorize_url: () -> untyped
+
+      def get_token: (String, String, ?Hash[untyped, untyped], ?Hash[untyped, untyped]) -> untyped
+    end
+
+    class Implicit < Base
+      def authorize_params: (?Hash[untyped, untyped]) -> Hash[untyped, untyped]
+
+      def authorize_url: (?Hash[untyped, untyped]) -> String
+
+      def get_token: (*untyped) -> untyped
+    end
+
+    class AuthCode < Base
+      def authorize_params: (?Hash[untyped, untyped]) -> Hash[untyped, untyped]
+
+      def authorize_url: (?Hash[untyped, untyped]) -> String
+
+      def get_token: (String, ?Hash[untyped, untyped], ?Hash[untyped, untyped]) -> untyped
+    end
+  end
+
+  class Client
+    def initialize: (String | nil, String | nil, Hash[Symbol, String]) -> void
+
+    def fetch_token: (url: String, **untyped) -> OAuth2::AccessToken
+
+    def auth_code: () -> Strategy::AuthCode
+
+    def implicit: () -> Strategy::Implicit
+
+    def password: () -> Strategy::Password
+
+    def client_credentials: () -> Strategy::ClientCredentials
+
+    def assertion: () -> Strategy::Assertion
+  end
+
+end
+

data/sig/lib/openssl/openssl.rbs

@@ -0,0 +1,10 @@
+module OpenSSL
+  module PKey
+    class PKey
+    end
+
+    class RSA < PKey
+      def initialize: (String, ?String) -> void
+    end
+  end
+end