readme-metrics 2.3.0 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9d2cf2f3a6e81a4ee2658ac887b8bb7ec3b9fc8cdbef76c627a7ab702f529ec
-  data.tar.gz: 83bfccb057682371e7c26a3b37133bf48f44aa77a7fc4eceeec9ab6f4a937210
+  metadata.gz: 6f8e683b5b79b9d14d30fd4189b8b2ae411ed40416894ff4ed244cf8da8d3829
+  data.tar.gz: f8f99c8409fb87f5ce9937283803317b9ff8deee796190337c3a94d90fead921
 SHA512:
-  metadata.gz: 204c6c2d98d6b7300f4ec160ab7c224acba62e4dafae77eae6d135adf84f54443ec7e83ae1d437185e621710553b720885335784a4cd85e60bb6807159b9805c
-  data.tar.gz: 0476a102da1dc9659cd965897df2ad2dd40baf07482c97b4519b1680e792639eebd9ed98864287354318702ddd93f85356544be9a69b1cc4ad6f0fbdfa9073af
+  metadata.gz: b736fab2ab12f5c7b818afd0ac6f0563f127953244c4f1a61565944213a218e11b159b7b445de05b8eb9575f09b56cdf4d24e5ff087df301ec71fcef23963ee1
+  data.tar.gz: fd274cef8ce31226c442e3f0775f12fe7e708a0c441ea01fa87cc4f46f590e1bc7fbad2b969e6c16fdba1fca2e946d2f5b7e8e90acf600bee85c3505bda933c3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    readme-metrics (2.2.0)
+    readme-metrics (2.4.1)
       httparty (~> 0.18)
       rack (>= 2.2, < 4)
 
@@ -21,7 +21,7 @@ GEM
     json (2.6.2)
     json-schema (2.8.1)
       addressable (>= 2.4)
-    mini_mime (1.1.2)
+    mini_mime (1.1.5)
     multi_xml (0.6.0)
     parallel (1.22.1)
     parser (3.1.2.1)

data/examples/metrics-rails/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    readme-metrics (2.2.0)
+    readme-metrics (2.3.0)
       httparty (~> 0.18)
       rack (>= 2.2, < 4)
 
@@ -99,7 +99,7 @@ GEM
     marcel (1.0.2)
     method_source (1.0.0)
     mini_mime (1.1.2)
-    mini_portile2 (2.8.0)
+    mini_portile2 (2.8.1)
     minitest (5.16.3)
     multi_xml (0.6.0)
     net-imap (0.2.3)
@@ -117,13 +117,15 @@ GEM
       net-protocol
       timeout
     nio4r (2.5.8)
-    nokogiri (1.13.9)
+    nokogiri (1.14.3)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
+    nokogiri (1.14.3-arm64-darwin)
+      racc (~> 1.4)
     puma (5.6.5)
       nio4r (~> 2.0)
-    racc (1.6.0)
-    rack (2.2.4)
+    racc (1.6.2)
+    rack (2.2.7)
     rack-test (2.0.2)
       rack (>= 1.3)
     rails (7.0.3.1)

data/lib/readme/http_request.rb

@@ -1,3 +1,4 @@
+require 'readme/mask'
 require 'rack'
 require 'rack/request'
 require_relative 'content_type_helper'
@@ -25,7 +26,10 @@ module Readme
     HTTP_NON_HEADERS.freeze
 
     def initialize(env)
+      # Sanitize the auth header, if it exists
+      env['HTTP_AUTHORIZATION'] = Readme::Mask.mask(env['HTTP_AUTHORIZATION']) if env.key?('HTTP_AUTHORIZATION')
       @request = Rack::Request.new(env)
+
       return unless IS_RACK_V3
 
       @input = Rack::RewindableInput.new(@request.body)

data/lib/readme/mask.rb

@@ -0,0 +1,11 @@
+require 'digest'
+
+module Readme
+  class Mask
+    def self.mask(data)
+      digest = Digest::SHA2.new(512).base64digest(data)
+      opts = data.length >= 4 ? data[-4, 4] : data
+      "sha512-#{digest}?#{opts}"
+    end
+  end
+end

data/lib/readme/metrics/version.rb

@@ -2,6 +2,6 @@
 
 module Readme
   class Metrics
-    VERSION = '2.3.0'
+    VERSION = '2.4.1'
   end
 end

data/lib/readme/payload.rb

@@ -1,3 +1,4 @@
+require 'readme/mask'
 require 'socket'
 require 'securerandom'
 
@@ -15,6 +16,7 @@ module Readme
       @har = har
       @user_info = info.slice(:id, :label, :email)
       @user_info[:id] = info[:api_key] unless info[:api_key].nil? # swap api_key for id if api_key is present
+      @user_info[:id] = Readme::Mask.mask(@user_info[:id])
       @log_id = info[:log_id]
       @ignore = info[:ignore]
       @ip_address = ip_address
@@ -25,6 +27,7 @@ module Readme
     def to_json(*_args)
       {
         _id: validate_uuid(@log_id) ? @log_id : @uuid,
+        _version: 3,
         group: @user_info,
         clientIPAddress: @ip_address,
         development: @development,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readme-metrics
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.1
 platform: ruby
 authors:
 - ReadMe
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-06 00:00:00.000000000 Z
+date: 2024-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -102,6 +102,7 @@ files:
 - lib/readme/har/serializer.rb
 - lib/readme/http_request.rb
 - lib/readme/http_response.rb
+- lib/readme/mask.rb
 - lib/readme/metrics.rb
 - lib/readme/metrics/version.rb
 - lib/readme/payload.rb
@@ -130,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: SDK for Readme's metrics API