workos 0.3.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2dc4e5ea1ade6d908e794c3b639b798c7e108c6d0f4b57b322943dd8f2385fb
-  data.tar.gz: b7aa22e7dcfe183574eb8db29990ba1427751b746aaf952f74d03be3a0ab1fb4
+  metadata.gz: 56cf52cb4a104516de13499b34f7c6f36a102c0c2af1bf6934e963579f27a596
+  data.tar.gz: 45dee16f5ed91f99133e7f974d607e76effa73e0d0d3b271fd7e9756e72055c5
 SHA512:
-  metadata.gz: 7563e3b8585a1dce014b44b0096b9f9b7cb8716d95b0328e0e26690e8ef4e588464ecf1333d6f18aa6720649be2a4f3b334ec58d0be43b95e466f1cdfece73c3
-  data.tar.gz: 3a1de478d8e10c8bf78a7c1b880df0ae01858562394c82161dbf36fb9bb2e8de51d0e6166a5556af4a715d8dd26d300b2bde4aadb47a3c06560be88687c532e8
+  metadata.gz: 00d537dcaf496aa3b8244f72b04137496fef5613100ec61d32f837f20f42f6f5ed20180d41eb560dd6bfe6491810f07d4f4401d0e0cacc121c991b5c74d80676
+  data.tar.gz: 843f4d8558e3412ed6fa3becaf6c7717a301121baa7fd6edb292184518d335b2f616f024fdf13a9adf8659110aae3411744525be76f25f1bf238dd05acf14d99

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    workos (0.3.2)
+    workos (0.5.0)
       sorbet-runtime (~> 0.5)
 
 GEM
@@ -10,17 +10,16 @@ GEM
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
-    codecov (0.1.16)
+    codecov (0.2.8)
       json
       simplecov
-      url
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
     docile (1.3.2)
     hashdiff (1.0.0)
     jaro_winkler (1.5.4)
-    json (2.3.0)
+    json (2.3.1)
     parallel (1.19.1)
     parser (2.7.0.0)
       ast (~> 2.4.0)
@@ -49,17 +48,15 @@ GEM
       unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.1)
     safe_yaml (1.0.5)
-    simplecov (0.17.1)
+    simplecov (0.19.0)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
     sorbet (0.5.5560)
       sorbet-static (= 0.5.5560)
-    sorbet-runtime (0.5.5657)
+    sorbet-runtime (0.5.5877)
     sorbet-static (0.5.5560-universal-darwin-14)
     unicode-display_width (1.6.0)
-    url (0.3.2)
     vcr (5.0.0)
     webmock (3.7.6)
       addressable (>= 2.3.6)
@@ -72,7 +69,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (>= 2.0.1)
-  codecov (~> 0.1.16)
+  codecov (~> 0.2.8)
   rake
   rspec (~> 3.9.0)
   rubocop (~> 0.77)

data/README.md

@@ -157,6 +157,13 @@ This method will return an instance of a `WorkOS::Profile` with the following at
   @connection_type="OktaSAML",
   @last_name="Demo",
   @idp_id="00u1klkowm8EGah2H357",
