tcell_agent 0.4.0 → 1.0.0

data/spec/lib/tcell_agent/sensor_events/util/sanitizer_utilities_spec.rb

@@ -4,52 +4,52 @@ module TCellAgent
   module SensorEvents
     module Util
       describe Util do
-        context "SHA256 Hash test" do
-          it "Create simple HMAC" do
-            expect(Util).to receive(:get_hmac_key).and_return("testkey")
-            expect(Util.hmac("testdata")).to eq("220afe7c01cca398fff2fc2c3687be94")
+        context 'SHA256 Hash test' do
+          it 'Create simple HMAC' do
+            expect(Util).to receive(:get_hmac_key).and_return('testkey')
+            expect(Util.hmac('testdata')).to eq('220afe7c01cca398fff2fc2c3687be94')
           end
-          it "Check with config HMAC" do
+          it 'Check with config HMAC' do
             old_hmac = TCellAgent.configuration.hmac_key
-            hmac_key = "HMAC KEY 123"
+            hmac_key = 'HMAC KEY 123'
             TCellAgent.configuration.hmac_key = hmac_key
             expect(Util.get_hmac_key).to eq(hmac_key)
             TCellAgent.configuration.hmac_key = old_hmac
           end
         end
-        context "Parsing request cookies and replacing values" do
-          it "Parsing regular uri without params" do
+        context 'Parsing request cookies and replacing values' do
+          it 'Parsing regular uri without params' do
             TCellAgent.configuration.app_id = nil
-            original_uri = "http://foo.com/posts"
-            expect_santized_uri = "http://foo.com/posts"
+            original_uri = 'http://foo.com/posts'
+            expect_santized_uri = 'http://foo.com/posts'
             expect(Util.sanitize_uri(original_uri)).to eq(expect_santized_uri)
           end
-          it "Parsing regular uri with regular query string" do
+          it 'Parsing regular uri with regular query string' do
             TCellAgent.configuration.app_id = nil
-            original_uri = "http://foo.com/posts?abcd"
-            expect_santized_uri = "http://foo.com/posts?abcd="
+            original_uri = 'http://foo.com/posts?abcd'
+            expect_santized_uri = 'http://foo.com/posts?abcd='
             expect(Util.sanitize_uri(original_uri)).to eq(expect_santized_uri)
           end
-          it "Parsing uri" do
+          it 'Parsing uri' do
             TCellAgent.configuration.app_id = nil
-            original_uri = "http://foo.com/posts?id=30&limit=5#time=1305298413"
-            expect_santized_uri = "http://foo.com/posts?id=61aa3630ced0e67b63a1c61e3b86f4d3&limit=89abb06a7bf0401b5911e61b68660c24#time=1305298413"
+            original_uri = 'http://foo.com/posts?id=30&limit=5#time=1305298413'
+            expect_santized_uri = 'http://foo.com/posts?id=61aa3630ced0e67b63a1c61e3b86f4d3&limit=89abb06a7bf0401b5911e61b68660c24#time=1305298413'
             expect(Util.sanitize_uri(original_uri)).to eq(expect_santized_uri)
           end
-          it "returns an empty set" do
+          it 'returns an empty set' do
             TCellAgent.configuration.app_id = nil
-            expect(Util.santize_request_cookie_string("ABC")).to eq("")
-            expect(Util.santize_request_cookie_string("abcd=")).to match("")
+            expect(Util.santize_request_cookie_string('ABC')).to eq('')
+            expect(Util.santize_request_cookie_string('abcd=')).to match('')
           end
-          it "parses a cookie" do
+          it 'parses a cookie' do
             TCellAgent.configuration.app_id = nil
-            expect(Util.santize_request_cookie_string("x=y;z=a")).to eq("x=97cb9e2aa3ec93888b356dbcf13b280e;z=566c1a1c12ad909d628d4537e10773bf")
+            expect(Util.santize_request_cookie_string('x=y;z=a')).to eq('x=97cb9e2aa3ec93888b356dbcf13b280e;z=566c1a1c12ad909d628d4537e10773bf')
           end
         end
