readme-metrics 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f8fe458fadd08b945bcd32ba4d64a4ba2ba6a609dde94f3a501c50bc505967d
-  data.tar.gz: bfa8ff8c37330c3487d8572e2d9ec207147780334295810dc3d0aecfe529e951
+  metadata.gz: edf64efc0c1f3a7ba72f9f6d30aaebbd1caf64774258fe7dc69e343751358adb
+  data.tar.gz: 36dd67292da34691382b5e3d9f7234275c9d14d4b133f8067ed22c2c0c861a02
 SHA512:
-  metadata.gz: 0b849b923ddafe6073b039ebedd9387b1f17fb93e990c3ffa7bcd8c407b5349a387001a6f46684fe7202d955826c705892d46dadc8da20db503546cf2a0d7e83
-  data.tar.gz: c728319d845cb1ae8d368c0f995a71f0f1451ad03a8f94064aaa782b4d6cc094cf2269c46c0e5c2d86dbde5ea3527edab4371b4e617df5ad24599558bb29fd3c
+  metadata.gz: 20c0d88a3e19f49a742ad52555b22f4cfa1d6fc34eeea60dbeb3410f97050d546ed9caa4d00ba5c518822296d9660a6e24c84c7232165724251cafd68dadab53
+  data.tar.gz: c29cb1edddfd487996d345be984f402353a1940c4626aad107b4df33537800de0cab8ba41cf294d9a7bfaae5f221cf266012bea8d925ac8794e717b7059c3238

data/.rubocop.yml

@@ -0,0 +1,67 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7
+
+# https://docs.rubocop.org/rubocop/cops_layout.html
+Layout/LineLength:
+  Max: 150
+
+# https://docs.rubocop.org/rubocop/cops_metrics.html
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Max: 20
+Metrics/BlockLength:
+  Exclude:
+    - spec/readme/*.rb
+    - spec/readme/har/*.rb
+Metrics/ClassLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Max: 20
+
+# https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec
+RSpec/AnyInstance:
+  Enabled: false
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/LeakyConstantDeclaration:
+  Exclude:
+    - spec/readme/*.rb
+RSpec/MultipleExpectations:
+  Enabled: false
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+# https://docs.rubocop.org/rubocop/cops_style.html
+Style/BlockDelimiters:
+  Exclude:
+    - spec/**/*
+Style/ClassVars:
+  Exclude:
+    - 'lib/readme/metrics.rb'
+Style/Documentation:
+  Enabled: false
+Style/ExpandPathArguments:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/GuardClause:
+  Exclude:
+    - 'lib/readme/filter.rb'
+    - 'lib/readme/metrics.rb'
+Style/IfUnlessModifier:
+  Exclude:
+    - 'lib/readme/metrics.rb'
+Style/RescueStandardError:
+  # We should ideally have this rule enabled but I'm paranoid that we don't have full documentation
+  # on all types of errors that might be thrown in the couple places this rule is being suppressed
+  # and by only catching `StandardError` we'll miss out on something else and potentially take down
+  # someones integration.
+  Enabled: false

data/Gemfile

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in readme-metrics.gemspec
 gemspec
 
-gem "json-schema"
-gem "rack-test"
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
-gem "standard"
-gem "webmock"
-gem "os"
-gem "uuid"
+gem 'json-schema'
+gem 'rack-test'
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', require: false
+gem 'rubocop-performance', require: false
+gem 'rubocop-rspec', require: false
+gem 'uuid'
+gem 'webmock'

data/Gemfile.lock

@@ -3,7 +3,6 @@ PATH
   specs:
     readme-metrics (2.0.1)
       httparty (~> 0.18)
-      os (~> 1.1.4)
       uuid (~> 2.3.8)
 
 GEM
@@ -27,12 +26,11 @@ GEM
       mime-types-data (~> 3.2015)
     mime-types-data (3.2022.0105)
     multi_xml (0.6.0)
-    os (1.1.4)
     parallel (1.19.2)
     parser (2.7.1.4)
       ast (~> 2.4.1)
     public_suffix (4.0.6)
-    rack (2.2.3)
+    rack (2.2.3.1)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rainbow (3.0.0)
@@ -63,13 +61,12 @@ GEM
       unicode-display_width (>= 1.4.0, < 2.0)
     rubocop-ast (0.3.0)
       parser (>= 2.7.1.4)
