readme-metrics 0.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00a1c3d34d8c61c9fbcaacc3914ddb3e03837ce22bd3325dbabd30ba5b4c373e
-  data.tar.gz: 34665a455715eaf423370cba89b31575dc87d53169c9bb8680f8b87a847e1704
+  metadata.gz: f22a117a4ef3e32682439eb3c6532766c442a32e067429857ed33548c2305ee1
+  data.tar.gz: 436f9b30983241c5ac5b1790e49c85268a7ef3afc3c07b208b13967f88ebfde6
 SHA512:
-  metadata.gz: '05980a5c1bbdb0b23d438f18c8fcb27f931e3781e2e41ce938dff13611bfc6b70d8c61c141f644d4eeb3b1381019a3eff38e52da2adeb223cd1761ba8b6e53e7'
-  data.tar.gz: 0a084c22580cc59868089773b85dec83ad295c1984ac616f1ad8a947a8914130f35c19c78bf05b8945188cddbf49882391a8375581c5f5f50d0af0531e9db2ea
+  metadata.gz: 432a22c8576ffb597876b7a899b18d1128c48226b27f4f0f30ae40f4855f50ce7586b169c0390257ab8da295a6f85aab618d9d3bbff24cc5f6bf00cf91dcaa91
+  data.tar.gz: abe8ecf0008727d3b05b984661db799ab5510ff201f3df5d8c05eb521e2f34231da44a915745dd9cea7ebd027c0c6fe48df312aa081cf75b93fc4bfd3049b5c6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    readme-metrics (0.1.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,10 @@
-# 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)
 
 ## Installation
@@ -24,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.
 
@@ -45,50 +48,62 @@ You may only specify either `reject_params` or `allow_only` keys, not both.
 ### Rails
 
 ```ruby
-# application.rb
+# config/environments/development.rb or config/environments/production.rb
 require "readme/metrics"
 
 options = {
-  api_key: "YOUR_API_KEY",
+  api_key: "<<apiKey>>",
   development: false,
   reject_params: ["not_included", "dont_send"],
   buffer_length: 5,
 }
 
 config.middleware.use Readme::Metrics, options do |env|
-  current_user = env['warden'].authenticate(scope: :current_user)
+  current_user = env['warden'].authenticate
 
-  {
-    id: current_user.id
-    label: current_user.full_name,
-    email: current_user.email
-  }
+  if 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
+    }
+  else
+    {
+      api_key: "guest",
+      label: "Guest User",
+      email: "guest@example.com"
+    }
+  end
 end
 ```
 
-### Rack::Builder
+### Rack
 
 ```ruby
-Rack::Builder.new do |builder|
-  options = {
-    api_key: "YOUR_API_KEY",
-    development: false,
-    reject_params: ["not_included", "dont_send"]
-  }
-
-  builder.use Readme::Metrics, options do |env|
+# config.ru
+options = {
+  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
-  builder.run your_app
 end
+
+run YourApp.new
 ```
 
-## License
+### Sample Applications
 
-[View our license here](https://github.com/readmeio/metrics-sdks/tree/master/packages/ruby/LICENSE)
+- [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)
 
+## 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

@@ -5,6 +5,10 @@ module Readme
     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
+    MESSAGE
 
     MISSING_BLOCK_ERROR = <<~MESSAGE
       Missing block argument. You must provide a block when configuring the
@@ -21,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,46 +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
+    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) }
-    end
-  end
+    class AllowOnly
+      def initialize(filter_fields)
+        @allowed_fields = filter_fields
+      end
 
-  class RejectParams
-    def initialize(filter_values)
-      @filter_values = filter_values
+      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)
+
+        allowed_params.merge(Filter.redact(rejected_params))
+      end
+
+      def pass_through?
+        false
+      end
     end
 
-    def filter(hash)
-      hash.reject { |key, _value| @filter_values.include?(key) }
+    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
+
+      def pass_through?
+        false
+      end
     end
