sso 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9660c9f78d14f395529c39a41a4355c7b0141cd
-  data.tar.gz: 56552af9e5cc37cae7ef084c68e80a0ac0a4d4c0
+  metadata.gz: a1612060577f395274bade4fb34686a7762d7a18
+  data.tar.gz: bc1c6cf750efdf8b5a94e8ab93e81a49d9e7c1be
 SHA512:
-  metadata.gz: b86244b2218c89bdac9433bf12c69ee0119e834cc1ec2c9d24a260e5121c05810a28cfbdb70cb012032383e59c1969e8322e5be21a7ef67b10973de0af66c8a5
-  data.tar.gz: 2823fc5f108f37bda20eaf72c75abaa70db5a270cb5522fa7d2dee388e57d26990d8a2010d2d283946bf3cef28d36a62be6254eea09b7f0fe3af9319185f30f4
+  metadata.gz: 64685ba474ed7bee87c26c7f0809d1f6a12d1b3f461cdbd22a6fc44fb733c7d3824d903e9fd01c918dc1533a8cb9263088cb4a350ad968f7a3710e787fad1772
+  data.tar.gz: 5a573a497c99e35bf9cd5b44aa5157988d7a9eaba2aed9b7da809e41c8f4b057b5ec7f8a67d43a2461f43f4beb301d12065f0fbc053d3422e786fc88becc70db

data/lib/sso/benchmarking.rb

@@ -12,7 +12,7 @@ module SSO
       end
       milliseconds = (seconds * 1000).round
       debug { "#{name || metric || 'Benchmark'} took #{milliseconds}ms" }
-      histogram key: metric, value: milliseconds if metric
+      timing key: metric, value: milliseconds if metric
       result
     end
   end

data/lib/sso/client/warden/hooks/after_fetch.rb

@@ -123,11 +123,12 @@ module SSO
           end
 
           def meter(key, data = {})
-            options[:key] = "client.warden.hooks.after_fetch.#{key}"
-            options[:tags] = { scope: warden_scope }
+            metrics = {}
+            metrics[:key] = "client.warden.hooks.after_fetch.#{key}"
+            metrics[:tags] = { scope: warden_scope }
             data[:passport_id] = passport.id
-            options[:data] = data
-            track options
+            metrics[:data] = data
+            track metrics
           end
 
           # TODO: Use ActionDispatch remote IP or you might get the Load Balancer's IP instead :(

data/lib/sso/client/warden/strategies/passport.rb

@@ -15,14 +15,17 @@ module SSO
             debug { 'Authenticating from Passport...' }
 
             authentication = passport_authentication
+            track key: 'client.warden.strategies.passport.authentication', tags: { scope: scope }
 
             if authentication.success?
               debug { 'Authentication on Client from Passport successful.' }
               debug { "Persisting trusted Passport #{authentication.object.inspect}" }
+              track key: "client.warden.strategies.passport.#{authentication.code}", tags: { scope: scope }
               success! authentication.object
             else
               debug { 'Authentication from Passport on Client failed.' }
               debug { "Responding with #{authentication.object.inspect}" }
+              track key: "client.warden.strategies.passport.#{authentication.code}", tags: { scope: scope }
               custom! authentication.object
             end
 
@@ -31,7 +34,7 @@ module SSO
           end
 
           def passport_authentication
-            benchmark(name: 'Passport proxy verification request', metric: 'client.passport.verification') do
+            benchmark(name: 'Passport proxy verification request', metric: 'client.passport.proxy_verification.duration') do
               ::SSO::Client::Authentications::Passport.new(request).authenticate
             end
           end

data/lib/sso/meter.rb

@@ -4,17 +4,17 @@ module SSO
 
     def track(key:, value: 1, tags: nil, data: {})
       data[:caller] = caller_name
-      # info { "Measuring increment #{key.inspect} with value #{value.inspect} and tags #{tags} and data #{data}" }
+      debug { "Measuring increment #{key.inspect} with value #{value.inspect} and tags #{tags.inspect} and data #{data.inspect}" }
       metric.call type: :increment, key: "sso.#{key}", value: value, tags: tags, data: data
 
     rescue => exception
       ::SSO.config.exception_handler.call exception
     end
 
-    def histogram(key:, value:, tags: nil, data: {})
+    def timing(key:, value:, tags: nil, data: {})
       data[:caller] = caller_name
