workos 0.5.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56cf52cb4a104516de13499b34f7c6f36a102c0c2af1bf6934e963579f27a596
-  data.tar.gz: 45dee16f5ed91f99133e7f974d607e76effa73e0d0d3b271fd7e9756e72055c5
+  metadata.gz: 9fd3e38d33d428497a46f40df28c4d142bc9adaf90c166b61c05914030c50b25
+  data.tar.gz: c445aa218658fe1fb57add7cc9081b1e63223641d29cac1e276429d3fb1244fd
 SHA512:
-  metadata.gz: 00d537dcaf496aa3b8244f72b04137496fef5613100ec61d32f837f20f42f6f5ed20180d41eb560dd6bfe6491810f07d4f4401d0e0cacc121c991b5c74d80676
-  data.tar.gz: 843f4d8558e3412ed6fa3becaf6c7717a301121baa7fd6edb292184518d335b2f616f024fdf13a9adf8659110aae3411744525be76f25f1bf238dd05acf14d99
+  metadata.gz: b94cf0c103286a457c3a73ab4ead5196ad2a8111f486ff22adbf4ecbdd5a21685dcb9483325b15813dcd5a25ea2383aec7d64fbc7545d4c80267731e97ed4a48
+  data.tar.gz: 30d4256a4b9218890dd880a5513dd90a09052f746085dffc282532bbf9ed5683b04d690181cfe1b209f02edc1fd1e37e04149819c8731afb81f5aba5561a2c18

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    workos (0.5.0)
+    workos (0.9.0)
       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.5877)
+    sorbet-runtime (0.5.5943)
     sorbet-static (0.5.5560-universal-darwin-14)
     unicode-display_width (1.6.0)
     vcr (5.0.0)

data/README.md

@@ -154,6 +154,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",

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

@@ -13,9 +13,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 +24,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 +42,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 +51,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 +61,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.rb

@@ -6,6 +6,10 @@ module WorkOS
   # so we're using Sorbet throughout this Ruby gem.
   module Types
     require_relative 'types/connection_struct'
+    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