readme-metrics 2.2.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e56a6d3e2f6345dcc6b17a00b3de12223b5982bbf2ed1d88c78e7bc6155a4a1
-  data.tar.gz: 40223680001e31af74173f227cc0b56cd74ef5c0c81437328d2506a303482d2b
+  metadata.gz: 1a539e9a1512385c01ba8b037b3325e89a762b2965f5b2b5aa6394989b2774d7
+  data.tar.gz: 3c95661d00dc2392ec8f805371ab8ed102335d697bfed20de6c11f14826e0c2e
 SHA512:
-  metadata.gz: afd8efd488128281a9d3e5c952b17a678e499e145aa6a448fdbe05a8b748bdcd36e2d01ff83195362931fd8158d884a8804b72e8f9d863237a729e632acab611
-  data.tar.gz: ebd3eb9482710916a7d969d6315147ab36526d53de86f12abc49892325d7405de2074d2744a89cb3160ea9b37050117335b1fc834900d74470d2301273865fda
+  metadata.gz: ca188a7f894ee7718907c902a1ec724b4aff21afcbc2007a3ec14cda78b8abb1ea2f846cda8ef8c882ec984de304a2f9bd7c4e530f8a7034682f365ee0271e6a
+  data.tar.gz: c90dd5e1b59db664af5f26b4f13c6e544eabe5a766ed2d8e7170e0dfd93849846efa5ff66251535ed2c957e772fe69936c61e3903159b9ed23267a9b322ec933

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    readme-metrics (2.1.0)
+    readme-metrics (2.4.0)
       httparty (~> 0.18)
+      rack (>= 2.2, < 4)
 
 GEM
   remote: https://rubygems.org/
@@ -14,15 +15,13 @@ GEM
       safe_yaml (~> 1.0.0)
     diff-lcs (1.4.4)
     hashdiff (1.0.1)
-    httparty (0.20.0)
-      mime-types (~> 3.0)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
     json (2.6.2)
     json-schema (2.8.1)
       addressable (>= 2.4)
-    mime-types (3.4.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2022.0105)
+    mini_mime (1.1.5)
     multi_xml (0.6.0)
     parallel (1.22.1)
     parser (3.1.2.1)

data/README.md

@@ -10,7 +10,7 @@
 
 <p align="center">
   <a href="https://rubygems.org/gems/readme-metrics"><img src="https://img.shields.io/gem/v/readme-metrics.svg?style=for-the-badge" alt="Latest release"></a>
-  <a href="https://github.com/readmeio/metrics-sdks"><img src="https://img.shields.io/github/workflow/status/readmeio/metrics-sdks/ruby.svg?style=for-the-badge" alt="Build status"></a>
+  <a href="https://github.com/readmeio/metrics-sdks"><img src="https://img.shields.io/github/actions/workflow/status/readmeio/metrics-sdks/ruby.yml?branch=main&style=for-the-badge" alt="Build status"></a>
 </p>
 
 With [ReadMe's Metrics API](https://readme.com/metrics) your team can get deep insights into your API's usage. If you're a developer, it takes a few small steps to send your API logs to [ReadMe](http://readme.com). Here's an overview of how the integration works:

data/examples/metrics-rails/Gemfile

@@ -1,8 +1,6 @@
 source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-ruby '3.1.2'
-
 # Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main"
 gem 'rails', '~> 7.0.3', '>= 7.0.3.1'
 

data/examples/metrics-rails/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: ../..
   specs:
-    readme-metrics (2.1.0)
+    readme-metrics (2.3.0)
       httparty (~> 0.18)
+      rack (>= 2.2, < 4)
 
 GEM
   remote: https://rubygems.org/
@@ -82,8 +83,8 @@ GEM
     erubi (1.11.0)
     globalid (1.0.0)
       activesupport (>= 5.0)
-    httparty (0.20.0)
-      mime-types (~> 3.0)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
@@ -97,11 +98,8 @@ GEM
       mini_mime (>= 0.1.1)
     marcel (1.0.2)
     method_source (1.0.0)
-    mime-types (3.4.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2022.0105)
     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)
