inst_access 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e81a1fd534b4927401037a4865828b0f402ee0b81a18c5d44e4ddeaf67205a8
-  data.tar.gz: d2a3cd8174208a3b943d20f9b57c0126585f7dd6bb1516821f2fa959771b6063
+  metadata.gz: 5078ae05b8177aa22350be75c165e5b8f3c2e469693544d2d6cdc88cdd725bad
+  data.tar.gz: 886e682197965ff3cb4af0ef81063757701b2928fa64f6d9cf93b505f5b1d150
 SHA512:
-  metadata.gz: 6ec033d6636a968926163b1ba44e4168efa78520a108c3ba0809e309d2564fedba1de0c41740a7d545cf424a3bd91225e929588ecf1e62fa31f527091eb01935
-  data.tar.gz: cf5b9d6012d3fec913dffa5195b088baa5c42140c1e78bfb8cdaffb55d623f1d44cfb5d9d91fa066d961e42b8661cddb5ce5a38af92d2e87eb51812537be6ee2
+  metadata.gz: 0f3da43796458852625c0cee8fa0197936780f91ae4bd3cb77463b21fb2435b6db3a6f8d56fafa33a1aac856847bda1d6871d1957a75c0860d3fca482e572b2c
+  data.tar.gz: a7d7b5ed84a25a81a237090e24844cff252b8ab2a14fef4973cbc58ee04de265014ce04790dc02ad193edb9ca6b6251a74828bc533ae70c8b0cf001a630c9cc5

data/lib/inst_access/token.rb

@@ -50,6 +50,10 @@ module InstAccess
       jwt_payload[:masq_shard]
     end
 
+    def region
+      jwt_payload[:region]
+    end
+
     def to_token_string
       jwe = to_jws.encrypt(InstAccess.config.encryption_key, ENCRYPTION_ALGO, ENCRYPTION_METHOD)
       jwe.to_s
@@ -74,7 +78,7 @@ module InstAccess
     class << self
       private :new
 
-      # rubocop:disable Metrics/ParameterLists, Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/ParameterLists
       def for_user(
         user_uuid: nil,
         account_uuid: nil,
@@ -82,27 +86,30 @@ module InstAccess
         real_user_uuid: nil,
         real_user_shard_id: nil,
         user_global_id: nil,
-        real_user_global_id: nil
+        real_user_global_id: nil,
+        region: nil
       )
         raise ArgumentError, 'Must provide user uuid and account uuid' if user_uuid.blank? || account_uuid.blank?
 
         now = Time.now.to_i
+
         payload = {
           iss: ISSUER,
           iat: now,
           exp: now + 1.hour.to_i,
           sub: user_uuid,
-          acct: account_uuid
-        }
-        payload[:canvas_domain] = canvas_domain if canvas_domain
-        payload[:masq_sub] = real_user_uuid if real_user_uuid
-        payload[:masq_shard] = real_user_shard_id if real_user_shard_id
-        payload[:debug_user_global_id] = user_global_id.to_s if user_global_id
-        payload[:debug_masq_global_id] = real_user_global_id.to_s if real_user_global_id
+          acct: account_uuid,
+          canvas_domain: canvas_domain,
+          masq_sub: real_user_uuid,
+          masq_shard: real_user_shard_id,
+          debug_user_global_id: user_global_id&.to_s,
+          debug_masq_global_id: real_user_global_id&.to_s,
+          region: region
+        }.compact
 
         new(payload)
       end
-      # rubocop:enable Metrics/ParameterLists, Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/ParameterLists
 
       # Takes an unencrypted (but signed) token string
       def from_token_string(jws)

data/spec/inst_access/token_spec.rb

@@ -74,6 +74,7 @@ describe InstAccess::Token do
     it 'creates an instance for the given uuids' do
       id = described_class.for_user(user_uuid: 'user-uuid', account_uuid: 'acct-uuid')
       expect(id.user_uuid).to eq('user-uuid')
+      expect(id.account_uuid).to eq('acct-uuid')
       expect(id.masquerading_user_uuid).to be_nil
     end
 
@@ -83,11 +84,31 @@ describe InstAccess::Token do
         account_uuid: 'acct-uuid',
         canvas_domain: 'z.instructure.com',
         real_user_uuid: 'masq-id',
-        real_user_shard_id: 5
+        real_user_shard_id: 5,
+        region: 'us-west-2'
       )
       expect(id.canvas_domain).to eq('z.instructure.com')
       expect(id.masquerading_user_uuid).to eq('masq-id')
       expect(id.masquerading_user_shard_id).to eq(5)
+      expect(id.region).to eq('us-west-2')
+    end
+
+    it 'includes global id debug info if given' do
+      id = described_class.for_user(
+        user_uuid: 'user-uuid',
+        account_uuid: 'acct-uuid',
+        user_global_id: 10_000_000_000_123,
+        real_user_global_id: 10_000_000_000_456
+      )
+
+      expect(id.jwt_payload[:debug_user_global_id]).to eq('10000000000123')
+      expect(id.jwt_payload[:debug_masq_global_id]).to eq('10000000000456')
+    end
+
+    it 'omits global id debug info if not given' do
+      id = described_class.for_user(user_uuid: 'user-uuid', account_uuid: 'acct-uuid')
+      expect(id.jwt_payload.keys).not_to include(:debug_user_global_id)
+      expect(id.jwt_payload.keys).not_to include(:debug_masq_global_id)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inst_access
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Michael Ziwisky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-05 00:00:00.000000000 Z
+date: 2021-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-ast
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -170,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Generation, parsing, and validation of Instructure access tokens