-    rubocop-performance (1.6.1)
-      rubocop (>= 0.71.0)
+    rubocop-performance (1.7.1)
+      rubocop (>= 0.82.0)
+    rubocop-rspec (1.41.0)
+      rubocop (>= 0.68.1)
     ruby-progressbar (1.10.1)
     safe_yaml (1.0.5)
-    standard (0.4.7)
-      rubocop (~> 0.85.0)
-      rubocop-performance (~> 1.6.0)
     systemu (2.6.5)
     unicode-display_width (1.7.0)
     uuid (2.3.9)
@@ -84,12 +81,13 @@ PLATFORMS
 
 DEPENDENCIES
   json-schema
-  os
   rack-test
   rake (~> 12.0)
   readme-metrics!
   rspec (~> 3.0)
-  standard
+  rubocop
+  rubocop-performance
+  rubocop-rspec
   uuid
   webmock
 

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2020, ReadMe
+Copyright (c) 2022, ReadMe
 
 Permission to use, copy, modify, and/or distribute this software for any purpose
 with or without fee is hereby granted, provided that the above copyright notice

data/Makefile

@@ -0,0 +1,14 @@
+install: ## Install all dependencies
+	bundle
+
+lint: ## Run code standard checks
+	bundle exec rubocop
+
+lint-fix: ## Attempt to automatically fix any code standard violations
+	bundle exec rubocop --auto-correct
+
+test: ## Run unit tests
+	rake spec
+
+help: ## Show this help
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

data/README.md

@@ -1,111 +1,30 @@
-# readme-metrics
+# ReadMe Metrics
 
-Track your API metrics within ReadMe.
+<p align="center">
+  <img src="https://user-images.githubusercontent.com/33762/182927634-2aebeb46-c215-4ac3-9e98-61f931e33583.png" />
+</p>
 
