susu 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0fa05c876bea2bb2aa92aae435330fc76f1ce079
-  data.tar.gz: c31d3ec03fc35ddd7384181b31c2b0ea7d68ec9e
+  metadata.gz: 9a5669b11647a6b1411118fbb1343a4b808c811f
+  data.tar.gz: e4c22adabfe5977d60060875af8b628d0bb59c49
 SHA512:
-  metadata.gz: 165efae4ffcce68a8dd5b3843b92e7fd60de9720126e67ebdc3888af61b33a0a442db524b9e03496b30c648340204d36ec2b056f9298db202abcfe254969dea7
-  data.tar.gz: 8f205733ed09858647274e4686d0932ab2cf717f92f3f1e6348dabbf179772f01a2e74c4ef6a30526aa5dfce8cf8c432f78fa497c21d807c8dc3616b9e878bd1
+  metadata.gz: 174a610163af1c0b3a4a9787bbf8817944aa458817ca1752c085fac86663aefdfcd991387d00f2bdffaea8f6a9d6df823b817b86553502c28c00c5e33b5a1cd4
+  data.tar.gz: 272454ad89fee4f2af6e8778380f5a01a5c7c35428b2bfd8234272e71031f1d6822806d4356a758309f5d99e110cb2777bfd1410940bb0d7c59d0e5596110e62

data/lib/susu/http_lib/http.rb

@@ -0,0 +1,35 @@
+if defined?(::HTTP::Client) && defined?(::HTTP::Connection)
+  module ::HTTP
+    class Client
+      request_method = respond_to?('make_request') ? 'make_request' : 'perform'
+      orig_request_method = "orig_#{request_method}"
+      alias_method(orig_request_method, request_method) unless method_defined?(orig_request_method)
+
+      define_method request_method do |req, options|
+        bm = Benchmark.realtime do
+          @response = send(orig_request_method, req, options)
+        end
+
+        headers = @response.headers
+        post_params = req.body
+        post_params = Rack::Utils.parse_nested_query post_params if post_params.class == String
+        
+        Susu.log_all(
+          req.verb, req.uri, @response.code, bm, post_params, @response.body,
+          headers, headers['Content-Encoding'], headers['Content-Type']
+        )
+
+        @response
+      end
+    end
+
+    class Connection
+      alias_method(:orig_initialize, :initialize) unless method_defined?(:orig_initialize)
+
+      def initialize(req, options)
+        Susu.log_connection(req.uri.host, req.uri.port)
+        orig_initialize(req, options)
+      end
+    end
+  end
+end

data/lib/susu/http_lib/httpclient.rb

@@ -0,0 +1,52 @@
+if defined?(::HTTPClient)
+  class HTTPClient
+    private
+    alias_method :orig_do_get_block, :do_get_block
+
+    def do_get_block(req, proxy, conn, &block)
+      retryable_response = nil
+      bm = Benchmark.realtime do
+        begin
+          orig_do_get_block(req, proxy, conn, &block)
+        rescue RetryableResponse => e
+          retryable_response = e
+        end
+      end
+
+      res = conn.pop
+      headers = res.headers
+      post_params = req.body
+      post_params = Rack::Utils.parse_nested_query post_params if post_params.class == String
+
+      Susu.log_all(
+        req.header.request_method, req.header.request_uri,
+        res.status_code, bm, post_params, res.body, headers,
+        headers['Content-Encoding'], headers['Content-Type']
+      )
+      conn.push(res)
+
+      raise retryable_response if retryable_response != nil
+    end
+
+    class Session
+      alias_method :orig_create_socket, :create_socket
+
+      # up to version 2.6, the method signature is `create_socket(site)`; after that,
+      # it's `create_socket(hort, port)`
+      if instance_method(:create_socket).arity == 1
+        def create_socket(site)
+          Susu.log_connection(site.host, site.port)
+          # end
+          orig_create_socket(site)
+        end
+
+      else
+        def create_socket(host, port)
+          Susu.log_connection(host, port)
+          # end
+          orig_create_socket(host,port)
+        end
+      end
+    end
+  end
+end

data/lib/susu/http_lib/net_http.rb

@@ -0,0 +1,35 @@
+module Net
+  class HTTP
+    alias_method(:orig_request, :request) unless method_defined?(:orig_request)
+    alias_method(:orig_connect, :connect) unless method_defined?(:orig_connect)
+
+    def request(req, body = nil, &block)
+
+      url = "http://#{@address}:#{@port}#{req.path}"
+
+      bm = Benchmark.realtime do
+        @response = orig_request(req, body, &block)
+      end
+      headers = @response.each_header.collect
+      post_params = req.body.nil? || req.body.size == 0 ? body : req.body
+      post_params = Rack::Utils.parse_nested_query post_params if post_params.class == String
+
+      if started?
+        Susu.log_all(
+          req.method, url, @response.code, bm, post_params,
+          @response.body, headers,
+          @response['Content-Encoding'], @response['Content-Type']
+        )
+      end
+
+      @response
+    end
+
+    def connect
+      Susu.log_connection(@address, @port) if !started?
+
+      orig_connect
+    end
+  end
+
+end