-        context "Parsing a response set-cookie and replacing values" do
-          it "sanitize a typical response set-cookie value" do
-            santized_string = Util.santize_response_cookie_string("name=Nicholas; expires=Sat, 02 May 2009 23:38:25 GMT; httponly")
-            expect(santized_string).to eq("name=beb56c04cdd764f6b7cbe6c078236aeb=; expires=Sat, 02 May 2009 23:38:25 GMT=; httponly=")
+        context 'Parsing a response set-cookie and replacing values' do
+          it 'sanitize a typical response set-cookie value' do
+            santized_string = Util.santize_response_cookie_string('name=Nicholas; expires=Sat, 02 May 2009 23:38:25 GMT; httponly')
+            expect(santized_string).to eq('name=beb56c04cdd764f6b7cbe6c078236aeb=; expires=Sat, 02 May 2009 23:38:25 GMT=; httponly=')
           end
         end
       end

data/spec/lib/tcell_agent/utils/bounded_queue_spec.rb

@@ -1,49 +1,47 @@
 require 'spec_helper'
 
 describe TCellAgent::BoundedQueue do
-
-  describe "#full?" do
-    it "should be true when the queue is full" do
+  describe '#full?' do
+    it 'should be true when the queue is full' do
       queue = TCellAgent::BoundedQueue.new(1)
-      queue.push("one")
+      queue.push('one')
       expect(queue.full?).to eq(true)
     end
 
-    it "should return false when the queue is not full" do
+    it 'should return false when the queue is not full' do
       queue = TCellAgent::BoundedQueue.new(1)
       expect(queue.full?).to eq(false)
     end
   end
 
-  describe "#push" do
-    context "pushing to a queue with space available" do
-      it "should push the item" do
+  describe '#push' do
+    context 'pushing to a queue with space available' do
+      it 'should push the item' do
         queue = TCellAgent::BoundedQueue.new(1)
-        queue.push("one")
+        queue.push('one')
 
         expect(queue.size).to eq(1)
       end
     end
 
-    context "pushing to a full queue" do
-      it "should not be possible to push anymore items" do
+    context 'pushing to a full queue' do
+      it 'should not be possible to push anymore items' do
         queue = TCellAgent::BoundedQueue.new(1)
-        queue.push("one")
+        queue.push('one')
 
         expect(queue.size).to eq(1)
         expect(queue.full?).to eq(true)
 
-        expect {
-          queue.push("two", 0.1)
-        }.to raise_error(RuntimeError)
+        expect do
+          queue.push('two', 0.1)
+        end.to raise_error(RuntimeError)
       end
     end
-
   end
 
-  describe "#pop" do
-    context "popping from an empty queue" do
-      it "should return nil when there are no items" do
+  describe '#pop' do
+    context 'popping from an empty queue' do
+      it 'should return nil when there are no items' do
         queue = TCellAgent::BoundedQueue.new(1)
         expect(queue.size).to eq(0)
 
@@ -51,5 +49,4 @@ describe TCellAgent::BoundedQueue do
       end
     end
   end
-
 end

data/spec/lib/tcell_agent/utils/params_spec.rb

@@ -1,39 +1,39 @@
-# encoding: utf-8
-
 require 'spec_helper'
 
 module TCellAgent
   module Utils
-
     describe Params do
-      context "flatten" do
-        it "should" do
+      context 'flatten' do
+        it 'should' do
           expect(
-            Params.flatten( {
-              action: "index",
-              utf8char: "Müller",
-              waitlist_entries: {email: "emailone", preferences: {email: "emaildos"}},
-              email_preferences: [:daily_digest, :reminders, "Müller"],
-              users: [
-                {email: "one@email.com"},
-                {email: "dos@email.com"},
-              ]
-            },
-            nil)
-          ).to eq({
-            ["action"]=>"index",
-            ["utf8char"] => "Müller",
-            ["waitlist_entries", "email"]=>"emailone",
-            ["waitlist_entries", "preferences", "email"]=>"emaildos",
-            [0, "email_preferences"]=>"daily_digest",
-            [1, "email_preferences"]=>"reminders",
-            [2, "email_preferences"]=>"Müller",
-            [0, "users", "email"]=>"one@email.com",
-            [1, "users", "email"]=>"dos@email.com"
-          })
+            Params.flatten(
+              {
+                :action => 'index',
+                :utf8char => 'Müller',
+                :waitlist_entries => { :email => 'emailone', :preferences => { :email => 'emaildos' } },
+                :email_preferences => [:daily_digest, :reminders, 'Müller'],
+                :users => [
+                  { :email => 'one@email.com' },
+                  { :email => 'dos@email.com' }
+                ]
+              },
+              nil
+            )
+          ).to eq(
+            {
+              ['action'] => 'index',
+              ['utf8char'] => 'Müller',
+              %w[waitlist_entries email] => 'emailone',
+              %w[waitlist_entries preferences email] => 'emaildos',
+              [0, 'email_preferences'] => 'daily_digest',
+              [1, 'email_preferences'] => 'reminders',
+              [2, 'email_preferences'] => 'Müller',
+              [0, 'users', 'email'] => 'one@email.com',
+              [1, 'users', 'email'] => 'dos@email.com'
+            }
+          )
         end
       end
     end