-[![RubyGems](https://img.shields.io/gem/v/readme-metrics)](https://rubygems.org/gems/readme-metrics)
-[![Build](https://github.com/readmeio/metrics-sdks/workflows/ruby/badge.svg)](https://github.com/readmeio/metrics-sdks)
+<p align="center">
+  Track usage of your API and troubleshoot issues faster.
+</p>
 
-[![](https://d3vv6lp55qjaqc.cloudfront.net/items/1M3C3j0I0s0j3T362344/Untitled-2.png)](https://readme.io)
+<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>
+</p>
 
-## Installation
+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:
 
-Add it to your Gemfile
+- You add the ReadMe middleware to your Rails application.
+- The middleware sends to ReadMe the request and response objects that your Express server generates each time a user makes a request to your API. The entire objects are sent, unless you allow or deny keys.
+- ReadMe extracts information to display in Metrics, such as which endpoint is being called, response code, and error messages. It also identifies the customer who called your API, using whichever keys in the middleware you call out as containing relevant customer info.
 
-`gem "readme-metrics"`
-
-## Usage
-
-`Readme::Metrics` is a Rack middleware and is compatible with all Rack-based
-apps, including Rails.
-
-When configuring the middleware, you must provide a block to tell the
-middleware how to get values for the current user. These may be values taken
-from the environment, or you may hardcode them.
-
-If you're using Warden-based authentication like Devise, you may fetch the
-current_user for a given request from the environment.
-
-### SDK Options
-
-Option           | Type             | Description
------------------|------------------|---------
-`reject_params`         | Array of strings | If you have sensitive data you'd like to prevent from being sent to the Metrics API via headers, query params or payload bodies, you can specify a list of keys to filter via the `reject_params` option. NOTE: cannot be used in conjunction with `allow_only`. You may only specify either `reject_params` or `allow_only` keys, not both.
-`allow_only`        | Array of strings | The inverse of `reject_params`. If included all parameters but those in this list will be redacted. NOTE: cannot be used in conjunction with `reject_params`. You may only specify either `reject_params` or `allow_only` keys, not both.
-`development`      | bool             | Defaults to `false`. When `true`, the log will be marked as a development log. This is great for separating staging or test data from data coming from customers.
-`buffer_length`     | number           | Defaults to `1`. This value should be a number representing the amount of requests to group up before sending them over the network. Increasing this value may increase performance by batching, but will also delay the time until logs show up in the dashboard given the buffer size needs to be reached in order for the logs to be sent.
-
-### Payload Data
-
-Option              | Required? | Type             | Description
---------------------|-----------|------------------|----------
-`api_key`           | yes       | string           | API Key used to make the request. Note that this is different from the `readmeAPIKey` described above in the options data. This should be a value from your API that is unique to each of your users.
-`label`             | no        | string           | This will be the user's display name in the API Metrics Dashboard, since it's much easier to remember a name than an API key.
-`email`             | no        | string           | Email of the user that is making the call.
-`log_id`            | no        | string           | A UUIDv4 identifier. If not provided this will be automatically generated for you. Providing your own `log_id` is useful if you want to know the URL of the log in advance, i.e. `{your_base_url}/logs/{your_log_id}`.
-`ignore`            | no        | bool           | A flag that when set to `true` will suppress sending the log.
-
-### Rails
-
-```ruby
-# config/environments/development.rb or config/environments/production.rb
-require "readme/metrics"
-
-sdk_options = {
-  api_key: "<<apiKey>>",
-  development: false,
-  reject_params: ["not_included", "dont_send"],
-  buffer_length: 5,
-}
-
-config.middleware.use Readme::Metrics, sdk_options do |env|
-  current_user = env['warden'].authenticate
-
-  payload_data = current_user.present? ? {
-    api_key: current_user.api_key, # Not the same as the ReadMe API Key
-    label: current_user.name,
-    email: current_user.email
-  } : {
-    api_key: "guest",
-    label: "Guest User",
-    email: "guest@example.com"
-  }
-
-  payload_data
-end
+```bash
+gem "readme-metrics"
 ```
 
-### Rack
-
-```ruby
-# config.ru
-sdk_options = {
-  api_key: "<<apiKey>>",
-  development: false,
-  reject_params: ["not_included", "dont_send"]
-}
-
-use Readme::Metrics, sdk_options do |env|
-    {
-      api_key: "owlbert_api_key"
-      label: "Owlbert",
-      email: "owlbert@example.com",
-      log_id: SecureRandom.uuid
-    }
-end
-
-run YourApp.new
-```
-
-### Sample Applications
-
-- [Rails](https://github.com/readmeio/metrics-sdk-rails-sample)
-- [Rack](https://github.com/readmeio/metrics-sdk-racks-sample)
-- [Sinatra](https://github.com/readmeio/metrics-sdk-sinatra-example)
-
-### Contributing
-
-Ensure you are running the version of ruby specified in the `Gemfile.lock`; use `rvm` to easy manage ruby versions. Run `bundle` to install dependencies, `rake` or `rspec` to ensure tests pass, and `bundle exec standardrb` to lint the code.
-
-## License
+**For more information on setup, check out our [integration documentation](https://docs.readme.com/docs/ruby-api-metrics-set-up).**
 
-[View our license here](https://github.com/readmeio/metrics-sdks/tree/main/packages/ruby/LICENSE)
+> 🚧 Any Issues?
+>
+> Integrations can be tricky! [Contact support](https://docs.readme.com/guides/docs/contact-support) if you have any questions/issues.

data/Rakefile

@@ -1,5 +1,5 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "readme/metrics"
+require 'bundler/setup'
+require 'readme/metrics'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "readme/metrics"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/readme/content_type_helper.rb

@@ -3,12 +3,12 @@ module Readme
     # Assumes the includer has a `content_type` method defined.
 
     JSON_MIME_TYPES = [
-      "application/json",
-      "application/x-json",
-      "text/json",
-      "text/x-json",
-      "+json"
-    ]
+      'application/json',
+      'application/x-json',
+      'text/json',
+      'text/x-json',
+      '+json'
+    ].freeze
 
     def json?
       JSON_MIME_TYPES.any? { |mime_type| content_type.include?(mime_type) }

data/lib/readme/errors.rb

@@ -1,10 +1,12 @@
+# frozen-string-literal: true
+
 module Readme
   class Errors
-    API_KEY_ERROR = "Missing API Key"
-    REJECT_PARAMS_ERROR = "The `reject_params` option must be an array of strings"
-    ALLOW_ONLY_ERROR = "The `allow_only` option must be an array of strings"
-    BUFFER_LENGTH_ERROR = "The `buffer_length` must be an Integer"
-    DEVELOPMENT_ERROR = "The `development` option must be a boolean"
+    API_KEY_ERROR = 'Missing API Key'
+    REJECT_PARAMS_ERROR = 'The `reject_params` option must be an array of strings'
+    ALLOW_ONLY_ERROR = 'The `allow_only` option must be an array of strings'
+    BUFFER_LENGTH_ERROR = 'The `buffer_length` must be an Integer'
+    DEVELOPMENT_ERROR = 'The `development` option must be a boolean'
     LOGGER_ERROR = <<~MESSAGE
       The `logger` option must be class that responds to the following messages:
         :unkown, :fatal, :error, :warn, :info, :debug, :level

data/lib/readme/filter.rb

@@ -15,7 +15,7 @@ module Readme
     def self.redact(rejected_params)
       rejected_params.each_with_object({}) do |(k, v), hash|
         # If it's a string then return the length of the redacted field
-        hash[k.to_str] = "[REDACTED#{v.is_a?(String) ? " #{v.length}" : ""}]"
+        hash[k.to_str] = "[REDACTED#{v.is_a?(String) ? " #{v.length}" : ''}]"
       end
     end
 
@@ -65,7 +65,7 @@ module Readme
 
     class FilterArgsError < StandardError
       def initialize
-        msg = "Can only supply either reject_params or allow_only, not both."
+        msg = 'Can only supply either reject_params or allow_only, not both.'
         super(msg)
       end
     end

data/lib/readme/har/collection.rb

@@ -11,7 +11,7 @@ module Readme
       end
 
       def to_a
-        filtered_hash.map { |name, value| {name: name, value: value} }
+        filtered_hash.map { |name, value| { name: name, value: value } }
       end
 
       private

data/lib/readme/har/request_serializer.rb

@@ -1,6 +1,6 @@
-require "cgi"
-require "readme/har/collection"
-require "readme/filter"
+require 'cgi'
+require 'readme/har/collection'
+require 'readme/filter'
 
 module Readme
   module Har
@@ -18,7 +18,7 @@ module Readme
           httpVersion: @request.http_version,
           headers: Har::Collection.new(@filter, @request.headers).to_a,
           cookies: Har::Collection.new(@filter, @request.cookies).to_a,
-          postData: postData,
+          postData: post_data,
           headersSize: -1,
           bodySize: @request.content_length
         }.compact
@@ -29,14 +29,14 @@ module Readme
       def url
         url = URI(@request.url)
         headers = @request.headers
-        forward_proto = headers["X-Forwarded-Proto"]
-        forward_host = headers["X-Forwarded-Host"]
+        forward_proto = headers['X-Forwarded-Proto']
+        forward_host = headers['X-Forwarded-Host']
         url.host = forward_host if forward_host.is_a?(String)
         url.scheme = forward_proto if forward_proto.is_a?(String)
         url.to_s
       end
 
-      def postData
+      def post_data
         if @request.content_type.nil?
           nil
         elsif @request.form_data?
@@ -59,22 +59,22 @@ module Readme
       def request_body
         if @filter.pass_through?
           pass_through_body
-        elsif is_form_urlencoded?
+        elsif form_urlencoded?
           form_urlencoded_body
-        elsif is_json?
+        elsif json?
           json_body
         else
           @request.body
         end
       end
 
-      def is_json?
-        ["application/json", "application/x-json", "text/json", "text/x-json"]
-          .include?(@request.content_type) || @request.content_type.include?("+json")
+      def json?
+        ['application/json', 'application/x-json', 'text/json', 'text/x-json']
+          .include?(@request.content_type) || @request.content_type.include?('+json')
       end
 
-      def is_form_urlencoded?
-        @request.content_type == "application/x-www-form-urlencoded"
+      def form_urlencoded?
+        @request.content_type == 'application/x-www-form-urlencoded'
       end
 
       def json_body

data/lib/readme/har/response_serializer.rb

@@ -1,5 +1,5 @@
-require "rack/utils"
-require "readme/har/collection"
+require 'rack/utils'
+require 'readme/har/collection'
 
 module Readme
   module Har
@@ -37,7 +37,7 @@ module Readme
       end
 
       def empty_content
-        {mimeType: "", size: 0}
+        { mimeType: '', size: 0 }
       end
 
       def json_content

data/lib/readme/har/serializer.rb

@@ -1,13 +1,15 @@
-require "rack"
-require "readme/metrics"
-require "readme/har/request_serializer"
-require "readme/har/response_serializer"
-require "readme/har/collection"
+# frozen-string-literal: true
+
+require 'rack'
+require 'readme/metrics'
+require 'readme/har/request_serializer'
+require 'readme/har/response_serializer'
+require 'readme/har/collection'
 
 module Readme
   module Har
     class Serializer
-      HAR_VERSION = "1.2"
+      HAR_VERSION = '1.2'
 
       def initialize(request, response, start_time, end_time, filter)
         @http_request = request
@@ -17,7 +19,7 @@ module Readme
         @filter = filter
       end
 
-      def to_json
+      def to_json(*_args)
         {
           log: {
             version: HAR_VERSION,
@@ -31,9 +33,9 @@ module Readme
 
       def creator
         {
-          name: Readme::Metrics::SDK_NAME,
+          name: 'readme-metrics (ruby)',
           version: Readme::Metrics::VERSION,
-          comment: "#{Readme::Metrics::PLATFORM}/#{RUBY_VERSION}"
+          comment: "#{RUBY_PLATFORM}/#{RUBY_VERSION}" # arm64-darwin21/2.7.2
         }
       end
 

data/lib/readme/http_request.rb

@@ -1,6 +1,6 @@
-require "rack"
-require "rack/request"
-require_relative "content_type_helper"
+require 'rack'
+require 'rack/request'
+require_relative 'content_type_helper'
 
 module Readme
   class HttpRequest
@@ -11,7 +11,7 @@ module Readme
       Rack::HTTP_VERSION,
       Rack::HTTP_HOST,
       Rack::HTTP_PORT
-    ]
+    ].freeze
 
     def initialize(env)
       @request = Rack::Request.new(env)
@@ -50,7 +50,7 @@ module Readme
     end
 
     def options?
-      @request.request_method == "OPTIONS"
+      @request.request_method == 'OPTIONS'
     end
 
     def headers
@@ -82,20 +82,22 @@ module Readme
     # Other "headers" like version and host are prefixed with `HTTP_` by Rack but
     # don't seem to be considered legit HTTP headers.
     def http_header?(name)
-      name.start_with?("HTTP") && !HTTP_NON_HEADERS.include?(name)
+      name.start_with?('HTTP') && !HTTP_NON_HEADERS.include?(name)
     end
 
     # Headers like `Content-Type: application/json` come into rack like
     # `"HTTP_CONTENT_TYPE" => "application/json"`.
     def normalize_header_name(header)
-      header.delete_prefix("HTTP_").split("_").map(&:capitalize).join("-")
+      header.delete_prefix('HTTP_').split('_').map(&:capitalize).join('-')
     end
 
     # These special headers are explicitly _not_ prefixed with HTTP_ in the Rack
     # env so we need to add them in manually
     def unprefixed_headers
-      {"Content-Type" => @request.content_type,
-       "Content-Length" => @request.content_length}.compact
+      {
+        'Content-Type' => @request.content_type,
+        'Content-Length' => @request.content_length
+      }.compact
     end
   end
 end

data/lib/readme/http_response.rb

@@ -1,6 +1,6 @@
-require "rack"
-require "rack/response"
-require_relative "content_type_helper"
+require 'rack'
+require 'rack/response'
+require_relative 'content_type_helper'
 
 module Readme
   class HttpResponse < SimpleDelegator
@@ -13,22 +13,22 @@ module Readme
     def body
       if raw_body.respond_to?(:rewind)
         raw_body.rewind
-        content = raw_body.each.reduce("", :+)
+        content = raw_body.each.reduce('', :+)
         raw_body.rewind
 
         content
       else
-        raw_body.each.reduce("", :+)
+        raw_body.each.reduce('', :+)
       end
     end
 
     def content_length
       if empty_body_status?
         0
-      elsif !headers["Content-Length"]
+      elsif !headers['Content-Length']
         body.bytesize
       else
-        headers["Content-Length"].to_i
+        headers['Content-Length'].to_i
       end
     end
 

data/lib/readme/metrics/version.rb

@@ -1,5 +1,7 @@
+# frozen-string-literal: true
+
 module Readme
   class Metrics
-    VERSION = "2.0.1"
+    VERSION = '2.1.0'
   end
 end

data/lib/readme/metrics.rb

@@ -1,33 +1,21 @@
-require "readme/metrics/version"
-require "readme/har/serializer"
-require "readme/filter"
-require "readme/payload"
-require "readme/request_queue"
-require "readme/errors"
-require "readme/http_request"
-require "readme/http_response"
-require "httparty"
-require "logger"
-require "os"
+# frozen-string-literal: true
+
+require 'readme/metrics/version'
+require 'readme/har/serializer'
+require 'readme/filter'
+require 'readme/payload'
+require 'readme/request_queue'
+require 'readme/errors'
+require 'readme/http_request'
+require 'readme/http_response'
+require 'httparty'
+require 'logger'
 
 module Readme
   class Metrics
-    def self.platform
-      if OS.windows?
-        "windows"
-      elsif OS.mac?
-        "mac"
-      elsif OS.linux?
-        "linux"
-      else
-        "unknown"
-      end
-    end
-
-    SDK_NAME = "Readme.io Ruby SDK"
-    PLATFORM = platform
+    SDK_NAME = 'readme-metrics'
     DEFAULT_BUFFER_LENGTH = 1
-    ENDPOINT = "https://metrics.readme.io/v1/request"
+    ENDPOINT = 'https://metrics.readme.io/v1/request'
 
     def self.logger
       @@logger
@@ -77,15 +65,16 @@ module Readme
       request = HttpRequest.new(env)
       har = Har::Serializer.new(request, response, start_time, end_time, @filter)
       user_info = @get_user_info.call(env)
+      ip = env['REMOTE_ADDR']
 
       if !user_info_valid?(user_info)
         Readme::Metrics.logger.warn Errors.bad_block_message(user_info)
       elsif request.options?
-        Readme::Metrics.logger.info "OPTIONS request omitted from ReadMe API logging"
+        Readme::Metrics.logger.info 'OPTIONS request omitted from ReadMe API logging'
       elsif !can_filter? request, response
         Readme::Metrics.logger.warn "Request or response body MIME type isn't supported for filtering. Omitting request from ReadMe API logging"
       else
-        payload = Payload.new(har, user_info, development: @development)
+        payload = Payload.new(har, user_info, ip, development: @development)
         @@request_queue.push(payload.to_json) unless payload.ignore
       end
     end
@@ -121,34 +110,36 @@ module Readme
         raise Errors::ConfigurationError, Errors::BUFFER_LENGTH_ERROR
       end
 
-      if options[:development] && !is_a_boolean?(options[:development])
+      if options[:development] && !a_boolean?(options[:development])
         raise Errors::ConfigurationError, Errors::DEVELOPMENT_ERROR
       end
 
-      if options[:logger] && has_logger_inferface?(options[:logger])
+      if options[:logger] && logger_inferface?(options[:logger])
         raise Errors::ConfigurationError, Errors::LOGGER_ERROR
       end
     end
 
-    def has_logger_inferface?(logger)
-      [
-        :unknown,
-        :fatal,
-        :error,
-        :warn,
-        :info,
-        :debug
+    def logger_inferface?(logger)
+      %i[
+        unknown
+        fatal
+        error
+        warn
+        info
+        debug
       ].any? { |message| !logger.respond_to? message }
     end
 
-    def is_a_boolean?(arg)
-      arg == true || arg == false
+    def a_boolean?(arg)
+      [true, false].include?(arg)
     end
 
+    # rubocop:disable Style/InverseMethods
     def user_info_valid?(user_info)
       !user_info.nil? &&
         !user_info.values.any?(&:nil?) &&
-        user_info.has_key?(:api_key) || user_info.has_key?(:id)
+        user_info.key?(:api_key) || user_info.key?(:id)
     end
+    # rubocop:enable Style/InverseMethods
   end
 end

data/lib/readme/payload.rb

@@ -1,24 +1,26 @@
-require "uuid"
+require 'socket'
+require 'uuid'
 
 module Readme
   class Payload
     attr_reader :ignore
 
-    def initialize(har, info, development:)
+    def initialize(har, info, ip_address, development:)
       @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
       @log_id = info[:log_id]
       @ignore = info[:ignore]
+      @ip_address = ip_address
       @development = development
       @uuid = UUID.new
     end
 
-    def to_json
+    def to_json(*_args)
       {
         logId: UUID.validate(@log_id) ? @log_id : @uuid.generate,
         group: @user_info,
-        clientIPAddress: "1.1.1.1",
+        clientIPAddress: @ip_address,
         development: @development,
         request: JSON.parse(@har.to_json)
       }.to_json

data/lib/readme/request_queue.rb

@@ -1,4 +1,4 @@
-require "readme/metrics"
+require 'readme/metrics'
 
 module Readme
   class RequestQueue
@@ -30,8 +30,8 @@ module Readme
       Thread.new do
         HTTParty.post(
           Readme::Metrics::ENDPOINT,
-          basic_auth: {username: @api_key, password: ""},
-          headers: {"Content-Type" => "application/json"},
+          basic_auth: { username: @api_key, password: '' },
+          headers: { 'Content-Type' => 'application/json' },
           body: to_json(payloads)
         )
       end
@@ -42,7 +42,7 @@ module Readme
     end
 
     def to_json(payloads)
-      "[#{payloads.join(", ")}]"
+      "[#{payloads.join(', ')}]"
     end
   end
 end

data/readme-metrics.gemspec

@@ -1,31 +1,31 @@
-require_relative "lib/readme/metrics/version"
+require_relative 'lib/readme/metrics/version'
 
 Gem::Specification.new do |spec|
-  spec.name = "readme-metrics"
+  spec.name = 'readme-metrics'
   spec.version = Readme::Metrics::VERSION
-  spec.authors = ["ReadMe"]
-  spec.email = ["support@readme.io"]
-  spec.license = "ISC"
+  spec.authors = ['ReadMe']
+  spec.email = ['support@readme.io']
+  spec.license = 'ISC'
 
   spec.summary = "SDK for Readme's metrics API"
   spec.description = "Middleware for logging requests to Readme's metrics API"
-  spec.homepage = "https://docs.readme.com/metrics/docs/getting-started-with-api-metrics"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+  spec.homepage = 'https://docs.readme.com/metrics/docs/getting-started-with-api-metrics'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/readmeio/metrics-sdks/blob/main/packages/ruby"
-  spec.metadata["changelog_uri"] = "https://github.com/readmeio/metrics-sdks/blob/main/packages/ruby/CHANGELOG.md"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/readmeio/metrics-sdks/tree/main/packages/ruby'
+  spec.metadata['changelog_uri'] = 'https://github.com/readmeio/metrics-sdks/blob/main/CHANGELOG.md'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
+
   # spec.bindir        = "exe"
   # spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency "httparty", "~> 0.18"
-  spec.add_runtime_dependency "uuid", "~> 2.3.8"
-  spec.add_runtime_dependency "os", "~> 1.1.4"
+  spec.add_runtime_dependency 'httparty', '~> 0.18'
+  spec.add_runtime_dependency 'uuid', '~> 2.3.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readme-metrics
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - ReadMe
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-21 00:00:00.000000000 Z
+date: 2022-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.8
-- !ruby/object:Gem::Dependency
-  name: os
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.1.4
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.1.4
 description: Middleware for logging requests to Readme's metrics API
 email:
 - support@readme.io
@@ -61,12 +47,13 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
+- Makefile
 - README.md
 - Rakefile
-- SECURITY.md
 - bin/console
 - bin/setup
 - lib/readme/content_type_helper.rb
@@ -88,9 +75,9 @@ licenses:
 - ISC
 metadata:
   homepage_uri: https://docs.readme.com/metrics/docs/getting-started-with-api-metrics
-  source_code_uri: https://github.com/readmeio/metrics-sdks/blob/main/packages/ruby
-  changelog_uri: https://github.com/readmeio/metrics-sdks/blob/main/packages/ruby/CHANGELOG.md
-post_install_message:
+  source_code_uri: https://github.com/readmeio/metrics-sdks/tree/main/packages/ruby
+  changelog_uri: https://github.com/readmeio/metrics-sdks/blob/main/CHANGELOG.md
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -105,8 +92,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: SDK for Readme's metrics API
 test_files: []

data/SECURITY.md

@@ -1,12 +0,0 @@
-# Security Policy
-
-## Reporting a Vulnerability
-
-If there are any vulnerabilities in `readme-metrics`, don't hesitate to _report them_.
-
-Please email security@readme.io and describe what you've found.
-
-- If you have a fix, explain or attach it.
-- In the near time, expect a reply with the required steps. Also, there may be a demand for a pull request which include the fixes.
-
-> You should not disclose the vulnerability publicly if you haven't received an answer in some weeks. If the vulnerability is rejected, you may post it publicly within some hour of rejection, unless the rejection is withdrawn within that time period. After the vulnerability has been fixed, you may disclose the vulnerability details publicly over some days.