workos 4.0.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 301b7f9d339c1ec1bf85dfc43a4d1ba85de8b6234323c8982fa2f2cf76bed6dd
-  data.tar.gz: 91ed96c899e42ccaed1955304fd98a7da7ca7e946be803df4e7c27f4cb3db5fc
+  metadata.gz: 7010166c9732e20f33a78674e669c1f583fda9695ddbce0b998b666166cbb60b
+  data.tar.gz: 642d0e92afe77f1aec7404fffdfec5af386d05807ee43c6bfa3201c11fe45cd7
 SHA512:
-  metadata.gz: b96feaf7d73165f33b979f3cd396adcf91aa4457161647b57423bf204bd89de42e6badeba37f06faf562bd58f5148fe9bd329850721c1efe5f0d0d18e0459bf6
-  data.tar.gz: 9417023f79e961c063fcb17c4ca60035e292fe2c321710778d99610165bea2b5c564e7dfad24a7b2effdb51b0d5355fe0c4155de45c7ef5d0d073ddfbbb1f1c6
+  metadata.gz: b65ccc5817fc14633a235b12e2f3c25be1b04b6f1c07d9b781fd5d131cad89d7528dd0ab6326f100d542425261de9d1a81d28e89c1e30158a7e2a05291cdb8dd
+  data.tar.gz: 94b2b2d3e59882de00b1ff7c01d2a0c5284357d52fa4e8418f86eff9ea37b0c0d0ef2c197b88ad0497ca56b872f2ab3309a4598feab6a80aa6b1f55114bc57e4

