workos 0.2.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06fb7835303dcd8aa08c89cdd04c24c59f0d649b7e21d7dfd6ae82cc57529304
-  data.tar.gz: 62bfacb18255d7c177c611c7dda0dd2a459610cdd1e0a0c48bbe3800a750ed64
+  metadata.gz: ce58ab479d49e4f828ebe675fb3f3b8104a6d82d85f19da6087f9a907dc1e827
+  data.tar.gz: 96d0c77cf047d6e56952414cda3d80d2395b692b4125af95c15a9ba85b00c0c9
 SHA512:
-  metadata.gz: dd38c198e15b8c0f9f804593aba4eebe23ccad4c3be119c3d75861f0f38769fa13bccf204ad1085f74a32d448877e172eac4f45132fae8e4a793d699e0e78327
-  data.tar.gz: de1017c20f88ad1ba4d74cb51e98a6f234e692564ef073ceaeaae893cdc3b70c2af9bce74d74264fe0461d21ce0757fc8e6548143de33a54a1dc9f08f8a91eab
+  metadata.gz: 8529507b9187453055b084ec30446123a2572f4045380f17916d640b1c0f052eb64089d620695469b3eb0839c3d88e4f6827a24de1802bd432f2c5f134cb3094
+  data.tar.gz: 505133b5a111f5efdfd1b9c26b773f6359dc21841273df43ae0f7090afec8ee11350830004f2dd285d7b607b3d423e95513c50484cab36ade8be60686be214f1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    workos (0.2.3)
+    workos (0.4.0)
       sorbet-runtime (~> 0.5)
 
 GEM
@@ -56,7 +56,7 @@ GEM
     simplecov-html (0.10.2)
     sorbet (0.5.5560)
       sorbet-static (= 0.5.5560)
-    sorbet-runtime (0.5.5560)
+    sorbet-runtime (0.5.5858)
     sorbet-static (0.5.5560-universal-darwin-14)
     unicode-display_width (1.6.0)
     url (0.3.2)

data/README.md