data/lib/susu/susu.rb

@@ -0,0 +1,74 @@
+require "net/http"
+require "logger"
+require "benchmark"
+require "rack"
+
+module Susu
+  LOG_PREFIX = "[SusuLog] "
+
+  class << self
+
+    def log(msg)
+      Rails.logger.debug(msg)
+      Rails.logger.flush
+    end
+
+    def log_connection(host, port = nil)
+    end
+
+    def log_all(method, uri, status, duration, post_params, response, headers, encoding, content_type)
+      status = Rack::Utils.status_code(status) unless status == /\d{3}/
+      duration = duration.to_f.round(6)
+      method = method.to_s.upcase
+      response_body = parse_body(response, encoding, content_type)
+      post_params = utf_encoded(post_params.to_s.dup)
+      # log("#{method.to_s.upcase} #{uri} completed with status code #{status} in #{seconds} seconds")
+      log("#{LOG_PREFIX}method=#{method} path=#{uri} status=#{status} duration=#{duration} post_params=#{post_params} response=#{response_body}")
+    end
+
+    private
+
+    def parse_body(body, encoding = nil, content_type=nil)
+      unless text_based?(content_type)
+        # log("Response: (not showing binary data)")
+        return "Response: (not showing binary data)"
+      end
+
+      if body.is_a?(Net::ReadAdapter)
+        # open-uri wraps the response in a Net::ReadAdapter that defers reading
+        # the content, so the reponse body is not available here.
+        # log("Response: (not available yet)")
+        return "Response: (not available yet)"
+      end
+
+      if encoding =~ /gzip/ && body && !body.empty?
+        sio = StringIO.new( body.to_s )
+        gz = Zlib::GzipReader.new( sio )
+        body = gz.read
+      end
+
+      data = utf_encoded(body.to_s, content_type)
+      return data
+    end
+
+    def utf_encoded(data, content_type=nil)
+      charset = content_type.to_s.scan(/; charset=(\S+)/).flatten.first || 'UTF-8'
+      data.force_encoding(charset) rescue data.force_encoding('UTF-8')
+      data.encode('UTF-8', :invalid => :replace, :undef => :replace)
+    end
+
+    def text_based?(content_type)
+      # This is a very naive way of determining if the content type is text-based; but
+      # it will allow application/json and the like without having to resort to more
+      # heavy-handed checks.
+      content_type =~ /^text/ ||
+      content_type =~ /^application/ && content_type != 'application/octet-stream'
+    end
+
+    def log_data_lines(data)
+      data.each_line.with_index do |line, row|
+        log("#{row + 1}: #{line.chomp}")
+      end
+    end
+  end
+end

data/lib/susu/version.rb

@@ -0,0 +1,3 @@
+module Susu
+  VERSION = "1.0.1"
+end

data/lib/susu.rb

@@ -0,0 +1,5 @@
+require "susu/version"
+require "susu/susu"
+require "susu/http_lib/net_http"
+require "susu/http_lib/httpclient"
+require "susu/http_lib/http"

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: susu
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - hoptq
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 2017-12-14 00:00:00.000000000 Z
 dependencies:
@@ -101,15 +101,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CODE_OF_CONDUCT.md
-- Gemfile
-- LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
-- test/susu_test.rb
-- test/test_helper.rb
+- lib/susu.rb
+- lib/susu/http_lib/http.rb
+- lib/susu/http_lib/httpclient.rb
+- lib/susu/http_lib/net_http.rb
+- lib/susu/susu.rb
+- lib/susu/version.rb
 homepage: ''
 licenses:
 - MIT

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at hoptq@topica.edu.vn. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1 +0,0 @@
-source "https://rubygems.org"

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2017 hoptq
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "susu"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/test/susu_test.rb

@@ -1,11 +0,0 @@
-require "test_helper"
-
-class SusuTest < Minitest::Test
-  def test_that_it_has_a_version_number
-    refute_nil ::Susu::VERSION
-  end
-
-  def test_it_does_something_useful
-    assert false
-  end
-end

data/test/test_helper.rb

@@ -1,4 +0,0 @@
-$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
-require "susu"
-
-require "minitest/autorun"