workos 0.4.2 → 0.8.1

data/lib/workos/types.rb

@@ -6,6 +6,10 @@ module WorkOS
   # so we're using Sorbet throughout this Ruby gem.
   module Types
     require_relative 'types/connection_struct'
+    require_relative 'types/intent_enum'
+    require_relative 'types/list_struct'
+    require_relative 'types/organization_struct'
+    require_relative 'types/passwordless_session_struct'
     require_relative 'types/profile_struct'
     require_relative 'types/provider_enum'
   end

data/lib/workos/types/intent_enum.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+# typed: strict
+
+module WorkOS
+  module Types
+    # The IntentEnum is type-safe declarations of a fixed set of values for
+    # intents while generating an Admin Portal link.
+    class Intent < T::Enum
+      enums do
+        SSO = new('sso')
+      end
+    end
+  end
+end

data/lib/workos/types/list_struct.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+# typed: strict
+
+module WorkOS
+  module Types
+    # ListStruct acts as a typed interface to expose lists of data and related
+    # metadata
+    class ListStruct < T::Struct
+      const :data, T::Array[T.untyped]
+      const :list_metadata, T::Hash[String, T.nilable(String)]
+    end
+  end
+end

data/lib/workos/types/organization_struct.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+# typed: strict
+
+module WorkOS
+  module Types
+    # This OrganizationStruct acts as a typed interface
+    # for the Organization class
+    class OrganizationStruct < T::Struct
+      const :id, String
+      const :name, String
+      const :domains, T::Array[T.untyped]
+    end
+  end
+end

data/lib/workos/types/passwordless_session_struct.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+# typed: strict
+
+module WorkOS
+  module Types
+    # This PasswordlessSessionStruct acts as a typed interface
+    # for the Passwordless class
+    class PasswordlessSessionStruct < T::Struct
+      const :id, String
+      const :email, String
+      const :expires_at, Date
+      const :link, String
+    end
+  end
+end

data/lib/workos/types/profile_struct.rb

@@ -12,6 +12,7 @@ module WorkOS
       const :last_name, T.nilable(String)
       const :connection_type, String
       const :idp_id, T.nilable(String)
+      const :raw_attributes, T::Hash[Symbol, Object]
     end
   end
 end

data/lib/workos/version.rb

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

data/spec/lib/workos/passwordless_spec.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+# typed: false
+
+describe WorkOS::Passwordless do
+  before(:all) do
+    WorkOS.key = 'key'
+  end
+
+  after(:all) do
+    WorkOS.key = nil
+  end
+
+  describe '.create_session' do
+    context 'with valid options payload' do
+      let(:valid_options) do
+        {
+          email: 'demo@workos-okta.com',
+          type: 'MagicLink',
+        }
+      end
+
+      it 'creates a session' do
+        VCR.use_cassette('passwordless/create_session') do
+          response = described_class.create_session(valid_options)
+
+          expect(response.email).to eq 'demo@workos-okta.com'
+        end
+      end
+    end
+
+    context 'with invalid event payload' do
+      let(:invalid_options) do
+        {}
+      end
+
+      it 'raises an error' do
+        VCR.use_cassette('passwordless/create_session_invalid') do
+          expect do
+            described_class.create_session(invalid_options)
+          end.to raise_error(
+            WorkOS::InvalidRequestError,
+            /Status 422, Validation failed \(email: email must be a string; type: type must be a valid enum value\)/,
+          )
+        end
+      end
+    end
+  end
+
+  describe '.send_session' do
+    context 'with valid session id' do
+      let(:valid_options) do
+        {
+          email: 'demo@workos-okta.com',
+          type: 'MagicLink',
+        }
+      end
+
+      it 'send a session' do
+        VCR.use_cassette('passwordless/send_session') do
+          response = described_class.send_session(
+            'passwordless_session_01EJC0F4KH42T11Y2DHPEB09BM',
+          )
+
+          expect(response['success']).to eq true
+        end
+      end
+    end
+
+    context 'with invalid session id' do
+      it 'raises an error' do
+        VCR.use_cassette('passwordless/send_session_invalid') do
+          expect do
+            described_class.send_session('session_123')
+          end.to raise_error(
+            WorkOS::InvalidRequestError,
+            /Status 422, The passwordless session 'session_123' has expired or is invalid./,
+          )
+        end
+      end
+    end
+  end
+end

