Add screen_hint to Ruby Gem + vcr 6

[Teyler7]

Description

As a solution to build "Sign-Up" paths in Rails applications, this adds the screen_hint to the UserManagement.authorization_url flow. This appears to be a valid api in NodeJS already (https://workos.com/docs/reference/authkit/authentication/get-authorization-url), this simply adds it to the Ruby Gem.

Unit tests have been added as well. VCR was also updated to latest in 5277fbf to resolve a global hook failure caused with vcr 5 and webmock.

Documentation

Does this require changes to the WorkOS Docs? E.g. the API Reference or code snippets need updates.

[x] Yes

If yes, link a related docs PR and add a docs maintainer as a reviewer. Their approval is required.

[greptile-apps]

Greptile Summary

This PR adds support for the screen_hint parameter to the UserManagement authorization URL functionality in the Ruby gem, bringing feature parity with the WorkOS Node.js SDK. The change enables developers to specify which AuthKit screen (e.g., 'sign_up' vs 'sign_in') users should land on upon redirection, facilitating the creation of dedicated sign-up flows in Rails applications.

The implementation follows established patterns in the codebase by:

• Adding the optional screen_hint parameter to the authorization_url method signature with a default value of nil
• Including proper documentation that specifies the parameter only applies when the provider is 'authkit'
• Passing the parameter through to the query string construction alongside existing optional parameters like login_hint and domain_hint
• Maintaining backward compatibility since the parameter is optional

The PR also includes a VCR dependency update from version ~> 5.0.0 to ~> 6.0 to resolve compatibility issues with webmock that were causing global hook failures in the test suite. Comprehensive test coverage has been added to verify URL generation, hostname handling, and proper query string formatting for the new parameter.

Confidence score: 5/5

• This PR is very safe to merge with minimal risk of production issues.
• The implementation follows existing patterns, maintains backward compatibility, adds proper tests, and addresses a legitimate feature gap.
• All files appear well-structured with appropriate error handling and documentation.

_{3 files reviewed, no comments}

_{Edit Code Review Bot Settings | Greptile}

[Teyler7]

Ideally, this would be updated in the Ruby Gem docs upon approval. I could be wrong, but I discovered this seems to be available in the API via the NodeJS docs.

https://workos.com/docs/reference/sso/get-authorization-url

[nholden]

Thank you!