workos 0.11.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64322be12c1dad447bc34d760225e99c47dc6611119ea74dd9a638bac6f23085
-  data.tar.gz: 99df76eeb89edac09cc58323049efeaad694bf3bd945d07c8d8fb492bb45052f
+  metadata.gz: f8a9f985318b4480c50a4d0528cf5036018235833585746e3ed632020fca3d00
+  data.tar.gz: bc75b64c4a4ffa8b32ee2b841af1c6bdb39df729bda95cc59d9ad36206cab387
 SHA512:
-  metadata.gz: 56de86af09e8c79821cb1789b0ceb27db74ac8f11176ff6b43ee36ebe0b18c0bcc60fd459c35dcfa369bd86a70c0f78724861380689c1afcc21296d77d8a9baa
-  data.tar.gz: b77ac5436b1d5f7a150778c68e259897576689a032d7490835e6ebf7411ba8dc1b3268548648c60261b0273528901a2d63edc3eb4d1e765cf75de7d4448da83e
+  metadata.gz: 56d3896fd8bb4194cbb50464759c9babfe2421e56148827fe282af956fa4fb9f38eb308363e30427bed0ef3596e5c1ba99150f108208835ecdb40921e99bf67e
+  data.tar.gz: e5f09155ab5a7e92dc0ccd6a10af885d5802925a7db1fdaf21cbeb9902b231642284ed06aa1ce0806271fceab5f42209d1c3c1c5442c6ea42a780a6264670ce4

data/Gemfile.lock

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

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 WorkOS
+Copyright (c) 2021 WorkOS
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/workos.rb

@@ -35,9 +35,11 @@ module WorkOS
   autoload :Directory, 'workos/directory'
   autoload :DirectoryGroup, 'workos/directory_group'
   autoload :Organization, 'workos/organization'
+  autoload :Organizations, 'workos/organizations'
   autoload :Passwordless, 'workos/passwordless'
   autoload :Portal, 'workos/portal'
   autoload :Profile, 'workos/profile'
+  autoload :ProfileAndToken, 'workos/profile_and_token'
   autoload :SSO, 'workos/sso'
   autoload :DirectoryUser, 'workos/directory_user'
 

data/lib/workos/organizations.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+# typed: true
+
+require 'net/http'
+
+module WorkOS
+  # The Organizations module provides resource methods for working with Organizations
+  module Organizations
+    class << self
+      extend T::Sig
+      include Base
+      include Client
+
+      # 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
+      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
+
+      # Get an Organization
+      #
+      # @param [String] id Organization unique identifier
+      #
+      # @example
+      #   WorkOS::Portal.get_organization(id: 'org_02DRA1XNSJDZ19A31F183ECQW9')
+      #   => #<WorkOS::Organization:0x00007fb6e4193d20
+      #         @id="org_02DRA1XNSJDZ19A31F183ECQW9",
+      #         @name="Foo Corp",
+      #         @domains=
+      #          [{:object=>"organization_domain",
+      #            :id=>"org_domain_01E6PK9N3XMD8RHWF7S66380AR",
+      #            :domain=>"foo-corp.com"}]>
+      #
+      # @return [WorkOS::Connection]
+      sig { params(id: String).returns(WorkOS::Organization) }
+      def get_organization(id:)
+        request = get_request(
+          auth: true,
+          path: "/organizations/#{id}",
+        )
+
+        response = execute_request(request: request)
+
+        WorkOS::Organization.new(response.body)
+      end
+
+      # 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
+
+      # Update an organization
+      #
+      # @param [String] organization Organization unique identifier
+      # @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(
+          organization: String,
+          domains: T::Array[String],
+          name: String,
+        ).returns(WorkOS::Organization)
+      end
+      def update_organization(organization:, domains:, name:)
+        request = put_request(
+          auth: true,
+          body: { domains: domains, name: name },
+          path: "/organizations/#{organization}",
+        )
+
+        response = execute_request(request: request)
+        check_and_raise_organization_error(response: response)
+
+        WorkOS::Organization.new(response.body)
+      end
+
+      private
+
+      sig { params(response: Net::HTTPResponse).void }
+      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
+    end
+  end
+end

data/lib/workos/portal.rb

@@ -15,30 +15,6 @@ module WorkOS
       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