data/.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - 'main'
+  pull_request: {}
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  test:
+    name: Test Ruby ${{ matrix.ruby }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - '2.7'
+          - '3.0'
+          - '3.1'
+          - '3.2'
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Rubocop
+        run: |
+          bundle exec rubocop
+
+      - name: Spec
+        run: |
+          bundle exec rspec

data/.github/workflows/release.yml

@@ -0,0 +1,43 @@
+name: Release
+
+on:
+  # Support manually pushing a new release
+  workflow_dispatch: {}
+  # Trigger when a release is published
+  release:
+    types: [released]
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  test:
+    name: Publish to RubyGems
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.2'
+          bundler-cache: true
+
+      - name: Spec
+        run: |
+          bundle exec rspec
+
+      - name: Publish
+        env:
+          RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
+        run: |
+          mkdir -p ~/.gem
+
+          cat << EOF > ~/.gem/credentials
+          ---
+          :rubygems_api_key: ${RUBYGEMS_API_KEY}
+          EOF
+
+          chmod 0600 ~/.gem/credentials
+
+          bundle exec gem build workos --output=release.gem
+          bundle exec gem push release.gem

data/.rubocop.yml

@@ -1,3 +1,6 @@
+# Disabling due to conflict with Ruby 2.7/3.1
+Layout/BlockAlignment:
+  Enabled: false
 Layout/DotPosition:
   EnforcedStyle: trailing
 Layout/EmptyLineAfterMagicComment:
@@ -16,9 +19,13 @@ Metrics/ModuleLength:
   Max: 200
 Metrics/ParameterLists:
   Max: 6
+Naming/ConstantName:
+  Exclude:
+    - 'lib/workos/user_management.rb'
+    - 'lib/workos/types/*.rb'
 Style/TrailingCommaInArguments:
   EnforcedStyleForMultiline: 'consistent_comma'
 Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: 'consistent_comma'
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.7

data/Gemfile.lock

@@ -1,41 +1,29 @@
 PATH
   remote: .
   specs:
-    workos (4.0.0)
-      sorbet-runtime (~> 0.5)
+    workos (4.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
-    codecov (0.2.12)
-      json
-      simplecov
-    coderay (1.1.3)
-    crack (0.4.5)
+    bigdecimal (3.1.7)
+    crack (1.0.0)
+      bigdecimal
       rexml
-    diff-lcs (1.4.4)
-    docile (1.3.5)
-    hashdiff (1.0.1)
-    json (2.5.1)
-    method_source (1.0.0)
-    parallel (1.20.1)
-    parser (3.0.1.0)
+    diff-lcs (1.5.1)
+    hashdiff (1.1.0)
+    parallel (1.24.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
-    pry (0.14.2)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    public_suffix (4.0.6)
-    rainbow (3.0.0)
-    rbi (0.0.16)
-      ast
-      parser (>= 2.6.4.0)
-      sorbet-runtime (>= 0.5.9204)
-      unparser
-    regexp_parser (2.1.1)
-    rexml (3.2.5)
+      racc
+    public_suffix (5.0.4)
+    racc (1.7.3)
+    rainbow (3.1.1)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -58,58 +46,23 @@ GEM
       rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
-    ruby-progressbar (1.11.0)
-    simplecov (0.21.2)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.2)
-    sorbet (0.5.11132)
-      sorbet-static (= 0.5.11132)
-    sorbet-runtime (0.5.10484)
-    sorbet-static (0.5.11132-universal-darwin)
-    sorbet-static (0.5.11132-x86_64-linux)
-    spoom (1.1.15)
-      sorbet (>= 0.5.10187)
-      sorbet-runtime (>= 0.5.9204)
-      thor (>= 0.19.2)
-    tapioca (0.7.3)
-      bundler (>= 1.17.3)
-      pry (>= 0.12.2)
-      rbi (~> 0.0.0, >= 0.0.14)
-      sorbet-runtime (>= 0.5.9204)
-      sorbet-static (>= 0.5.9204)
-      spoom (~> 1.1.0, >= 1.1.11)
-      thor (>= 1.2.0)
-      yard-sorbet
-    thor (1.2.1)
-    unicode-display_width (1.7.0)
-    unparser (0.6.2)
-      diff-lcs (~> 1.3)
-      parser (>= 3.0.0)
+    rubocop-ast (1.31.2)
+      parser (>= 3.3.0.4)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (1.8.0)
     vcr (5.0.0)
-    webmock (3.12.2)
-      addressable (>= 2.3.6)
+    webmock (3.23.0)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    yard (0.9.26)
-    yard-sorbet (0.8.0)
-      sorbet-runtime (>= 0.5)
-      yard (>= 0.9)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (>= 2.0.1)
-  codecov (~> 0.2.8)
   rspec (~> 3.9.0)
   rubocop (~> 0.77)
-  sorbet (~> 0.5)
-  tapioca
   vcr (~> 5.0.0)
   webmock
   workos!

data/lib/workos/audit_log_export.rb

@@ -1,24 +1,21 @@
 # frozen_string_literal: true
-# typed: true
 
 module WorkOS
   # The AuditLogExport class represents the WorkOS entity created when exporting Audit Log Events.
   class AuditLogExport
     include HashProvider
-    extend T::Sig
 
     attr_accessor :object, :id, :state, :url, :created_at, :updated_at
 
-    sig { params(json: String).void }
     def initialize(json)
-      raw = parse_json(json)
-
-      @object = T.let(raw.object, String)
-      @id = T.let(raw.id, String)
-      @state = T.let(raw.state, String)
-      @url = raw.url
-      @created_at = T.let(raw.created_at, String)
-      @updated_at = T.let(raw.updated_at, String)
+      hash = JSON.parse(json, symbolize_names: true)
+
+      @object = hash[:object]
+      @id = hash[:id]
+      @state = hash[:state]
+      @url = hash[:url]
+      @created_at = hash[:created_at]
+      @updated_at = hash[:updated_at]
     end
 
     def to_json(*)
@@ -31,25 +28,5 @@ module WorkOS
         updated_at: updated_at,
       }
     end
-
-    private
-
-    sig do
-      params(
-        json_string: String,
-      ).returns(WorkOS::Types::AuditLogExportStruct)
-    end
-    def parse_json(json_string)
-      hash = JSON.parse(json_string, symbolize_names: true)
-
-      WorkOS::Types::AuditLogExportStruct.new(
-        object: hash[:object],
-        id: hash[:id],
-        state: hash[:state],
-        url: hash[:url],
-        created_at: hash[:created_at],
-        updated_at: hash[:updated_at],
-      )
-    end
   end
 end

data/lib/workos/audit_logs.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: true
 
 require 'net/http'
 require 'uri'
@@ -9,7 +8,6 @@ module WorkOS
   # WorkOS Audit Logs platform. You'll need a valid API key.
   module AuditLogs
     class << self
-      extend T::Sig
       include Client
 
       # Create an Audit Log Event.
@@ -19,13 +17,6 @@ module WorkOS
       # @param [String] idempotency_key An idempotency key
       #
       # @return [nil]
-      sig do
-        params(
-          organization: String,
-          event: Hash,
-          idempotency_key: T.nilable(String),
-        ).void
-      end
       def create_event(organization:, event:, idempotency_key: nil)
         request = post_request(
           path: '/audit_logs/events',
@@ -52,18 +43,6 @@ module WorkOS
       # @param [Array<String>] targets A list of target types to filter by
       #
       # @return [WorkOS::AuditLogExport]
-      sig do
-        params(
-          organization: String,
-          range_start: String,
-          range_end: String,
-          actions: T.nilable(T::Array[String]),
-          actors: T.nilable(T::Array[String]),
-          targets: T.nilable(T::Array[String]),
-          actor_names: T.nilable(T::Array[String]),
-          actor_ids: T.nilable(T::Array[String]),
-        ).returns(WorkOS::AuditLogExport)
-      end
       def create_export(organization:, range_start:, range_end:, actions: nil, # rubocop:disable Metrics/ParameterLists
                         actors: nil, targets: nil, actor_names: nil, actor_ids: nil)
         body = {
@@ -94,11 +73,6 @@ module WorkOS
       # @param [String] id An Audit Log Export ID
       #
       # @return [WorkOS::AuditLogExport]
-      sig do
-        params(
-          id: String,
-        ).returns(WorkOS::AuditLogExport)
-      end
       def get_export(id:)
         request = get_request(
           auth: true,

data/lib/workos/authentication_factor_and_challenge.rb

@@ -1,16 +1,13 @@
 # frozen_string_literal: true
-# typed: true
 
 module WorkOS
   # The AuthenticationFactorAndChallenge class represents
   # an authentication factor and challenge for a given user.
   class AuthenticationFactorAndChallenge
     include HashProvider
-    extend T::Sig
 
     attr_accessor :authentication_factor, :authentication_challenge
 
-    sig { params(authentication_response_json: String).void }
     def initialize(authentication_response_json)
       json = JSON.parse(authentication_response_json, symbolize_names: true)
       @authentication_factor = WorkOS::Factor.new(

data/lib/workos/authentication_response.rb

@@ -1,26 +1,33 @@
 # frozen_string_literal: true
-# typed: true
 
 module WorkOS
   # The AuthenticationResponse class represents an Authentication Response as well as an corresponding
   # response data that can later be appended on.
   class AuthenticationResponse
     include HashProvider
-    extend T::Sig
 
-    attr_accessor :user, :organization_id
+    attr_accessor :user, :organization_id, :impersonator, :access_token, :refresh_token
 
-    sig { params(authentication_response_json: String).void }
     def initialize(authentication_response_json)
       json = JSON.parse(authentication_response_json, symbolize_names: true)
       @user = WorkOS::User.new(json[:user].to_json)
-      @organization_id = T.let(json[:organization_id], T.nilable(String))
+      @organization_id = json[:organization_id]
+      @impersonator =
+        if (impersonator_json = json[:impersonator])
+          Impersonator.new(email: impersonator_json[:email],
+                           reason: impersonator_json[:reason],)
+        end
+      @access_token = json[:access_token]
+      @refresh_token = json[:refresh_token]
     end
 
     def to_json(*)
       {
         user: user.to_json,
         organization_id: organization_id,
+        impersonator: impersonator.to_json,
+        access_token: access_token,
+        refresh_token: refresh_token,
       }
     end
   end

data/lib/workos/challenge.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: false
 
 module WorkOS
   # The Challnge class provides a lightweight wrapper around
@@ -7,20 +6,19 @@ module WorkOS
   # in DirectoryUser space, and is instantiated internally but exposed.
   class Challenge
     include HashProvider
-    extend T::Sig
 
     attr_accessor :id, :object, :expires_at, :code, :authentication_factor_id, :updated_at, :created_at
 
-    sig { params(json: String).void }
     def initialize(json)
-      raw = parse_json(json)
-      @id = T.let(raw.id, String)
-      @object = T.let(raw.object, String)
-      @expires_at = T.let(raw.expires_at, String)
-      @code = raw.code
-      @authentication_factor_id = T.let(raw.authentication_factor_id, String)
-      @created_at = T.let(raw.created_at, String)
-      @updated_at = T.let(raw.updated_at, String)
+      hash = JSON.parse(json, symbolize_names: true)
+
+      @id = hash[:id]
+      @object = hash[:object]
+      @expires_at = hash[:expires_at]
+      @code = hash[:code]
+      @authentication_factor_id = hash[:authentication_factor_id]
+      @created_at = hash[:created_at]
+      @updated_at = hash[:updated_at]
     end
 
     def to_json(*)
@@ -34,22 +32,5 @@ module WorkOS
         updated_at: updated_at,
       }
     end
-
-    private
-
-    sig { params(json_string: String).returns(WorkOS::Types::ChallengeStruct) }
-    def parse_json(json_string)
-      hash = JSON.parse(json_string, symbolize_names: true)
-
-      WorkOS::Types::ChallengeStruct.new(
-        id: hash[:id],
-        object: hash[:object],
-        expires_at: hash[:expires_at],
-        code: hash[:code],
-        authentication_factor_id: hash[:authentication_factor_id],
-        created_at: hash[:created_at],
-        updated_at: hash[:updated_at],
-      )
-    end
   end
 end

data/lib/workos/client.rb

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
-# typed: false
 
 module WorkOS
   # A Net::HTTP based API client for interacting with the WorkOS API
   module Client
-    extend T::Sig
     include Kernel
 
-    sig { returns(Net::HTTP) }
     def client
       Net::HTTP.new(WorkOS.config.api_hostname, 443).tap do |http_client|
         http_client.use_ssl = true
@@ -17,11 +14,6 @@ module WorkOS
       end
     end
 
-    sig do
-      params(
-        request: T.any(Net::HTTP::Get, Net::HTTP::Post, Net::HTTP::Delete, Net::HTTP::Put),
-      ).returns(::T.untyped)
-    end
     def execute_request(request:)
       begin
         response = client.request(request)
@@ -37,14 +29,6 @@ module WorkOS
       response
     end
 
-    sig do
-      params(
-        path: String,
-        auth: T.nilable(T::Boolean),
-        params: T.nilable(Hash),
-        access_token: T.nilable(String),
-      ).returns(Net::HTTP::Get)
-    end
     def get_request(path:, auth: false, params: {}, access_token: nil)
       uri = URI(path)
       uri.query = URI.encode_www_form(params) if params
@@ -59,14 +43,6 @@ module WorkOS
       request
     end
 
-    sig do
-      params(
-        path: String,
-        auth: T.nilable(T::Boolean),
-        idempotency_key: T.nilable(String),
-        body: T.nilable(Hash),
-      ).returns(Net::HTTP::Post)
-    end
     def post_request(path:, auth: false, idempotency_key: nil, body: nil)
       request = Net::HTTP::Post.new(path, 'Content-Type' => 'application/json')
       request.body = body.to_json if body
@@ -76,13 +52,6 @@ module WorkOS
       request
     end
 
-    sig do
-      params(
-        path: String,
-        auth: T.nilable(T::Boolean),
-        params: T.nilable(Hash),
-      ).returns(Net::HTTP::Delete)
-    end
     def delete_request(path:, auth: false, params: {})
       uri = URI(path)
       uri.query = URI.encode_www_form(params) if params
@@ -97,14 +66,6 @@ module WorkOS
       request
     end
 
-    sig do
-      params(
-        path: String,
-        auth: T.nilable(T::Boolean),
-        idempotency_key: T.nilable(String),
-        body: T.nilable(Hash),
-      ).returns(Net::HTTP::Put)
-    end
     def put_request(path:, auth: false, idempotency_key: nil, body: nil)
       request = Net::HTTP::Put.new(path, 'Content-Type' => 'application/json')
       request.body = body.to_json if body
@@ -114,7 +75,6 @@ module WorkOS
       request
     end
 
-    sig { returns(String) }
     def user_agent
       engine = defined?(::RUBY_ENGINE) ? ::RUBY_ENGINE : 'Ruby'
 
@@ -127,7 +87,6 @@ module WorkOS
     end
 
     # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-    sig { params(response: ::T.untyped).void }
     def handle_error_response(response:)
       http_status = response.code.to_i
       json = JSON.parse(response.body)

data/lib/workos/configuration.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: true
 
 module WorkOS
   # Configuration class sets config initializer

data/lib/workos/connection.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: true
 
 module WorkOS
   # The Connection class provides a lightweight wrapper around
@@ -8,27 +7,23 @@ module WorkOS
   # Note: status is deprecated - use state instead
   class Connection
     include HashProvider
-    extend T::Sig
 
     attr_accessor :id, :name, :connection_type, :domains, :organization_id,
                   :state, :status, :created_at, :updated_at
 
-    # rubocop:disable Metrics/AbcSize
-    sig { params(json: String).void }
     def initialize(json)
-      raw = parse_json(json)
-
-      @id = T.let(raw.id, String)
-      @name = T.let(raw.name, String)
-      @connection_type = T.let(raw.connection_type, String)
-      @domains = T.let(raw.domains, Array)
-      @organization_id = raw.organization_id
-      @state = T.let(raw.state, String)
-      @status = T.let(raw.status, String)
-      @created_at = T.let(raw.created_at, String)
-      @updated_at = T.let(raw.updated_at, String)
+      hash = JSON.parse(json, symbolize_names: true)
+
+      @id = hash[:id]
+      @name = hash[:name]
+      @connection_type = hash[:connection_type]
+      @domains = hash[:domains]
+      @organization_id = hash[:organization_id]
+      @state = hash[:state]
+      @status = hash[:status]
+      @created_at = hash[:created_at]
+      @updated_at = hash[:updated_at]
     end
-    # rubocop:enable Metrics/AbcSize
 
     def to_json(*)
       {
@@ -43,24 +38,5 @@ module WorkOS
         updated_at: updated_at,
       }
     end
-
-    private
-
-    sig { params(json_string: String).returns(WorkOS::Types::ConnectionStruct) }
-    def parse_json(json_string)
-      hash = JSON.parse(json_string, symbolize_names: true)
-
-      WorkOS::Types::ConnectionStruct.new(
-        id: hash[:id],
-        name: hash[:name],
-        connection_type: hash[:connection_type],
-        domains: hash[:domains],
-        organization_id: hash[:organization_id],
-        state: hash[:state],
-        status: hash[:status],
-        created_at: hash[:created_at],
-        updated_at: hash[:updated_at],
-      )
-    end
   end
 end