-
   end
 end

data/spec/lib/tcell_agent/utils/passwords_spec.rb

@@ -0,0 +1,143 @@
+require 'spec_helper'
+
+module TCellAgent
+  module Utils
+    describe '.fingerprint_password' do
+      context 'with nil password' do
+        it 'should return nil' do
+          configuration = double('configuration',
+                                 :app_id => 'app_id',
+                                 :password_hmac_key => 'password_hmac_key')
+
+          expect(TCellAgent).to receive(:configuration).and_return(
+            configuration
+          )
+          expect(TCellAgent).to receive(:configuration).and_return(
+            configuration
+          )
+
+          expect(Passwords.fingerprint_password(nil, nil)).to be_nil
+        end
+      end
+
+      context "with '' password" do
+        it 'should return nil' do
+          configuration = double('configuration',
+                                 :app_id => 'app_id',
+                                 :password_hmac_key => 'password_hmac_key')
+
+          expect(TCellAgent).to receive(:configuration).and_return(
+            configuration
+          )
+          expect(TCellAgent).to receive(:configuration).and_return(
+            configuration
+          )
+
+          expect(Passwords.fingerprint_password('', nil)).to be_nil
+        end
+      end
+
+      context "with '   ' password" do
+        it 'should return nil' do
+          configuration = double('configuration',
+                                 :app_id => 'app_id',
+                                 :password_hmac_key => 'password_hmac_key')
+
+          expect(TCellAgent).to receive(:configuration).and_return(
+            configuration
+          )
+          expect(TCellAgent).to receive(:configuration).and_return(
+            configuration
+          )
+
+          expect(Passwords.fingerprint_password('   ', nil)).to be_nil
+        end
+      end
+
+      context 'with nil password_hmac_key' do
+        it 'should return nil' do
+          configuration = double('configuration',
+                                 :app_id => 'app_id',
+                                 :password_hmac_key => nil)
+
+          expect(TCellAgent).to receive(:configuration).and_return(
+            configuration
+          )
+          expect(TCellAgent).to receive(:configuration).and_return(
+            configuration
+          )
+
+          expect(Passwords.fingerprint_password('admin123', nil)).to be_nil
+        end
+      end
+
+      context "with '' password_hmac_key" do
+        it 'should return nil' do
+          configuration = double('configuration',
+                                 :app_id => 'app_id',
+                                 :password_hmac_key => '')
+
+          expect(TCellAgent).to receive(:configuration).and_return(
+            configuration
+          )
+          expect(TCellAgent).to receive(:configuration).and_return(
+            configuration
+          )
+
+          expect(Passwords.fingerprint_password('admin123', nil)).to be_nil
+        end
+      end
+
+      context "with '   ' password_hmac_key" do
+        it 'should return nil' do
+          configuration = double('configuration',
+                                 :app_id => 'app_id',
+                                 :password_hmac_key => '   ')
+
+          expect(TCellAgent).to receive(:configuration).and_return(
+            configuration
+          )
+          expect(TCellAgent).to receive(:configuration).and_return(
+            configuration
+          )
+
+          expect(Passwords.fingerprint_password('admin123', nil)).to be_nil
+        end
+      end
+
+      context 'with no user_id' do
+        it 'should return digest' do
+          configuration = double('configuration',
+                                 :app_id => 'TestAppId-AppId',
+                                 :password_hmac_key => 'password_hmac_key')
+
+          expect(TCellAgent).to receive(:configuration).and_return(
+            configuration
+          )
+          expect(TCellAgent).to receive(:configuration).and_return(
+            configuration
+          )
+
+          expect(Passwords.fingerprint_password('admin123', nil)).to eq('83ff14db')
+        end
+      end
+
+      context 'with user_id present' do
+        it 'should return digest' do
+          configuration = double('configuration',
+                                 :app_id => 'TestAppId-AppId',
+                                 :password_hmac_key => 'password_hmac_key')
+
+          expect(TCellAgent).to receive(:configuration).and_return(
+            configuration
+          )
+          expect(TCellAgent).to receive(:configuration).and_return(
+            configuration
+          )
+
+          expect(Passwords.fingerprint_password('admin123', 'user_id')).to eq('11a88b27')
+        end
+      end
+    end
+  end
+end