-  end
 
-  class None
-    def filter(hash)
-      hash
+    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/har/request_serializer.rb

@@ -46,9 +46,21 @@ module Readme
       end
 
       def request_body
+        if @filter.pass_through?
+          pass_through_body
+        else
+          # Only JSON allowed for non-pass-through situations. It will raise
+          # if the body can't be parsed as JSON, aborting the request.
+          json_body
+        end
+      end
+
+      def json_body
         parsed_body = JSON.parse(@request.body)
         Har::Collection.new(@filter, parsed_body).to_h.to_json
-      rescue
+      end
+
+      def pass_through_body
         @request.body
       end
     end

data/lib/readme/har/response_serializer.rb

@@ -4,8 +4,6 @@ require "readme/har/collection"
 module Readme
   module Har
     class ResponseSerializer
-      JSON_MIME_TYPES = ["application/json", "application/x-json", "text/json", "text/x-json", "+json"]
-
       def initialize(request, response, filter)
         @request = request
         @response = response
@@ -29,9 +27,9 @@ module Readme
       private
 
       def content
-        if response_body.nil?
+        if @response.body.empty?
           empty_content
-        elsif content_type_is_json?
+        elsif @response.json?
           json_content
         else
           pass_through_content
@@ -43,37 +41,23 @@ module Readme
       end
 
       def json_content
-        parsed_body = JSON.parse(response_body)
+        parsed_body = JSON.parse(@response.body)
 
-        {mimeType: @response.content_type,
-         size: @response.content_length,
-         text: Har::Collection.new(@filter, parsed_body).to_h.to_json}
+        {
+          mimeType: @response.content_type,
+          size: @response.content_length,
+          text: Har::Collection.new(@filter, parsed_body).to_h.to_json
+        }
       rescue
         pass_through_content
       end
 
       def pass_through_content
-        {mimeType: @response.content_type,
-         size: @response.content_length,
-         text: response_body}
-      end
-
-      def response_body
-        if @response.body.nil?
-          nil
-        elsif @response.body.respond_to?(:rewind)
-          @response.body.rewind
-          body = @response.body.each.reduce(:+)
-          @response.body.rewind
-
-          body
-        else
-          @response.body.each.reduce(:+)
-        end
-      end
-
-      def content_type_is_json?
-        JSON_MIME_TYPES.include? @response.content_type
+        {
+          mimeType: @response.content_type,
+          size: @response.content_length,
+          text: @response.body
+        }
       end
     end
   end

data/lib/readme/har/serializer.rb

@@ -1,5 +1,4 @@
 require "rack"
-require "http_request"
 require "readme/metrics"
 require "readme/har/request_serializer"
 require "readme/har/response_serializer"
@@ -10,8 +9,8 @@ module Readme
     class Serializer
       HAR_VERSION = "1.2"
 
-      def initialize(env, response, start_time, end_time, filter)
-        @http_request = HttpRequest.new(env)
+      def initialize(request, response, start_time, end_time, filter)
+        @http_request = request
         @response = response
         @start_time = start_time
         @end_time = end_time

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,14 +4,22 @@ 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
     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
+    end
 
     def initialize(app, options, &get_user_info)
       validate_options(options)
@@ -26,7 +34,8 @@ module Readme
       @get_user_info = get_user_info
 
       buffer_length = options[:buffer_length] || DEFAULT_BUFFER_LENGTH
-      @@request_queue = Readme::RequestQueue.new(options[:api_key], buffer_length)
+      @@request_queue = options[:request_queue] || Readme::RequestQueue.new(options[:api_key], buffer_length)
+      @@logger = options[:logger] || Logger.new($stdout)
     end
 
     def call(env)
@@ -34,24 +43,56 @@ module Readme
       status, headers, body = @app.call(env)
       end_time = Time.now
 
-      response = Rack::Response.new(body, status, headers)
+      begin
+        response = HttpResponse.from_parts(status, headers, body)
+        process_response(
+          response: response,
+          env: env,
+          start_time: start_time,
+          end_time: end_time
+        )
+      rescue => e
+        Readme::Metrics.logger.warn "The following error occured when trying to log to the ReadMe metrics API: #{e.message}. Request not logged."
+        [status, headers, body]
+      end
+
+      [status, headers, body]
+    end
 
-      har = Har::Serializer.new(env, response, start_time, end_time, @filter)
+    private
 
+    def process_response(response:, env:, start_time:, end_time:)
+      request = HttpRequest.new(env)
+      har = Har::Serializer.new(request, response, start_time, end_time, @filter)
       user_info = @get_user_info.call(env)
 
-      if user_info_invalid?(user_info)
-        puts Errors.bad_block_message(user_info)
-        return [status, headers, body]
+      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"
+      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)
         @@request_queue.push(payload.to_json)
       end
+    end
 
-      [status, headers, body]
+    def can_filter?(request, response)
+      @filter.pass_through? || can_parse_bodies?(request, response)
     end
 
-    private
+    def can_parse_bodies?(request, response)
+      parseable_request?(request) && parseable_response?(response)
+    end
+
+    def parseable_response?(response)
+      response.body.empty? || response.json?
+    end
+
+    def parseable_request?(request)
+      request.body.empty? || request.json? || request.form_data?
+    end
 
     def validate_options(options)
       raise Errors::ConfigurationError, Errors::API_KEY_ERROR if options[:api_key].nil?
@@ -71,16 +112,33 @@ module Readme
       if options[:development] && !is_a_boolean?(options[:development])
         raise Errors::ConfigurationError, Errors::DEVELOPMENT_ERROR
       end
+
+      if options[:logger] && has_logger_inferface?(options[:logger])
+        raise Errors::ConfigurationError, Errors::LOGGER_ERROR
+      end
+    end
+
+    def has_logger_inferface?(logger)
+      [
+        :unknown,
+        :fatal,
+        :error,
+        :warn,
+        :info,
+        :debug
+      ].any? { |message| !logger.respond_to? message }
     end
 
     def is_a_boolean?(arg)
       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 = "0.1.0"
+    VERSION = "1.1.1"
   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/lib/readme/request_queue.rb

@@ -2,19 +2,32 @@ require "readme/metrics"
 
 module Readme
   class RequestQueue
-    attr_reader :queue
-
     def initialize(api_key, buffer_length)
       @queue = []
       @buffer_length = buffer_length
       @api_key = api_key
+      @lock = Mutex.new
     end
 
     def push(request)
-      @queue << request
+      @lock.synchronize do
+        @queue << request
+
+        if ready_to_send?
+          payloads = @queue.slice!(0, @buffer_length)
+          send_payloads(payloads)
+        end
+      end
+    end
+
+    def length
+      @queue.length
+    end
+
+    private
 
-      if ready_to_send?
-        payloads = @queue.slice!(0, @buffer_length)
+    def send_payloads(payloads)
+      Thread.new do
         HTTParty.post(
           Readme::Metrics::ENDPOINT,
           basic_auth: {username: @api_key, password: ""},
@@ -24,10 +37,8 @@ module Readme
       end
     end
 
-    private
-
     def ready_to_send?
-      @queue.length >= @buffer_length
+      length >= @buffer_length
     end
 
     def to_json(payloads)

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: 0.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - ReadMe
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-20 00:00:00.000000000 Z
+date: 2021-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -40,13 +40,15 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/http_request.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
@@ -57,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:
@@ -74,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/http_request.rb

@@ -1,84 +0,0 @@
-require "rack"
-require "rack/request"
-
-class HttpRequest
-  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 headers
-    @request
-      .each_header
-      .select { |key, _| http_header?(key) }
-      .to_h
-      .transform_keys { |header| normalize_header_name(header) }
-  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
-end