workos 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fd3e38d33d428497a46f40df28c4d142bc9adaf90c166b61c05914030c50b25
-  data.tar.gz: c445aa218658fe1fb57add7cc9081b1e63223641d29cac1e276429d3fb1244fd
+  metadata.gz: aa4a3df1bd438866ffdd87bea0cc2b4c0155a1a72073f22265335845711e0b07
+  data.tar.gz: e0330ab1c70938e2092f76102aa62559574a20dce5e9b6d3443c1c80792c82b7
 SHA512:
-  metadata.gz: b94cf0c103286a457c3a73ab4ead5196ad2a8111f486ff22adbf4ecbdd5a21685dcb9483325b15813dcd5a25ea2383aec7d64fbc7545d4c80267731e97ed4a48
-  data.tar.gz: 30d4256a4b9218890dd880a5513dd90a09052f746085dffc282532bbf9ed5683b04d690181cfe1b209f02edc1fd1e37e04149819c8731afb81f5aba5561a2c18
+  metadata.gz: c1e6953bd43faa02ba0f0a7e8e6fe192a05b68d6a5694f6a448a6da7d419a9adb409a7512b3a7a95caf8ba630cb56d9eb0a52cb5d32f7afc0205dcc4e7b80434
+  data.tar.gz: 3ff44f67cbe7f1fa8151d08579ee1e997d30d222b0c72d666a5d0cca21817a2201c97a1780aefe2965dcb20f42640cce71827e6092375eff87fbb114eed2cc0e

data/.github/CODEOWNERS

@@ -0,0 +1,5 @@
+# See GitHub's docs for more details:
+# https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners
+
+# Rubyist Team
+* @workos-inc/ruby

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    workos (0.9.0)
+    workos (0.9.1)
       sorbet-runtime (~> 0.5)
 
 GEM

data/README.md

@@ -42,50 +42,9 @@ Alternatively, you may set the key yourself, such as in an initializer in your a
 WorkOS.key = '[your api key]'
 ```
 
-## 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')
-```
-
-See our [API
-Reference](https://docs.workos.com/audit-trail/api-reference#idempotency)
-for more information on idempotency keys.
-
 ## The SSO Module
 
-The SSO Module provides convenience methods for authenticating a Single Sign On (SSO) user via WorkOS. WorkOS SSO follows the Oauth 2.0 specification.
+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
@@ -137,7 +96,7 @@ the user to your callback URL with a `code` parameter. You'll use `WorkOS::SSO.p
 code for a `WorkOS::Profile`.
 
 ```ruby
-WorkOS::SSO.profile(code:, project_id:)</h4>
+WorkOS::SSO.profile(code:, project_id:)
 ```
 
 > Fetch a WorkOS::Profile for an authorized user.
@@ -168,7 +127,7 @@ This method will return an instance of a `WorkOS::Profile` with the following at
 >
 ```
 
-Our Sintatra app can be extended to use this method:
+Our Sinatra app can be extended to use this method:
 
 ```ruby
 DOMAIN = 'example.com'
@@ -198,3 +157,107 @@ 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 project 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
+PROJECT_ID = '{projectId}'
+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'],
+    project_id: PROJECT_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')
+```
+
+See our [API
+Reference](https://docs.workos.com/audit-trail/api-reference#idempotency)
+for more information on idempotency keys.

data/lib/workos/passwordless.rb

@@ -25,6 +25,9 @@ module WorkOS
       #  redirects.
       # @option options [String] type The type of Passwordless Session to
       #  create. Currently, the only supported value is 'MagicLink'.
+      # @option options [String] redirect_uri The URI where users are directed
+      #  after completing the authentication step. Must match a
+      #  configured redirect URI on your WorkOS dashboard.
       #
       # @return Hash
       sig do

data/lib/workos/version.rb

@@ -2,5 +2,5 @@
 # typed: strong
 
 module WorkOS
-  VERSION = '0.9.0'
+  VERSION = '0.9.1'
 end

data/spec/lib/workos/passwordless_spec.rb

@@ -16,6 +16,7 @@ describe WorkOS::Passwordless do
         {
           email: 'demo@workos-okta.com',
           type: 'MagicLink',
+          redirect_uri: 'foo.com/auth/callback',
         }
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workos
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - WorkOS
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-15 00:00:00.000000000 Z
+date: 2020-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -161,6 +161,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/CODEOWNERS"
 - ".github/renovate.json"
 - ".gitignore"
 - ".rspec"
@@ -168,7 +169,6 @@ files:
 - ".ruby-version"
 - ".semaphore/rubygems.yml"
 - ".semaphore/semaphore.yml"
-- CODEOWNERS
 - Gemfile
 - Gemfile.lock
 - LICENSE

data/CODEOWNERS

@@ -1 +0,0 @@
-@marktran