data/spec/lib/tcell_agent/utils/strings_spec.rb

@@ -2,77 +2,77 @@ require 'spec_helper'
 
 module TCellAgent
   module Utils
-    describe ".blank?" do
-      context "with nil" do
-        it "should return true" do
+    describe '.blank?' do
+      context 'with nil' do
+        it 'should return true' do
           expect(Strings.blank?(nil)).to be(true)
         end
       end
 
-      context "with empty string" do
-        it "should return true" do
-          expect(Strings.blank?("")).to be(true)
+      context 'with empty string' do
+        it 'should return true' do
+          expect(Strings.blank?('')).to be(true)
         end
       end
 
-      context "with white space string" do
-        it "should return true" do
+      context 'with white space string' do
+        it 'should return true' do
           expect(Strings.blank?("\t \r\n \s\s")).to be(true)
         end
       end
 
-      context "with a string containing non whitespace chars" do
-        it "should return false" do
-          expect(Strings.blank?("A\t \r\n \s\s")).to be(false)
+      context 'with a string containing non whitespace chars' do
+        it 'should return false' do
+          expect(Strings.blank?('A\t \r\n \s\s')).to be(false)
         end
       end
     end
 
-    describe ".remove_trailing_slash" do
-      context "with nil" do
-        it "should return nil" do
+    describe '.remove_trailing_slash' do
+      context 'with nil' do
+        it 'should return nil' do
           expect(Strings.remove_trailing_slash(nil)).to eq(nil)
         end
       end
 
-      context "with empty string" do
-        it "should return empty string" do
-          expect(Strings.remove_trailing_slash("")).to eq("")
+      context 'with empty string' do
+        it 'should return empty string' do
+          expect(Strings.remove_trailing_slash('')).to eq('')
         end
       end
 
-      context "with / route" do
-        it "should return /" do
-          expect(Strings.remove_trailing_slash("/")).to eq("/")
+      context 'with / route' do
+        it 'should return /' do
+          expect(Strings.remove_trailing_slash('/')).to eq('/')
         end
       end
 
-      context "with no trailing slash" do
-        it "should return original string" do
-          expect(Strings.remove_trailing_slash("/index")).to eq("/index")
+      context 'with no trailing slash' do
+        it 'should return original string' do
+          expect(Strings.remove_trailing_slash('/index')).to eq('/index')
         end
       end
 
-      context "with a trailing slash" do
-        it "should remove the trailing slash" do
-          expect(Strings.remove_trailing_slash("/index")).to eq("/index")
+      context 'with a trailing slash' do
+        it 'should remove the trailing slash' do
+          expect(Strings.remove_trailing_slash('/index')).to eq('/index')
         end
       end
     end
 
-    describe ".java_hashcode" do
-      context "with some string" do
-        it "should equal the older java hash" do
-          java = 312563920
-          us = Strings.java_hashcode("The quick brown fox jumped over the lazy dogs.")
+    describe '.java_hashcode' do
+      context 'with some string' do
+        it 'should equal the older java hash' do
+          java = 312_563_920
+          us = Strings.java_hashcode('The quick brown fox jumped over the lazy dogs.')
           expect(us).to eq(java)
 
-          java = -1225848487
-          us = Strings.java_hashcode("I have a negative hash")
+          java = -1_225_848_487
+          us = Strings.java_hashcode('I have a negative hash')
           expect(us).to eq(java)
 
-          java = 628018387
-          us = Strings.java_hashcode("你好世界")
+          java = 628_018_387
+          us = Strings.java_hashcode('你好世界')
           expect(us).to eq(java)
         end
       end

data/spec/lib/tcell_agent_spec.rb

@@ -2,20 +2,20 @@ require 'spec_helper'
 
 module TCellAgent
   describe Agent do
-    context "Agent Read File" do
+    context 'Agent Read File' do
       agent_worker = Agent.new(0)