@@ -119,15 +117,15 @@ GEM
       net-protocol
       timeout
     nio4r (2.5.8)
-    nokogiri (1.13.8)
+    nokogiri (1.14.3)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    nokogiri (1.13.8-arm64-darwin)
+    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)
@@ -157,10 +155,12 @@ GEM
       thor (~> 1.0)
       zeitwerk (~> 2.5)
     rake (13.0.6)
-    reline (0.3.1)
+    reline (0.3.2)
       io-console (~> 0.5)
-    sqlite3 (1.4.4)
-    strscan (3.0.4)
+    sqlite3 (1.6.1)
+      mini_portile2 (~> 2.8.0)
+    sqlite3 (1.6.1-arm64-darwin)
+    strscan (3.0.6)
     thor (1.2.1)
     timeout (0.3.0)
     tzinfo (2.0.5)
@@ -182,8 +182,5 @@ DEPENDENCIES
   sqlite3 (~> 1.4)
   tzinfo-data
 
-RUBY VERSION
-   ruby 3.1.2p20
-
 BUNDLED WITH
    2.3.11

data/examples/metrics-rails/config/environments/production.rb

@@ -51,7 +51,7 @@ Rails.application.configure do
   config.active_support.report_deprecations = false
 
   # Use default logging formatter so that PID and timestamp are not suppressed.
-  config.log_formatter = ::Logger::Formatter.new
+  config.log_formatter = Logger::Formatter.new
 
   # Use a different logger for distributed setups.
   # require "syslog/logger"

data/lib/readme/http_request.rb

@@ -1,3 +1,4 @@
+require 'readme/mask'
 require 'rack'
 require 'rack/request'
 require_relative 'content_type_helper'
@@ -6,15 +7,32 @@ module Readme
   class HttpRequest
     include ContentTypeHelper
 
+    IS_RACK_V3 = Gem.loaded_specs['rack'].version > Gem::Version.create('3.0')
+
+    # rubocop:disable Style/MutableConstant
     HTTP_NON_HEADERS = [
       Rack::HTTP_COOKIE,
-      Rack::HTTP_VERSION,
       Rack::HTTP_HOST,
       Rack::HTTP_PORT
-    ].freeze
+    ]
+    # rubocop:enable Style/MutableConstant
+
+    if IS_RACK_V3
+      HTTP_NON_HEADERS.push(Rack::SERVER_PROTOCOL)
+    else
+      HTTP_NON_HEADERS.push(Rack::HTTP_VERSION)
+    end
+
+    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)
     end
 
     def url
@@ -30,7 +48,11 @@ module Readme
     end
 
     def http_version
-      @request.get_header(Rack::HTTP_VERSION)
+      if IS_RACK_V3
+        @request.get_header(Rack::SERVER_PROTOCOL)
+      else
+        @request.get_header(Rack::HTTP_VERSION)
+      end
     end
 
     def request_method
@@ -64,11 +86,17 @@ module Readme
     end
 
     def body
-      @request.body.rewind
-      content = @request.body.read
-      @request.body.rewind
-
-      content
+      if IS_RACK_V3
+        body = @input.read
+        @input.rewind
+        body
+      else
+        @request.body.rewind
+        content = @request.body.read
+        @request.body.rewind
+
+        content
+      end
     end
 
     def parsed_form_data

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.2.0'
+    VERSION = '2.4.0'
   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

data/readme-metrics.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'httparty', '~> 0.18'
+  spec.add_runtime_dependency 'rack', '>= 2.2', '< 4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readme-metrics
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.4.0
 platform: ruby
 authors:
 - ReadMe
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-16 00:00:00.000000000 Z
+date: 2024-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -24,6 +24,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 description: Middleware for logging requests to Readme's metrics API
 email:
 - support@readme.io
@@ -82,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
@@ -110,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: SDK for Readme's metrics API