@@ -73,117 +49,8 @@ module WorkOS
         JSON.parse(response.body)['link']
       end
 
-      # 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
-      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
-
-      # Get an Organization
-      #
-      # @param [String] id Organization unique identifier
-      #
-      # @example
-      #   WorkOS::Portal.get_organization(id: 'org_02DRA1XNSJDZ19A31F183ECQW9')
-      #   => #<WorkOS::Organization:0x00007fb6e4193d20
-      #         @id="org_02DRA1XNSJDZ19A31F183ECQW9",
-      #         @name="Foo Corp",
-      #         @domains=
-      #          [{:object=>"organization_domain",
-      #            :id=>"org_domain_01E6PK9N3XMD8RHWF7S66380AR",
-      #            :domain=>"foo-corp.com"}]>
-      #
-      # @return [WorkOS::Connection]
-      sig { params(id: String).returns(WorkOS::Organization) }
-      def get_organization(id:)
-        request = get_request(
-          auth: true,
-          path: "/organizations/#{id}",
-        )
-
-        response = execute_request(request: request)
-
-        WorkOS::Organization.new(response.body)
-      end
-
-      # Update an organization
-      #
-      # @param [String] organization Organization unique identifier
-      # @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(
-          organization: String,
-          domains: T::Array[String],
-          name: String,
-        ).returns(WorkOS::Organization)
-      end
-      def update_organization(organization:, domains:, name:)
-        request = put_request(
-          auth: true,
-          body: { domains: domains, name: name },
-          path: "/organizations/#{organization}",
-        )
-
-        response = execute_request(request: request)
-        check_and_raise_organization_error(response: response)
-
-        WorkOS::Organization.new(response.body)
-      end
-
       private
 
-      sig { params(response: Net::HTTPResponse).void }
-      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
-
       sig { params(intent: String).void }
       def validate_intent(intent)
         return if GENERATE_LINK_INTENTS.include?(intent)

data/lib/workos/profile_and_token.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+# typed: true
+
+module WorkOS
+  # The ProfileAndToken class represents a Profile and a corresponding
+  # Access Token. This class is not meant to be instantiated in user space, and
+  # is instantiated internally but exposed.
+  class ProfileAndToken
+    extend T::Sig
+
+    attr_accessor :access_token, :profile
+
+    sig { params(profile_and_token_json: String).void }
+    def initialize(profile_and_token_json)
+      json = JSON.parse(profile_and_token_json, symbolize_names: true)
+
+      @access_token = T.let(json[:access_token], String)
+      @profile = WorkOS::Profile.new(profile_and_token_json)
+    end
+
+    def to_json(*)
+      {
+        access_token: access_token,
+        profile: profile.to_json,
+      }
+    end
+  end
+end

data/lib/workos/sso.rb

@@ -30,8 +30,6 @@ module WorkOS
       #  WorkOS.
       # @param [String] client_id The WorkOS client ID for the environment
       #  where you've configured your SSO connection.
-      # @param [String] project_id The WorkOS project ID for the project.
-      # The project_id is deprecated in Dashboard2.
       # @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.
@@ -56,7 +54,6 @@ module WorkOS
       sig do
         params(
           redirect_uri: String,
-          project_id: T.nilable(String),
           client_id: T.nilable(String),
           domain: T.nilable(String),
           provider: T.nilable(String),
@@ -64,22 +61,14 @@ module WorkOS
           state: T.nilable(String),
         ).returns(String)
       end
-      # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists
       def authorization_url(
         redirect_uri:,
-        project_id: nil,
         client_id: nil,
         domain: nil,
         provider: nil,
         connection: nil,
         state: ''
       )
