workos 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0fdd6aec096f0a3a3aa2f20c398515b1bf42d8e5b3d529e316bdce2327a0961
-  data.tar.gz: 269a70ac10a9aa6f7b49f7cefbde2b1af8e5bf559b429d202b5d5167bb8b83f2
+  metadata.gz: dbb2aa0d20fb9d4fa99930c63d67240f2bb911613dd48848aa2c89d5dc94fcf7
+  data.tar.gz: 838ca6771237c0df8acd0e7b1ef59c021f87f8b4c7e94b32a5f6fb83c3158ac9
 SHA512:
-  metadata.gz: dd67a590cefd06ae6fc83e45cd0cfe9243d8849e865e0b7f7eb342d0bb9a29b10cbb6693802d54bb25c045a2f90505f17217358c36ef196a2066ffab0ca6f2bc
-  data.tar.gz: e528ade9f4a33fff0a25d24fcdb94f6232a3fc00c8ef27233735520a71a7b8c207c2fb853040c96ce34a5a8b91c842d4b9dc485699101bcc58159743f9471934
+  metadata.gz: 6bf3d16a8e76427557d5b08dc2897e167730a7b8b81fc96c42b6c04b5db74f64a5c06b24f381784f6b9c845fcff945fc273f3d0ceaf872d97c80c0b1beb6639f
+  data.tar.gz: 0f33de9781d1df7fd2f02bac813cbb3d192fe17f5690a28804a848400d422575e2d7e91c955259d99ff7fbc5bd60d457a595fe7279128058d3ba0100c1858378

data/Gemfile.lock

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

data/lib/workos.rb

@@ -32,6 +32,7 @@ module WorkOS
   autoload :Connection, 'workos/connection'
   autoload :DirectorySync, 'workos/directory_sync'
   autoload :Organization, 'workos/organization'
+  autoload :Passwordless, 'workos/passwordless'
   autoload :Portal, 'workos/portal'
   autoload :Profile, 'workos/profile'
   autoload :SSO, 'workos/sso'

data/lib/workos/audit_trail.rb

@@ -83,8 +83,8 @@ module WorkOS
       #  event occurred at or after
       # @option options [String] occurred_at_lt ISO-8601 datetime of when an
       #  event occurred before
-      # @option options [String] ISO-8601 datetime of when an event occured at
-      #  or before
+      # @option options [String] occurred_at_lte ISO-8601 datetime of when an
+      #  event occured at or before
       # @option options [String] search Keyword search
       #
       # @return [Array<Hash>]

data/lib/workos/client.rb

@@ -81,8 +81,7 @@ module WorkOS
       ].join('; ')
     end
 
-
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity
     sig { params(response: ::T.untyped).void }
     def handle_error_response(response:)
       http_status = response.code.to_i
@@ -108,11 +107,10 @@ module WorkOS
           request_id: response['x-request-id'],
         )
       when 422
-        errors = json['errors'].map do |error|
-          "#{error['field']}: #{error['code']}"
-        end.join('; ')
+        message = json['message']
+        errors = extract_error(json['errors']) if json['errors']
+        message += " (#{errors})" if errors
 
-        message = "#{json['message']} (#{errors})"
         raise InvalidRequestError.new(
           message: message,
           http_status: http_status,
@@ -120,6 +118,14 @@ module WorkOS
         )
       end
     end
-    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity
+
+    private
+
+    def extract_error(errors)
+      errors.map do |error|
+        "#{error['field']}: #{error['code']}"
+      end.join('; ')
+    end
   end
 end

