workos 0.7.0 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbb2aa0d20fb9d4fa99930c63d67240f2bb911613dd48848aa2c89d5dc94fcf7
-  data.tar.gz: 838ca6771237c0df8acd0e7b1ef59c021f87f8b4c7e94b32a5f6fb83c3158ac9
+  metadata.gz: f72ed378ff8e20a866b38dae789600e327a166d8278cff389a7f6475f4846404
+  data.tar.gz: 55f0f218dc1d01745bff80b142ea13a96dd016a228cbd492483d15e6a84d77a2
 SHA512:
-  metadata.gz: 6bf3d16a8e76427557d5b08dc2897e167730a7b8b81fc96c42b6c04b5db74f64a5c06b24f381784f6b9c845fcff945fc273f3d0ceaf872d97c80c0b1beb6639f
-  data.tar.gz: 0f33de9781d1df7fd2f02bac813cbb3d192fe17f5690a28804a848400d422575e2d7e91c955259d99ff7fbc5bd60d457a595fe7279128058d3ba0100c1858378
+  metadata.gz: 5c291aa09e469c0ed3d39ed421f3ea1061b6d45edcdbc6dab6525ea01b5568063818ea5bcfc16e54a76286afe427380710da4d51300f087fded2932138c24648
+  data.tar.gz: 9b3d79b06bdb13aba050c3bf4ed11c6970f5ccffcc5fe14c6fcceb70ea0bcd98860f7d228fa04333df0b38045f5b407fccad2d7ab139f9f2f39a10611a602ef1

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.7.0)
+    workos (0.9.2)
       sorbet-runtime (~> 0.5)
 
 GEM
@@ -54,7 +54,7 @@ GEM
     simplecov-html (0.12.2)
     sorbet (0.5.5560)
       sorbet-static (= 0.5.5560)
-    sorbet-runtime (0.5.5909)
+    sorbet-runtime (0.5.6140)
     sorbet-static (0.5.5560-universal-darwin-14)
     unicode-display_width (1.6.0)
     vcr (5.0.0)

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.
@@ -154,6 +113,7 @@ This method will return an instance of a `WorkOS::Profile` with the following at
   @id="prof_01DRA1XNSJDZ19A31F183ECQW5",
   @email="demo@workos-okta.com",
   @first_name="WorkOS",
+  @connection_id="conn_01EMH8WAK20T42N2NBMNBCYHAG",
   @connection_type="OktaSAML",
   @last_name="Demo",
   @idp_id="00u1klkowm8EGah2H357",
@@ -167,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'
@@ -197,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.rb

@@ -3,6 +3,7 @@
 
 require 'workos/version'
 require 'sorbet-runtime'
+require 'json'
 
 # Use the WorkOS module to authenticate your
 # requests to the WorkOS API. The gem will read

data/lib/workos/audit_trail.rb

@@ -51,6 +51,7 @@ module WorkOS
       def create_event(event:, idempotency_key: nil)
         request = post_request(
           path: '/events',
+          auth: true,
           idempotency_key: idempotency_key,
           body: event,
         )

data/lib/workos/connection.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 # typed: true
 
-require 'json'
-
 module WorkOS
   # The Connection class provides a lightweight wrapper around
   # a WorkOS Connection resource. This class is not meant to be instantiated

data/lib/workos/organization.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 # typed: true
 
-require 'json'
-
 module WorkOS
   # The Organization class provides a lightweight wrapper around
   # a WorkOS Organization resource. This class is not meant to be instantiated

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/portal.rb

@@ -103,8 +103,12 @@ module WorkOS
 
         parsed_response = JSON.parse(response.body)
 
+        organizations = parsed_response['data'].map do |organization|
+          ::WorkOS::Organization.new(organization.to_json)
+        end
+
         WorkOS::Types::ListStruct.new(
-          data: parsed_response['data'],
+          data: organizations,
           list_metadata: parsed_response['listMetadata'],
         )
       end

