RubyGems - workos - Versions diffs - 1.6.1 → 2.0.0 - Mend

workos 1.6.1 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (14) hide show

checksums.yaml +4 -4
data/Gemfile.lock +1 -1
data/lib/workos/connection.rb +1 -1
data/lib/workos/directory.rb +1 -1
data/lib/workos/directory_sync.rb +29 -0
data/lib/workos/profile.rb +1 -1
data/lib/workos/types/connection_struct.rb +1 -1
data/lib/workos/types/directory_struct.rb +1 -1
data/lib/workos/types/profile_struct.rb +1 -1
data/lib/workos/version.rb +1 -1
data/spec/lib/workos/directory_sync_spec.rb +32 -0
data/spec/support/fixtures/vcr_cassettes/directory_sync/get_directory_with_invalid_id.yml +83 -0
data/spec/support/fixtures/vcr_cassettes/directory_sync/get_directory_with_valid_id.yml +84 -0
metadata +7 -3

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18ce86de81ae6d0135098cff2358718a85e32216b668fa8812561518765d08c3
-  data.tar.gz: 8536d98714bbd426436f2b6ac0a24164da2837e6d4ec1f9162d4bcbb167fd344
+  metadata.gz: 739e4734f5caa4b4c8180e125a206106242fea489c1dccc19f1bc45ad514bc7e
+  data.tar.gz: '029c0a8ef19f9b9b933a73eec53a9770851ea2a338a81060c040b72a06e39189'
 SHA512:
-  metadata.gz: f4befc50b81553c325994aca87349d8c4badc3af319cd1924967542352dd5b9e0c36ad8375fa71f1605979dd9415e720d03bf55a9fe74bbba35d7fa2127d34ad
-  data.tar.gz: 25f9bf26defd800826522200a2328f1ce1c1e1ae169cad9c3a297a4f45d0f120a9fd25d0d60d1ff5050c56408b7ef25619827a6083307f17203f66a0ce72c72e
+  metadata.gz: 18631e0e0cdc5033b7df32d3ff95e2eeadcd7babd6c3b11063e174006ed3e8abd7769bfe4b0c828967e79b724ce0d8a79243960b5f2922eeb242051b56395b41
+  data.tar.gz: 2a2b2d48b1410ad0fc86943a168d584234fd5c01ca5ee3e3b4b3117f9924ddc4199d55d10d338b1f07daa193edc0144312ec6271a68c65b89ec8fa2243064aa0

data/Gemfile.lock CHANGED Viewed

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

data/lib/workos/connection.rb CHANGED Viewed

@@ -21,7 +21,7 @@ module WorkOS
       @name = T.let(raw.name, String)
       @connection_type = T.let(raw.connection_type, String)
       @domains = T.let(raw.domains, Array)
-      @organization_id = T.let(raw.organization_id, String)
+      @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)

data/lib/workos/directory.rb CHANGED Viewed

@@ -20,7 +20,7 @@ module WorkOS
       @domain = raw.domain
       @type = T.let(raw.type, String)
       @state = T.let(raw.state, String)
-      @organization_id = T.let(raw.organization_id, String)
+      @organization_id = raw.organization_id
       @created_at = T.let(raw.created_at, String)
       @updated_at = T.let(raw.updated_at, String)
     end

data/lib/workos/directory_sync.rb CHANGED Viewed

@@ -53,6 +53,35 @@ module WorkOS
         )
       end
+      # Retrieve directory.
+      #
+      # @param [String] id Directory unique identifier
+      #
+      # @example
+      #   WorkOS::SSO.get_directory(id: 'directory_01FK17DWRHH7APAFXT5B52PV0W')
+      #   => #<WorkOS::Directory:0x00007fb6e4193d20
+      #         @id="directory_01FK17DWRHH7APAFXT5B52PV0W",
+      #         @name="Foo Corp",
+      #         @domain="foo-corp.com",
+      #         @type="okta scim v2.0",
+      #         @state="linked",
+      #         @organization_id="org_01F6Q6TFP7RD2PF6J03ANNWDKV",
+      #         @created_at="2021-10-27T15:55:47.856Z",
+      #         @updated_at="2021-10-27T16:03:43.990Z"
+      #
+      # @return [WorkOS::Directory]
+      sig { params(id: String).returns(WorkOS::Directory) }
+      def get_directory(id:)
+        request = get_request(
+          auth: true,
+          path: "/directories/#{id}",
+        )
+        response = execute_request(request: request)
+        WorkOS::Directory.new(response.body)
+      end
       # Retrieve directory groups.
       #
       # @param [Hash] options An options hash