-        if project_id
-          warn '[DEPRECATION] `project_id` is deprecated.
-          Please use `client_id` instead.'
-          client_id = project_id
-        end
-
         validate_authorization_url_arguments(
           provider: provider,
           domain: domain,
@@ -98,46 +87,21 @@ module WorkOS
 
         "https://#{WorkOS::API_HOSTNAME}/sso/authorize?#{query}"
       end
-      # rubocop:enable Metrics/MethodLength, Metrics/ParameterLists
 
       # Fetch the profile details for the authenticated SSO user.
       #
       # @param [String] code The authorization code provided in the callback URL
       # @param [String] client_id The WorkOS client ID for the environment
-      #  where you've  configured your SSO connection
-      # @param [String] project_id The WorkOS project ID for the project.
-      # The project_id is deprecated in Dashboard2.
-      #
-      # @example
-      #   WorkOS::SSO.profile(
-      #     code: 'acme.com',
-      #     client_id: 'project_01DG5TGK363GRVXP3ZS40WNGEZ'
-      #   )
-      #   => #<WorkOS::Profile:0x00007fb6e4193d20
-      #         @id="prof_01DRA1XNSJDZ19A31F183ECQW5",
-      #         @email="demo@workos-okta.com",
-      #         @first_name="WorkOS",
-      #         @connection_type="OktaSAML",
-      #         @last_name="Demo",
-      #         @idp_id="00u1klkowm8EGah2H357",
-      #         @access_token="01DVX6QBS3EG6FHY2ESAA5Q65X"
-      #        >
+      #  where you've configured your SSO connection
       #
-      # @return [WorkOS::Profile]
+      # @return [WorkOS::ProfileAndToken]
       sig do
         params(
           code: String,
-          project_id: T.nilable(String),
           client_id: T.nilable(String),
-        ).returns(WorkOS::Profile)
+        ).returns(WorkOS::ProfileAndToken)
       end
-      def profile(code:, project_id: nil, client_id: nil)
-        if project_id
-          warn '[DEPRECATION] `project_id` is deprecated.
-          Please use `client_id` instead.'
-          client_id = project_id
-        end
-
+      def profile_and_token(code:, client_id: nil)
         body = {
           client_id: client_id,
           client_secret: WorkOS.key!,
@@ -146,65 +110,9 @@ module WorkOS
         }
 
         response = client.request(post_request(path: '/sso/token', body: body))
-        check_and_raise_profile_error(response: response)
-
-        WorkOS::Profile.new(response.body)
-      end
-
-      # Promote a DraftConnection created via the WorkOS.js embed such that the
-      # Enterprise users can begin signing into your application.
-      #
-      # @param [String] token The Draft Connection token that's been provided to
-      # you by the WorkOS.js
-      #
-      # @example
-      #   WorkOS::SSO.promote_draft_connection(
-      #     token: 'draft_conn_429u59js',
-      #   )
-      #   => true
-      #
-      # @return [Bool] - returns `true` if successful, `false` otherwise.
-      # @see https://github.com/workos-inc/ruby-idp-link-example
-      sig { params(token: String).returns(T::Boolean) }
-      def promote_draft_connection(token:)
-        request = post_request(
-          auth: true,
-          path: "/draft_connections/#{token}/activate",
-        )
-
-        response = client.request(request)
-
-        response.is_a? Net::HTTPSuccess
-      end
+        check_and_raise_profile_and_token_error(response: response)
 
-      # Create a Connection
-      #
-      # @param [String] source The Draft Connection token that's been provided
-      # to you by WorkOS.js
-      #
-      # @example
-      #   WorkOS::SSO.create_connection(source: 'draft_conn_429u59js')
-      #   => #<WorkOS::Connection:0x00007fb6e4193d20
-      #         @id="conn_02DRA1XNSJDZ19A31F183ECQW9",
-      #         @name="Foo Corp",
-      #         @connection_type="OktaSAML",
-      #         @domains=
-      #          [{:object=>"connection_domain",
-      #            :id=>"domain_01E6PK9N3XMD8RHWF7S66380AR",
-      #            :domain=>"example.com"}]>
-      #
-      # @return [WorkOS::Connection]
-      sig { params(source: String).returns(WorkOS::Connection) }
-      def create_connection(source:)
-        request = post_request(
-          auth: true,
-          path: '/connections',
-          body: { source: source },
-        )
-
-        response = execute_request(request: request)
-
-        WorkOS::Connection.new(response.body)
+        WorkOS::ProfileAndToken.new(response.body)
       end
 
       # Retrieve connections.
@@ -323,10 +231,10 @@ module WorkOS
       end
 
       sig { params(response: Net::HTTPResponse).void }
-      def check_and_raise_profile_error(response:)
+      def check_and_raise_profile_and_token_error(response:)
         begin
           body = JSON.parse(response.body)