data/lib/workos/passwordless.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+# typed: true
+
+require 'net/http'
+
+module WorkOS
+  # The Passwordless module provides convenience methods for working with
+  # passwordless sessions including the WorkOS Magic Link. You'll need a valid
+  # API key.
+  #
+  # @see https://workos.com/docs/sso/configuring-magic-link
+  module Passwordless
+    class << self
+      extend T::Sig
+      include Base
+      include Client
+
+      # Create a Passwordless Session.
+      #
+      # @param [Hash] options A hash with options for the session
+      # @option options [String] email The email of the user to authenticate.
+      # @option options [String] state Optional parameter that the redirect URI
+      #  received from WorkOS will contain. The state parameter can be used to
+      #  encode arbitrary information to help restore application state between
+      #  redirects.
+      # @option options [String] type The type of Passwordless Session to
+      #  create. Currently, the only supported value is 'MagicLink'.
+      #
+      # @return Hash
+      sig do
+        params(
+          options: Hash,
+        ).returns(WorkOS::Types::PasswordlessSessionStruct)
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def create_session(options)
+        response = execute_request(
+          request: post_request(
+            path: '/passwordless/sessions',
+            auth: true,
+            body: options,
+          ),
+        )
+
+        hash = JSON.parse(response.body)
+
+        WorkOS::Types::PasswordlessSessionStruct.new(
+          id: hash['id'],
+          email: hash['email'],
+          expires_at: Date.parse(hash['expires_at']),
+          link: hash['link'],
+        )
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      # Send a Passwordless Session via email.
+      #
+      # @param [String] session_id The unique identifier of the Passwordless
+      #  Session to send an email for.
+      #
+      # @return Hash
+      sig do
+        params(
+          session_id: String,
+        ).returns(T::Hash[String, T::Boolean])
+      end
+
+      def send_session(session_id)
+        response = execute_request(
+          request: post_request(
+            path: "/passwordless/sessions/#{session_id}/send",
+            auth: true,
+          ),
+        )
+
+        JSON.parse(response.body)
+      end
+    end
+  end
+end

data/lib/workos/types.rb

@@ -9,6 +9,7 @@ module WorkOS
     require_relative 'types/intent_enum'
     require_relative 'types/list_struct'
     require_relative 'types/organization_struct'
+    require_relative 'types/passwordless_session_struct'
     require_relative 'types/profile_struct'
     require_relative 'types/provider_enum'
   end

data/lib/workos/types/passwordless_session_struct.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+# typed: strict
+
+module WorkOS
+  module Types
+    # This PasswordlessSessionStruct acts as a typed interface
+    # for the Passwordless class
+    class PasswordlessSessionStruct < T::Struct
+      const :id, String
+      const :email, String
+      const :expires_at, Date
+      const :link, String
+    end
+  end
+end

data/lib/workos/version.rb

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

data/spec/lib/workos/passwordless_spec.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+# typed: false
+
+describe WorkOS::Passwordless do
+  before(:all) do
+    WorkOS.key = 'key'
+  end
+
+  after(:all) do
+    WorkOS.key = nil
+  end
+
+  describe '.create_session' do
+    context 'with valid options payload' do
+      let(:valid_options) do
+        {
+          email: 'demo@workos-okta.com',
+          type: 'MagicLink',
+        }
+      end
+
+      it 'creates a session' do
+        VCR.use_cassette('passwordless/create_session') do
+          response = described_class.create_session(valid_options)
+
+          expect(response.email).to eq 'demo@workos-okta.com'
+        end
+      end
+    end
+
+    context 'with invalid event payload' do
+      let(:invalid_options) do
+        {}
+      end
+
+      it 'raises an error' do
+        VCR.use_cassette('passwordless/create_session_invalid') do
+          expect do
+            described_class.create_session(invalid_options)
+          end.to raise_error(
+            WorkOS::InvalidRequestError,
+            /Status 422, Validation failed \(email: email must be a string; type: type must be a valid enum value\)/,
+          )
+        end
+      end
+    end
+  end
+
+  describe '.send_session' do
+    context 'with valid session id' do
+      let(:valid_options) do
+        {
+          email: 'demo@workos-okta.com',
+          type: 'MagicLink',
+        }
+      end
+
+      it 'send a session' do
+        VCR.use_cassette('passwordless/send_session') do
+          response = described_class.send_session(
+            'passwordless_session_01EJC0F4KH42T11Y2DHPEB09BM',
+          )
+
+          expect(response['success']).to eq true
+        end
+      end
+    end
+
+    context 'with invalid session id' do
+      it 'raises an error' do
+        VCR.use_cassette('passwordless/send_session_invalid') do
+          expect do
+            described_class.send_session('session_123')
+          end.to raise_error(
+            WorkOS::InvalidRequestError,
+            /Status 422, The passwordless session 'session_123' has expired or is invalid./,
+          )
+        end
+      end
+    end
+  end
+end