data/spec/lib/workos/portal_spec.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+# typed: false
+
+describe WorkOS::Portal do
+  before :all do
+    WorkOS.key = 'test'
+  end
+
+  after :all do
+    WorkOS.key = nil
+  end
+
+  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' }
+
+    describe 'with a valid organization' do
+      describe 'with the minimal params' do
+        it 'returns an Admin Portal link' do
+          VCR.use_cassette 'portal/generate_link' do
+            portal_link = described_class.generate_link(
+              intent: 'sso',
+              organization: organization,
+            )
+
+            expect(portal_link).to eq(
+              'https://id.workos.com/portal/launch?secret=secret',
+            )
+          end
+        end
+      end
+    end
+
+    describe 'with an invalid organization' do
+      it 'raises an error' do
+        VCR.use_cassette 'portal/generate_link_invalid' do
+          expect do
+            described_class.generate_link(
+              intent: 'sso',
+              organization: 'bogus-id',
+            )
+          end.to raise_error(
+            WorkOS::InvalidRequestError,
+            /Could not find an organization with the id, bogus-id/,
+          )
+        end
+      end
+    end
+
+    describe 'with an invalid intent' do
+      it 'raises an error' do
+        expect do
+          described_class.generate_link(
+            intent: 'bogus-intent',
+            organization: organization,
+          )
+        end.to raise_error(
+          ArgumentError,
+          'bogus-intent is not a valid value. `intent` must be in ["sso"]',
+        )
+      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
+end

data/spec/lib/workos/sso_spec.rb

@@ -161,6 +161,24 @@ describe WorkOS::SSO do
       it 'returns a WorkOS::Profile' do
         profile = described_class.profile(**args)
         expect(profile).to be_a(WorkOS::Profile)
+
+        expectation = {
+          connection_type: 'OktaSAML',
+          email: 'demo@workos-okta.com',
+          first_name: 'WorkOS',
+          id: 'prof_01DRA1XNSJDZ19A31F183ECQW5',
+          idp_id: '00u1klkowm8EGah2H357',
+          last_name: 'Demo',
+          raw_attributes: {
+            email: 'demo@workos-okta.com',
+            first_name: 'WorkOS',
+            id: 'prof_01DRA1XNSJDZ19A31F183ECQW5',
+            idp_id: '00u1klkowm8EGah2H357',
+            last_name: 'Demo',
+          },
+        }
+
+        expect(profile.to_json).to eq(expectation)
       end
     end
 

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

@@ -0,0 +1,72 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.workos.com/organizations
+    body:
+      encoding: UTF-8
+      string: '{"domains":["example.com"],"name":"Test Organization"}'
+    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.5.0
+      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'
+      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:
+      - bcddfa8b-3a12-4d48-b265-6094a26225a4
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '203'
+      Etag:
+      - W/"cb-T4+GTGrJeuAmC0PAjcaSX5ZXL18"
+      Date:
+      - Wed, 09 Sep 2020 20:17:53 GMT
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: UTF-8
+      string: '{"name":"Test Organization","object":"organization","id":"org_01EHT88Z8J8795GZNQ4ZP1J81T","domains":[{"domain":"example.com","object":"organization_domain","id":"org_domain_01EHT88Z8WZEFWYPM6EC9BX2R8"}]}'
+    http_version: 
+  recorded_at: Wed, 09 Sep 2020 20:17:54 GMT
+recorded_with: VCR 5.0.0