Add GET /organization/:orgId/roles support (#338)

Author: mattgd

lib/workos.rb

@@ -71,6 +71,7 @@ def self.key
   autoload :Profile, 'workos/profile'
   autoload :ProfileAndToken, 'workos/profile_and_token'
   autoload :RefreshAuthenticationResponse, 'workos/refresh_authentication_response'
+  autoload :Role, 'workos/role'
   autoload :Session, 'workos/session'
   autoload :SSO, 'workos/sso'
   autoload :Types, 'workos/types'

lib/workos/organizations.rb

@@ -180,6 +180,32 @@ def delete_organization(id:)
         response.is_a? Net::HTTPSuccess
       end
 
+      # Retrieve a list of roles for the given organization.
+      #
+      # @param [String] organizationId The ID of the organization to fetch roles for.
+      def list_organization_roles(organization_id:)
+        response = execute_request(
+          request: get_request(
+            path: "/organizations/#{organization_id}/roles",
+            auth: true,
+          ),
+        )
+
+        parsed_response = JSON.parse(response.body)
+
+        roles = parsed_response['data'].map do |role|
+          WorkOS::Role.new(role.to_json)
+        end
+
+        WorkOS::Types::ListStruct.new(
+          data: roles,
+          list_metadata: {
+            after: nil,
+            before: nil,
+          },
+        )
+      end
+
       private
 
       def check_and_raise_organization_error(response:)

lib/workos/role.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module WorkOS
+  # The Role class provides a lightweight wrapper around
+  # a WorkOS Role resource. This class is not meant to be instantiated
+  # in user space, and is instantiated internally but exposed.
+  class Role
+    include HashProvider
+
+    attr_accessor :id, :name, :slug, :description, :type, :created_at, :updated_at
+
+    def initialize(json)
+      hash = JSON.parse(json, symbolize_names: true)
+
+      @id = hash[:id]
+      @name = hash[:name]
+      @slug = hash[:slug]
+      @description = hash[:description]
+      @type = hash[:type]
+      @created_at = hash[:created_at]
+      @updated_at = hash[:updated_at]
+    end
+
+    def to_json(*)
+      {
+        id: id,
+        name: name,
+        slug: slug,
+        description: description,
+        type: type,
+        created_at: created_at,
+        updated_at: updated_at,
+      }
+    end
+  end
+end

spec/lib/workos/organizations_spec.rb

@@ -323,4 +323,22 @@
       end
     end
   end
+
+  describe '.list_organization_roles' do
+    context 'with no options' do
+      it 'returns roles for organization' do
+        expected_metadata = {
+          after: nil,
+          before: nil,
+        }
+
+        VCR.use_cassette 'organization/list_organization_roles' do
+          roles = described_class.list_organization_roles(organization_id: 'org_01JEXP6Z3X7HE4CB6WQSH9ZAFE')
+
+          expect(roles.data.size).to eq(7)
+          expect(roles.list_metadata).to eq(expected_metadata)
+        end
+      end
+    end
+  end
 end