readme-metrics 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66f7b071458adb5af02621626935bc6d9520bad8e246369a5f500f9037c3ea3b
-  data.tar.gz: f3d313877ae15673722a1c749a5529e971ec17491a7eef639924cf3991419c49
+  metadata.gz: 17dad1b40b974d05ae3d57a664e6f95c393cbaf8e807071631c11800b2ee118c
+  data.tar.gz: 2d3595d321dea5bac6b5577180f608a2f9045e333592e5c33cca4c52a3e997ea
 SHA512:
-  metadata.gz: be4ec7898257dbd67adf3e27070ea4cb1ee37b0d54d80de7ca2418356bfe3330a0fcdfa8ea3b16fed15afaa03a65ae0c58882f634385f37e76c275a2209f681d
-  data.tar.gz: 76323ca324090a903898b7bd0ff818097272a6270466b4ed9eb58e06897c9becc6cc47264a0e64ee81e4a5a577aa7241ebd09f4d2bda9c3027e914b512b946e9
+  metadata.gz: a586f8ae1273269473451ea60bfeccb5e9fd01b6fa4ddacfd99b5918dfed24aa340a9e61aba6036a96b572c1eef50c4d2e1a9cd87162442197a02a4ff2456b2c
+  data.tar.gz: a7d894c039bdc676164f1dcd083650ae8ce026152baad7d83ea790a3ee4850e4de59246e922a641d6446943389c456557c1712b8b34c2085d4398e226c323c86

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    readme-metrics (0.1.0)
+    readme-metrics (0.2.0)
       httparty (~> 0.18)
 
 GEM

data/README.md

@@ -47,7 +47,7 @@ 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 = {
@@ -58,39 +58,51 @@ options = {
 }
 
 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?
+    {
+      id: current_user.id,
+      label: current_user.name,
+      email: current_user.email
+    }
+  else
+    {
+      id: "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: "YOUR_API_KEY",
+  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"
     }
-  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/master/packages/ruby/LICENSE)

data/lib/content_type_helper.rb

@@ -0,0 +1,15 @@
+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,7 +1,10 @@
 require "rack"
 require "rack/request"
+require "content_type_helper"
 
 class HttpRequest
+  include ContentTypeHelper
+
   HTTP_NON_HEADERS = [
     Rack::HTTP_COOKIE,
     Rack::HTTP_VERSION,
@@ -55,6 +58,7 @@ class HttpRequest
       .select { |key, _| http_header?(key) }
       .to_h
       .transform_keys { |header| normalize_header_name(header) }
+      .merge unprefixed_headers
   end
 
   def body
@@ -85,4 +89,11 @@ class HttpRequest
   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

@@ -0,0 +1,43 @@
+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

data/lib/readme/filter.rb

@@ -13,21 +13,29 @@ class Filter
 
   class AllowOnly
     def initialize(filter_values)
-      @filter_values = filter_values
+      @filter_values = filter_values.map(&:downcase)
     end
 
     def filter(hash)
-      hash.select { |key, _value| @filter_values.include?(key) }
+      hash.select { |key, _value| @filter_values.include?(key.downcase) }
+    end
+
+    def pass_through?
+      false
     end
   end
 
   class RejectParams
     def initialize(filter_values)
-      @filter_values = filter_values
+      @filter_values = filter_values.map(&:downcase)
     end
 
     def filter(hash)
-      hash.reject { |key, _value| @filter_values.include?(key) }
+      hash.reject { |key, _value| @filter_values.include?(key.downcase) }
+    end
+
+    def pass_through?
+      false
     end
   end
 
@@ -35,6 +43,10 @@ class Filter
     def filter(hash)
       hash
     end
+
+    def pass_through?
+      true
+    end
   end
 
   class FilterArgsError < StandardError

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/metrics.rb

@@ -5,6 +5,7 @@ require "readme/payload"
 require "readme/request_queue"
 require "readme/errors"
 require "http_request"
+require "http_response"
 require "httparty"
 require "logger"
 
@@ -40,16 +41,17 @@ module Readme
       start_time = Time.now
       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
+      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
 
@@ -64,15 +66,33 @@ module Readme
       user_info = @get_user_info.call(env)
 
       if user_info_invalid?(user_info)
-        Readme::Metrics.logger.error Errors.bad_block_message(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
 
+    def can_filter?(request, response)
+      @filter.pass_through? || can_parse_bodies?(request, response)
+    end
+
+    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?
 

data/lib/readme/metrics/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readme-metrics
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - ReadMe
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-26 00:00:00.000000000 Z
+date: 2020-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -40,7 +40,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/content_type_helper.rb
 - lib/http_request.rb
+- lib/http_response.rb
 - lib/readme/errors.rb
 - lib/readme/filter.rb
 - lib/readme/har/collection.rb