@@ -80,7 +80,7 @@ WorkOS::AuditTrail.create_event(event: payload, idempotency_key: 'key123456')
 ```
 
 See our [API
-Reference](https://docs.workos.com/api-reference#idempotency)
+Reference](https://docs.workos.com/audit-trail/api-reference#idempotency)
 for more information on idempotency keys.
 
 ## The SSO Module

data/lib/workos.rb

@@ -30,6 +30,7 @@ module WorkOS
   autoload :Client, 'workos/client'
   autoload :AuditTrail, 'workos/audit_trail'
   autoload :Connection, 'workos/connection'
+  autoload :DirectorySync, 'workos/directory_sync'
   autoload :Profile, 'workos/profile'
   autoload :SSO, 'workos/sso'
 

data/lib/workos/audit_trail.rb

@@ -57,6 +57,54 @@ module WorkOS
 
         execute_request(request: request)
       end
+
+      # Retrieve Audit Trail events.
+      #
+      # @param [Hash] options An options hash
+      # @option options [String] before Event ID to look before
+      # @option options [String] after Event ID to look after
+      # @option options [Integer] limit Number of Events to return
+      # @option options [Array<String>] group List of Groups to filter for
+      # @option options [Array<String>] action List of Actions to filter for
+      # @option options [Array<String>] action_type List of Action Types to
+      #  filter for
+      # @option options [Array<String>] actor_name List of Actor Name to filter
+      #  for
+      # @option options [Array<String>] actor_id List of Actor IDs to filter for
+      # @option options [Array<String>] target_name List of Target Names to
+      #  filter for
+      # @option options [Array<String>] target_id List of Target IDs to filter
+      #  for
+      # @option options [String] occurred_at ISO-8601 datetime of when an event
+      #  occurred
+      # @option options [String] occurred_at_gt ISO-8601 datetime of when an
+      #  event occurred after
+      # @option options [String] occurred_at_gte ISO-8601 datetime of when an
+      #  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] search Keyword search
+      #
+      # @return [Array<Hash>]
+      sig do
+        params(
+          options: T::Hash[Symbol, String],
+        ).returns(T::Array[T::Hash[String, T.nilable(String)]])
+      end
+
+      def get_events(options = {})
+        response = execute_request(
+          request: get_request(
+            path: '/events',
+            auth: true,
+            params: options,
+          ),
+        )
+
+        JSON.parse(response.body)['data']
+      end
     end
   end
 end

data/lib/workos/directory_sync.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+# typed: true
+
+module WorkOS
+  # The Directory Sync module provides convenience methods for working with the
+  # WorkOS Directory Sync platform. You'll need a valid API key and to have
+  # created a Directory Sync connection on your WorkOS dashboard.
+  #
+  # @see https://docs.workos.com/directory-sync/overview
+  module DirectorySync
+    class << self
+      extend T::Sig
+      include Base
+      include Client
+
+      # Retrieve directories.
+      #
+      # @param [Hash] options An options hash
+      # @option options [String] domain The domain of the directory to be
+      #  retrieved.
+      # @option options [String] search A search term for direcory names.
+      #
+      # @return [Hash]
+      sig do
+        params(
+          options: T::Hash[Symbol, String],
+        ).returns(T::Array[T::Hash[String, T.nilable(String)]])
+      end
+      def list_directories(options = {})
+        response = execute_request(
+          request: get_request(
+            path: '/directories',
+            auth: true,
+            params: options,
+          ),
+        )
+
+        JSON.parse(response.body)['data']
+      end
+
+      # Retrieve directory groups.
+      #
+      # @param [Hash] options An options hash
+      # @option options [String] directory The ID of the directory whose
+      #  directory groups will be retrieved.
+      # @option options [String] user The ID of the directory user whose
+      #  directory groups will be retrieved.
+      #
+      # @return [Hash]
+      sig do
+        params(
+          options: T::Hash[Symbol, String],
+        ).returns(T::Array[T::Hash[String, T.nilable(String)]])
+      end
+      def list_groups(options = {})
+        response = execute_request(
+          request: get_request(
+            path: '/directory_groups',
+            auth: true,
+            params: options,
+          ),
+        )
+
+        JSON.parse(response.body)['data']
+      end
+
+      # Retrieve directory users.
+      #
+      # @param [Hash] options An options hash
+      # @option options [String] directory The ID of the directory whose
+      #  directory users will be retrieved.
+      # @option options [String] user The ID of the directory group whose
+      #  directory users will be retrieved.
+      #
+      # @return [Hash]
+      sig do
+        params(
+          options: T::Hash[Symbol, String],
+        ).returns(T::Array[T::Hash[String, T.untyped]])
+      end
+      def list_users(options = {})
+        response = execute_request(
+          request: get_request(
+            path: '/directory_users',
+            auth: true,
+            params: options,
+          ),
+        )
+
+        JSON.parse(response.body)['data']
+      end
+
+      # Retrieve the directory group with the given ID.
+      #
+      # @param [String] id The ID of the directory group.
+      #
+      # @return Hash
+      sig { params(id: String).returns(T::Hash[String, T.untyped]) }
+      def get_group(id)
+        response = execute_request(
+          request: get_request(
+            path: "/directory_groups/#{id}",
+            auth: true,
+          ),
+        )
+
+        JSON.parse(response.body)
+      end
+
+      # Retrieve the directory user with the given ID.
+      #
+      # @param [String] id The ID of the directory user.
+      #
+      # @return Hash
+      sig { params(id: String).returns(T::Hash[String, T.untyped]) }
+      def get_user(id)
+        response = execute_request(
+          request: get_request(
+            path: "/directory_users/#{id}",
+            auth: true,
+          ),
+        )
+
+        JSON.parse(response.body)
+      end
+    end
+  end
+end

data/lib/workos/profile.rb

@@ -22,8 +22,8 @@ module WorkOS
 
       @id = T.let(raw.id, String)
       @email = T.let(raw.email, String)
-      @first_name = T.let(raw.first_name, String)
-      @last_name = T.let(raw.last_name, String)
+      @first_name = raw.first_name
+      @last_name = raw.last_name
       @connection_type = T.let(raw.connection_type, String)
       @idp_id = T.let(raw.idp_id, String)
     end

data/lib/workos/sso.rb

@@ -31,7 +31,7 @@ module WorkOS
       # @param [String] redirect_uri The URI where users are directed
       #  after completing the authentication step. Must match a
       #  configured redirect URI on your WorkOS dashboard.
-      # @param [Hash] state An aribtrary state object
+      # @param [String] state An aribtrary state object
       #  that is preserved and available to the client in the response.
       # @example
       #   WorkOS::SSO.authorization_url(
@@ -40,7 +40,7 @@ module WorkOS
       #     redirect_uri: 'https://workos.com/callback',
       #     state: {
       #       next_page: '/docs'
-      #     }
+      #     }.to_s
       #   )
       #
       #   => "https://api.workos.com/sso/authorize?domain=acme.com" \
@@ -55,11 +55,11 @@ module WorkOS
           redirect_uri: String,
           domain: T.nilable(String),
           provider: T.nilable(String),
-          state: Hash,
+          state: T.nilable(String),
         ).returns(String)
       end
       def authorization_url(
-        project_id:, redirect_uri:, domain: nil, provider: nil, state: {}
+        project_id:, redirect_uri:, domain: nil, provider: nil, state: ''
       )
         validate_domain_and_provider(provider: provider, domain: domain)
 

data/lib/workos/types/profile_struct.rb

@@ -8,8 +8,8 @@ module WorkOS
     class ProfileStruct < T::Struct
       const :id, String
       const :email, String
-      const :first_name, String
-      const :last_name, String
+      const :first_name, T.nilable(String)
+      const :last_name, T.nilable(String)
       const :connection_type, String
       const :idp_id, String
     end

data/lib/workos/version.rb

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

data/spec/lib/workos/audit_trail_spec.rb

@@ -137,4 +137,16 @@ describe WorkOS::AuditTrail do
       end
     end
   end
+
+  describe '.get_events' do
+    context 'with no options' do
+      it 'returns events' do
+        VCR.use_cassette('audit_trail/get_events') do
+          events = described_class.get_events
+
+          expect(events.size).to eq(2)
+        end
+      end
+    end
+  end
 end

data/spec/lib/workos/directory_sync_spec.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+# typed: false
+
+describe WorkOS::DirectorySync do
+  before(:all) do
+    WorkOS.key = 'key'
+  end
+
+  after(:all) do
+    WorkOS.key = nil
+  end
+
+  describe '.list_directories' do
+    context 'with no options' do
+      it 'returns directories' do
+        VCR.use_cassette('directory_sync/list_directories') do
+          directories = WorkOS::DirectorySync.list_directories
+          expect(directories.size).to eq(1)
+        end
+      end
+    end
+
+    context 'with domain option' do
+      it 'returns directories' do
+        VCR.use_cassette('directory_sync/list_directories_with_domain_param') do
+          directories = WorkOS::DirectorySync.list_directories(
+            domain: 'foo-corp.com',
+          )
+
+          expect(directories.first['domain']).to eq('foo-corp.com')
+        end
+      end
+    end
+  end
+
+  describe '.list_groups' do
+    context 'with no options' do
+      it 'returns groups' do
+        VCR.use_cassette('directory_sync/list_groups') do
+          expect do
+            WorkOS::DirectorySync.list_groups
+          end.to raise_error(
+            WorkOS::InvalidRequestError,
+            /Status 422, Validation failed/,
+          )
+        end
+      end
+    end
+
+    context 'with directory option' do
+      it 'returns groups' do
+        VCR.use_cassette('directory_sync/list_groups_with_directory_param') do
+          groups = WorkOS::DirectorySync.list_groups(
+            directory: 'directory_edp_01E64QQVQTCB0DECJ9CFNXEWDW',
+          )
+
+          expect(groups.size).to eq(2)
+          expect(groups.first['name']).to eq('Walrus')
+        end
+      end
+    end
+  end
+
+  describe '.list_users' do
+    context 'with no options' do
+      it 'returns users' do
+        VCR.use_cassette('directory_sync/list_users') do
+          expect do
+            WorkOS::DirectorySync.list_users
+          end.to raise_error(
+            WorkOS::InvalidRequestError,
+            /Status 422, Validation failed/,
+          )
+        end
+      end
+    end
+
+    context 'with directory option' do
+      it 'returns users' do
+        VCR.use_cassette('directory_sync/list_users_with_directory_param') do
+          users = WorkOS::DirectorySync.list_users(
+            directory: 'directory_edp_01E64QQVQTCB0DECJ9CFNXEWDW',
+          )
+
+          expect(users.size).to eq(1)
+          expect(users.first['last_name']).to eq('Tran')
+        end
+      end
+    end
+  end
+
+  describe '.get_group' do
+    context 'with valid id' do
+      it 'returns a group' do
+        VCR.use_cassette('directory_sync/get_group') do
+          group = WorkOS::DirectorySync.get_group(
+            'directory_grp_01E64QTDNS0EGJ0FMCVY9BWGZT',
+          )
+
+          expect(group['name']).to eq('Walrus')
+        end
+      end
+    end
+
+    context 'with invalid id' do
+      it 'raises an error' do
+        VCR.use_cassette('directory_sync/get_group_with_invalid_id') do
+          expect do
+            WorkOS::DirectorySync.get_group('invalid')
+          end.to raise_error(WorkOS::APIError)
+        end
+      end
+    end
+  end
+
+  describe '.get_user' do
+    context 'with valid id' do
+      it 'returns a user' do
+        VCR.use_cassette('directory_sync/get_user') do
+          user = WorkOS::DirectorySync.get_user(
+            'directory_usr_01E64QS50EAY48S0XJ1AA4WX4D',
+          )
+
+          expect(user['first_name']).to eq('Mark')
+        end
+      end
+    end
+
+    context 'with invalid id' do
+      it 'raises an error' do
+        VCR.use_cassette('directory_sync/get_user_with_invalid_id') do
+          expect do
+            WorkOS::DirectorySync.get_user('invalid')
+          end.to raise_error(WorkOS::APIError)
+        end
+      end
+    end
+  end
+end

data/spec/lib/workos/sso_spec.rb

@@ -13,7 +13,7 @@ describe WorkOS::SSO do
           redirect_uri: 'foo.com/auth/callback',
           state: {
             next_page: '/dashboard/edit',
-          },
+          }.to_s,
         }
       end
       it 'returns a valid URL' do
@@ -47,7 +47,7 @@ describe WorkOS::SSO do
           redirect_uri: 'foo.com/auth/callback',
           state: {
             next_page: '/dashboard/edit',
-          },
+          }.to_s,
         }
       end
       it 'returns a valid URL' do
@@ -80,7 +80,7 @@ describe WorkOS::SSO do
           redirect_uri: 'foo.com/auth/callback',
           state: {
             next_page: '/dashboard/edit',
-          },
+          }.to_s,
         }
       end
       it 'raises an error' do
@@ -101,7 +101,7 @@ describe WorkOS::SSO do
           redirect_uri: 'foo.com/auth/callback',
           state: {
             next_page: '/dashboard/edit',
-          },
+          }.to_s,
         }
       end
       it 'raises an error' do

data/spec/support/fixtures/vcr_cassettes/audit_trail/get_events.yml

@@ -0,0 +1,61 @@
+---
+http_interactions:
+  - request:
+      method: get
+      uri: https://api.workos.com/events
+      body:
+        encoding: US-ASCII
+        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.4.0
+        Authorization:
+          - Bearer <API_KEY>
+    response:
+      status:
+        code: 200
+        message: OK
+      headers:
+        Vary:
+          - Origin, Accept-Encoding
+        Access-Control-Allow-Credentials:
+          - "true"
+        X-Dns-Prefetch-Control:
+          - "off"
+        X-Frame-Options:
+          - SAMEORIGIN
+        Strict-Transport-Security:
+          - max-age=15552000; includeSubDomains
+        X-Download-Options:
+          - noopen
+        X-Content-Type-Options:
+          - nosniff
+        X-Xss-Protection:
+          - 1; mode=block
+        X-Request-Id:
+          - ""
+        Content-Type:
+          - application/json; charset=utf-8
+        Etag:
+          - W/"1784-HtVN7X+AT30Dlt9nZrirP0nnyV8"
+        Date:
+          - Fri, 31 Jul 2020 14:41:12 GMT
+        Connection:
+          - keep-alive
+        Transfer-Encoding:
+          - chunked
+      body:
+        encoding: ASCII-8BIT
+        string:
+          '{"data":[{"object":"event","id":"evt_01EEJM9Q9SMC3W2SZDKA5VJ8XQ","group":"workos.com","location":"::1","latitude":null,"longitude":null,"type":"r","actor_name":"foo@example.com","actor_id":"user_01EEG9P7A1DA9VY9CX7GT47RPF","target_name":"api_key_query","target_id":"key_01EEG9MPHAYX46BBZKGK3BGQXJ","metadata":{"description":"User
+          viewed API key.","x_request_id":""},"occurred_at":"2020-07-31T14:27:00.384Z","action":{"object":"event_action","id":"evt_action_01EEGQXWAHB065P5JD0QDAAGDC","name":"user.viewed_api_key","project_id":"project_01DZB0E7HQMA6G85PQNHQJMZD0"}},{"object":"event","id":"evt_01EEJM9Q7GMR1VGT6VXN2N2JJQ","group":"workos.com","location":"::1","latitude":null,"longitude":null,"type":"r","actor_name":"foo@example.com","actor_id":"user_01EEG9P7A1DA9VY9CX7GT47RPF","target_name":"api_key_query","target_id":"key_01EEG9MPGM8KFT9VBQHJMV8YZB","metadata":{"description":"User
+          viewed API key.","x_request_id":""},"occurred_at":"2020-07-31T14:27:00.360Z","action":{"object":"event_action","id":"evt_action_01EEGQXWAHB065P5JD0QDAAGDC","name":"user.viewed_api_key","project_id":"project_01DZB0E7HQMA6G85PQNHQJMZD0"}}],"listMetadata":{"before":"evt_01EEJKZDAR6G4JHFQT4R3KSZDQ","after":null}}'
+      http_version:
+    recorded_at: Fri, 31 Jul 2020 14:41:12 GMT
+recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/directory_sync/get_group.yml

@@ -0,0 +1,62 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.workos.com/directory_groups/directory_grp_01E64QTDNS0EGJ0FMCVY9BWGZT
+    body:
+      encoding: US-ASCII
+      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.2.3
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Cowboy
+      Connection:
+      - keep-alive
+      Vary:
+      - Origin, Accept-Encoding
+      Access-Control-Allow-Credentials:
+      - 'true'
+      X-Dns-Prefetch-Control:
+      - 'off'
+      X-Frame-Options:
+      - SAMEORIGIN
+      Strict-Transport-Security:
+      - max-age=15552000; includeSubDomains
+      X-Download-Options:
+      - noopen
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Request-Id:
+      - 4fb94ab3-ecff-4cea-b0b7-d4d1b3ffad3a
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '65'
+      Etag:
+      - W/"41-QrnAKhorJuUwAsR1OyMpfB8q1Kc"
+      Date:
+      - Thu, 30 Apr 2020 04:47:49 GMT
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: UTF-8
+      string: '{"id":"directory_grp_01E64QTDNS0EGJ0FMCVY9BWGZT","name":"Walrus"}'
+    http_version:
+  recorded_at: Thu, 30 Apr 2020 04:47:49 GMT
+recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/directory_sync/get_group_with_invalid_id.yml

@@ -0,0 +1,62 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.workos.com/directory_groups/invalid
+    body:
+      encoding: US-ASCII
+      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.2.3
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Server:
+      - Cowboy
+      Connection:
+      - keep-alive
+      Vary:
+      - Origin, Accept-Encoding
+      Access-Control-Allow-Credentials:
+      - 'true'
+      X-Dns-Prefetch-Control:
+      - 'off'
+      X-Frame-Options:
+      - SAMEORIGIN
+      Strict-Transport-Security:
+      - max-age=15552000; includeSubDomains
+      X-Download-Options:
+      - noopen
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Request-Id:
+      - bbf92391-32bd-4d77-bbdc-0e77983d04d4
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '23'
+      Etag:
+      - W/"17-SuRA/yvUWUo8rK6x7dKURLeBo+0"
+      Date:
+      - Thu, 30 Apr 2020 04:48:28 GMT
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: UTF-8
+      string: '{"message":"Not Found"}'
+    http_version:
+  recorded_at: Thu, 30 Apr 2020 04:48:28 GMT
+recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/directory_sync/get_user.yml

@@ -0,0 +1,62 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.workos.com/directory_users/directory_usr_01E64QS50EAY48S0XJ1AA4WX4D
+    body:
+      encoding: US-ASCII
+      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.2.3
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Cowboy
+      Connection:
+      - keep-alive
+      Vary:
+      - Origin, Accept-Encoding
+      Access-Control-Allow-Credentials:
+      - 'true'
+      X-Dns-Prefetch-Control:
+      - 'off'
+      X-Frame-Options:
+      - SAMEORIGIN
+      Strict-Transport-Security:
+      - max-age=15552000; includeSubDomains
+      X-Download-Options:
+      - noopen
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Request-Id:
+      - fe3f582a-b944-4f2c-a225-ae3a7f099fa0
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '368'
+      Etag:
+      - W/"170-JjGTDHa7GqXeAwXcua+s3+2z/oA"
+      Date:
+      - Thu, 30 Apr 2020 04:43:14 GMT
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: UTF-8
+      string: '{"id":"directory_usr_01E64QS50EAY48S0XJ1AA4WX4D","raw_attributes":{"name":{"givenName":"Mark","familyName":"Tran"},"emails":[{"value":"mark@foo-corp.com","primary":true}],"userName":"mark@foo-corp.com","externalId":"118325297729072421906"},"first_name":"Mark","emails":[{"value":"mark@foo-corp.com","primary":true}],"username":"mark@foo-corp.com","last_name":"Tran"}'
+    http_version:
+  recorded_at: Thu, 30 Apr 2020 04:43:15 GMT
+recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/directory_sync/get_user_with_invalid_id.yml

@@ -0,0 +1,62 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.workos.com/directory_users/invalid
+    body:
+      encoding: US-ASCII
+      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.2.3
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Server:
+      - Cowboy
+      Connection:
+      - keep-alive
+      Vary:
+      - Origin, Accept-Encoding
+      Access-Control-Allow-Credentials:
+      - 'true'
+      X-Dns-Prefetch-Control:
+      - 'off'
+      X-Frame-Options:
+      - SAMEORIGIN
+      Strict-Transport-Security:
+      - max-age=15552000; includeSubDomains
+      X-Download-Options:
+      - noopen
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Request-Id:
+      - 19dfa905-2015-44fb-8d5f-46f2d6c49826
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '23'
+      Etag:
+      - W/"17-SuRA/yvUWUo8rK6x7dKURLeBo+0"
+      Date:
+      - Thu, 30 Apr 2020 04:45:35 GMT
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: UTF-8
+      string: '{"message":"Not Found"}'
+    http_version:
+  recorded_at: Thu, 30 Apr 2020 04:45:35 GMT
+recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/directory_sync/list_directories.yml

@@ -0,0 +1,62 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.workos.com/directories
+    body:
+      encoding: US-ASCII
+      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.2.3
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Cowboy
+      Connection:
+      - keep-alive
+      Vary:
+      - Origin, Accept-Encoding
+      Access-Control-Allow-Credentials:
+      - 'true'
+      X-Dns-Prefetch-Control:
+      - 'off'
+      X-Frame-Options:
+      - SAMEORIGIN
+      Strict-Transport-Security:
+      - max-age=15552000; includeSubDomains
+      X-Download-Options:
+      - noopen
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Request-Id:
+      - 53c53a76-1f3f-43bb-85a3-8faef43db375
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - W/"b53-vfsK4+PwHsj4f+pAs0MzdO3odVo"
+      Date:
+      - Thu, 30 Apr 2020 03:11:45 GMT
+      Transfer-Encoding:
+      - chunked
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: ASCII-8BIT
+      string: '{"object":"list","listMetadata":{"before":"directory_edp_01E44H95QPBGZ6A4D89VYZ0WX1","after":null},"data":[{"object":"directory","id":"directory_edp_01E64QQVQTCB0DECJ9CFNXEWDW","external_key":"lA3gS1kCZMCkk82E","state":"linked","type":"gsuite directory","name":"Foo Corp","bearer_token":null,"project_id":"project_01DFYCG8RCB1DB6DKFTGXF4Q9F","domain":"foo-corp.com"}]}'
+    http_version:
+  recorded_at: Thu, 30 Apr 2020 03:11:45 GMT
+recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/directory_sync/list_directories_with_domain_param.yml

@@ -0,0 +1,63 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.workos.com/directories?domain=foo-corp.com
+    body:
+      encoding: US-ASCII
+      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.2.3
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Cowboy
+      Connection:
+      - keep-alive
+      Vary:
+      - Origin, Accept-Encoding
+      Access-Control-Allow-Credentials:
+      - 'true'
+      X-Dns-Prefetch-Control:
+      - 'off'
+      X-Frame-Options:
+      - SAMEORIGIN
+      Strict-Transport-Security:
+      - max-age=15552000; includeSubDomains
+      X-Download-Options:
+      - noopen
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Request-Id:
+      - '08feb93b-22e8-4955-b17d-0e5efa1ed6a4'
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '330'
+      Etag:
+      - W/"14a-Q+U+kuKWjl8FQwSosUsvUraY82A"
+      Date:
+      - Thu, 30 Apr 2020 03:42:20 GMT
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: UTF-8
+      string: '{"object":"list","listMetadata":{"before":null,"after":null},"data":[{"object":"directory","id":"directory_edp_01E64QQVQTCB0DECJ9CFNXEWDW","external_key":"lA3gS1kCZMCkk82E","state":"linked","type":"gsuite
+        directory","name":"Foo Corp","bearer_token":null,"project_id":"project_01DFYCG8RCB1DB6DKFTGXF4Q9F","domain":"foo-corp.com"}]}'
+    http_version:
+  recorded_at: Thu, 30 Apr 2020 03:42:20 GMT
+recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/directory_sync/list_groups.yml

@@ -0,0 +1,64 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.workos.com/directory_groups
+    body:
+      encoding: US-ASCII
+      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.2.3
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 422
+      message: Unprocessable Entity
+    headers:
+      Server:
+      - Cowboy
+      Connection:
+      - keep-alive
+      Vary:
+      - Origin, Accept-Encoding
+      Access-Control-Allow-Credentials:
+      - 'true'
+      X-Dns-Prefetch-Control:
+      - 'off'
+      X-Frame-Options:
+      - SAMEORIGIN
+      Strict-Transport-Security:
+      - max-age=15552000; includeSubDomains
+      X-Download-Options:
+      - noopen
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Request-Id:
+      - 3ffb5dc0-7dbe-453f-9514-6e50363b413e
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '219'
+      Etag:
+      - W/"db-gphk1TAe8P3eXtQnl1v8qxKQjZs"
+      Date:
+      - Thu, 30 Apr 2020 06:24:08 GMT
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: UTF-8
+      string: '{"message":"Validation failed","errors":[{"field":"directory","code":"Please
+        provide either \"directory\" or \"user\" parameters."},{"field":"user","code":"Please
+        provide either \"directory\" or \"user\" parameters."}]}'
+    http_version: 
+  recorded_at: Thu, 30 Apr 2020 06:24:08 GMT
+recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/directory_sync/list_groups_with_directory_param.yml

@@ -0,0 +1,62 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.workos.com/directory_groups?directory=directory_edp_01E64QQVQTCB0DECJ9CFNXEWDW
+    body:
+      encoding: US-ASCII
+      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.2.3
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Cowboy
+      Connection:
+      - keep-alive
+      Vary:
+      - Origin, Accept-Encoding
+      Access-Control-Allow-Credentials:
+      - 'true'
+      X-Dns-Prefetch-Control:
+      - 'off'
+      X-Frame-Options:
+      - SAMEORIGIN
+      Strict-Transport-Security:
+      - max-age=15552000; includeSubDomains
+      X-Download-Options:
+      - noopen
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Request-Id:
+      - 87133408-9847-42ef-a6da-183280e6402c
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '813'
+      Etag:
+      - W/"32d-Pi2S8kCjmY/SVPoMmwh0JNvHbgY"
+      Date:
+      - Thu, 30 Apr 2020 04:31:47 GMT
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: UTF-8
+      string: '{"object":"list","listMetadata":{"before":"directory_grp_01E64QTDHHE80V9N03ZTDV5SXD","after":null},"data":[{"id":"directory_grp_01E64QTDNS0EGJ0FMCVY9BWGZT","name":"Walrus"},{"id":"directory_grp_01E64QTDJTE8P0S3JKM7KV848A","name":"Design team"}]}'
+    http_version:
+  recorded_at: Thu, 30 Apr 2020 04:31:47 GMT
+recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/directory_sync/list_users.yml

@@ -0,0 +1,64 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.workos.com/directory_users
+    body:
+      encoding: US-ASCII
+      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.2.3
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 422
+      message: Unprocessable Entity
+    headers:
+      Server:
+      - Cowboy
+      Connection:
+      - keep-alive
+      Vary:
+      - Origin, Accept-Encoding
+      Access-Control-Allow-Credentials:
+      - 'true'
+      X-Dns-Prefetch-Control:
+      - 'off'
+      X-Frame-Options:
+      - SAMEORIGIN
+      Strict-Transport-Security:
+      - max-age=15552000; includeSubDomains
+      X-Download-Options:
+      - noopen
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Request-Id:
+      - 67a36a16-8d82-495d-a4cd-11a42e6c111e
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '222'
+      Etag:
+      - W/"de-33B+CY27z2HlOGKZPu4nzUVQpuI"
+      Date:
+      - Thu, 30 Apr 2020 06:23:44 GMT
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: UTF-8
+      string: '{"message":"Validation failed","errors":[{"field":"directory","code":"Please
+        provide either \"directory\" or \"group\" parameters."},{"field":"group","code":"Please
+        provide either \"directory\" or \"group\" parameters."}]}'
+    http_version: 
+  recorded_at: Thu, 30 Apr 2020 06:23:44 GMT
+recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/directory_sync/list_users_with_directory_param.yml

@@ -0,0 +1,62 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.workos.com/directory_users?directory=directory_edp_01E64QQVQTCB0DECJ9CFNXEWDW
+    body:
+      encoding: US-ASCII
+      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.2.3
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Cowboy
+      Connection:
+      - keep-alive
+      Vary:
+      - Origin, Accept-Encoding
+      Access-Control-Allow-Credentials:
+      - 'true'
+      X-Dns-Prefetch-Control:
+      - 'off'
+      X-Frame-Options:
+      - SAMEORIGIN
+      Strict-Transport-Security:
+      - max-age=15552000; includeSubDomains
+      X-Download-Options:
+      - noopen
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Request-Id:
+      - 91802a43-3053-41e6-9a71-44fe88321224
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - W/"e55-P0NG6CugY3cr6/bL+B4xBkwDGns"
+      Date:
+      - Thu, 30 Apr 2020 04:36:02 GMT
+      Transfer-Encoding:
+      - chunked
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: ASCII-8BIT
+      string: '{"object":"list","listMetadata":{"before":null,"after":null},"data":[{"id":"directory_usr_01E64QS50EAY48S0XJ1AA4WX4D","raw_attributes":{"name":{"givenName":"Mark","familyName":"Tran"},"emails":[{"value":"mark@foo-corp.com","primary":true}],"userName":"mark@foo-corp.com","externalId":"118325297729072421906"},"first_name":"Mark","emails":[{"value":"mark@foo-corp.com","primary":true}],"username":"mark@foo-corp.com","last_name":"Tran"}]}'
+    http_version:
+  recorded_at: Thu, 30 Apr 2020 04:36:02 GMT
+recorded_with: VCR 5.0.0

data/workos.gemspec

@@ -5,18 +5,21 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'workos/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'workos'
-  spec.version       = WorkOS::VERSION
-  spec.authors       = ['WorkOS']
-  spec.email         = ['support@workos.com']
-  spec.description   = 'API client for WorkOS'
-  spec.summary       = 'API client for WorkOS'
-  spec.homepage      = 'https://github.com/workos/workos-ruby'
-  spec.license       = 'MIT'
+  spec.name = 'workos'
+  spec.version = WorkOS::VERSION
+  spec.authors = ['WorkOS']
+  spec.email = ['support@workos.com']
+  spec.description = 'API client for WorkOS'
+  spec.summary = 'API client for WorkOS'
+  spec.homepage = 'https://github.com/workos-inc/workos-ruby'
+  spec.license = 'MIT'
+  spec.metadata = {
+    'documentation_uri' => 'https://docs.workos.com/sdk/ruby',
+  }
 
-  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
   spec.add_dependency 'sorbet-runtime', '~> 0.5'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workos
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.4.0
 platform: ruby
 authors:
 - WorkOS
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-24 00:00:00.000000000 Z
+date: 2020-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -211,6 +211,7 @@ files:
 - lib/workos/base.rb
 - lib/workos/client.rb
 - lib/workos/connection.rb
+- lib/workos/directory_sync.rb
 - lib/workos/errors.rb
 - lib/workos/profile.rb
 - lib/workos/sso.rb
@@ -230,6 +231,7 @@ files:
 - sorbet/rbi/todo.rbi
 - spec/lib/workos/audit_trail_spec.rb
 - spec/lib/workos/base_spec.rb
+- spec/lib/workos/directory_sync_spec.rb
 - spec/lib/workos/sso_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixtures/vcr_cassettes/audit_trail/create_event.yml
@@ -237,15 +239,27 @@ files:
 - spec/support/fixtures/vcr_cassettes/audit_trail/create_event_invalid.yml
 - spec/support/fixtures/vcr_cassettes/audit_trail/create_events_duplicate_idempotency_key_and_payload.yml
 - spec/support/fixtures/vcr_cassettes/audit_trail/create_events_duplicate_idempotency_key_different_payload.yml
+- spec/support/fixtures/vcr_cassettes/audit_trail/get_events.yml
 - spec/support/fixtures/vcr_cassettes/base/execute_request_unauthenticated.yml
+- spec/support/fixtures/vcr_cassettes/directory_sync/get_group.yml
+- spec/support/fixtures/vcr_cassettes/directory_sync/get_group_with_invalid_id.yml
+- spec/support/fixtures/vcr_cassettes/directory_sync/get_user.yml
+- spec/support/fixtures/vcr_cassettes/directory_sync/get_user_with_invalid_id.yml
+- spec/support/fixtures/vcr_cassettes/directory_sync/list_directories.yml
+- spec/support/fixtures/vcr_cassettes/directory_sync/list_directories_with_domain_param.yml
+- spec/support/fixtures/vcr_cassettes/directory_sync/list_groups.yml
+- spec/support/fixtures/vcr_cassettes/directory_sync/list_groups_with_directory_param.yml
+- spec/support/fixtures/vcr_cassettes/directory_sync/list_users.yml
+- spec/support/fixtures/vcr_cassettes/directory_sync/list_users_with_directory_param.yml
 - spec/support/fixtures/vcr_cassettes/sso/create_connection_with_invalid_source.yml
 - spec/support/fixtures/vcr_cassettes/sso/create_connection_with_valid_source.yml
 - spec/support/profile.txt
 - workos.gemspec
-homepage: https://github.com/workos/workos-ruby
+homepage: https://github.com/workos-inc/workos-ruby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  documentation_uri: https://docs.workos.com/sdk/ruby
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -261,13 +275,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: API client for WorkOS
 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/sso_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixtures/vcr_cassettes/audit_trail/create_event.yml
@@ -275,7 +290,18 @@ test_files:
 - spec/support/fixtures/vcr_cassettes/audit_trail/create_event_invalid.yml
 - spec/support/fixtures/vcr_cassettes/audit_trail/create_events_duplicate_idempotency_key_and_payload.yml
 - spec/support/fixtures/vcr_cassettes/audit_trail/create_events_duplicate_idempotency_key_different_payload.yml
+- spec/support/fixtures/vcr_cassettes/audit_trail/get_events.yml
 - spec/support/fixtures/vcr_cassettes/base/execute_request_unauthenticated.yml
+- spec/support/fixtures/vcr_cassettes/directory_sync/get_group.yml
+- spec/support/fixtures/vcr_cassettes/directory_sync/get_group_with_invalid_id.yml
+- spec/support/fixtures/vcr_cassettes/directory_sync/get_user.yml
+- spec/support/fixtures/vcr_cassettes/directory_sync/get_user_with_invalid_id.yml
+- spec/support/fixtures/vcr_cassettes/directory_sync/list_directories.yml
+- spec/support/fixtures/vcr_cassettes/directory_sync/list_directories_with_domain_param.yml
+- spec/support/fixtures/vcr_cassettes/directory_sync/list_groups.yml
+- spec/support/fixtures/vcr_cassettes/directory_sync/list_groups_with_directory_param.yml
+- spec/support/fixtures/vcr_cassettes/directory_sync/list_users.yml
+- spec/support/fixtures/vcr_cassettes/directory_sync/list_users_with_directory_param.yml
 - spec/support/fixtures/vcr_cassettes/sso/create_connection_with_invalid_source.yml
 - spec/support/fixtures/vcr_cassettes/sso/create_connection_with_valid_source.yml
 - spec/support/profile.txt