data/spec/support/fixtures/vcr_cassettes/passwordless/create_session.yml

@@ -0,0 +1,72 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.workos.com/passwordless/sessions
+    body:
+      encoding: UTF-8
+      string: '{"email":"demo@workos-okta.com","type":"MagicLink"}'
+    headers:
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - WorkOS; ruby/2.7.1; x86_64-darwin19; v0.7.0
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Server:
+      - Cowboy
+      Connection:
+      - keep-alive
+      Vary:
+      - Origin, Accept-Encoding
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Content-Security-Policy:
+      - 'default-src ''self'';base-uri ''self'';block-all-mixed-content;font-src ''self''
+        https: data:;frame-ancestors ''self'';img-src ''self'' data:;object-src ''none'';script-src
+        ''self'';script-src-attr ''none'';style-src ''self'' https: ''unsafe-inline'';upgrade-insecure-requests'
+      X-Dns-Prefetch-Control:
+      - 'off'
+      Expect-Ct:
+      - max-age=0
+      X-Frame-Options:
+      - SAMEORIGIN
+      Strict-Transport-Security:
+      - max-age=15552000; includeSubDomains
+      X-Download-Options:
+      - noopen
+      X-Content-Type-Options:
+      - nosniff
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      Referrer-Policy:
+      - no-referrer
+      X-Xss-Protection:
+      - '0'
+      X-Request-Id:
+      - 611c2a85-84e1-4bad-a2ec-43cf8371f134
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '238'
+      Etag:
+      - W/"ee-6KkIusxSXraxKqTLP+31C0PeHDU"
+      Date:
+      - Wed, 16 Sep 2020 15:39:08 GMT
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: UTF-8
+      string: '{"object":"passwordless_session","id":"passwordless_session_01EJBS3JSXFE2DP6JC6ZVBZ095","email":"demo@workos-okta.com","expires_at":"2020-09-16T15:44:08.475Z","link":"https://api.workos.com/passwordless/ZBxkn2ZTUYqa82ky6QEYecemI/confirm"}'
+    http_version:
+  recorded_at: Wed, 16 Sep 2020 15:39:08 GMT
+recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/passwordless/create_session_invalid.yml

@@ -0,0 +1,73 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.workos.com/passwordless/sessions
+    body:
+      encoding: UTF-8
+      string: "{}"
+    headers:
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - WorkOS; ruby/2.7.1; x86_64-darwin19; v0.7.0
+      Authorization:
+      - Bearer sk_4q5ka3d9bx0XJiZhkKmUIOG87
+  response:
+    status:
+      code: 422
+      message: Unprocessable Entity
+    headers:
+      Server:
+      - Cowboy
+      Connection:
+      - keep-alive
+      Vary:
+      - Origin, Accept-Encoding
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Content-Security-Policy:
+      - 'default-src ''self'';base-uri ''self'';block-all-mixed-content;font-src ''self''
+        https: data:;frame-ancestors ''self'';img-src ''self'' data:;object-src ''none'';script-src
+        ''self'';script-src-attr ''none'';style-src ''self'' https: ''unsafe-inline'';upgrade-insecure-requests'
+      X-Dns-Prefetch-Control:
+      - 'off'
+      Expect-Ct:
+      - max-age=0
+      X-Frame-Options:
+      - SAMEORIGIN
+      Strict-Transport-Security:
+      - max-age=15552000; includeSubDomains
+      X-Download-Options:
+      - noopen
+      X-Content-Type-Options:
+      - nosniff
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      Referrer-Policy:
+      - no-referrer
+      X-Xss-Protection:
+      - '0'
+      X-Request-Id:
+      - e3ca7215-2b2d-45cf-a04f-90279225f27e
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '150'
+      Etag:
+      - W/"96-O5ltHaJ3rEQ8+dqFwhN+Lhmgdb0"
+      Date:
+      - Wed, 16 Sep 2020 17:34:07 GMT
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: UTF-8
+      string: '{"message":"Validation failed","errors":[{"field":"email","code":"email
+        must be a string"},{"field":"type","code":"type must be a valid enum value"}]}'
+    http_version: 
+  recorded_at: Wed, 16 Sep 2020 17:34:07 GMT
+recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/passwordless/send_session.yml

