Rename main client class to Zitadel::Client for API consistency

[mridang]

Which Problems Are Solved

This PR addresses the naming convention of the main public API class in the Ruby SDK. Specifically:

• The previous main client class name (e.g., Zitadel::ZitadelClient or a similar variation) was less aligned with the desired concise naming strategy for SDK components.
• This change aims to provide a clearer, more idiomatic, and standardized entry point for users of the Zitadel Ruby SDK, making it more intuitive.

How the Problems Are Solved

The primary SDK class has been refined to improve clarity and consistency:

• Renamed the main public client class to Client and ensured it is properly namespaced under the top-level Zitadel module. The fully qualified name for the main class is now Zitadel::Client.
• Updated the class definition file (e.g., likely moved from lib/zitadel/zitadel_client.rb or similar to lib/zitadel/client.rb).
• Modified all internal references, instantiation examples (e.g., Zitadel::Client.new(...) or Zitadel::Client.withPrivateKey(...)), and method calls throughout the SDK to use the new Zitadel::Client class.
• Adjusted the test suite to accurately reflect and test the renamed class and its usage.

Additional Changes

To support the primary renaming and ensure a smooth transition:

• Updated all documentation (README.md, code comments, and any other relevant guides) to reflect the new class name Zitadel::Client and its usage.
• Ensured all provided code snippets and examples for SDK initialization and usage now correctly demonstrate interaction with Zitadel::Client.
• Verified that the gem's main module file (lib/zitadel.rb) correctly requires and loads the renamed client class file.

Additional Context

This renaming to Zitadel::Client helps align the Ruby SDK's namespace and class structure with patterns used in our other SDKs, promoting consistency across the Zitadel ecosystem:

• It introduces a clear Client identifier as the primary class name within the main Zitadel module. This is conceptually similar to how the PHP SDK organizes its client under a Zitadel\Client namespace structure.
• It maintains a consistent top-level Zitadel module for the gem, which is akin to the com.zitadel base package in the Java SDK and the Zitadel vendor namespace in PHP.

You can also add specific issue links if they apply:

• Closes #[issue_number]
• Related to discussion in [link to Slack/Discord thread, GitHub Discussion]

[github-actions]

Qodana for PHP

It seems all right 👌

No new problems were found according to the checks applied

💡 Qodana analysis was run in the pull request mode: only the changed files were checked
☁️ View the detailed Qodana report

Contact Qodana team

Contact us at qodana-support@jetbrains.com

• Or via our issue tracker: https://jb.gg/qodana-issue
• Or share your feedback: https://jb.gg/qodana-discussions