workos 0.10.1 → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a00962231e6c619c78e5b5549a2e53ca7c60e5e31bd06f46a383b1797f673b0
-  data.tar.gz: 593fb9342f9085abdd855a9a861f01859fd0ad7427e146b22c10dce142cd6779
+  metadata.gz: 64322be12c1dad447bc34d760225e99c47dc6611119ea74dd9a638bac6f23085
+  data.tar.gz: 99df76eeb89edac09cc58323049efeaad694bf3bd945d07c8d8fb492bb45052f
 SHA512:
-  metadata.gz: 02fc5ab50f261d7f3a5d0eebcaa40003c86222a98c5dad13b066d61b643b18e47998e1919bd257d9a3873fe54d04690de7a0c47457c9a34aab7f6d8909e307f8
-  data.tar.gz: 9ef0e3d05c5d15fa4ff3645488fc8cf725c24c48477b5ab0c8c7621e7cc1f4ca51a1161e00cc6ef74cb8dadc18b07ca68223f525b5aba66d843ccfb92000f711
+  metadata.gz: 56de86af09e8c79821cb1789b0ceb27db74ac8f11176ff6b43ee36ebe0b18c0bcc60fd459c35dcfa369bd86a70c0f78724861380689c1afcc21296d77d8a9baa
+  data.tar.gz: b77ac5436b1d5f7a150778c68e259897576689a032d7490835e6ebf7411ba8dc1b3268548648c60261b0273528901a2d63edc3eb4d1e765cf75de7d4448da83e

data/.rubocop.yml

@@ -13,7 +13,7 @@ Metrics/BlockLength:
 Metrics/MethodLength:
   Max: 15
 Metrics/ModuleLength:
-  Max: 150
+  Max: 200
 Metrics/ParameterLists:
   Max: 6
 Style/TrailingCommaInArguments:

data/.ruby-version

@@ -1 +1 @@
-2.7.1
+3.0.1

data/.semaphore/semaphore.yml

@@ -60,10 +60,16 @@ blocks:
             - sem-version ruby 2.6.5
             - bundle install
             - bundle exec rspec
-        - name: Ruby 2.7.1
+        - name: Ruby 2.7.3
           commands:
             - checkout
-            - sem-version ruby 2.7.1
+            - sem-version ruby 2.7.3
+            - bundle install
+            - bundle exec rspec
+        - name: Ruby 3.0.1
+          commands:
+            - checkout
+            - sem-version ruby 3.0.1
             - bundle install
             - bundle exec rspec
 promotions:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    workos (0.10.1)
+    workos (0.11.2)
       sorbet-runtime (~> 0.5)
 
 GEM