data/lib/workos/profile.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 # typed: true
 
-require 'json'
-
 module WorkOS
   # The Profile class provides a lighweight wrapper around
   # a normalized response from the various IDPs WorkOS
@@ -13,9 +11,9 @@ module WorkOS
     extend T::Sig
 
     sig { returns(String) }
-    attr_accessor :id, :email, :first_name, :last_name,
+    attr_accessor :id, :email, :first_name, :last_name, :connection_id,
                   :connection_type, :idp_id, :raw_attributes
-
+    # rubocop:disable Metrics/AbcSize
     sig { params(profile_json: String).void }
     def initialize(profile_json)
       raw = parse_json(profile_json)
@@ -24,10 +22,12 @@ module WorkOS
       @email = T.let(raw.email, String)
       @first_name = raw.first_name
       @last_name = raw.last_name
+      @connection_id = T.let(raw.connection_id, String)
       @connection_type = T.let(raw.connection_type, String)
       @idp_id = raw.idp_id
       @raw_attributes = raw.raw_attributes
     end
+    # rubocop:enable Metrics/AbcSize
 
     sig { returns(String) }
     def full_name
@@ -40,6 +40,7 @@ module WorkOS
         email: email,
         first_name: first_name,
         last_name: last_name,
+        connection_id: connection_id,
         connection_type: connection_type,
         idp_id: idp_id,
         raw_attributes: raw_attributes,
@@ -48,7 +49,7 @@ module WorkOS
 
     private
 
-    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     sig { params(json_string: String).returns(WorkOS::Types::ProfileStruct) }
     def parse_json(json_string)
       hash = JSON.parse(json_string, symbolize_names: true)
@@ -58,11 +59,12 @@ module WorkOS
         email: hash[:profile][:email],
         first_name: hash[:profile][:first_name],
         last_name: hash[:profile][:last_name],
+        connection_id: hash[:profile][:connection_id],
         connection_type: hash[:profile][:connection_type],
         idp_id: hash[:profile][:idp_id],
         raw_attributes: hash[:profile][:raw_attributes],
       )
     end
-    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
   end
 end

data/lib/workos/types/profile_struct.rb

@@ -10,6 +10,7 @@ module WorkOS
       const :email, String
       const :first_name, T.nilable(String)
       const :last_name, T.nilable(String)
+      const :connection_id, String
       const :connection_type, String
       const :idp_id, T.nilable(String)
       const :raw_attributes, T::Hash[Symbol, Object]

data/lib/workos/version.rb

@@ -2,5 +2,5 @@
 # typed: strong
 
 module WorkOS
-  VERSION = '0.7.0'
+  VERSION = '0.9.2'
 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
 

data/spec/lib/workos/sso_spec.rb

@@ -163,6 +163,7 @@ describe WorkOS::SSO do
         expect(profile).to be_a(WorkOS::Profile)
 
         expectation = {
+          connection_id: 'conn_01EMH8WAK20T42N2NBMNBCYHAG',
           connection_type: 'OktaSAML',
           email: 'demo@workos-okta.com',
           first_name: 'WorkOS',

data/spec/support/profile.txt

@@ -1 +1 @@
-{"profile":{"object":"profile","id":"prof_01DRA1XNSJDZ19A31F183ECQW5","email":"demo@workos-okta.com","first_name":"WorkOS","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"}},"access_token":"01DVX6QBS3EG6FHY2ESAA5Q65X"}
+{"profile":{"object":"profile","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"}},"access_token":"01DVX6QBS3EG6FHY2ESAA5Q65X"}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workos
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.2
 platform: ruby
 authors:
 - WorkOS
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-17 00:00:00.000000000 Z
+date: 2020-12-09 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
@@ -293,7 +293,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.5
 signing_key: 
 specification_version: 4
 summary: API client for WorkOS

data/CODEOWNERS

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