@@ -0,0 +1,72 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.workos.com/passwordless/sessions/passwordless_session_01EJC0F4KH42T11Y2DHPEB09BM/send
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - WorkOS; ruby/2.7.1; x86_64-darwin19; v0.7.0
+      Authorization:
+      - Bearer sk_4q5ka3d9bx0XJiZhkKmUIOG87
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Server:
+      - Cowboy
+      Connection:
+      - keep-alive
+      Vary:
+      - Origin, Accept-Encoding
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Content-Security-Policy:
+      - 'default-src ''self'';base-uri ''self'';block-all-mixed-content;font-src ''self''
+        https: data:;frame-ancestors ''self'';img-src ''self'' data:;object-src ''none'';script-src
+        ''self'';script-src-attr ''none'';style-src ''self'' https: ''unsafe-inline'';upgrade-insecure-requests'
+      X-Dns-Prefetch-Control:
+      - 'off'
+      Expect-Ct:
+      - max-age=0
+      X-Frame-Options:
+      - SAMEORIGIN
+      Strict-Transport-Security:
+      - max-age=15552000; includeSubDomains
+      X-Download-Options:
+      - noopen
+      X-Content-Type-Options:
+      - nosniff
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      Referrer-Policy:
+      - no-referrer
+      X-Xss-Protection:
+      - '0'
+      X-Request-Id:
+      - d7d72520-9223-4145-b34e-df5e80a776d6
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '16'
+      Etag:
+      - W/"10-oV4hJxRVSENxc/wX8+mA4/Pe4tA"
+      Date:
+      - Wed, 16 Sep 2020 17:47:47 GMT
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: UTF-8
+      string: '{"success":true}'
+    http_version:
+  recorded_at: Wed, 16 Sep 2020 17:47:47 GMT
+recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/passwordless/send_session_invalid.yml

@@ -0,0 +1,73 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.workos.com/passwordless/sessions/session_123/send
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - WorkOS; ruby/2.7.1; x86_64-darwin19; v0.7.0
+      Authorization:
+      - Bearer sk_4q5ka3d9bx0XJiZhkKmUIOG87
+  response:
+    status:
+      code: 422
+      message: Unprocessable Entity
+    headers:
+      Server:
+      - Cowboy
+      Connection:
+      - keep-alive
+      Vary:
+      - Origin, Accept-Encoding
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Content-Security-Policy:
+      - 'default-src ''self'';base-uri ''self'';block-all-mixed-content;font-src ''self''
+        https: data:;frame-ancestors ''self'';img-src ''self'' data:;object-src ''none'';script-src
+        ''self'';script-src-attr ''none'';style-src ''self'' https: ''unsafe-inline'';upgrade-insecure-requests'
+      X-Dns-Prefetch-Control:
+      - 'off'
+      Expect-Ct:
+      - max-age=0
+      X-Frame-Options:
+      - SAMEORIGIN
+      Strict-Transport-Security:
+      - max-age=15552000; includeSubDomains
+      X-Download-Options:
+      - noopen
+      X-Content-Type-Options:
+      - nosniff
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      Referrer-Policy:
+      - no-referrer
+      X-Xss-Protection:
+      - '0'
+      X-Request-Id:
+      - 6c22578f-9d49-4118-a7bd-18014d447aad
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '79'
+      Etag:
+      - W/"4f-NjqaLicbRDM9SfS5gYKHlSgozt0"
+      Date:
+      - Wed, 16 Sep 2020 17:52:24 GMT
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: UTF-8
+      string: '{"message":"The passwordless session ''session_123'' has expired or
+        is invalid."}'
+    http_version: 
+  recorded_at: Wed, 16 Sep 2020 17:52:24 GMT
+recorded_with: VCR 5.0.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workos
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - WorkOS
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-14 00:00:00.000000000 Z
+date: 2020-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -214,6 +214,7 @@ files:
 - lib/workos/directory_sync.rb
 - lib/workos/errors.rb
 - lib/workos/organization.rb
