workos 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d48c12ff6a0a470ca2a35fb76cabf17fe9d4f2444b11811891a9ea0c81f9cda
-  data.tar.gz: ec43b59ca57135efd145346ce14ebab1ed30341f210b3a47f8525afb907d3856
+  metadata.gz: c1e38af4531cb784be6a6cc834752307e8bfcf7379dde43272c0e85b762f9f56
+  data.tar.gz: 2de643c621a51264c255d7d8b0a55d1aa7a900f5a1b9bd49877e6f5ad9f47956
 SHA512:
-  metadata.gz: 2068f4bd90b52d90b802eea6f1e8ebeb2a5e1b166d5256d952df40af30821bd858999813532f18e9ab44eff36f4cde40a27f423126028509fe9c12f15ef07d58
-  data.tar.gz: 526f33fd44a2371696dc19f400461af7e170e362d7057bf04529767eae8692d12b8e56635f6b61d5b0e8c585f2275e65e62422f064bbe056645c2c0cc1cfe14f
+  metadata.gz: '095f641cd40934575456a19cdf4dc5714d010555680d18b98f599467bafaf57b78f6f90988d064f53611f6d95bb7daa6e1ebdea450a7e7a03f43637026856a7b'
+  data.tar.gz: 157928a66025475cc4b306fbcc719ea6e3fe6404006f3fb00eb6498d7d4655d18076cbe64874137ba8c301a22561752c5feb40d9158225a89797e5eff36c1503

data/Gemfile.lock

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

data/lib/workos/organizations.rb

@@ -62,7 +62,7 @@ module WorkOS
       #            :id=>"org_domain_01E6PK9N3XMD8RHWF7S66380AR",
       #            :domain=>"foo-corp.com"}]>
       #
-      # @return [WorkOS::Connection]
+      # @return [WorkOS::Organization]
       sig { params(id: String).returns(WorkOS::Organization) }
       def get_organization(id:)
         request = get_request(
@@ -125,6 +125,27 @@ module WorkOS
         WorkOS::Organization.new(response.body)
       end
 
+      # Delete an Organization
+      #
+      # @param [String] id Organization unique identifier
+      #
+      # @example
+      #   WorkOS::SSO.delete_organization(id: 'org_01EHZNVPK3SFK441A1RGBFSHRT')
+      #   => true
+      #
+      # @return [Bool] - returns `true` if successful
+      sig { params(id: String).returns(T::Boolean) }
+      def delete_organization(id:)
+        request = delete_request(
+          auth: true,
+          path: "/organizations/#{id}",
+        )
+
+        response = execute_request(request: request)
+
+        response.is_a? Net::HTTPSuccess
+      end
+
       private
 
       sig { params(response: Net::HTTPResponse).void }

data/lib/workos/version.rb

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

data/spec/lib/workos/organizations_spec.rb

@@ -161,4 +161,31 @@ describe WorkOS::Organizations do
       end
     end
   end
+
+  describe '.delete_organization' do
+    context 'with a valid id' do
+      it 'returns true' do
+        VCR.use_cassette('organization/delete') do
+          response = described_class.delete_organization(
+            id: 'org_01F4A8TD0B4N1Y9SJ8SH635HDB',
+          )
+
+          expect(response).to be(true)
+        end
+      end
+    end
+
+    context 'with an invalid id' do
+      it 'returns false' do
+        VCR.use_cassette('organization/delete_invalid') do
+          expect do
+            described_class.delete_organization(id: 'invalid')
+          end.to raise_error(
+            WorkOS::APIError,
+            'Status 404, Not Found - request ID: ',
+          )
+        end
+      end
+    end
+  end
 end

data/spec/support/fixtures/vcr_cassettes/organization/delete.yml

@@ -0,0 +1,72 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://api.workos.com/organizations/org_01F4A8TD0B4N1Y9SJ8SH635HDB
+    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.1; x86_64-darwin19; v1.1.0
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 202
+      message: Accepted
+    headers:
+      Server:
+      - Cowboy
+      Connection:
+      - keep-alive
+      Vary:
+      - Origin, Accept-Encoding
+      Access-Control-Allow-Credentials:
+      - 'true'
+      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'
+      X-Request-Id:
+      - 
+      Content-Type:
+      - text/plain; charset=utf-8
+      Content-Length:
+      - '8'
+      Etag:
+      - W/"8-YaBXLEiT7zQxEyDYTILfiL6oPhE"
+      Date:
+      - Mon, 24 May 2021 21:07:34 GMT
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: UTF-8
+      string: Accepted
+    http_version:
+  recorded_at: Mon, 24 May 2021 21:07:34 GMT
+recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/organization/delete_invalid.yml

@@ -0,0 +1,72 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://api.workos.com/organizations/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.1; x86_64-darwin19; v1.1.0
+      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'
+      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'
+      X-Request-Id:
+      - 
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '23'
+      Etag:
+      - W/"17-SuRA/yvUWUo8rK6x7dKURLeBo+0"
+      Date:
+      - Mon, 24 May 2021 21:07:34 GMT
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: UTF-8
+      string: '{"message":"Not Found"}'
+    http_version:
+  recorded_at: Mon, 24 May 2021 21:07:34 GMT
+recorded_with: VCR 5.0.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workos
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - WorkOS
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-24 00:00:00.000000000 Z
+date: 2021-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -309,6 +309,8 @@ files:
 - spec/support/fixtures/vcr_cassettes/directory_sync/list_users/with_no_options.yml
 - spec/support/fixtures/vcr_cassettes/organization/create.yml
 - spec/support/fixtures/vcr_cassettes/organization/create_invalid.yml
+- spec/support/fixtures/vcr_cassettes/organization/delete.yml
+- spec/support/fixtures/vcr_cassettes/organization/delete_invalid.yml
 - spec/support/fixtures/vcr_cassettes/organization/get.yml
 - spec/support/fixtures/vcr_cassettes/organization/get_invalid.yml
 - spec/support/fixtures/vcr_cassettes/organization/list.yml
@@ -400,6 +402,8 @@ test_files:
 - spec/support/fixtures/vcr_cassettes/directory_sync/list_users/with_no_options.yml
 - spec/support/fixtures/vcr_cassettes/organization/create.yml
 - spec/support/fixtures/vcr_cassettes/organization/create_invalid.yml
+- spec/support/fixtures/vcr_cassettes/organization/delete.yml
+- spec/support/fixtures/vcr_cassettes/organization/delete_invalid.yml
 - spec/support/fixtures/vcr_cassettes/organization/get.yml
 - spec/support/fixtures/vcr_cassettes/organization/get_invalid.yml
 - spec/support/fixtures/vcr_cassettes/organization/list.yml