readme-metrics 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17dad1b40b974d05ae3d57a664e6f95c393cbaf8e807071631c11800b2ee118c
-  data.tar.gz: 2d3595d321dea5bac6b5577180f608a2f9045e333592e5c33cca4c52a3e997ea
+  metadata.gz: df0dd7efcddca3f324e4e6f7b61fd70a1bee3d3d81571ffa1dc72e090bf2934e
+  data.tar.gz: b99811540e9195cecad5c8ee3cf7807fb3340e87353327d021a166af5f34a112
 SHA512:
-  metadata.gz: a586f8ae1273269473451ea60bfeccb5e9fd01b6fa4ddacfd99b5918dfed24aa340a9e61aba6036a96b572c1eef50c4d2e1a9cd87162442197a02a4ff2456b2c
-  data.tar.gz: a7d894c039bdc676164f1dcd083650ae8ce026152baad7d83ea790a3ee4850e4de59246e922a641d6446943389c456557c1712b8b34c2085d4398e226c323c86
+  metadata.gz: 6d39db68ce16afde0e0139a4e31bfac53f5bef2066972777165502eac78fd09ed292a23e945d7584385148e3375d72f8d254275a7367e7e07278a16a79b85819
+  data.tar.gz: c8e5b439466d50cbac88269d6036c22f7aa84864590cc28862976bf005ada580431b3e9a4a8e652a6ae5ecadb687b2bf59e6607f0cd87e15315f26b86a003d12

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    readme-metrics (0.2.0)
+    readme-metrics (1.1.0)
       httparty (~> 0.18)
 
 GEM
@@ -21,7 +21,7 @@ GEM
       addressable (>= 2.4)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2020.0512)
+    mime-types-data (3.2021.0225)
     multi_xml (0.6.0)
     parallel (1.19.2)
     parser (2.7.1.4)

data/README.md

@@ -1,7 +1,8 @@
-# readmeio
+# readme-metrics
 
 Track your API metrics within ReadMe.
 