-          return if body['profile']
+          return if body['access_token'] && body['profile']
 
           message = body['message']
           request_id = response['x-request-id']

data/lib/workos/version.rb

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

data/spec/lib/workos/organizations_spec.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+# typed: false
+
+describe WorkOS::Organizations do
+  describe '.create_organization' do
+    context 'with valid payload' do
+      it 'creates an organization' do
+        VCR.use_cassette 'organization/create' do
+          organization = described_class.create_organization(
+            domains: ['example.com'],
+            name: 'Test Organization',
+          )
+
+          expect(organization.id).to eq('org_01EHT88Z8J8795GZNQ4ZP1J81T')
+          expect(organization.name).to eq('Test Organization')
+          expect(organization.domains.first[:domain]).to eq('example.com')
+        end
+      end
+    end
+
+    context 'with an invalid payload' do
+      it 'returns an error' do
+        VCR.use_cassette 'organization/create_invalid' do
+          expect do
+            described_class.create_organization(
+              domains: ['example.com'],
+              name: 'Test Organization 2',
+            )
+          end.to raise_error(
+            WorkOS::APIError,
+            /An Organization with the domain example.com already exists/,
+          )
+        end
+      end
+    end
+  end
+
+  describe '.list_organizations' do
+    context 'with no options' do
+      it 'returns organizations and metadata' do
+        expected_metadata = {
+          'after' => nil,
+          'before' => 'before-id',
+        }
+
+        VCR.use_cassette 'organization/list' do
+          organizations = described_class.list_organizations
+
+          expect(organizations.data.size).to eq(7)
+          expect(organizations.list_metadata).to eq(expected_metadata)
+        end
+      end
+    end
+
+    context 'with the before option' do
+      it 'forms the proper request to the API' do
+        request_args = [
+          '/organizations?before=before-id',
+          'Content-Type' => 'application/json'
+        ]
+
+        expected_request = Net::HTTP::Get.new(*request_args)
+
+        expect(Net::HTTP::Get).to receive(:new).with(*request_args).
+          and_return(expected_request)
+
+        VCR.use_cassette 'organization/list', match_requests_on: [:path] do
+          organizations = described_class.list_organizations(
+            before: 'before-id',
+          )
+
+          expect(organizations.data.size).to eq(7)
+        end
+      end
+    end
+
+    context 'with the after option' do
+      it 'forms the proper request to the API' do
+        request_args = [
+          '/organizations?after=after-id',
+          'Content-Type' => 'application/json'
+        ]
+
+        expected_request = Net::HTTP::Get.new(*request_args)
+
+        expect(Net::HTTP::Get).to receive(:new).with(*request_args).
+          and_return(expected_request)
+
+        VCR.use_cassette 'organization/list', match_requests_on: [:path] do
+          organizations = described_class.list_organizations(after: 'after-id')
+
+          expect(organizations.data.size).to eq(7)
+        end
+      end
+    end
+
+    context 'with the limit option' do
+      it 'forms the proper request to the API' do
+        request_args = [
+          '/organizations?limit=10',
+          'Content-Type' => 'application/json'
+        ]
+
+        expected_request = Net::HTTP::Get.new(*request_args)
+
+        expect(Net::HTTP::Get).to receive(:new).with(*request_args).
+          and_return(expected_request)
+
+        VCR.use_cassette 'organization/list', match_requests_on: [:path] do
+          organizations = described_class.list_organizations(limit: 10)
+
+          expect(organizations.data.size).to eq(7)
+        end
+      end
+    end
+  end
+
+  describe '.get_organization' do
+    context 'with a valid id' do
+      it 'gets the organization details' do
+        VCR.use_cassette('organization/get') do
+          organization = described_class.get_organization(
+            id: 'org_01EZDF20TZEJXKPSX2BJRN6TV6',
+          )
+
+          expect(organization.id).to eq('org_01EZDF20TZEJXKPSX2BJRN6TV6')
+          expect(organization.name).to eq('Foo Corp')
+          expect(organization.domains.first[:domain]).to eq('foo-corp.com')
+        end
+      end
+    end
+
+    context 'with an invalid id' do
+      it 'raises an error' do
+        VCR.use_cassette('organization/get_invalid') do
+          expect do
+            described_class.get_organization(id: 'invalid')
+          end.to raise_error(
+            WorkOS::APIError,
+            'Status 404, Not Found - request ID: ',
+          )
+        end
+      end
+    end
+  end
+
+  describe '.update_organization' do
+    context 'with valid payload' do
+      it 'creates an organization' do
+        VCR.use_cassette 'organization/update' do
+          organization = described_class.update_organization(
+            organization: 'org_01F29YJ068E52HGEB8ZQGC9MJG',
+            domains: ['example.me'],
+            name: 'Test Organization',
+          )
+
+          expect(organization.id).to eq('org_01F29YJ068E52HGEB8ZQGC9MJG')
+          expect(organization.name).to eq('Test Organization')
+          expect(organization.domains.first[:domain]).to eq('example.me')
+        end
+      end
+    end
+  end
+end