@@ -9,60 +9,73 @@ GEM
   specs:
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.0)
-    codecov (0.2.8)
+    ast (2.4.2)
+    codecov (0.2.12)
       json
       simplecov
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
-    docile (1.3.2)
-    hashdiff (1.0.0)
-    jaro_winkler (1.5.4)
-    json (2.3.1)
-    parallel (1.19.1)
-    parser (2.7.0.0)
-      ast (~> 2.4.0)
-    public_suffix (4.0.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    docile (1.3.5)
+    hashdiff (1.0.1)
+    json (2.5.1)
+    parallel (1.20.1)
+    parser (3.0.1.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
     rainbow (3.0.0)
-    rake (13.0.1)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-expectations (3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.4)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
-    rubocop (0.78.0)
-      jaro_winkler (~> 1.5.1)
+    rspec-support (3.9.4)
+    rubocop (0.93.1)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.10.1)
-    safe_yaml (1.0.5)
-    simplecov (0.19.0)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
-    sorbet (0.5.5560)
-      sorbet-static (= 0.5.5560)
-    sorbet-runtime (0.5.6300)
-    sorbet-static (0.5.5560-universal-darwin-14)
-    unicode-display_width (1.6.0)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    sorbet (0.5.6388)
+      sorbet-static (= 0.5.6388)
+    sorbet-runtime (0.5.6403)
+    sorbet-static (0.5.6388-universal-darwin-14)
+    sorbet-static (0.5.6388-universal-darwin-15)
+    sorbet-static (0.5.6388-universal-darwin-16)
+    sorbet-static (0.5.6388-universal-darwin-17)
+    sorbet-static (0.5.6388-universal-darwin-18)
+    sorbet-static (0.5.6388-universal-darwin-19)
+    sorbet-static (0.5.6388-universal-darwin-20)
+    sorbet-static (0.5.6388-x86_64-linux)
+    unicode-display_width (1.7.0)
     vcr (5.0.0)
-    webmock (3.7.6)
+    webmock (3.12.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    yard (0.9.22)
+    yard (0.9.26)
 
 PLATFORMS
   ruby
@@ -80,4 +93,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.1.4
+   2.2.16

data/README.md

@@ -1,22 +1,22 @@
-# workos-ruby [![codecov](https://codecov.io/gh/workos-inc/workos-ruby/branch/master/graph/badge.svg)](https://codecov.io/gh/workos-inc/workos-ruby)
+# WorkOS Ruby Library
 
-WorkOS official Ruby gem for interacting with WorkOS APIs
+The WorkOS library for Ruby provides convenient access to the WorkOS API from applications written in Ruby.
 
 ## Documentation
 
-Complete documentation for the latest version of WorkOS Ruby Gem can be found [here](https://workos-inc.github.io/workos-ruby/).
+See the [API Reference](https://workos.com/docs/reference/client-libraries) for Ruby usage examples.
 
 ## Installation
 
-To get started, you can install the WorkOS gem via RubyGems with:
+Install the package with:
 
-```ruby
+```
 gem install workos
 ```
 
 If you're using Bundler to manage your application's gems, add the WorkOS gem to your Gemfile:
 
-```ruby
+```
 source 'https://rubygems.org'
 
 gem 'workos'
@@ -24,17 +24,13 @@ gem 'workos'
 
 ## Configuration
 
-To use the SDK you must first provide your API key from the [WorkOS Developer Dashboard](https://dashboard.workos.com/api-keys).
-
-You can do this through the `WORKOS_API_KEY` environment variable or by calling `WorkOS.key = [your API key]`.
-
-The WorkOS Gem will read the environment variable `WORKOS_API_KEY`:
+To use the library you must provide an API key, located in the WorkOS dashboard, as an environment variable `WORKOS_API_KEY`:
 
 ```sh
 $ WORKOS_API_KEY=[your api key] ruby app.rb
 ```
 
-Alternatively, you may set the key yourself, such as in an initializer in your application load path:
+Or, you may set the key yourself, such as in an initializer in your application load path:
 
 ```ruby
 # /config/initializers/workos.rb
@@ -42,222 +38,9 @@ Alternatively, you may set the key yourself, such as in an initializer in your a
 WorkOS.key = '[your api key]'
 ```
 
-## The SSO Module
-
-The SSO Module provides convenient methods for authenticating a Single Sign On (SSO) user via WorkOS. WorkOS SSO follows the OAuth 2.0 specification.
-
-First, you'll direct your SSO users to an `authorization_url`. They will sign in to their SSO account with their Identity Provider, and be redirected to a
-callback URL that you set in your WorkOS Dashboard. The user will be redirected with a `code` URL parameter, which you can then exchange for a WorkOS::Profile
-using the `WorkOS::SSO.get_profile` method.
-
-See our Ruby SSO example app for a [complete example](https://github.com/workos-inc/ruby-sso-example).
-
-```ruby
-WorkOS::SSO.authorization_url(domain:, client_id:, redirect_uri:, state: {})
-```
-
-> Generate an authorization URL to intitiate the WorkOS OAuth2 workflow.
-
-`WorkOS::SSO.authorization_url` accepts four arguments:
-
-- `domain` (string) — the authenticating user's company domain, without protocol (ex. `example.com`)
-- `client_id` (string) — your application's WorkOS [Client ID](https://dashboard.workos.com/sso/configuration) (ex. `project_01JG3BCPTRTSTTWQR4VSHXGWCQ`)
-- `state` (optional, hash) — an optional hash used to manage state across authorization transactions (ex. `{ next_page: '/docs'}`)
-- `redirect_uri` (string) — a callback URL where your application redirects the user-agent after an authorization code is granted (ex. `workos.dev/callback`). This must match one of your configured callback URLs for the associated environment on your WorkOS dashboard.
-
-This method will return an OAuth2 query string of the form:
-
-`https://${domain}/sso/authorize?response_type=code&client_id=${clientID}&redirect_uri=${redirectURI}&state=${state}`
-
-For example, when used in a [Sinatra app](http://sinatrarb.com/):
-
-```ruby
-DOMAIN = 'example.com'
-CLIENT_ID = '{clientId}'
-REDIRECT_URI = 'http://localhost:4567/callback'
-
-get '/auth' do
-  authorization_url = WorkOS::SSO.authorization_url(
-    domain: DOMAIN,
-    client_id: CLIENT_ID,
-    redirect_uri: REDIRECT_URI,
-  )
-
-  redirect authorization_url
-end
-```
-
-The user would be redirected to:
-
-`https://api.workos.com/sso/authorize?response_type=code&client_id={clientID}&redirect_uri=http://localhost:4567/callback`
-
-WorkOS takes over from here, sending the user to authenticate with their IDP, and on successful login, returns
-the user to your callback URL with a `code` parameter. You'll use `WorkOS::SSO.profile` to exchange the
-code for a `WorkOS::Profile`.
-
-```ruby
-WorkOS::SSO.profile(code:, client_id:)
-```
-
-> Fetch a WorkOS::Profile for an authorized user.
-
-`WorkOS::SSO.profile` accepts two arguments:
-
-- `code` (string) — an opaque string provided by the authorization server; will be exchanged for an Access Token when the user's profile is sent
-- `client_id` (string) — your application's WorkOS [Client ID](https://dashboard.workos.com/sso/configuration) (ex. `project_01JG3BCPTRTSTTWQR4VSHXGWCQ`)
-
-This method will return an instance of a `WorkOS::Profile` with the following attributes:
-
-```ruby
-<WorkOS::Profile:0x00007fb6e4193d20
-  @id="prof_01DRA1XNSJDZ19A31F183ECQW5",
-  @email="demo@workos-okta.com",
-  @first_name="WorkOS",
-  @connection_id="conn_01EMH8WAK20T42N2NBMNBCYHAG",
-  @connection_type="OktaSAML",
-  @last_name="Demo",
-  @idp_id="00u1klkowm8EGah2H357",
-  @raw_attributes={
-    :id=>"prof_01DRA1XNSJDZ19A31F183ECQW5",
-    :email=>"demo@workos-okta.com",
-    :first_name=>"WorkOS",
-    :last_name=>"Demo",
-    :idp_id=>"00u1klkowm8EGah2H357"
-  },
->
-```
-
-Our Sinatra app can be extended to use this method:
-
-```ruby
-DOMAIN = 'example.com'
-CLIENT_ID = '{clientId}'
-REDIRECT_URI = 'http://localhost:4567/callback'
-
-get '/auth' do
-  authorization_url = WorkOS::SSO.authorization_url(
-    domain: DOMAIN,
-    client_id: CLIENT_ID,
-    redirect_uri: REDIRECT_URI,
-  )
-
-  redirect authorization_url
-end
-
-get '/callback' do
-  profile = WorkOS::SSO.profile(
-    code: params['code'],
-    client_id: CLIENT_ID,
-  )
-
-  session[:user] = profile.to_json
-
-  redirect '/'
-end
-```
-
-Given the `WorkOS::Profile`, you can now sign the user in according to your own authentication setup.
-
-## The Magic Link Module
-
-The Magic Link Module provides methods for authenticating a Passwordless user via WorkOS.
-
-First, you'll create a Passwordless Session for a Magic Link connection.
-Then, using the session ID, you'll email a user the Magic Link confirmation URL.
-The user can then click on that link to be authenticated to your application.
-
-> Create a Passwordless Session for a Magic Link Connection.
-
-`WorkOS::Passwordless.create_session` accepts four arguments:
-
-- `email` (string) - the email of the user to authenticate.
-- `type` (string) - The type of Passwordless Session to create. Currently, the only supported value is `MagicLink`.
-- `state` (optional, string) - Optional parameter that a Developer can choose to include in their authorization URL. If included, then the redirect URI received from WorkOS will contain the exact `state` that was passed in the authorization URL.
-- `redirect_uri` (string) - a callback URL where your application redirects the user-agent after an authorization code is granted (ex. `workos.dev/callback`). This must match one of your configured callback URLs for the associated environment on your WorkOS dashboard.
-
-This method will return a Passwordless Session object, containing the following attributes:
-
-- `id` (string) - the unique ID of the session.
-- `email` (string) - the email address of the user for the session.
-- `expires_at` (date) - the ISO-8601 datetime at which the session expires.
-- `link` (string) - the link for the user to authenticate with. You can use this link to send a custom email to the user, or send an email using the `WorkOS::Passwordless.send_session` method, described below.
-
-> Email a user the Magic Link confirmation URL.
-
-`WorkOS::Passwordless.send_session` accepts one argument:
-
-- `id` (string) - the unique identifier of the Passwordless Session to send an email for.
-
-This method will return a boolean confirming the Magic Link was sent.
-
-> Example with Sinatra application
-
-Our Sinatra app can be altered to use Magic Link:
-
-```ruby
-CLIENT_ID = '{clientId}'
-REDIRECT_URI = 'http://localhost:4567/callback'
-
-post '/passwordless-auth' do
-  session = WorkOS::Passwordless.create_session(
-    email: params[:email],
-    type: 'MagicLink',
-    redirect_uri: REDIRECT_URI
-  )
-  WorkOS::Passwordless.send_session(session.id)
-
-  redirect '/check-email'
-end
-
-get '/callback' do
-  profile = WorkOS::SSO.profile(
-    code: params['code'],
-    client_id: CLIENT_ID,
-  )
-
-  session[:user] = profile.to_json
-
-  redirect '/'
-end
-```
-
-## The Audit Trail Module
-
-The Audit Trail Module provides methods for creating Audit Trail events on
-WorkOS.
-
-See our [Audit Trail
-Overview](https://docs.workos.com/audit-trail/overview) for
-more information.
-
-```ruby
-payload = {
-  group: 'Foo Corp',
-  location: '127.0.0.1',
-  action: 'user.created',
-  action_type: 'C',
-  actor_name: 'Foo',
-  actor_id: 'user_12345',
-  target_name: 'Bar',
-  target_id: 'user_67890',
-  occurred_at: '2020-01-10T15:30:00-05:00',
-  metadata: {
-    source: 'Email',
-  }
-}
-
-WorkOS::AuditTrail.create_event(event: payload)
-```
-
-### Idempotency
-
-To perform an idempotent request, provide an additional idempotency_key
-parameter to the `create_event` options.
-
-```ruby
-WorkOS::AuditTrail.create_event(event: payload, idempotency_key: 'key123456')
-```
+## More Information
 
-See our [API
-Reference](https://docs.workos.com/audit-trail/api-reference#idempotency)
-for more information on idempotency keys.
+* [Single Sign-On Guide](https://workos.com/docs/sso/guide)
+* [Directory Sync Guide](https://workos.com/docs/directory-sync/guide)
+* [Admin Portal Guide](https://workos.com/docs/admin-portal/guide)
+* [Magic Link Guide](https://workos.com/docs/magic-link/guide)

data/lib/workos.rb

@@ -32,11 +32,14 @@ module WorkOS
   autoload :AuditTrail, 'workos/audit_trail'
   autoload :Connection, 'workos/connection'
   autoload :DirectorySync, 'workos/directory_sync'
+  autoload :Directory, 'workos/directory'
+  autoload :DirectoryGroup, 'workos/directory_group'
   autoload :Organization, 'workos/organization'
   autoload :Passwordless, 'workos/passwordless'
   autoload :Portal, 'workos/portal'
   autoload :Profile, 'workos/profile'
   autoload :SSO, 'workos/sso'
+  autoload :DirectoryUser, 'workos/directory_user'
 
   # Errors
   autoload :APIError, 'workos/errors'