+[![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)
 
 [![](https://d3vv6lp55qjaqc.cloudfront.net/items/1M3C3j0I0s0j3T362344/Untitled-2.png)](https://readme.io)
@@ -26,8 +27,8 @@ current_user for a given request from the environment.
 
 ### Batching requests
 
-By default, the middleware will batch requests to the ReadMe API in groups of
-10. For every 10 requests made to your application, the middleware will make a
+By default, the middleware will batch requests to the ReadMe API in groups of 10.
+For every 10 requests made to your application, the middleware will make a
 single request to ReadMe. If you wish to override this, provide a
 `buffer_length` option when configuring the middleware.
 
@@ -51,7 +52,7 @@ You may only specify either `reject_params` or `allow_only` keys, not both.
 require "readme/metrics"
 
 options = {
-  api_key: "YOUR_API_KEY",
+  api_key: "<<apiKey>>",
   development: false,
   reject_params: ["not_included", "dont_send"],
   buffer_length: 5,
@@ -62,13 +63,13 @@ config.middleware.use Readme::Metrics, options do |env|
 
   if current_user.present?
     {
-      id: current_user.id,
+      api_key: current_user.api_key, # Not the same as the ReadMe API Key
       label: current_user.name,
       email: current_user.email
     }
   else
     {
-      id: "guest",
+      api_key: "guest",
       label: "Guest User",
       email: "guest@example.com"
     }
@@ -81,16 +82,16 @@ end
 ```ruby
 # config.ru
 options = {
-  api_key: "YOUR_API_KEY",
+  api_key: "<<apiKey>>",
   development: false,
   reject_params: ["not_included", "dont_send"]
 }
 
 use Readme::Metrics, options do |env|
     {
-      id: "my_application_id"
-      label: "My Application",
-      email: "my.application@example.com"
+      api_key: "owlbert_api_key"
+      label: "Owlbert",
+      email: "owlbert@example.com"
     }
 end
 
@@ -105,4 +106,4 @@ run YourApp.new
 
 ## License
 
-[View our license here](https://github.com/readmeio/metrics-sdks/tree/master/packages/ruby/LICENSE)
+[View our license here](https://github.com/readmeio/metrics-sdks/tree/main/packages/ruby/LICENSE)

data/lib/readme/content_type_helper.rb

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

data/lib/readme/errors.rb

@@ -25,7 +25,7 @@ module Readme
         middleware.
 
         Expected a hash with the shape:
-          { id: "unique_id", label: "Your user label", email: "Your user email" }
+          { api_key: "Your user api key", label: "Your user label", email: "Your user email" }
 
         Received value:
           #{result}

data/lib/readme/filter.rb

@@ -1,58 +1,73 @@
-class Filter
-  def self.for(reject: nil, allow_only: nil)
-    if !reject.nil? && !allow_only.nil?
-      raise FilterArgsError
-    elsif !reject.nil?
-      RejectParams.new(reject)
-    elsif !allow_only.nil?
-      AllowOnly.new(allow_only)
-    else
-      None.new
+module Readme
+  class Filter
+    def self.for(reject: nil, allow_only: nil)
+      if !reject.nil? && !allow_only.nil?
+        raise FilterArgsError
+      elsif !reject.nil?
+        RejectParams.new(reject)
+      elsif !allow_only.nil?
+        AllowOnly.new(allow_only)
+      else
+        None.new
+      end
     end
-  end
 
-  class AllowOnly
-    def initialize(filter_values)
-      @filter_values = filter_values.map(&:downcase)
+    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}" : ""}]"
+      end
     end
 
-    def filter(hash)
-      hash.select { |key, _value| @filter_values.include?(key.downcase) }
-    end
+    class AllowOnly
+      def initialize(filter_fields)
+        @allowed_fields = filter_fields
+      end
 
-    def pass_through?
-      false
-    end
-  end
+      def filter(hash)
+        allowed_fields = @allowed_fields.map(&:downcase)
+        allowed_params, rejected_params = hash.partition { |key, _value| allowed_fields.include?(key.downcase) }.map(&:to_h)
 
-  class RejectParams
-    def initialize(filter_values)
-      @filter_values = filter_values.map(&:downcase)
-    end
+        allowed_params.merge(Filter.redact(rejected_params))
+      end
 
-    def filter(hash)
-      hash.reject { |key, _value| @filter_values.include?(key.downcase) }
+      def pass_through?
+        false
+      end
     end
 
-    def pass_through?
-      false
-    end
-  end
+    class RejectParams
+      def initialize(filter_fields)
+        @rejected_fields = filter_fields
+      end
+
+      def filter(hash)
+        rejected_fields = @rejected_fields.map(&:downcase)
+        rejected_params, allowed_params = hash.partition { |key, _value| rejected_fields.include?(key.downcase) }.map(&:to_h)
+
+        allowed_params.merge(Filter.redact(rejected_params))
+      end
 
-  class None
-    def filter(hash)
-      hash
+      def pass_through?
+        false
+      end
     end
 
-    def pass_through?
-      true
+    class None
+      def filter(hash)
+        hash
+      end
+
+      def pass_through?
+        true
+      end
     end
-  end
 
-  class FilterArgsError < StandardError
-    def initialize
-      msg = "Can only supply either reject_params or allow_only, not both."
-      super(msg)
+    class FilterArgsError < StandardError
+      def initialize
+        msg = "Can only supply either reject_params or allow_only, not both."
+        super(msg)
+      end
     end
   end
 end

data/lib/readme/http_request.rb

@@ -0,0 +1,101 @@
+require "rack"
+require "rack/request"
+require_relative "content_type_helper"
+
+module Readme
+  class HttpRequest
+    include ContentTypeHelper
+
+    HTTP_NON_HEADERS = [
+      Rack::HTTP_COOKIE,
+      Rack::HTTP_VERSION,
+      Rack::HTTP_HOST,
+      Rack::HTTP_PORT
+    ]
+
+    def initialize(env)
+      @request = Rack::Request.new(env)
+    end
+
+    def url
+      @request.url
+    end
+
+    def query_params
+      @request.GET
+    end
+
+    def cookies
+      @request.cookies
+    end
+
+    def http_version
+      @request.get_header(Rack::HTTP_VERSION)
+    end
+
+    def request_method
+      @request.request_method
+    end
+
+    def content_type
+      @request.content_type
+    end
+
+    def form_data?
+      @request.form_data?
+    end
+
+    def content_length
+      @request.content_length.to_i
+    end
+
+    def options?
+      @request.request_method == "OPTIONS"
+    end
+
+    def headers
+      @request
+        .each_header
+        .select { |key, _| http_header?(key) }
+        .to_h
+        .transform_keys { |header| normalize_header_name(header) }
+        .merge unprefixed_headers
+    end
+
+    def body
+      @request.body.rewind
+      content = @request.body.read
+      @request.body.rewind
+
+      content
+    end
+
+    def parsed_form_data
+      @request.POST
+    end
+
+    private
+
+    # "headers" in Rack::Request just means any key in the env. The HTTP headers
+    # are all the headers prefixed with `HTTP_` as per the spec:
+    # https://github.com/rack/rack/blob/master/SPEC.rdoc#the-environment-
+    # 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)
+    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("-")
+    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
+    end
+  end
+end

data/lib/readme/http_response.rb

@@ -0,0 +1,45 @@
+require "rack"
+require "rack/response"
+require_relative "content_type_helper"
+
+module Readme
+  class HttpResponse < SimpleDelegator
+    include ContentTypeHelper
+
+    def self.from_parts(status, headers, body)
+      new(Rack::Response.new(body, status, headers))
+    end
+
+    def body
+      if raw_body.respond_to?(:rewind)
+        raw_body.rewind
+        content = raw_body.each.reduce("", :+)
+        raw_body.rewind
+
+        content
+      else
+        raw_body.each.reduce("", :+)
+      end
+    end
+
+    def content_length
+      if empty_body_status?
+        0
+      elsif !headers["Content-Length"]
+        body.bytesize
+      else
+        headers["Content-Length"].to_i
+      end
+    end
+
+    private
+
+    def raw_body
+      __getobj__.body
+    end
+
+    def empty_body_status?
+      Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.include?(status.to_i)
+    end
+  end
+end

data/lib/readme/metrics.rb

@@ -4,8 +4,8 @@ require "readme/filter"
 require "readme/payload"
 require "readme/request_queue"
 require "readme/errors"
-require "http_request"
-require "http_response"
+require "readme/http_request"
+require "readme/http_response"
 require "httparty"
 require "logger"
 
@@ -14,7 +14,8 @@ module Readme
     SDK_NAME = "Readme.io Ruby SDK"
     DEFAULT_BUFFER_LENGTH = 10
     ENDPOINT = "https://metrics.readme.io/v1/request"
-    USER_INFO_KEYS = [:id, :label, :email]
+    USER_INFO_KEYS = [:api_key, :label, :email]
+    USER_INFO_KEYS_DEPRECATED = [:id, :label, :email]
 
     def self.logger
       @@logger
@@ -65,7 +66,7 @@ module Readme
       har = Har::Serializer.new(request, response, start_time, end_time, @filter)
       user_info = @get_user_info.call(env)
 
-      if user_info_invalid?(user_info)
+      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"
@@ -132,10 +133,12 @@ module Readme
       arg == true || arg == false
     end
 
-    def user_info_invalid?(user_info)
-      user_info.nil? ||
-        user_info.values.any?(&:nil?) ||
-        USER_INFO_KEYS.sort != user_info.keys.sort
+    def user_info_valid?(user_info)
+      sorted_user_info_keys = user_info.keys.sort
+      !user_info.nil? &&
+        !user_info.values.any?(&:nil?) &&
+        (sorted_user_info_keys === USER_INFO_KEYS.sort ||
+          sorted_user_info_keys === USER_INFO_KEYS_DEPRECATED.sort)
     end
   end
 end

data/lib/readme/metrics/version.rb

@@ -1,5 +1,5 @@
 module Readme
   class Metrics
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
   end
 end

data/lib/readme/payload.rb

@@ -2,6 +2,8 @@ module Readme
   class Payload
     def initialize(har, user_info, development:)
       @har = har
+      # swap api_key for id
+      user_info[:id] = user_info.delete :api_key unless user_info[:api_key].nil?
       @user_info = user_info
       @development = development
     end

data/readme-metrics.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |spec|
   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/master/packages/ruby"
-  spec.metadata["changelog_uri"] = "https://github.com/readmeio/metrics-sdks/blob/master/packages/ruby/CHANGELOG.md"
+  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"
 
   # 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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readme-metrics
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - ReadMe
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-28 00:00:00.000000000 Z
+date: 2021-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -40,15 +40,15 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/content_type_helper.rb
-- lib/http_request.rb
-- lib/http_response.rb
+- lib/readme/content_type_helper.rb
 - lib/readme/errors.rb
 - lib/readme/filter.rb
 - lib/readme/har/collection.rb
 - lib/readme/har/request_serializer.rb
 - lib/readme/har/response_serializer.rb
 - lib/readme/har/serializer.rb
+- lib/readme/http_request.rb
+- lib/readme/http_response.rb
 - lib/readme/metrics.rb
 - lib/readme/metrics/version.rb
 - lib/readme/payload.rb
@@ -59,8 +59,8 @@ 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/master/packages/ruby
-  changelog_uri: https://github.com/readmeio/metrics-sdks/blob/master/packages/ruby/CHANGELOG.md
+  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:
 rdoc_options: []
 require_paths:
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: SDK for Readme's metrics API

data/lib/content_type_helper.rb

@@ -1,15 +0,0 @@
-module ContentTypeHelper
-  # Assumes the includer has a `content_type` method defined.
-
-  JSON_MIME_TYPES = [
-    "application/json",
-    "application/x-json",
-    "text/json",
-    "text/x-json",
-    "+json"
-  ]
-
-  def json?
-    JSON_MIME_TYPES.any? { |mime_type| content_type.include?(mime_type) }
-  end
-end

data/lib/http_request.rb

@@ -1,99 +0,0 @@
-require "rack"
-require "rack/request"
-require "content_type_helper"
-
-class HttpRequest
-  include ContentTypeHelper
-
-  HTTP_NON_HEADERS = [
-    Rack::HTTP_COOKIE,
-    Rack::HTTP_VERSION,
-    Rack::HTTP_HOST,
-    Rack::HTTP_PORT
-  ]
-
-  def initialize(env)
-    @request = Rack::Request.new(env)
-  end
-
-  def url
-    @request.url
-  end
-
-  def query_params
-    @request.GET
-  end
-
-  def cookies
-    @request.cookies
-  end
-
-  def http_version
-    @request.get_header(Rack::HTTP_VERSION)
-  end
-
-  def request_method
-    @request.request_method
-  end
-
-  def content_type
-    @request.content_type
-  end
-
-  def form_data?
-    @request.form_data?
-  end
-
-  def content_length
-    @request.content_length.to_i
-  end
-
-  def options?
-    @request.request_method == "OPTIONS"
-  end
-
-  def headers
-    @request
-      .each_header
-      .select { |key, _| http_header?(key) }
-      .to_h
-      .transform_keys { |header| normalize_header_name(header) }
-      .merge unprefixed_headers
-  end
-
-  def body
-    @request.body.rewind
-    content = @request.body.read
-    @request.body.rewind
-
-    content
-  end
-
-  def parsed_form_data
-    @request.POST
-  end
-
-  private
-
-  # "headers" in Rack::Request just means any key in the env. The HTTP headers
-  # are all the headers prefixed with `HTTP_` as per the spec:
-  # https://github.com/rack/rack/blob/master/SPEC.rdoc#the-environment-
-  # 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)
-  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("-")
-  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
-  end
-end

data/lib/http_response.rb

@@ -1,43 +0,0 @@
-require "rack"
-require "rack/response"
-require "content_type_helper"
-
-class HttpResponse < SimpleDelegator
-  include ContentTypeHelper
-
-  def self.from_parts(status, headers, body)
-    new(Rack::Response.new(body, status, headers))
-  end
-
-  def body
-    if raw_body.respond_to?(:rewind)
-      raw_body.rewind
-      content = raw_body.each.reduce("", :+)
-      raw_body.rewind
-
-      content
-    else
-      raw_body.each.reduce("", :+)
-    end
-  end
-
-  def content_length
-    if empty_body_status?
-      0
-    elsif !headers["Content-Length"]
-      body.bytesize
-    else
-      headers["Content-Length"].to_i
-    end
-  end
-
-  private
-
-  def raw_body
-    __getobj__.body
-  end
-
-  def empty_body_status?
-    Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.include?(status.to_i)
-  end
-end