data/spec/lib/workos/portal_spec.rb

@@ -2,39 +2,6 @@
 # typed: false
 
 describe WorkOS::Portal do
-  describe '.create_organization' do
-    context 'with valid payload' do
-      it 'creates an organization' do
-        VCR.use_cassette 'organization/create' do
-          organization = described_class.create_organization(
-            domains: ['example.com'],
-            name: 'Test Organization',
-          )
-
-          expect(organization.id).to eq('org_01EHT88Z8J8795GZNQ4ZP1J81T')
-          expect(organization.name).to eq('Test Organization')
-          expect(organization.domains.first[:domain]).to eq('example.com')
-        end
-      end
-    end
-
-    context 'with an invalid payload' do
-      it 'returns an error' do
-        VCR.use_cassette 'organization/create_invalid' do
-          expect do
-            described_class.create_organization(
-              domains: ['example.com'],
-              name: 'Test Organization 2',
-            )
-          end.to raise_error(
-            WorkOS::APIError,
-            /An Organization with the domain example.com already exists/,
-          )
-        end
-      end
-    end
-  end
-
   describe '.generate_link' do
     let(:organization) { 'org_01EHQMYV6MBK39QC5PZXHY59C3' }
 
@@ -100,131 +67,4 @@ describe WorkOS::Portal do
       end
     end
   end
-
-  describe '.list_organizations' do
-    context 'with no options' do
-      it 'returns organizations and metadata' do
-        expected_metadata = {
-          'after' => nil,
-          'before' => 'before-id',
-        }
-
-        VCR.use_cassette 'organization/list' do
-          organizations = described_class.list_organizations
-
-          expect(organizations.data.size).to eq(7)
-          expect(organizations.list_metadata).to eq(expected_metadata)
-        end
-      end
-    end
-
-    context 'with the before option' do
-      it 'forms the proper request to the API' do
-        request_args = [
-          '/organizations?before=before-id',
-          'Content-Type' => 'application/json'
-        ]
-
-        expected_request = Net::HTTP::Get.new(*request_args)
-
-        expect(Net::HTTP::Get).to receive(:new).with(*request_args).
-          and_return(expected_request)
-
-        VCR.use_cassette 'organization/list', match_requests_on: [:path] do
-          organizations = described_class.list_organizations(
-            before: 'before-id',
-          )
-
-          expect(organizations.data.size).to eq(7)
-        end
-      end
-    end
-
-    context 'with the after option' do
-      it 'forms the proper request to the API' do
-        request_args = [
-          '/organizations?after=after-id',
-          'Content-Type' => 'application/json'
-        ]
-
-        expected_request = Net::HTTP::Get.new(*request_args)
-
-        expect(Net::HTTP::Get).to receive(:new).with(*request_args).
-          and_return(expected_request)
-
-        VCR.use_cassette 'organization/list', match_requests_on: [:path] do
-          organizations = described_class.list_organizations(after: 'after-id')
-
-          expect(organizations.data.size).to eq(7)
-        end
-      end
-    end
-
-    context 'with the limit option' do
-      it 'forms the proper request to the API' do
-        request_args = [
-          '/organizations?limit=10',
-          'Content-Type' => 'application/json'
-        ]
-
-        expected_request = Net::HTTP::Get.new(*request_args)
-
-        expect(Net::HTTP::Get).to receive(:new).with(*request_args).
-          and_return(expected_request)
-
-        VCR.use_cassette 'organization/list', match_requests_on: [:path] do
-          organizations = described_class.list_organizations(limit: 10)
-
-          expect(organizations.data.size).to eq(7)
-        end
-      end
-    end
-  end
-
-  describe '.get_organization' do
-    context 'with a valid id' do
-      it 'gets the organization details' do
-        VCR.use_cassette('organization/get') do
-          organization = described_class.get_organization(
-            id: 'org_01EZDF20TZEJXKPSX2BJRN6TV6',
-          )
-
-          expect(organization.id).to eq('org_01EZDF20TZEJXKPSX2BJRN6TV6')
-          expect(organization.name).to eq('Foo Corp')
-          expect(organization.domains.first[:domain]).to eq('foo-corp.com')
-        end
-      end
-    end
-
-    context 'with an invalid id' do
-      it 'raises an error' do
-        VCR.use_cassette('organization/get_invalid') do
-          expect do
-            described_class.get_organization(id: 'invalid')
-          end.to raise_error(
-            WorkOS::APIError,
-            'Status 404, Not Found - request ID: ',
-          )
-        end
-      end
-    end
-  end
-
-  describe '.update_organization' do
-    context 'with valid payload' do
-      it 'creates an organization' do
-        VCR.use_cassette 'organization/update' do
-          organization = described_class.update_organization(
-            organization: 'org_01F29YJ068E52HGEB8ZQGC9MJG',
-            domains: ['example.me'],
-            name: 'Test Organization',
-          )
-
-          expect(organization.id).to eq('org_01F29YJ068E52HGEB8ZQGC9MJG')
-          expect(organization.name).to eq('Test Organization')
-          expect(organization.domains.first[:domain]).to eq('example.me')
-        end
-      end
-    end
-  end
 end