-      # info { "Measuring histogram #{key.inspect} with value #{value.inspect} and tags #{tags} and data #{data}" }
-      metric.call type: :histogram, key: "sso.#{key}", value: value, tags: tags, data: data
+      debug { "Measuring timing #{key.inspect} with value #{value.inspect} and tags #{tags.inspect} and data #{data.inspect}" }
+      metric.call type: :timing, key: "sso.#{key}", value: value, tags: tags, data: data
 
     rescue => exception
       ::SSO.config.exception_handler.call exception

data/lib/sso/server/warden/strategies/passport.rb

@@ -14,13 +14,16 @@ module SSO
             debug { 'Authenticating from Passport...' }
 
             authentication = passport_authentication
+            track key: 'server.warden.strategies.passport.authentication'
 
             if authentication.success?
               debug { 'Authentication on Server from Passport successful.' }
               debug { "Responding with #{authentication.object}" }
+              track key: "server.warden.strategies.passport.#{authentication.code}"
               custom! authentication.object
             else
               debug { 'Authentication from Passport on Server failed.' }
+              track key: "server.warden.strategies.passport.#{authentication.code}"
               custom! authentication.object
             end
 

data/spec/lib/sso/benchmarking_spec.rb

@@ -45,35 +45,37 @@ RSpec.describe ::SSO::Benchmarking do
         end
 
         it 'does not meter' do
-          expect(instance).to_not receive(:histogram)
+          expect(instance).to_not receive(:timing)
           instance.benchmark(name: 'Long calculation') {}
         end
       end
 
       context 'only with metric' do
         it 'logs with the metric' do
-          expect(instance).to receive(:debug) do |_, &block|
+          expect(instance).to receive(:debug).twice do |_, &block|
+            next if block.call.include?('Measuring')
             expect(block.call).to eq 'blob.serialization took 0ms'
           end
           instance.benchmark(metric: 'blob.serialization') {}
         end
 
-        it 'meters as histogram with the metric as name' do
-          expect(instance).to receive(:histogram).with key: 'blob.serialization', value: 0
+        it 'meters as timing with the metric as name' do
+          expect(instance).to receive(:timing).with key: 'blob.serialization', value: 0
           instance.benchmark(metric: 'blob.serialization') {}
         end
       end
 
       context 'with name and metric' do
         it 'logs with the name' do
-          expect(instance).to receive(:debug) do |_, &block|
+          expect(instance).to receive(:debug).twice do |_, &block|
+            next if block.call.include?('Measuring')
             expect(block.call).to eq 'Synchronous encryption took 0ms'
           end
           instance.benchmark(name: 'Synchronous encryption', metric: 'encryption.aes') {}
         end
 
-        it 'meters as histogram with the metric as name' do
-          expect(instance).to receive(:histogram).with key: 'encryption.aes', value: 0
+        it 'meters as timing with the metric as name' do
+          expect(instance).to receive(:timing).with key: 'encryption.aes', value: 0
           instance.benchmark(name: 'Synchronous encryption', metric: 'encryption.aes') {}
         end
       end

data/spec/lib/sso/client/warden/hooks/after_fetch_spec.rb

@@ -7,7 +7,8 @@ RSpec.describe SSO::Client::Warden::Hooks::AfterFetch, type: :request, db: true,
   let(:client_params)   { { device_id: 'unique device identifier' } }
   let(:warden_request)  { double :warden_request, ip: ip, user_agent: agent, params: client_params, env: warden_env }
   let(:warden)          { double :warden, request: warden_request }
-  let(:hook)            { described_class.new passport: client_passport, warden: warden, options: {} }
+  let(:hook)            { described_class.new passport: client_passport, warden: warden, options: { scope: warden_scope } }
+  let(:warden_scope)    {}
   let(:client_user)     { double :client_user, name: 'Good old client user' }
   let(:client_passport) { ::SSO::Client::Passport.new id: passport_id, secret: passport_secret, state: passport_state, user: client_user }
   let(:operation)       { hook.call }
@@ -60,10 +61,24 @@ RSpec.describe SSO::Client::Warden::Hooks::AfterFetch, type: :request, db: true,
     end
 
     it 'meters the invalid passport' do
-      expect(::SSO.config.metric).to receive(:call).with type: :histogram, key: 'sso.client.passport.verification.duration', value: 42_000, tags: nil, data: { caller: 'SSO::Client::PassportVerifier' }
+      expect(::SSO.config.metric).to receive(:call).with type: :increment, key: 'sso.server.warden.strategies.passport.passport_authentication_failed', value: 1, tags: nil, data: { caller: 'SSO::Server::Warden::Strategies::Passport' }
+      expect(::SSO.config.metric).to receive(:call).with type: :increment, key: 'sso.server.warden.strategies.passport.authentication', value: 1, tags: nil, data: { caller: 'SSO::Server::Warden::Strategies::Passport' }
+      expect(::SSO.config.metric).to receive(:call).with type: :timing, key: 'sso.client.passport.verification.duration', value: 42_000, tags: nil, data: { caller: 'SSO::Client::PassportVerifier' }
       expect(::SSO.config.metric).to receive(:call).with type: :increment, key: 'sso.client.warden.hooks.after_fetch.invalid', value: 1, tags: { scope: nil }, data: { passport_id: client_passport.id, caller: 'SSO::Client::Warden::Hooks::AfterFetch' }
       hook.call
     end
+
+    context 'with warden scope' do
+      let(:warden_scope) { :vip }
+
+      it 'meters the invalid passport with the scope' do
+        expect(::SSO.config.metric).to receive(:call).with type: :increment, key: 'sso.server.warden.strategies.passport.passport_authentication_failed', value: 1, tags: nil, data: { caller: 'SSO::Server::Warden::Strategies::Passport' }
+        expect(::SSO.config.metric).to receive(:call).with type: :increment, key: 'sso.server.warden.strategies.passport.authentication', value: 1, tags: nil, data: { caller: 'SSO::Server::Warden::Strategies::Passport' }
+        expect(::SSO.config.metric).to receive(:call).with type: :timing, key: 'sso.client.passport.verification.duration', value: 42_000, tags: nil, data: { caller: 'SSO::Client::PassportVerifier' }
+        expect(::SSO.config.metric).to receive(:call).with type: :increment, key: 'sso.client.warden.hooks.after_fetch.invalid', value: 1, tags: { scope: :vip }, data: { passport_id: client_passport.id, caller: 'SSO::Client::Warden::Hooks::AfterFetch' }
+        hook.call
+      end
+    end
   end
 
   context 'user does not change' do
@@ -93,7 +108,9 @@ RSpec.describe SSO::Client::Warden::Hooks::AfterFetch, type: :request, db: true,
     end
 
     it 'meters the invalid passport' do
-      expect(::SSO.config.metric).to receive(:call).with type: :histogram, key: 'sso.client.passport.verification.duration', value: 42_000, tags: nil, data: { caller: 'SSO::Client::PassportVerifier' }
+      expect(::SSO.config.metric).to receive(:call).with type: :increment, key: 'sso.server.warden.strategies.passport.signature_approved_no_changes', value: 1, tags: nil, data: { caller: 'SSO::Server::Warden::Strategies::Passport' }
+      expect(::SSO.config.metric).to receive(:call).with type: :increment, key: 'sso.server.warden.strategies.passport.authentication', value: 1, tags: nil, data: { caller: 'SSO::Server::Warden::Strategies::Passport' }
+      expect(::SSO.config.metric).to receive(:call).with type: :timing, key: 'sso.client.passport.verification.duration', value: 42_000, tags: nil, data: { caller: 'SSO::Client::PassportVerifier' }
       expect(::SSO.config.metric).to receive(:call).with type: :increment, key: 'sso.client.warden.hooks.after_fetch.valid', value: 1, tags: { scope: nil }, data: { passport_id: client_passport.id, caller: 'SSO::Client::Warden::Hooks::AfterFetch' }
       hook.call
     end
@@ -131,7 +148,9 @@ RSpec.describe SSO::Client::Warden::Hooks::AfterFetch, type: :request, db: true,
     end
 
     it 'meters the invalid passport' do
-      expect(::SSO.config.metric).to receive(:call).with type: :histogram, key: 'sso.client.passport.verification.duration', value: 42_000, tags: nil, data: { caller: 'SSO::Client::PassportVerifier' }
+      expect(::SSO.config.metric).to receive(:call).with type: :increment, key: 'sso.server.warden.strategies.passport.signature_approved_no_changes', value: 1, tags: nil, data: { caller: 'SSO::Server::Warden::Strategies::Passport' }
+      expect(::SSO.config.metric).to receive(:call).with type: :increment, key: 'sso.server.warden.strategies.passport.authentication', value: 1, tags: nil, data: { caller: 'SSO::Server::Warden::Strategies::Passport' }
+      expect(::SSO.config.metric).to receive(:call).with type: :timing, key: 'sso.client.passport.verification.duration', value: 42_000, tags: nil, data: { caller: 'SSO::Client::PassportVerifier' }
       expect(::SSO.config.metric).to receive(:call).with type: :increment, key: 'sso.client.warden.hooks.after_fetch.valid', value: 1, tags: { scope: nil }, data: { passport_id: client_passport.id, caller: 'SSO::Client::Warden::Hooks::AfterFetch' }
       hook.call
     end
@@ -169,7 +188,9 @@ RSpec.describe SSO::Client::Warden::Hooks::AfterFetch, type: :request, db: true,
     end
 
     it 'meters the invalid passport' do
-      expect(::SSO.config.metric).to receive(:call).with type: :histogram, key: 'sso.client.passport.verification.duration', value: 42_000, tags: nil, data: { caller: 'SSO::Client::PassportVerifier' }
+      expect(::SSO.config.metric).to receive(:call).with type: :increment, key: 'sso.server.warden.strategies.passport.signature_approved_state_changed', value: 1, tags: nil, data: { caller: 'SSO::Server::Warden::Strategies::Passport' }
+      expect(::SSO.config.metric).to receive(:call).with type: :increment, key: 'sso.server.warden.strategies.passport.authentication', value: 1, tags: nil, data: { caller: 'SSO::Server::Warden::Strategies::Passport' }
+      expect(::SSO.config.metric).to receive(:call).with type: :timing, key: 'sso.client.passport.verification.duration', value: 42_000, tags: nil, data: { caller: 'SSO::Client::PassportVerifier' }
       expect(::SSO.config.metric).to receive(:call).with type: :increment, key: 'sso.client.warden.hooks.after_fetch.valid_and_modified', value: 1, tags: { scope: nil }, data: { passport_id: client_passport.id, caller: 'SSO::Client::Warden::Hooks::AfterFetch' }
       hook.call
     end
@@ -208,7 +229,7 @@ RSpec.describe SSO::Client::Warden::Hooks::AfterFetch, type: :request, db: true,
     end
 
     it 'meters the timeout' do
-      expect(::SSO.config.metric).to receive(:call).with type: :histogram, key: 'sso.client.passport.verification.duration', value: 42_000, tags: nil, data: { caller: 'SSO::Client::PassportVerifier' }
+      expect(::SSO.config.metric).to receive(:call).with type: :timing, key: 'sso.client.passport.verification.duration', value: 42_000, tags: nil, data: { caller: 'SSO::Client::PassportVerifier' }
       expect(::SSO.config.metric).to receive(:call).with type: :increment, key: 'sso.client.warden.hooks.after_fetch.server_unreachable', value: 1, tags: { scope: nil }, data: { passport_id: client_passport.id, caller: 'SSO::Client::Warden::Hooks::AfterFetch' }
       hook.call
     end
@@ -231,7 +252,7 @@ RSpec.describe SSO::Client::Warden::Hooks::AfterFetch, type: :request, db: true,
     end
 
     it 'meters the timeout' do
-      expect(::SSO.config.metric).to receive(:call).with type: :histogram, key: 'sso.client.passport.verification.duration', value: 42_000, tags: nil, data: { caller: 'SSO::Client::PassportVerifier' }
+      expect(::SSO.config.metric).to receive(:call).with type: :timing, key: 'sso.client.passport.verification.duration', value: 42_000, tags: nil, data: { caller: 'SSO::Client::PassportVerifier' }
       expect(::SSO.config.metric).to receive(:call).with type: :increment, key: 'sso.client.warden.hooks.after_fetch.server_response_not_parseable', value: 1, tags: { scope: nil }, data: { passport_id: client_passport.id, caller: 'SSO::Client::Warden::Hooks::AfterFetch' }
       hook.call
     end
@@ -253,7 +274,7 @@ RSpec.describe SSO::Client::Warden::Hooks::AfterFetch, type: :request, db: true,
     end
 
     it 'meters the timeout' do
-      expect(::SSO.config.metric).to receive(:call).with type: :histogram, key: 'sso.client.passport.verification.duration', value: 42_000, tags: nil, data: { caller: 'SSO::Client::PassportVerifier' }
+      expect(::SSO.config.metric).to receive(:call).with type: :timing, key: 'sso.client.passport.verification.duration', value: 42_000, tags: nil, data: { caller: 'SSO::Client::PassportVerifier' }
       expect(::SSO.config.metric).to receive(:call).with type: :increment, key: 'sso.client.warden.hooks.after_fetch.server_response_missing_success_flag', value: 1, tags: { scope: nil }, data: { passport_id: client_passport.id, caller: 'SSO::Client::Warden::Hooks::AfterFetch' }
       hook.call
     end
@@ -275,7 +296,7 @@ RSpec.describe SSO::Client::Warden::Hooks::AfterFetch, type: :request, db: true,
     end
 
     it 'meters the timeout' do
-      expect(::SSO.config.metric).to receive(:call).with type: :histogram, key: 'sso.client.passport.verification.duration', value: 42_000, tags: nil, data: { caller: 'SSO::Client::PassportVerifier' }
+      expect(::SSO.config.metric).to receive(:call).with type: :timing, key: 'sso.client.passport.verification.duration', value: 42_000, tags: nil, data: { caller: 'SSO::Client::PassportVerifier' }
       expect(::SSO.config.metric).to receive(:call).with type: :increment, key: 'sso.client.warden.hooks.after_fetch.unexpected_server_response_status', value: 1, tags: { scope: nil }, data: { passport_id: client_passport.id, caller: 'SSO::Client::Warden::Hooks::AfterFetch' }
       hook.call
     end

data/spec/lib/sso/client/warden/strategies/passport_spec.rb

@@ -1,9 +1,10 @@
 require 'spec_helper'
 
-RSpec.describe SSO::Client::Warden::Strategies::Passport do
+RSpec.describe SSO::Client::Warden::Strategies::Passport, stub_benchmarks: true do
 
   let(:env)      { env_with_params }
-  let(:strategy) { described_class.new env }
+  let(:strategy) { described_class.new env, scope }
+  let(:scope)    {}
 
   describe '#valid?' do
     context 'with :auth_version and :state' do
@@ -45,6 +46,24 @@ RSpec.describe SSO::Client::Warden::Strategies::Passport do
       it 'is a custom response' do
         expect(strategy.authenticate!).to eq :custom
       end
+
+      it 'meters' do
+        expect(::SSO.config.metric).to receive(:call).with type: :increment, key: 'sso.client.warden.strategies.passport.authentication', value: 1, tags: { scope: nil }, data: { caller: 'SSO::Client::Warden::Strategies::Passport' }
+        expect(::SSO.config.metric).to receive(:call).with type: :increment, key: 'sso.client.warden.strategies.passport.passport_authentication_failed', value: 1, tags: { scope: nil }, data: { caller: 'SSO::Client::Warden::Strategies::Passport' }
+        expect(::SSO.config.metric).to receive(:call).with type: :timing, key: 'sso.client.passport.proxy_verification.duration', value: 42_000, tags: nil, data: { caller: 'SSO::Client::Warden::Strategies::Passport' }
+        strategy.authenticate!
+      end
+
+      context 'with scope' do
+        let(:scope) { :cool }
+
+        it 'meters with the scope' do
+          expect(::SSO.config.metric).to receive(:call).with type: :increment, key: 'sso.client.warden.strategies.passport.authentication', value: 1, tags: { scope: :cool }, data: { caller: 'SSO::Client::Warden::Strategies::Passport' }
+          expect(::SSO.config.metric).to receive(:call).with type: :increment, key: 'sso.client.warden.strategies.passport.passport_authentication_failed', value: 1, tags: { scope: :cool }, data: { caller: 'SSO::Client::Warden::Strategies::Passport' }
+          expect(::SSO.config.metric).to receive(:call).with type: :timing, key: 'sso.client.passport.proxy_verification.duration', value: 42_000, tags: nil, data: { caller: 'SSO::Client::Warden::Strategies::Passport' }
+          strategy.authenticate!
+        end
+      end
     end
 
     it 'fails' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sso
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - halo