data/lib/workos/profile.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module WorkOS
       @email = T.let(raw.email, String)
       @first_name = raw.first_name
       @last_name = raw.last_name
-      @organization_id = T.let(raw.organization_id, String)
+      @organization_id = raw.organization_id
       @connection_id = T.let(raw.connection_id, String)
       @connection_type = T.let(raw.connection_type, String)
       @idp_id = raw.idp_id

data/lib/workos/types/connection_struct.rb CHANGED Viewed

@@ -10,7 +10,7 @@ module WorkOS
       const :name, String
       const :connection_type, String
       const :domains, T::Array[T.untyped]
-      const :organization_id, String
+      const :organization_id, T.nilable(String)
       const :state, String
       const :status, String
       const :created_at, String

data/lib/workos/types/directory_struct.rb CHANGED Viewed

@@ -11,7 +11,7 @@ module WorkOS
       const :domain, T.nilable(String)
       const :type, String
       const :state, String
-      const :organization_id, String
+      const :organization_id, T.nilable(String)
       const :created_at, String
       const :updated_at, String
     end

data/lib/workos/types/profile_struct.rb CHANGED Viewed

@@ -10,7 +10,7 @@ module WorkOS
       const :email, String
       const :first_name, T.nilable(String)
       const :last_name, T.nilable(String)
-      const :organization_id, String
+      const :organization_id, T.nilable(String)
       const :connection_id, String
       const :connection_type, String
       const :idp_id, T.nilable(String)

data/lib/workos/version.rb CHANGED Viewed

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

data/spec/lib/workos/directory_sync_spec.rb CHANGED Viewed

@@ -143,6 +143,38 @@ describe WorkOS::DirectorySync do
     end
   end
+  describe '.get_directory' do
+    context 'with a valid id' do
+      it 'gets the directory details' do
+        VCR.use_cassette('directory_sync/get_directory_with_valid_id') do
+          directory = WorkOS::DirectorySync.get_directory(
+            id: 'directory_01FK17DWRHH7APAFXT5B52PV0W',
+          )
+          expect(directory.id).to eq('directory_01FK17DWRHH7APAFXT5B52PV0W')
+          expect(directory.name).to eq('Testing Active Attribute')
+          expect(directory.domain).to eq('example.me')
+          expect(directory.type).to eq('azure scim v2.0')
+          expect(directory.state).to eq('linked')
+          expect(directory.organization_id).to eq('org_01F6Q6TFP7RD2PF6J03ANNWDKV')
+        end
+      end
+    end
+    context 'with an invalid id' do
+      it 'raises an error' do
+        VCR.use_cassette('directory_sync/get_directory_with_invalid_id') do
+          expect do
+            WorkOS::DirectorySync.get_directory(id: 'invalid')
+          end.to raise_error(
+            WorkOS::APIError,
+            "Status 404, Directory not found: 'invalid'. - request ID: ",
+          )
+        end
+      end
+    end
+  end
   describe '.list_groups' do
     context 'with no options' do
       it 'raises an error' do

data/spec/support/fixtures/vcr_cassettes/directory_sync/get_directory_with_invalid_id.yml ADDED Viewed