data/spec/lib/workos/sso_spec.rb

@@ -147,52 +147,9 @@ describe WorkOS::SSO do
         )
       end
     end
-
-    context 'passing the project_id' do
-      let(:args) do
-        {
-          domain: 'foo.com',
-          project_id: 'workos-proj-123',
-          redirect_uri: 'foo.com/auth/callback',
-          state: {
-            next_page: '/dashboard/edit',
-          }.to_s,
-        }
-      end
-      it 'raises a deprecation warning' do
-        expect do
-          described_class.authorization_url(**args)
-        end.to output(
-          "[DEPRECATION] `project_id` is deprecated.
-          Please use `client_id` instead.\n",
-        ).to_stderr
-      end
-
-      it 'returns a valid URL' do
-        authorization_url = described_class.authorization_url(**args)
-
-        expect(URI.parse(authorization_url)).to be_a URI
-      end
-
-      it 'returns the expected hostname' do
-        authorization_url = described_class.authorization_url(**args)
-
-        expect(URI.parse(authorization_url).host).to eq(WorkOS::API_HOSTNAME)
-      end
-
-      it 'returns the expected query string' do
-        authorization_url = described_class.authorization_url(**args)
-
-        expect(URI.parse(authorization_url).query).to eq(
-          'client_id=workos-proj-123&redirect_uri=foo.com%2Fauth%2Fcallback' \
-          '&response_type=code&state=%7B%3Anext_page%3D%3E%22%2Fdashboard%2F' \
-          'edit%22%7D&domain=foo.com',
-        )
-      end
-    end
   end
 
-  describe '.profile' do
+  describe '.profile_and_token' do
     let(:args) do
       {
         code: SecureRandom.hex(10),
@@ -225,15 +182,15 @@ describe WorkOS::SSO do
       end
 
       it 'includes the SDK Version header' do
-        described_class.profile(**args)
+        described_class.profile_and_token(**args)
 
         expect(a_request(:post, 'https://api.workos.com/sso/token').
           with(headers: headers, body: request_body)).to have_been_made
       end
 
-      it 'returns a WorkOS::Profile' do
-        profile = described_class.profile(**args)
-        expect(profile).to be_a(WorkOS::Profile)
+      it 'returns a WorkOS::ProfileAndToken' do
+        profile_and_token = described_class.profile_and_token(**args)
+        expect(profile_and_token).to be_a(WorkOS::ProfileAndToken)
 
         expectation = {
           connection_id: 'conn_01EMH8WAK20T42N2NBMNBCYHAG',
@@ -252,7 +209,8 @@ describe WorkOS::SSO do
           },
         }
 
