readme-metrics 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00a1c3d34d8c61c9fbcaacc3914ddb3e03837ce22bd3325dbabd30ba5b4c373e
-  data.tar.gz: 34665a455715eaf423370cba89b31575dc87d53169c9bb8680f8b87a847e1704
+  metadata.gz: 66f7b071458adb5af02621626935bc6d9520bad8e246369a5f500f9037c3ea3b
+  data.tar.gz: f3d313877ae15673722a1c749a5529e971ec17491a7eef639924cf3991419c49
 SHA512:
-  metadata.gz: '05980a5c1bbdb0b23d438f18c8fcb27f931e3781e2e41ce938dff13611bfc6b70d8c61c141f644d4eeb3b1381019a3eff38e52da2adeb223cd1761ba8b6e53e7'
-  data.tar.gz: 0a084c22580cc59868089773b85dec83ad295c1984ac616f1ad8a947a8914130f35c19c78bf05b8945188cddbf49882391a8375581c5f5f50d0af0531e9db2ea
+  metadata.gz: be4ec7898257dbd67adf3e27070ea4cb1ee37b0d54d80de7ca2418356bfe3330a0fcdfa8ea3b16fed15afaa03a65ae0c58882f634385f37e76c275a2209f681d
+  data.tar.gz: 76323ca324090a903898b7bd0ff818097272a6270466b4ed9eb58e06897c9becc6cc47264a0e64ee81e4a5a577aa7241ebd09f4d2bda9c3027e914b512b946e9

data/README.md

@@ -2,6 +2,8 @@
 
 Track your API metrics within ReadMe.
 
+[![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

data/lib/http_request.rb

@@ -45,6 +45,10 @@ class HttpRequest
     @request.content_length.to_i
   end
 
+  def options?
+    @request.request_method == "OPTIONS"
+  end
+
   def headers
     @request
       .each_header

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

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

@@ -4,7 +4,9 @@ require "readme/filter"
 require "readme/payload"
 require "readme/request_queue"
 require "readme/errors"
+require "http_request"
 require "httparty"
+require "logger"
 
 module Readme
   class Metrics
@@ -13,6 +15,10 @@ module Readme
     ENDPOINT = "https://metrics.readme.io/v1/request"
     USER_INFO_KEYS = [:id, :label, :email]
 
+    def self.logger
+      @@logger
+    end
+
     def initialize(app, options, &get_user_info)
       validate_options(options)
       raise Errors::ConfigurationError, Errors::MISSING_BLOCK_ERROR if get_user_info.nil?
@@ -27,32 +33,46 @@ module Readme
 
       buffer_length = options[:buffer_length] || DEFAULT_BUFFER_LENGTH
       @@request_queue = Readme::RequestQueue.new(options[:api_key], buffer_length)
+      @@logger = options[:logger] || Logger.new($stdout)
     end
 
     def call(env)
       start_time = Time.now
       status, headers, body = @app.call(env)
       end_time = Time.now
-
       response = Rack::Response.new(body, status, headers)
 
-      har = Har::Serializer.new(env, response, start_time, end_time, @filter)
+      begin
+        process_response(
+          response: response,
+          env: env,
+          start_time: start_time,
+          end_time: end_time
+        )
+      rescue
+        [status, headers, body]
+      end
+
+      [status, headers, body]
+    end
+
+    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]
+        Readme::Metrics.logger.error Errors.bad_block_message(user_info)
+      elsif request.options?
+        Readme::Metrics.logger.info "OPTIONS request omitted from ReadMe API logging"
       else
         payload = Payload.new(har, user_info, development: @development)
         @@request_queue.push(payload.to_json)
       end
-
-      [status, headers, body]
     end
 
-    private
-
     def validate_options(options)
       raise Errors::ConfigurationError, Errors::API_KEY_ERROR if options[:api_key].nil?
 
@@ -71,6 +91,21 @@ 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)

data/lib/readme/metrics/version.rb

@@ -1,5 +1,5 @@
 module Readme
   class Metrics
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readme-metrics
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - ReadMe
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-20 00:00:00.000000000 Z
+date: 2020-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty