tcell_agent 0.4.0 → 1.0.0

data/spec/lib/tcell_agent/hooks/login_fraud_spec.rb

@@ -1,14 +1,12 @@
 require 'spec_helper'
 
 module TCellAgent
-
   module Hooks
     module V1
       module Frameworks
         module Rails
           module Login
-            def self.register_login_event(status, rails_request, user_id, user_valid=nil)
-            end
+            def self.register_login_event(status, rails_request, user_id, user_valid = nil, password = nil); end
           end
         end
       end
@@ -18,55 +16,55 @@ module TCellAgent
   module Hooks
     module V1
       module Login
-        LOGIN_SUCCESS = "success"
-        LOGIN_FAILURE = "failure"
-        def self.register_login_event(status, session_id, user_agent, referrer, remote_addr, header_keys, user_id, document_uri, user_valid=nil)
-        end
+        LOGIN_SUCCESS = 'success'.freeze
+        LOGIN_FAILURE = 'failure'.freeze
+
+        def self.register_login_event(status, session_id, user_agent, referrer, remote_addr, header_keys, user_id, document_uri, user_valid = nil, password = nil); end
       end
     end
   end
 
-  describe "manually requiring auth hooks" do
+  describe 'manually requiring auth hooks' do
     before(:all) do
       require 'tcell_agent/hooks/login_fraud'
     end
 
-    describe "Using generic interface" do
-      context "with a login failure" do
-        context "with login_failed_enabled set to true" do
-          it "should report the login failure" do
-            login_fraud = double("login_fraud", enabled: true, login_failed_enabled: true)
+    describe 'Using generic interface' do
+      context 'with a login failure' do
+        context 'with login_failed_enabled set to true' do
+          it 'should report the login failure' do
+            login_fraud = double('login_fraud', :enabled => true, :login_failed_enabled => true)
 
             expect(TCellAgent).to receive(:policy).with(TCellAgent::PolicyTypes::LoginFraud).and_return(
               login_fraud
             )
             expect(TCellAgent).to receive(:send_event).with(
               {
-                "event_type" => "login",
-                "header_keys" => ["USER_AGENT", "X_FORWARDED_FOR"],
-                "user_agent" => "user_agent",
-                "referrer" => "referrer",
-                "remote_addr" => "1.1.1.1",
-                "user_id" => "user_id",
-                "document_uri" => "http://tcell.tcell.io/login?param_name=",
-                "session" => "48c0ce7961d8d5d4bd57bd77976b3d38",
-                "event_name" => "login-failure"
+                'event_type' => 'login',
+                'header_keys' => %w[USER_AGENT X_FORWARDED_FOR],
+                'user_agent' => 'user_agent',
+                'referrer' => 'referrer',
+                'remote_addr' => '1.1.1.1',
+                'user_id' => 'user_id',
+                'document_uri' => 'http://tcell.tcell.io/login?param_name=',
+                'session' => '48c0ce7961d8d5d4bd57bd77976b3d38',
+                'event_name' => 'login-failure'
               }
             )
 
             status = Hooks::V1::Login::LOGIN_FAILURE
-            header_keys = ["HTTP_USER_AGENT", "HTTP_X_FORWARDED_FOR"]
-            document_uri = "http://tcell.tcell.io/login?param_name=param_value"
+            header_keys = %w[HTTP_USER_AGENT HTTP_X_FORWARDED_FOR]
+            document_uri = 'http://tcell.tcell.io/login?param_name=param_value'
 
             Hooks::V1::Login.register_login_event(
-              status, "session_id", "user_agent", "referrer", "1.1.1.1", header_keys, "user_id", document_uri
+              status, 'session_id', 'user_agent', 'referrer', '1.1.1.1', header_keys, 'user_id', document_uri
             )
           end
         end
 
-        context "with login_failed_enabled set to false" do
-          it "should NOT report the login failure" do
-            login_fraud = double("login_fraud", enabled: true, login_failed_enabled: false)
+        context 'with login_failed_enabled set to false' do
+          it 'should NOT report the login failure' do
+            login_fraud = double('login_fraud', :enabled => true, :login_failed_enabled => false)
 
             expect(TCellAgent).to receive(:policy).with(TCellAgent::PolicyTypes::LoginFraud).and_return(
               login_fraud
@@ -74,51 +72,51 @@ module TCellAgent
             expect(TCellAgent).to_not receive(:send_event)
 
             status = Hooks::V1::Login::LOGIN_FAILURE
-            header_keys = ["HTTP_USER_AGENT", "HTTP_X_FORWARDED_FOR"]
-            document_uri = "http://tcell.tcell.io/login?param_name=param_value"
+            header_keys = %w[HTTP_USER_AGENT HTTP_X_FORWARDED_FOR]
+            document_uri = 'http://tcell.tcell.io/login?param_name=param_value'
 
             Hooks::V1::Login.register_login_event(
-              status, "session_id", "user_agent", "referrer", "1.1.1.1", header_keys, "user_id", document_uri
+              status, 'session_id', 'user_agent', 'referrer', '1.1.1.1', header_keys, 'user_id', document_uri
             )
           end
         end
       end
 
-      context "with a login success" do
-        context "with login_success_enabled set to true" do
-          it "should report the login success" do
-            login_fraud = double("login_fraud", enabled: true, login_success_enabled: true)
+      context 'with a login success' do
+        context 'with login_success_enabled set to true' do
+          it 'should report the login success' do
+            login_fraud = double('login_fraud', :enabled => true, :login_success_enabled => true)
 
             expect(TCellAgent).to receive(:policy).with(TCellAgent::PolicyTypes::LoginFraud).and_return(
               login_fraud
             )
             expect(TCellAgent).to receive(:send_event).with(
               {
-                "event_type" => "login",
-                "header_keys" => ["USER_AGENT", "X_FORWARDED_FOR"],
-                "user_agent" => "user_agent",
-                "referrer" => "referrer",
-                "remote_addr" => "1.1.1.1",
-                "user_id" => "user_id",
-                "document_uri" => "http://tcell.tcell.io/login?param_name=",
-                "session" => "48c0ce7961d8d5d4bd57bd77976b3d38",
-                "event_name" => "login-success"
+                'event_type' => 'login',
+                'header_keys' => %w[USER_AGENT X_FORWARDED_FOR],
+                'user_agent' => 'user_agent',
+                'referrer' => 'referrer',
+                'remote_addr' => '1.1.1.1',
+                'user_id' => 'user_id',
+                'document_uri' => 'http://tcell.tcell.io/login?param_name=',
+                'session' => '48c0ce7961d8d5d4bd57bd77976b3d38',
+                'event_name' => 'login-success'
               }
             )
 
             status = Hooks::V1::Login::LOGIN_SUCCESS
-            header_keys = ["HTTP_USER_AGENT", "HTTP_X_FORWARDED_FOR"]
-            document_uri = "http://tcell.tcell.io/login?param_name=param_value"
+            header_keys = %w[HTTP_USER_AGENT HTTP_X_FORWARDED_FOR]
+            document_uri = 'http://tcell.tcell.io/login?param_name=param_value'
 
             Hooks::V1::Login.register_login_event(
-              status, "session_id", "user_agent", "referrer", "1.1.1.1", header_keys, "user_id", document_uri
+              status, 'session_id', 'user_agent', 'referrer', '1.1.1.1', header_keys, 'user_id', document_uri
             )
           end
         end
 
-        context "with login_success_enabled set to false" do
-          it "should NOT report the login success" do
-            login_fraud = double("login_fraud", enabled: true, login_success_enabled: false)
+        context 'with login_success_enabled set to false' do
+          it 'should NOT report the login success' do
+            login_fraud = double('login_fraud', :enabled => true, :login_success_enabled => false)
 
             expect(TCellAgent).to receive(:policy).with(TCellAgent::PolicyTypes::LoginFraud).and_return(
               login_fraud
@@ -126,58 +124,57 @@ module TCellAgent
             expect(TCellAgent).to_not receive(:send_event)
 
             status = Hooks::V1::Login::LOGIN_SUCCESS
-            header_keys = ["HTTP_USER_AGENT", "HTTP_X_FORWARDED_FOR"]
-            document_uri = "http://tcell.tcell.io/login?param_name=param_value"
+            header_keys = %w[HTTP_USER_AGENT HTTP_X_FORWARDED_FOR]
+            document_uri = 'http://tcell.tcell.io/login?param_name=param_value'
 
             Hooks::V1::Login.register_login_event(
-              status, "session_id", "user_agent", "referrer", "1.1.1.1", header_keys, "user_id", document_uri
+              status, 'session_id', 'user_agent', 'referrer', '1.1.1.1', header_keys, 'user_id', document_uri
             )
           end
         end
       end
 
-      context "with an unknown status" do
-        it "should log the error" do
-          login_fraud = double("login_fraud", enabled: true)
-          logger = double("logger")
+      context 'with an unknown status' do
+        it 'should log the error' do
+          login_fraud = double('login_fraud', :enabled => true)
+          logger = double('logger')
 
           expect(TCellAgent).to receive(:policy).with(TCellAgent::PolicyTypes::LoginFraud).and_return(
             login_fraud
           )
           expect(TCellAgent).to_not receive(:send_event)
           expect(TCellAgent).to receive(:logger).and_return(logger)
-          expect(logger).to receive(:error).with("Unkown login status: mumbo-jumbo")
+          expect(logger).to receive(:error).with('Unkown login status: mumbo-jumbo')
 
-          status = "mumbo-jumbo"
-          header_keys = ["HTTP_USER_AGENT", "HTTP_X_FORWARDED_FOR"]
-          document_uri = "http://tcell.tcell.io/login?param_name=param_value"
+          status = 'mumbo-jumbo'
+          header_keys = %w[HTTP_USER_AGENT HTTP_X_FORWARDED_FOR]
+          document_uri = 'http://tcell.tcell.io/login?param_name=param_value'
 
           Hooks::V1::Login.register_login_event(
-            status, "session_id", "user_agent", "referrer", "1.1.1.1", header_keys, "user_id", document_uri
+            status, 'session_id', 'user_agent', 'referrer', '1.1.1.1', header_keys, 'user_id', document_uri
           )
         end
       end
     end
 
-    describe "Using rails interface" do
-      context "with a login failure" do
-        context "with login_failed_enabled set to true" do
-          it "should report the login failure" do
-            login_fraud = double("login_fraud", enabled: true, login_failed_enabled: true)
-            rails_request = double("rails_request")
+    describe 'Using rails interface' do
+      context 'with a login failure' do
+        context 'with login_failed_enabled set to true' do
+          it 'should report the login failure' do
+            login_fraud = double('login_fraud', :enabled => true, :login_failed_enabled => true)
+            rails_request = double('rails_request')
             tcell_data = TCellAgent::Instrumentation::TCellData.new
-            tcell_data.user_agent = "user_agent"
-            tcell_data.referrer = "referrer"
-            tcell_data.ip_address = "1.1.1.1"
-            tcell_data.path = "http://tcell.tcell.io/login?param_name=param_value"
-            tcell_data.hmac_session_id = TCellAgent::SensorEvents::Util.hmac("session_id")
+            tcell_data.user_agent = 'user_agent'
+            tcell_data.referrer = 'referrer'
+            tcell_data.ip_address = '1.1.1.1'
+            tcell_data.path = 'http://tcell.tcell.io/login?param_name=param_value'
+            tcell_data.hmac_session_id = TCellAgent::SensorEvents::Util.hmac('session_id')
             request_env = {
               TCellAgent::Instrumentation::TCELL_ID => tcell_data,
-              "HTTP_USER_AGENT" => true,
-              "HTTP_X_FORWARDED_FOR" => true
+              'HTTP_USER_AGENT' => true,
+              'HTTP_X_FORWARDED_FOR' => true
             }
 
-
             expect(TCellAgent).to receive(:policy).with(TCellAgent::PolicyTypes::LoginFraud).and_return(
               login_fraud
             )
@@ -185,43 +182,42 @@ module TCellAgent
             expect(rails_request).to receive(:env).and_return(request_env)
             expect(TCellAgent).to receive(:send_event).with(
               {
-                "event_type" => "login",
-                "header_keys" => ["USER_AGENT", "X_FORWARDED_FOR"],
-                "user_agent" => "user_agent",
-                "referrer" => "referrer",
-                "remote_addr" => "1.1.1.1",
-                "user_id" => "user_id",
-                "document_uri" => "http://tcell.tcell.io/login?param_name=",
-                "session" => "48c0ce7961d8d5d4bd57bd77976b3d38",
-                "event_name" => "login-failure"
+                'event_type' => 'login',
+                'header_keys' => %w[USER_AGENT X_FORWARDED_FOR],
+                'user_agent' => 'user_agent',
+                'referrer' => 'referrer',
+                'remote_addr' => '1.1.1.1',
+                'user_id' => 'user_id',
+                'document_uri' => 'http://tcell.tcell.io/login?param_name=',
+                'session' => '48c0ce7961d8d5d4bd57bd77976b3d38',
+                'event_name' => 'login-failure'
               }
             )
 
             status = Hooks::V1::Login::LOGIN_FAILURE
 
             Hooks::V1::Frameworks::Rails::Login.register_login_event(
-              status, rails_request, "user_id"
+              status, rails_request, 'user_id'
             )
           end
         end
 
-        context "with login_failed_enabled set to false" do
-          it "should NOT report the login failure" do
-            login_fraud = double("login_fraud", enabled: true, login_failed_enabled: false)
-            rails_request = double("rails_request")
+        context 'with login_failed_enabled set to false' do
+          it 'should NOT report the login failure' do
+            login_fraud = double('login_fraud', :enabled => true, :login_failed_enabled => false)
+            rails_request = double('rails_request')
             tcell_data = TCellAgent::Instrumentation::TCellData.new
-            tcell_data.user_agent = "user_agent"
-            tcell_data.referrer = "referrer"
-            tcell_data.ip_address = "1.1.1.1"
-            tcell_data.path = "http://tcell.tcell.io/login?param_name=param_value"
-            tcell_data.hmac_session_id = TCellAgent::SensorEvents::Util.hmac("session_id")
+            tcell_data.user_agent = 'user_agent'
+            tcell_data.referrer = 'referrer'
+            tcell_data.ip_address = '1.1.1.1'
+            tcell_data.path = 'http://tcell.tcell.io/login?param_name=param_value'
+            tcell_data.hmac_session_id = TCellAgent::SensorEvents::Util.hmac('session_id')
             request_env = {
               TCellAgent::Instrumentation::TCELL_ID => tcell_data,
-              "HTTP_USER_AGENT" => true,
-              "HTTP_X_FORWARDED_FOR" => true
+              'HTTP_USER_AGENT' => true,
+              'HTTP_X_FORWARDED_FOR' => true
             }
 
-
             expect(TCellAgent).to receive(:policy).with(TCellAgent::PolicyTypes::LoginFraud).and_return(
               login_fraud
             )
@@ -232,30 +228,29 @@ module TCellAgent
             status = Hooks::V1::Login::LOGIN_FAILURE
 
             Hooks::V1::Frameworks::Rails::Login.register_login_event(
-              status, rails_request, "user_id"
+              status, rails_request, 'user_id'
             )
           end
         end
       end
 
-      context "with a login success" do
-        context "with login_success_enabled set to true" do
-          it "should report the login success" do
-            login_fraud = double("login_fraud", enabled: true, login_success_enabled: true)
-            rails_request = double("rails_request")
+      context 'with a login success' do
+        context 'with login_success_enabled set to true' do
+          it 'should report the login success' do
+            login_fraud = double('login_fraud', :enabled => true, :login_success_enabled => true)
+            rails_request = double('rails_request')
             tcell_data = TCellAgent::Instrumentation::TCellData.new
-            tcell_data.user_agent = "user_agent"
-            tcell_data.referrer = "referrer"
-            tcell_data.ip_address = "1.1.1.1"
-            tcell_data.path = "http://tcell.tcell.io/login?param_name=param_value"
-            tcell_data.hmac_session_id = TCellAgent::SensorEvents::Util.hmac("session_id")
+            tcell_data.user_agent = 'user_agent'
+            tcell_data.referrer = 'referrer'
+            tcell_data.ip_address = '1.1.1.1'
+            tcell_data.path = 'http://tcell.tcell.io/login?param_name=param_value'
+            tcell_data.hmac_session_id = TCellAgent::SensorEvents::Util.hmac('session_id')
             request_env = {
               TCellAgent::Instrumentation::TCELL_ID => tcell_data,
-              "HTTP_USER_AGENT" => true,
-              "HTTP_X_FORWARDED_FOR" => true
+              'HTTP_USER_AGENT' => true,
+              'HTTP_X_FORWARDED_FOR' => true
             }
 
-
             expect(TCellAgent).to receive(:policy).with(TCellAgent::PolicyTypes::LoginFraud).and_return(
               login_fraud
             )
@@ -263,43 +258,42 @@ module TCellAgent
             expect(rails_request).to receive(:env).and_return(request_env)
             expect(TCellAgent).to receive(:send_event).with(
               {
-                "event_type" => "login",
-                "header_keys" => ["USER_AGENT", "X_FORWARDED_FOR"],
-                "user_agent" => "user_agent",
-                "referrer" => "referrer",
-                "remote_addr" => "1.1.1.1",
-                "user_id" => "user_id",
-                "document_uri" => "http://tcell.tcell.io/login?param_name=",
-                "session" => "48c0ce7961d8d5d4bd57bd77976b3d38",
-                "event_name" => "login-success"
+                'event_type' => 'login',
+                'header_keys' => %w[USER_AGENT X_FORWARDED_FOR],
+                'user_agent' => 'user_agent',
+                'referrer' => 'referrer',
+                'remote_addr' => '1.1.1.1',
+                'user_id' => 'user_id',
+                'document_uri' => 'http://tcell.tcell.io/login?param_name=',
+                'session' => '48c0ce7961d8d5d4bd57bd77976b3d38',
+                'event_name' => 'login-success'
               }
             )
 
             status = Hooks::V1::Login::LOGIN_SUCCESS
 
             Hooks::V1::Frameworks::Rails::Login.register_login_event(
-              status, rails_request, "user_id"
+              status, rails_request, 'user_id'
             )
           end
         end
 
-        context "with login_success_enabled set to false" do
-          it "should NOT report the login success" do
-            login_fraud = double("login_fraud", enabled: true, login_success_enabled: false)
-            rails_request = double("rails_request")
+        context 'with login_success_enabled set to false' do
+          it 'should NOT report the login success' do
+            login_fraud = double('login_fraud', :enabled => true, :login_success_enabled => false)
+            rails_request = double('rails_request')
             tcell_data = TCellAgent::Instrumentation::TCellData.new
-            tcell_data.user_agent = "user_agent"
-            tcell_data.referrer = "referrer"
-            tcell_data.ip_address = "1.1.1.1"
-            tcell_data.path = "http://tcell.tcell.io/login?param_name=param_value"
-            tcell_data.hmac_session_id = TCellAgent::SensorEvents::Util.hmac("session_id")
+            tcell_data.user_agent = 'user_agent'
+            tcell_data.referrer = 'referrer'
+            tcell_data.ip_address = '1.1.1.1'
+            tcell_data.path = 'http://tcell.tcell.io/login?param_name=param_value'
+            tcell_data.hmac_session_id = TCellAgent::SensorEvents::Util.hmac('session_id')
             request_env = {
               TCellAgent::Instrumentation::TCELL_ID => tcell_data,
-              "HTTP_USER_AGENT" => true,
-              "HTTP_X_FORWARDED_FOR" => true
+              'HTTP_USER_AGENT' => true,
+              'HTTP_X_FORWARDED_FOR' => true
             }
 
-
             expect(TCellAgent).to receive(:policy).with(TCellAgent::PolicyTypes::LoginFraud).and_return(
               login_fraud
             )
@@ -310,30 +304,29 @@ module TCellAgent
             status = Hooks::V1::Login::LOGIN_SUCCESS
 
             Hooks::V1::Frameworks::Rails::Login.register_login_event(
-              status, rails_request, "user_id"
+              status, rails_request, 'user_id'
             )
           end
         end
       end
 
-      context "with an unknown status" do
-        it "should log the error" do
-          login_fraud = double("login_fraud", enabled: true, login_failed_enabled: true)
-          logger = double("logger")
-          rails_request = double("rails_request")
+      context 'with an unknown status' do
+        it 'should log the error' do
+          login_fraud = double('login_fraud', :enabled => true, :login_failed_enabled => true)
+          logger = double('logger')
+          rails_request = double('rails_request')
           tcell_data = TCellAgent::Instrumentation::TCellData.new
-          tcell_data.user_agent = "user_agent"
-          tcell_data.referrer = "referrer"
-          tcell_data.ip_address = "1.1.1.1"
-          tcell_data.path = "http://tcell.tcell.io/login?param_name=param_value"
-          tcell_data.hmac_session_id = TCellAgent::SensorEvents::Util.hmac("session_id")
+          tcell_data.user_agent = 'user_agent'
+          tcell_data.referrer = 'referrer'
+          tcell_data.ip_address = '1.1.1.1'
+          tcell_data.path = 'http://tcell.tcell.io/login?param_name=param_value'
+          tcell_data.hmac_session_id = TCellAgent::SensorEvents::Util.hmac('session_id')
           request_env = {
             TCellAgent::Instrumentation::TCELL_ID => tcell_data,
-            "HTTP_USER_AGENT" => true,
-            "HTTP_X_FORWARDED_FOR" => true
+            'HTTP_USER_AGENT' => true,
+            'HTTP_X_FORWARDED_FOR' => true
           }
 
-
           expect(TCellAgent).to receive(:policy).with(TCellAgent::PolicyTypes::LoginFraud).and_return(
             login_fraud
           )
@@ -341,17 +334,15 @@ module TCellAgent
           expect(rails_request).to receive(:env).and_return(request_env)
           expect(TCellAgent).to_not receive(:send_event)
           expect(TCellAgent).to receive(:logger).and_return(logger)
-          expect(logger).to receive(:error).with("Unkown login status: mumbo-jumbo")
+          expect(logger).to receive(:error).with('Unkown login status: mumbo-jumbo')
 
-          status = "mumbo-jumbo"
+          status = 'mumbo-jumbo'
 
           Hooks::V1::Frameworks::Rails::Login.register_login_event(
-            status, rails_request, "user_id"
+            status, rails_request, 'user_id'
           )
         end
       end
     end
-
   end
-
 end