salestation 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7af82fc0b7698f3f66945b5291d2a2d9ccf869bd
-  data.tar.gz: e0f635d0e541cb790124900cc7c6b2cc10a8fc5e
+  metadata.gz: 8ebf9157080bc595e5627ac9dd0a63a24afd3f12
+  data.tar.gz: 06f85ef72b8cf37c248129448e9466040016c6c2
 SHA512:
-  metadata.gz: deab697cdfd27d779bdf67e09508e0dbadb602e0351b6727592f9d695e54de121223133f01d8e92af3ca818fe5952b3f8831f49c776b5e508ea8f61c23081db5
-  data.tar.gz: 818726078b70b2e9a44b6af528e81a8e2aaef8ceffba89ec299b61c345c67a002152d164f6200fd31dfa5f33ca46f584118760728c70ad8fd713f6cca194f0b3
+  metadata.gz: a1ceaacece5be4693ce08f0542486b86e7c4462b273b8e9efebe958f30ac3471e21e3f95e77f7b90b7f77a01f64861b5a63b9ac7f9599dcfa86c2f91304925e2
+  data.tar.gz: 54fd1b4f4a7dca1e60959d3f213f2a33d2178ca400c3e4170bfab88a43ab1356775ad25075519aadbdb7b7c164c7f9bfcb2e03f83a392e68135a3b4355dfa3ed

data/README.md

@@ -73,6 +73,32 @@ Salestation allows and recommends you to define your own custom errors. This is
   })
 ```
 
+### Using a logger
+
+Salestation provides a rack logging middleware which can be used to log structured objects.
+
+```ruby
+class Webapp < Sinatra::Base
+  # ...
+  use Salestation::Web::RequestLogger, my_logger
+end
+```
+
+### Using StatsD
+
+Salestation provides a StatsD middleware which can be used record request
+execution time. A `timing` call with elapsed seconds is made to the provided
+StatsD instance with `path`, `method`, `status` tags.
+
+```ruby
+class Webapp < Sinatra::Base
+  # ...
+  use Salestation::Web::StatsdMiddleware,
+    Statsd.new(host, port),
+    metric: 'my-metric'
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/salestation/web/request_logger.rb

@@ -0,0 +1,91 @@
+module Salestation
+  class Web < Module
+    class RequestLogger
+
+      REMOTE_ADDR = 'REMOTE_ADDR'.freeze
+      REQUEST_URI = 'REQUEST_URI'.freeze
+      REQUEST_METHOD = 'REQUEST_METHOD'.freeze
+      QUERY_STRING   = 'QUERY_STRING'.freeze
+      CONTENT_TYPE = 'CONTENT_TYPE'.freeze
+      HTTP_USER_AGENT = 'HTTP_USER_AGENT'.freeze
+      HTTP_ACCEPT = 'HTTP_ACCEPT'.freeze
+      SERVER_NAME = 'SERVER_NAME'.freeze
+      JSON_CONTENT_TYPE = 'application/json'.freeze
+
+      def initialize(app, logger)
+        @app = app
+        @logger = logger
+      end
+
+      def call(env)
+        request_id = SecureRandom.hex(4)
+        request_logger = Logger.new(@logger, request_id)
+
+        env['request_logger'] = request_logger
+        began_at = Time.now
+
+        request_logger.info('Received request', request_log(env))
+        @app.call(env).tap do |status, headers, body|
+          type = status >= 500 ? :info : :error
+          request_logger.public_send(type, 'Processed request', response_log(env, status, headers, body, began_at))
+        end
+      end
+
+      private
+
+      def request_log(env)
+        {
+          remote_addr:  env[REMOTE_ADDR],
+          method:       env[REQUEST_METHOD],
+          path:         env[REQUEST_URI],
+          query:        env[QUERY_STRING],
+          content_type: env[CONTENT_TYPE],
+          http_agent:   env[HTTP_USER_AGENT],
+          http_accept:  env[HTTP_ACCEPT],
+          server_name:  env[SERVER_NAME]
+        }
+      end
+
+      def response_log(env, status, headers, body, began_at)
+        response_payload =
+          if status >= 400
+            { error: parse_body(body) }
+          else
+            { body: parse_body(body) }
+          end
+
+        {
+          path: env[REQUEST_URI],
+          method: env[REQUEST_METHOD],
+          status: status,
+          duration: Time.now - began_at,
+          headers: headers.slice(
+            'Location', 'Content-Length', 'Content-Type'
+          )
+        }.merge(response_payload)
+      end
+
+      def parse_body(body)
+        begin
+          # Rack body is an array
+          JSON.parse(body.join())
+        rescue Exception
+          {error: "Failed to parse response body"}
+        end
+      end
+
+      class Logger
+        def initialize(logger, request_id)
+          @logger = logger
+          @request_id = request_id
+        end
+
+        [:debug, :info, :warn, :error].each do |name|
+          define_method(name) do |msg, metadata = {}|
+            @logger.public_send(name, msg, metadata.merge(request_id: @request_id))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/salestation/web/statsd_middleware.rb

@@ -0,0 +1,28 @@
+module Salestation
+  class Web < Module
+    class StatsdMiddleware
+
+      def initialize(app, statsd, metric:)
+        @app = app
+        @statsd = statsd
+        @metric = metric
+      end
+
+      def call(env)
+        start = Time.now
+
+        status, header, body = @app.call env
+
+        method, path = env['sinatra.route'].split
+
+        @statsd.timing(@metric, (Time.now - start) * 1000, tags: [
+          "path:#{ path }",
+          "method:#{ method }",
+          "status:#{ status }"
+        ])
+
+        [status, header, body]
+      end
+    end
+  end
+end

data/lib/salestation/web.rb

@@ -33,3 +33,5 @@ end
 require_relative './web/responses'
 require_relative './web/error_mapper'
 require_relative './result_helper'
+require_relative './web/request_logger'
+require_relative './web/statsd_middleware'

data/salestation.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "salestation"
-  spec.version       = "0.1.0"
+  spec.version       = "0.1.1"
   spec.authors       = ["SaleMove TechMovers"]
   spec.email         = ["techmovers@salemove.com"]
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: salestation
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - SaleMove TechMovers
@@ -116,7 +116,9 @@ files:
 - lib/salestation/result_helper.rb
 - lib/salestation/web.rb
 - lib/salestation/web/error_mapper.rb
+- lib/salestation/web/request_logger.rb
 - lib/salestation/web/responses.rb
+- lib/salestation/web/statsd_middleware.rb
 - salestation.gemspec
 homepage: ''
 licenses: