workos 0.4.2 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a179e7a1a9dcd3e5bb85ab328900de17d3987e0763bb285ce4539e44fb11524
-  data.tar.gz: 52586ff03484f8550db6e1f538e3ffdbc22b0ccc2dd275e3dc75056c8d18a407
+  metadata.gz: 4d0c25850478e9c956759f36703587fd5da039b17063b8bbe5471937aadc15cf
+  data.tar.gz: ab19b3a879da2a46560d2fa0dffeb4da85428ebec07ceeabe6f45f38059e6734
 SHA512:
-  metadata.gz: cd6378af304ecb31e392dfe8c1a8807b48e8290e466865937aae9565f79fe3e598df0a9a165d0849db8ae548e45076f1a2f8e5fc54ad2962fda1cc1060ea34ee
-  data.tar.gz: 9249a469a463e5bb9e9cfb8e300bde22b153e8c39b2e7327f2aefa628a932607635bc2df5309d109336177024f8b8157ba2622b0245faf5b3cf11a223650956f
+  metadata.gz: 1894c61c6804fa7089f7475461e402d1803bca62fcf728ee7c549bd318980602df6f7aa6641cbd9050ebcacfe4fd12c9e85c8c3e5e880eed80d7fa3ce8468327
+  data.tar.gz: ce0521b22be9055589b774fab6d726105c01cd86cab54ddaa0e22b99338175a62d27b11e7aa5783b76b4b2bb69514e619897fd2c048ebacb71a1a057920d554d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    workos (0.4.2)
+    workos (0.8.1)
       sorbet-runtime (~> 0.5)
 
 GEM
@@ -10,17 +10,16 @@ GEM
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
-    codecov (0.1.16)
+    codecov (0.2.8)
       json
       simplecov
-      url
     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.0)
+    json (2.3.1)
     parallel (1.19.1)
     parser (2.7.0.0)
       ast (~> 2.4.0)
@@ -49,17 +48,15 @@ GEM
       unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.1)
     safe_yaml (1.0.5)
-    simplecov (0.17.1)
+    simplecov (0.19.0)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
     sorbet (0.5.5560)
       sorbet-static (= 0.5.5560)
-    sorbet-runtime (0.5.5870)
+    sorbet-runtime (0.5.5923)
     sorbet-static (0.5.5560-universal-darwin-14)
     unicode-display_width (1.6.0)
-    url (0.3.2)
     vcr (5.0.0)
     webmock (3.7.6)
       addressable (>= 2.3.6)
@@ -72,7 +69,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (>= 2.0.1)
-  codecov (~> 0.1.16)
+  codecov (~> 0.2.8)
   rake
   rspec (~> 3.9.0)
   rubocop (~> 0.77)

data/README.md

@@ -157,6 +157,13 @@ This method will return an instance of a `WorkOS::Profile` with the following at
   @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"
+  },
 >
 ```
 

data/lib/workos.rb

@@ -31,6 +31,9 @@ module WorkOS
   autoload :AuditTrail, 'workos/audit_trail'
   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/organization.rb

@@ -0,0 +1,49 @@
+# 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
+  # in user space, and is instantiated internally but exposed.
+  class Organization
+    extend T::Sig
+
+    attr_accessor :id, :domains, :name
+
+    sig { params(json: String).void }
+    def initialize(json)
+      raw = parse_json(json)
+
+      @id = T.let(raw.id, String)
+      @name = T.let(raw.name, String)
+      @domains = T.let(raw.domains, Array)
+    end
+
+    def to_json(*)
+      {
+        id: id,
+        name: name,
+        domains: domains,
+      }
+    end
+
+    private
+
+    sig do
+      params(
+        json_string: String,
+      ).returns(WorkOS::Types::OrganizationStruct)
+    end
+    def parse_json(json_string)
+      hash = JSON.parse(json_string, symbolize_names: true)
+
+      WorkOS::Types::OrganizationStruct.new(
+        id: hash[:id],
+        name: hash[:name],
+        domains: hash[:domains],
+      )
+    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/portal.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+# typed: true
+
+require 'net/http'
+
+module WorkOS
+  # The Portal module provides resource methods for working with the Admin
+  # Portal product
+  module Portal
+    class << self
+      extend T::Sig
+      include Base
+      include Client
+
+      GENERATE_LINK_INTENTS = WorkOS::Types::Intent.values.map(&:serialize).
+                              freeze
+
+      # Create an organization
+      #
+      # @param [Array<String>] domains List of domains that belong to the
+      #  organization
+      # @param [String] name A unique, descriptive name for the organization
+      sig do
+        params(
+          domains: T::Array[String],
+          name: String,
+        ).returns(WorkOS::Organization)
+      end
+      def create_organization(domains:, name:)
+        request = post_request(
+          auth: true,
+          body: { domains: domains, name: name },
+          path: '/organizations',
+        )
+
+        response = execute_request(request: request)
+        check_and_raise_organization_error(response: response)
+
+        WorkOS::Organization.new(response.body)
+      end
+
+      # Generate a link to grant access to an organization's Admin Portal
+      #
+      # @param [String] intent The access scope for the generated Admin Portal
+      #  link. Valid values are: ["sso"]
+      # @param [String] organization The ID of the organization the Admin
+      #  Portal link will be generated for.
+      # @param [String] The URL that the end user will be redirected to upon
+      #  exiting the generated Admin Portal. If none is provided, the default
+      #  redirect link set in your WorkOS Dashboard will be used.
+      sig do
+        params(
+          intent: String,
+          organization: String,
+          return_url: T.nilable(String),
+        ).returns(String)
+      end
+      # rubocop:disable Metrics/MethodLength
+      def generate_link(intent:, organization:, return_url: nil)
+        validate_intent(intent)
+
+        request = post_request(
+          auth: true,
+          body: {
+            intent: intent,
+            organization: organization,
+            return_url: return_url,
+          },
+          path: '/portal/generate_link',
+        )
+
+        response = execute_request(request: request)
+
+        JSON.parse(response.body)['link']
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      # Retrieve a list of organizations that have connections configured
+      # within your WorkOS dashboard.
+      #
+      # @param [Array<String>] domains Filter organizations to only return those
+      #  that are associated with the provided domains.
+      # @param [String] before A pagination argument used to request
+      #  organizations before the provided Organization ID.
+      # @param [String] after A pagination argument used to request
+      #  organizations after the provided Organization ID.
+      # @param [Integer] limit A pagination argument used to limit the number
+      #  of listed Organizations that are returned.
+      sig do
+        params(
+          options: T::Hash[Symbol, String],
+        ).returns(WorkOS::Types::ListStruct)
+      end
+      # rubocop:disable Metrics/MethodLength
+      def list_organizations(options = {})
+        response = execute_request(
+          request: get_request(
+            path: '/organizations',
+            auth: true,
+            params: options,
+          ),
+        )
+
+        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: organizations,
+          list_metadata: parsed_response['listMetadata'],
+        )
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      private
+
+      sig { params(response: Net::HTTPResponse).void }
+      # rubocop:disable Metrics/MethodLength
+      def check_and_raise_organization_error(response:)
+        begin
+          body = JSON.parse(response.body)
+          return unless body['message']
+
+          message = body['message']
+          request_id = response['x-request-id']
+        rescue StandardError
+          message = 'Something went wrong'
+        end
+
+        raise APIError.new(
+          message: message,
+          http_status: nil,
+          request_id: request_id,
+        )
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      sig { params(intent: String).void }
+      def validate_intent(intent)
+        return if GENERATE_LINK_INTENTS.include?(intent)
+
+        raise ArgumentError, "#{intent} is not a valid value." \
+        " `intent` must be in #{GENERATE_LINK_INTENTS}"
+      end
+    end
+  end
+end

data/lib/workos/profile.rb

@@ -14,7 +14,7 @@ module WorkOS
 
     sig { returns(String) }
     attr_accessor :id, :email, :first_name, :last_name,
-                  :connection_type, :idp_id
+                  :connection_type, :idp_id, :raw_attributes
 
     sig { params(profile_json: String).void }
     def initialize(profile_json)
@@ -26,6 +26,7 @@ module WorkOS
       @last_name = raw.last_name
       @connection_type = T.let(raw.connection_type, String)
       @idp_id = raw.idp_id
+      @raw_attributes = raw.raw_attributes
     end
 
     sig { returns(String) }
@@ -41,11 +42,13 @@ module WorkOS
         last_name: last_name,
         connection_type: connection_type,
         idp_id: idp_id,
+        raw_attributes: raw_attributes,
       }
     end
 
     private
 
+    # rubocop:disable Metrics/AbcSize
     sig { params(json_string: String).returns(WorkOS::Types::ProfileStruct) }
     def parse_json(json_string)
       hash = JSON.parse(json_string, symbolize_names: true)
@@ -57,7 +60,9 @@ module WorkOS
         last_name: hash[:profile][:last_name],
         connection_type: hash[:profile][:connection_type],
         idp_id: hash[:profile][:idp_id],
+        raw_attributes: hash[:profile][:raw_attributes],
       )
     end
+    # rubocop:enable Metrics/AbcSize
   end
 end