@@ -0,0 +1,83 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.workos.com/directories/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/3.0.2; x86_64-darwin19; v1.6.1
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Date:
+      - Sun, 07 Nov 2021 19:18:31 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      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'
+      Vary:
+      - Origin, Accept-Encoding
+      Access-Control-Allow-Credentials:
+      - 'true'
+      X-Request-Id:
+      -
+      Etag:
+      - W/"5d-Sx4XoCfDLxkGIc0yAjSbi2ILYww"
+      Via:
+      - 1.1 vegur
+      Cf-Cache-Status:
+      - DYNAMIC
+      Report-To:
+      - '{"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=9UGS4Swz%2BHWvLOf0MGTCQbJyS0uBKnB72E77LfjybUN%2FXbJaDPBYfHnAUcgVM7JZbTefNquu4bG0Fw0edgQVoGnTK9OWPuO6fVKmo8XkF1G%2FNgibe8B715ZZje%2FZM7m3%2B9bEbNout5ArQfFyyQ%3D%3D"}],"group":"cf-nel","max_age":604800}'
+      Nel:
+      - '{"success_fraction":0,"report_to":"cf-nel","max_age":604800}'
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 6aa8e86f7b5a66bf-DFW
+      Alt-Svc:
+      - h3=":443"; ma=86400, h3-29=":443"; ma=86400, h3-28=":443"; ma=86400, h3-27=":443";
+        ma=86400
+    body:
+      encoding: ASCII-8BIT
+      string: '{"message":"Directory not found: ''invalid''.","code":"entity_not_found","entity_id":"invalid"}'
+    http_version:
+  recorded_at: Sun, 07 Nov 2021 19:18:31 GMT
+recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/directory_sync/get_directory_with_valid_id.yml ADDED Viewed

@@ -0,0 +1,84 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.workos.com/directories/directory_01FK17DWRHH7APAFXT5B52PV0W
+    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/3.0.2; x86_64-darwin19; v1.6.1
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sun, 07 Nov 2021 19:18:31 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      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'
+      Vary:
+      - Origin, Accept-Encoding
+      Access-Control-Allow-Credentials:
+      - 'true'
+      X-Request-Id:
+      - c63229f4-faa3-4693-a769-f132af1d156e
+      Etag:
+      - W/"149-gnrinkKr5pyIOSLENIObBLph9N0"
+      Via:
+      - 1.1 vegur
+      Cf-Cache-Status:
+      - DYNAMIC
+      Report-To:
+      - '{"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=8pe6lAa%2BE5FfpwjmgW1wU%2Fn%2BqfVS0xUHV0FKT%2Fvt%2FpQCa1A4nNwqR1hMyE9ytoi%2F3InXs3rP9ELYw%2FpJZ1Ow0uaNd3xoll7al5maCCPI1JWivjr%2Bxx6G1Otiw5iTIaAh3MXoP0pjUAnZVsf4bw%3D%3D"}],"group":"cf-nel","max_age":604800}'
+      Nel:
+      - '{"success_fraction":0,"report_to":"cf-nel","max_age":604800}'
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 6aa8e86daa570b76-DFW
+      Alt-Svc:
+      - h3=":443"; ma=86400, h3-29=":443"; ma=86400, h3-28=":443"; ma=86400, h3-27=":443";
+        ma=86400
+    body:
+      encoding: ASCII-8BIT
+      string: '{"object":"directory","id":"directory_01FK17DWRHH7APAFXT5B52PV0W","organization_id":"org_01F6Q6TFP7RD2PF6J03ANNWDKV","name":"Testing
+        Active Attribute","external_key":"QArgyQQkq4G0MquM","type":"azure scim v2.0","state":"linked","created_at":"2021-10-27T15:55:47.856Z","updated_at":"2021-10-27T16:03:43.990Z","domain":"example.me"}'
+    http_version:
+  recorded_at: Sun, 07 Nov 2021 19:18:31 GMT
+recorded_with: VCR 5.0.0

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workos
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 2.0.0
 platform: ruby
 authors:
 - WorkOS
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-03 00:00:00.000000000 Z
+date: 2021-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -289,6 +289,8 @@ files:
 - 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/delete_directory.yml
+- spec/support/fixtures/vcr_cassettes/directory_sync/get_directory_with_invalid_id.yml
+- spec/support/fixtures/vcr_cassettes/directory_sync/get_directory_with_valid_id.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
@@ -362,7 +364,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.30
+rubygems_version: 3.2.31
 signing_key:
 specification_version: 4
 summary: API client for WorkOS
@@ -384,6 +386,8 @@ test_files:
 - 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/delete_directory.yml
+- spec/support/fixtures/vcr_cassettes/directory_sync/get_directory_with_invalid_id.yml
+- spec/support/fixtures/vcr_cassettes/directory_sync/get_directory_with_valid_id.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