+- lib/workos/passwordless.rb
 - lib/workos/portal.rb
 - lib/workos/profile.rb
 - lib/workos/sso.rb
@@ -222,6 +223,7 @@ files:
 - lib/workos/types/intent_enum.rb
 - lib/workos/types/list_struct.rb
 - lib/workos/types/organization_struct.rb
+- lib/workos/types/passwordless_session_struct.rb
 - lib/workos/types/profile_struct.rb
 - lib/workos/types/provider_enum.rb
 - lib/workos/version.rb
@@ -237,6 +239,7 @@ files:
 - spec/lib/workos/audit_trail_spec.rb
 - spec/lib/workos/base_spec.rb
 - spec/lib/workos/directory_sync_spec.rb
+- spec/lib/workos/passwordless_spec.rb
 - spec/lib/workos/portal_spec.rb
 - spec/lib/workos/sso_spec.rb
 - spec/spec_helper.rb
@@ -260,6 +263,10 @@ files:
 - spec/support/fixtures/vcr_cassettes/organization/create.yml
 - spec/support/fixtures/vcr_cassettes/organization/create_invalid.yml
 - spec/support/fixtures/vcr_cassettes/organization/list.yml
+- spec/support/fixtures/vcr_cassettes/passwordless/create_session.yml
+- spec/support/fixtures/vcr_cassettes/passwordless/create_session_invalid.yml
+- spec/support/fixtures/vcr_cassettes/passwordless/send_session.yml
+- spec/support/fixtures/vcr_cassettes/passwordless/send_session_invalid.yml
 - spec/support/fixtures/vcr_cassettes/portal/generate_link.yml
 - spec/support/fixtures/vcr_cassettes/portal/generate_link_invalid.yml
 - spec/support/fixtures/vcr_cassettes/sso/create_connection_with_invalid_source.yml
@@ -294,6 +301,7 @@ test_files:
 - spec/lib/workos/audit_trail_spec.rb
 - spec/lib/workos/base_spec.rb
 - spec/lib/workos/directory_sync_spec.rb
+- spec/lib/workos/passwordless_spec.rb
 - spec/lib/workos/portal_spec.rb
 - spec/lib/workos/sso_spec.rb
 - spec/spec_helper.rb
@@ -317,6 +325,10 @@ test_files:
 - spec/support/fixtures/vcr_cassettes/organization/create.yml
 - spec/support/fixtures/vcr_cassettes/organization/create_invalid.yml
 - spec/support/fixtures/vcr_cassettes/organization/list.yml
+- spec/support/fixtures/vcr_cassettes/passwordless/create_session.yml
+- spec/support/fixtures/vcr_cassettes/passwordless/create_session_invalid.yml
+- spec/support/fixtures/vcr_cassettes/passwordless/send_session.yml
+- spec/support/fixtures/vcr_cassettes/passwordless/send_session_invalid.yml
 - spec/support/fixtures/vcr_cassettes/portal/generate_link.yml
 - spec/support/fixtures/vcr_cassettes/portal/generate_link_invalid.yml
 - spec/support/fixtures/vcr_cassettes/sso/create_connection_with_invalid_source.yml