+  @raw_attributes={
+    :id=>"prof_01DRA1XNSJDZ19A31F183ECQW5",
+    :email=>"demo@workos-okta.com",
+    :first_name=>"WorkOS",
+    :last_name=>"Demo",
+    :idp_id=>"00u1klkowm8EGah2H357"
+  },
 >
 ```
 

data/lib/workos/audit_trail.rb

@@ -57,6 +57,54 @@ module WorkOS
 
         execute_request(request: request)
       end
+
+      # Retrieve Audit Trail events.
+      #
+      # @param [Hash] options An options hash
+      # @option options [String] before Event ID to look before
+      # @option options [String] after Event ID to look after
+      # @option options [Integer] limit Number of Events to return
+      # @option options [Array<String>] group List of Groups to filter for
+      # @option options [Array<String>] action List of Actions to filter for
+      # @option options [Array<String>] action_type List of Action Types to
+      #  filter for
+      # @option options [Array<String>] actor_name List of Actor Name to filter
+      #  for
+      # @option options [Array<String>] actor_id List of Actor IDs to filter for
+      # @option options [Array<String>] target_name List of Target Names to
+      #  filter for
+      # @option options [Array<String>] target_id List of Target IDs to filter
+      #  for
+      # @option options [String] occurred_at ISO-8601 datetime of when an event
+      #  occurred
+      # @option options [String] occurred_at_gt ISO-8601 datetime of when an
+      #  event occurred after
+      # @option options [String] occurred_at_gte ISO-8601 datetime of when an
+      #  event occurred at or after
+      # @option options [String] occurred_at_lt ISO-8601 datetime of when an
+      #  event occurred before
+      # @option options [String] ISO-8601 datetime of when an event occured at
+      #  or before
+      # @option options [String] search Keyword search
+      #
+      # @return [Array<Hash>]
+      sig do
+        params(
+          options: T::Hash[Symbol, String],
+        ).returns(T::Array[T::Hash[String, T.nilable(String)]])
+      end
+
+      def get_events(options = {})
+        response = execute_request(
+          request: get_request(
+            path: '/events',
+            auth: true,
+            params: options,
+          ),
+        )
+
+        JSON.parse(response.body)['data']
+      end
     end
   end
 end

data/lib/workos/directory_sync.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 # typed: true
 
+require 'net/http'
+
 module WorkOS
   # The Directory Sync module provides convenience methods for working with the
   # WorkOS Directory Sync platform. You'll need a valid API key and to have

data/lib/workos/profile.rb

@@ -14,7 +14,7 @@ module WorkOS
 
     sig { returns(String) }
     attr_accessor :id, :email, :first_name, :last_name,
-                  :connection_type, :idp_id
+                  :connection_type, :idp_id, :raw_attributes
 
     sig { params(profile_json: String).void }
     def initialize(profile_json)
@@ -22,10 +22,11 @@ module WorkOS
 
       @id = T.let(raw.id, String)
       @email = T.let(raw.email, String)
-      @first_name = T.let(raw.first_name, String)
-      @last_name = T.let(raw.last_name, String)
+      @first_name = raw.first_name
+      @last_name = raw.last_name
       @connection_type = T.let(raw.connection_type, String)
-      @idp_id = T.let(raw.idp_id, String)
+      @idp_id = raw.idp_id
+      @raw_attributes = raw.raw_attributes
     end
 
     sig { returns(String) }
@@ -41,11 +42,13 @@ module WorkOS
         last_name: last_name,
         connection_type: connection_type,
         idp_id: idp_id,
+        raw_attributes: raw_attributes,
       }
     end
 
     private
 
+    # rubocop:disable Metrics/AbcSize
     sig { params(json_string: String).returns(WorkOS::Types::ProfileStruct) }
     def parse_json(json_string)
       hash = JSON.parse(json_string, symbolize_names: true)
@@ -57,7 +60,9 @@ module WorkOS
         last_name: hash[:profile][:last_name],
         connection_type: hash[:profile][:connection_type],
         idp_id: hash[:profile][:idp_id],
+        raw_attributes: hash[:profile][:raw_attributes],
       )
     end
+    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/workos/sso.rb

@@ -40,7 +40,7 @@ module WorkOS
       #     redirect_uri: 'https://workos.com/callback',
       #     state: {
       #       next_page: '/docs'
-      #     }
+      #     }.to_s
       #   )
       #
       #   => "https://api.workos.com/sso/authorize?domain=acme.com" \

data/lib/workos/types/profile_struct.rb

@@ -8,10 +8,11 @@ module WorkOS
     class ProfileStruct < T::Struct
       const :id, String
       const :email, String
-      const :first_name, String
-      const :last_name, String
+      const :first_name, T.nilable(String)
+      const :last_name, T.nilable(String)
       const :connection_type, String
-      const :idp_id, 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.3.2'
+  VERSION = '0.5.0'
 end

data/spec/lib/workos/audit_trail_spec.rb

@@ -137,4 +137,16 @@ describe WorkOS::AuditTrail do
       end
     end
   end
+
+  describe '.get_events' do
+    context 'with no options' do
+      it 'returns events' do
+        VCR.use_cassette('audit_trail/get_events') do
+          events = described_class.get_events
+
+          expect(events.size).to eq(2)
+        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/audit_trail/get_events.yml

@@ -0,0 +1,61 @@
+---
+http_interactions:
+  - request:
+      method: get
+      uri: https://api.workos.com/events
+      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/2.7.1; x86_64-darwin19; v0.4.0
+        Authorization:
+          - Bearer <API_KEY>
+    response:
+      status:
+        code: 200
+        message: OK
+      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
+        Etag:
+          - W/"1784-HtVN7X+AT30Dlt9nZrirP0nnyV8"
+        Date:
+          - Fri, 31 Jul 2020 14:41:12 GMT
+        Connection:
+          - keep-alive
+        Transfer-Encoding:
+          - chunked
+      body:
+        encoding: ASCII-8BIT
+        string:
+          '{"data":[{"object":"event","id":"evt_01EEJM9Q9SMC3W2SZDKA5VJ8XQ","group":"workos.com","location":"::1","latitude":null,"longitude":null,"type":"r","actor_name":"foo@example.com","actor_id":"user_01EEG9P7A1DA9VY9CX7GT47RPF","target_name":"api_key_query","target_id":"key_01EEG9MPHAYX46BBZKGK3BGQXJ","metadata":{"description":"User
+          viewed API key.","x_request_id":""},"occurred_at":"2020-07-31T14:27:00.384Z","action":{"object":"event_action","id":"evt_action_01EEGQXWAHB065P5JD0QDAAGDC","name":"user.viewed_api_key","project_id":"project_01DZB0E7HQMA6G85PQNHQJMZD0"}},{"object":"event","id":"evt_01EEJM9Q7GMR1VGT6VXN2N2JJQ","group":"workos.com","location":"::1","latitude":null,"longitude":null,"type":"r","actor_name":"foo@example.com","actor_id":"user_01EEG9P7A1DA9VY9CX7GT47RPF","target_name":"api_key_query","target_id":"key_01EEG9MPGM8KFT9VBQHJMV8YZB","metadata":{"description":"User
+          viewed API key.","x_request_id":""},"occurred_at":"2020-07-31T14:27:00.360Z","action":{"object":"event_action","id":"evt_action_01EEGQXWAHB065P5JD0QDAAGDC","name":"user.viewed_api_key","project_id":"project_01DZB0E7HQMA6G85PQNHQJMZD0"}}],"listMetadata":{"before":"evt_01EEJKZDAR6G4JHFQT4R3KSZDQ","after":null}}'
+      http_version:
+    recorded_at: Fri, 31 Jul 2020 14:41:12 GMT
+recorded_with: VCR 5.0.0

data/spec/support/profile.txt

@@ -1 +1 @@
-{"profile":{"object":"profile","id":"prof_01DRA1XNSJDZ19A31F183ECQW5","email":"demo@workos-okta.com","first_name":"WorkOS","connection_type":"OktaSAML","last_name":"Demo","idp_id":"00u1klkowm8EGah2H357"},"access_token":"01DVX6QBS3EG6FHY2ESAA5Q65X"}
+{"profile":{"object":"profile","id":"prof_01DRA1XNSJDZ19A31F183ECQW5","email":"demo@workos-okta.com","first_name":"WorkOS","connection_type":"OktaSAML","last_name":"Demo","idp_id":"00u1klkowm8EGah2H357","raw_attributes":{"id":"prof_01DRA1XNSJDZ19A31F183ECQW5","email":"demo@workos-okta.com","first_name":"WorkOS","last_name":"Demo","idp_id":"00u1klkowm8EGah2H357"}},"access_token":"01DVX6QBS3EG6FHY2ESAA5Q65X"}

data/workos.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'sorbet-runtime', '~> 0.5'
 
   spec.add_development_dependency 'bundler', '>= 2.0.1'
-  spec.add_development_dependency 'codecov', '~> 0.1.16'
+  spec.add_development_dependency 'codecov', '~> 0.2.8'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.9.0'
   spec.add_development_dependency 'rubocop', '~> 0.77'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workos
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.5.0
 platform: ruby
 authors:
 - WorkOS
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-20 00:00:00.000000000 Z
+date: 2020-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.16
+        version: 0.2.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.16
+        version: 0.2.8
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -239,6 +239,7 @@ files:
 - spec/support/fixtures/vcr_cassettes/audit_trail/create_event_invalid.yml
 - spec/support/fixtures/vcr_cassettes/audit_trail/create_events_duplicate_idempotency_key_and_payload.yml
 - spec/support/fixtures/vcr_cassettes/audit_trail/create_events_duplicate_idempotency_key_different_payload.yml
+- 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/get_group.yml
 - spec/support/fixtures/vcr_cassettes/directory_sync/get_group_with_invalid_id.yml
@@ -274,7 +275,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: API client for WorkOS
@@ -289,6 +290,7 @@ test_files:
 - spec/support/fixtures/vcr_cassettes/audit_trail/create_event_invalid.yml
 - spec/support/fixtures/vcr_cassettes/audit_trail/create_events_duplicate_idempotency_key_and_payload.yml
 - spec/support/fixtures/vcr_cassettes/audit_trail/create_events_duplicate_idempotency_key_different_payload.yml
+- 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/get_group.yml
 - spec/support/fixtures/vcr_cassettes/directory_sync/get_group_with_invalid_id.yml