-      it "Reads in a policy file" do
+      it 'Reads in a policy file' do
         policy_file_json = {
-          "csp-headers"=>{
-            "policy_id"=>"00a1",
-            "headers"=>[
-              {"name"=>"csp", "value"=>"csp loaded header"}
+          'csp-headers' => {
+            'policy_id' => '00a1',
+            'headers' => [
+              { 'name' => 'csp', 'value' => 'csp loaded header' }
             ]
           }
         }
         agent_worker.processPolicyJson(policy_file_json)
-        expect(agent_worker.policies[TCellAgent::PolicyTypes::CSP].headers[0].type).to eq("csp")
-        expect(agent_worker.policies[TCellAgent::PolicyTypes::CSP].headers[0].value).to eq("csp loaded header")
+        expect(agent_worker.policies[TCellAgent::PolicyTypes::CSP].headers[0].type).to eq('csp')
+        expect(agent_worker.policies[TCellAgent::PolicyTypes::CSP].headers[0].value).to eq('csp loaded header')
       end
     end
   end

data/spec/spec_helper.rb

@@ -3,14 +3,14 @@ require 'rails'
 require 'webmock/rspec'
 require 'fork_break'
 
-ENV['TCELL_AGENT_SERVER'] = "mock"
+ENV['TCELL_AGENT_SERVER'] = 'mock'
 require File.join(File.dirname(__FILE__), '..', 'lib', 'tcell_agent')
-require File.join(File.dirname(__FILE__), '..', 'lib', 'tcell_agent','rails') if defined?(Rails)
+require File.join(File.dirname(__FILE__), '..', 'lib', 'tcell_agent', 'rails') if defined?(Rails)
 
-Dir[File.join(File.dirname(__FILE__), "support", "**", "*.rb")].each { |f| require f }
+Dir[File.join(File.dirname(__FILE__), 'support', '**', '*.rb')].each { |f| require f }
 
 def get_test_resource_path(name)
-  File.join(File.dirname(__FILE__), "support", "resources", name)
+  File.join(File.dirname(__FILE__), 'support', 'resources', name)
 end
 
 require 'tcell_agent/agent'

data/spec/support/middleware_helper.rb

@@ -2,16 +2,16 @@ require 'spec_helper'
 require 'rack/test'
 require 'rack'
 
-def withTCellMiddleware(app, inner_middleware=nil)
-    TCellAgent::Instrumentation::Rails::Middleware::ContextMiddleware.new(
-        TCellAgent::Instrumentation::Rails::Middleware::HeadersMiddleware.new(
-            ActionDispatch::ParamsParser.new(
-            TCellAgent::Instrumentation::Rails::Middleware::BodyFilterMiddleware.new(
-                TCellAgent::Instrumentation::Rails::Middleware::GlobalMiddleware.new(
-                   app
-                )
-            )
-            )
+def with_tcell_middleware(app, _inner_middleware = nil)
+  TCellAgent::Instrumentation::Rails::Middleware::ContextMiddleware.new(
+    TCellAgent::Instrumentation::Rails::Middleware::HeadersMiddleware.new(
+      ActionDispatch::ParamsParser.new(
+        TCellAgent::Instrumentation::Rails::Middleware::BodyFilterMiddleware.new(
+          TCellAgent::Instrumentation::Rails::Middleware::GlobalMiddleware.new(
+            app
+          )
         )
+      )
     )
+  )
 end

data/spec/support/static_agent_overrides.rb

@@ -1,36 +1,40 @@
 module TCellAgent
   @@spec_event_queue = []
+
   def self.empty_event_queue
     @@spec_event_queue = []
   end
+
   def self.event_queue
-    return @@spec_event_queue
+    @@spec_event_queue
   end
+
   def self.send_event(event)
     event.post_process
     @@spec_event_queue.push(event)
   end
+
   def self.set_thread_agent(thread_agent)
     self.thread_agent = thread_agent
   end
+
   def self.queue_metric(event)
-    #puts "Queue metric"
-    self.thread_agent._queue_metric(event)
+    thread_agent._queue_metric(event)
   end
+
   def self.increment_session_info(hmac_session_id, user_id, ip_address, user_agent)
-    #puts "Inc Session Info"
-    self.thread_agent.increment_session_info(hmac_session_id, user_id, ip_address, user_agent)
+    thread_agent.increment_session_info(hmac_session_id, user_id, ip_address, user_agent)
   end
+
   def self.increment_route(route_id, response_time)
-    self.thread_agent.increment_route(route_id, response_time)
-  end
-  def self.ensure_event_processor_running
-    #puts "Ensure running"
-    #self.thread_agent.ensure_event_processor_running
+    thread_agent.increment_route(route_id, response_time)
   end
+
+  def self.ensure_event_processor_running; end
+
   class TCellApi
-    def send_event_set(events)
-      puts "Send Events"
+    def send_event_set(_events)
+      puts 'Send Events'
     end
   end
 end