-        expect(profile.to_json).to eq(expectation)
+        expect(profile_and_token.access_token).to eq('01DVX6QBS3EG6FHY2ESAA5Q65X')
+        expect(profile_and_token.profile.to_json).to eq(expectation)
       end
     end
 
@@ -269,7 +227,7 @@ describe WorkOS::SSO do
 
       it 'raises an exception with request ID' do
         expect do
-          described_class.profile(**args)
+          described_class.profile_and_token(**args)
         end.to raise_error(
           WorkOS::APIError,
           'some error message - request ID: request-id',
@@ -293,7 +251,7 @@ describe WorkOS::SSO do
 
       it 'raises an exception' do
         expect do
-          described_class.profile(**args)
+          described_class.profile_and_token(**args)
         end.to raise_error(
           WorkOS::APIError,
           "The code '01DVX3C5Z367SFHR8QNDMK7V24'" \
@@ -303,76 +261,6 @@ describe WorkOS::SSO do
     end
   end
 
-  describe '.create_connection' do
-    context 'with a valid source' do
-      it 'creates a connection' do
-        VCR.use_cassette('sso/create_connection_with_valid_source') do
-          connection = WorkOS::SSO.create_connection(
-            source: 'draft_conn_01E6PK87QP6NQ29RRX0G100YGV',
-          )
-
-          expect(connection.id).to eq('conn_01E4F9T2YWZFD218DN04KVFDSY')
-          expect(connection.connection_type).to eq('GoogleOAuth')
-          expect(connection.name).to eq('Foo Corp')
-          expect(connection.domains.first[:domain]).to eq('example.com')
-          expect(connection.organization_id).to eq('12345')
-          expect(connection.state).to eq('active')
-          expect(connection.status).to eq('linked')
-        end
-      end
-    end
-
-    context 'with an invalid source' do
-      it 'raises an error' do
-        VCR.use_cassette('sso/create_connection_with_invalid_source') do
-          expect do
-            WorkOS::SSO.create_connection(source: 'invalid')
-          end.to raise_error(
-            WorkOS::APIError,
-            'Status 404, Not Found - request ID: ',
-          )
-        end
-      end
-    end
-  end
-
-  describe '.promote_draft_connection' do
-    let(:token) { 'draft_conn_id' }
-    let(:client_id) { 'proj_0239u590h' }
-
-    context 'with a valid request' do
-      before do
-        stub_request(
-          :post,
-          "https://api.workos.com/draft_connections/#{token}/activate",
-        ).to_return(status: 200)
-      end
-      it 'returns true' do
-        response = described_class.promote_draft_connection(
-          token: token,
-        )
-
-        expect(response).to be(true)
-      end
-    end
-
-    context 'with an invalid request' do
-      before do
-        stub_request(
-          :post,
-          "https://api.workos.com/draft_connections/#{token}/activate",
-        ).to_return(status: 403)
-      end
-      it 'returns true' do
-        response = described_class.promote_draft_connection(
-          token: token,
-        )
-
-        expect(response).to be(false)
-      end
-    end
-  end
-
   describe '.list_connections' do
     context 'with no options' do
       it 'returns connections and metadata' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workos
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 1.0.0
 platform: ruby
 authors:
 - WorkOS
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-10 00:00:00.000000000 Z
+date: 2021-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -217,9 +217,11 @@ files:
 - lib/workos/directory_user.rb
 - lib/workos/errors.rb
 - lib/workos/organization.rb
+- lib/workos/organizations.rb
 - lib/workos/passwordless.rb
 - lib/workos/portal.rb
 - lib/workos/profile.rb
+- lib/workos/profile_and_token.rb
 - lib/workos/sso.rb
 - lib/workos/types.rb
 - lib/workos/types/connection_struct.rb
@@ -270,6 +272,7 @@ files:
 - spec/lib/workos/audit_trail_spec.rb
 - spec/lib/workos/base_spec.rb
 - spec/lib/workos/directory_sync_spec.rb
+- spec/lib/workos/organizations_spec.rb
 - spec/lib/workos/passwordless_spec.rb
 - spec/lib/workos/portal_spec.rb
 - spec/lib/workos/sso_spec.rb
@@ -318,8 +321,6 @@ files:
 - spec/support/fixtures/vcr_cassettes/portal/generate_link_dsync.yml
 - spec/support/fixtures/vcr_cassettes/portal/generate_link_invalid.yml
 - spec/support/fixtures/vcr_cassettes/portal/generate_link_sso.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/fixtures/vcr_cassettes/sso/delete_connection_with_invalid_id.yml
 - spec/support/fixtures/vcr_cassettes/sso/delete_connection_with_valid_id.yml
 - spec/support/fixtures/vcr_cassettes/sso/get_connection_with_invalid_id.yml
@@ -361,6 +362,7 @@ 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/organizations_spec.rb
 - spec/lib/workos/passwordless_spec.rb
 - spec/lib/workos/portal_spec.rb
 - spec/lib/workos/sso_spec.rb
@@ -409,8 +411,6 @@ test_files:
 - spec/support/fixtures/vcr_cassettes/portal/generate_link_dsync.yml
 - spec/support/fixtures/vcr_cassettes/portal/generate_link_invalid.yml
 - spec/support/fixtures/vcr_cassettes/portal/generate_link_sso.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/fixtures/vcr_cassettes/sso/delete_connection_with_invalid_id.yml
 - spec/support/fixtures/vcr_cassettes/sso/delete_connection_with_valid_id.yml
 - spec/support/fixtures/vcr_cassettes/sso/get_connection_with_invalid_id.yml

data/spec/support/fixtures/vcr_cassettes/sso/create_connection_with_invalid_source.yml

@@ -1,58 +0,0 @@
----
-http_interactions:
-- request:
-    method: post
-    uri: https://api.workos.com/connections
-    body:
-      encoding: UTF-8
-      string: '{"source":"invalid"}'
-    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.2
-      Authorization:
-      - Bearer <API_KEY>
-  response:
-    status:
-      code: 404
-      message: Not Found
-    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
-      Content-Length:
-      - '23'
-      Etag:
-      - W/"17-SuRA/yvUWUo8rK6x7dKURLeBo+0"
-      Date:
-      - Fri, 24 Apr 2020 02:16:27 GMT
-      Connection:
-      - keep-alive
-    body:
-      encoding: UTF-8
-      string: '{"message":"Not Found"}'
-    http_version: 
-  recorded_at: Fri, 24 Apr 2020 02:16:27 GMT
-recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/sso/create_connection_with_valid_source.yml

@@ -1,63 +0,0 @@
----
-http_interactions:
-- request:
-    method: post
-    uri: https://api.workos.com/connections
-    body:
-      encoding: UTF-8
-      string: '{"source":"draft_conn_01E6PK87QP6NQ29RRX0G100YGV"}'
-    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.2
-      Authorization:
-      - Bearer <API_KEY>
-  response:
-    status:
-      code: 201
-      message: Created
-    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:
-      - 8cd03fab-ca1a-4c0b-9953-1f918849a9de
-      Content-Type:
-      - application/json; charset=utf-8
-      Etag:
-      - W/"55a-z00MNCfGmS/7RWJwhsBrAXo09Ls"
-      Date:
-      - Fri, 24 Apr 2020 17:20:52 GMT
-      Transfer-Encoding:
-      - chunked
-      Via:
-      - 1.1 vegur
-    body:
-      encoding: ASCII-8BIT
-      string: '{"object":"connection","id":"conn_01E4F9T2YWZFD218DN04KVFDSY","state":"active","status":"linked","name":"Foo Corp","connection_type":"GoogleOAuth","oauth_uid":"demo
-        client id","oauth_secret":"demo client secret","oauth_redirect_uri":"https://auth.workos.com/sso/oauth/google/gcrSPYSytyQeZKkwKs6Ye4ogM/callback","saml_entity_id":null,"saml_idp_url":null,"saml_relying_party_trust_cert":null,"saml_x509_certs":null,"organization_id":"12345","domains":[{"object":"connection_domain","id":"domain_01E6PK9N3XMD8RHWF7S66380AR","domain":"example.com"}]}'
-    http_version:
-  recorded_at: Fri, 24 Apr 2020 17:20:52 GMT
-recorded_with: VCR 5.0.0