rack_middleware_metrics 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 98990077c946511fb1f4b12324b71802b2b7d0a5541c598e1f4396698f545fa3
+  data.tar.gz: 9f209425500a239563c966cf4ceaaf29d5d831d6c5df2e6f4dfcc559ef189b56
+SHA512:
+  metadata.gz: e00125579f4516e61a798ff8f69b04446ea0e2803a3953ea5bdf83fb90638c87f6edc7095e416a39e7ccc79272007d2b019422cecef1653865ac2e14b1916632
+  data.tar.gz: a7c14ed40b52f708e33ea7538c1a01c40e86b096d4c3dbd2dbb1968ce5182fc561c6bfb5cc0295984e254c0f3e1148dfbf5e2fd637ffc973ab8d28dd94289588

data/.gitignore

@@ -0,0 +1,60 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+.bundle/
+vendor
+lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+*.csv
+target
+lib/md5_ruby_ext

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop-performance.yml

@@ -0,0 +1,3 @@
+#--------1---------2---------3---------4---------5---------6---------7---------8---------9---------0
+require:
+  - rubocop-performance

data/.rubocop-rspec.yml

@@ -0,0 +1,72 @@
+#--------1---------2---------3---------4---------5---------6---------7---------8---------9---------0
+require:
+  - rubocop-rspec
+# The idea is to bring this file in line with the default configuration:
+# https://github.com/rubocop-hq/rubocop-rspec/blob/master/config/default.yml.
+# We're not quite at a point to do that yet.
+AllCops:
+  TargetRubyVersion: 2.5
+RSpec/AnyInstance:
+  Enabled: false
+RSpec/ContextWording:
+  Prefixes:
+    - and
+    - before
+    - but
+    - can
+    - for
+    - in
+    - is
+    - such
+    - that
+    - when    # default
+    - which
+    - while
+    - will
+    - with    # default
+    - without # default
+RSpec/DescribeClass:
+  Exclude:
+    - spec/contrast/core_extensions/assess/rules/*_spec.rb # assess rules don't have concrete classes
+    - spec/contrast/rails_extensions/**/*_spec.rb
+    - spec/contrast/sinatra_extensions/**/*_spec.rb
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/FilePath:
+  CustomTransform:
+    Activity: inventory_activity
+    AppContext: app_context
+    ApplicationSettings: application_settings
+    CmdInjection: cmd_injection
+    ContrastService: contrast_service
+    EntityWrapper: entity_wrapper
+    PreShift: preshift
+    TraceEvent: trace_event
+  Exclude:
+    - spec/contrast/core_extensions/assess/freeze_spec.rb
+    - spec/contrast/core_extensions/postgresql_spec.rb
+    - spec/contrast/core_extensions/protect/sqlite3_spec.rb
+    - spec/contrast/rack_extensions/*.rb
+    - spec/contrast/sinatra_extensions/sinatra_base_spec.rb
+RSpec/MessageSpies:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Max: 22
+RSpec/NestedGroups:
+  Max: 5  # Target around 3 or 4.  Drop as we have more spec helpers. -ajm
+RSpec/VerifiedDoubles:
+  Enabled: false
+#
+# ...
+#
+# And to then enable the default disabled cops.
+# These cops are off by default, but should be audited to see if they're worth
+# enabling as they're recommended, but hard to implement or controversial.
+RSpec/DescribedClassModuleWrapping:
+  Enabled: false
+RSpec/Dialect:
+  Enabled: false
+RSpec/MessageExpectation:
+  Enabled: false
+RSpec/Pending:
+  Enabled: false

data/.rubocop.yml

@@ -0,0 +1,53 @@
+#--------1---------2---------3---------4---------5---------6---------7---------8---------9---------0
+# The idea is to bring this file in line with the default configuration:
+# https://github.com/rubocop-hq/rubocop/blob/master/config/default.yml
+# We're not quite at a point to do that yet.
+AllCops:
+  EnabledByDefault: true
+  NewCops: enable
+  TargetRubyVersion: 2.5
+Bundler/DuplicatedGem:
+  Enabled: false
+Bundler/GemComment:
+  Enabled: false
+Layout/DotPosition:
+  EnforcedStyle: trailing
+Layout/FirstArgumentIndentation:
+  IndentationWidth: 4
+Layout/FirstHashElementIndentation:
+  IndentationWidth: 4
+Layout/FirstParameterIndentation:
+  IndentationWidth: 4
+Layout/LineLength:
+  IgnoredPatterns:
+    - '^\s*# http' # allow URLs, standalone, in comments
+Layout/MultilineMethodCallBraceLayout:
+  EnforcedStyle: same_line
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+  IndentationWidth: 4
+Layout/MultilineMethodDefinitionBraceLayout:
+  EnforcedStyle: same_line
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+  IndentationWidth: 4
+Layout/SpaceInsideStringInterpolation:
+  EnforcedStyle: space
+Lint/ConstantResolution:
+  Enabled: false
+Naming/MemoizedInstanceVariableName:
+  EnforcedStyleForLeadingUnderscores: required
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+Style/DisableCopsWithinSourceCodeDirective:
+  Enabled: false
+Style/DoubleNegation: # team prefers !!var over !var.nil? syntax, so we are leaving this cop off
+  Enabled: false
+Style/MethodDefParentheses:
+  EnforcedStyle: require_no_parentheses_except_multiline
+Style/Copyright:
+  Enabled: false
+Style/DocumentationMethod:
+  Enabled: false
+Style/MissingElse:
+  Enabled: false

data/.solargraph.yml

@@ -0,0 +1,15 @@
+---
+include:
+- "**/*.rb"
+exclude:
+- spec/**/*
+- test/**/*
+- vendor/**/*
+- ".bundle/**/*"
+require: []
+domains: []
+reporters:
+- rubocop
+require_paths: []
+plugins: []
+max_files: 5000

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+cache: bundler
+rvm:
+- 2.5
+- 2.6
+- 2.7
+before_install:
+- curl https://sh.rustup.rs -sSf | sh -s -- -y
+- source $HOME/.cargo/env
+deploy:
+  provider: rubygems
+  api_key:
+    secure: cJgoY38KR4cqoVCbNsQaXbqKMbXCSh/JOxHXpKIodP0IzdqBwO2+JyuUnIKW9oq4CMlj7V8bNUMmY3Bce0NZoSFDc+A1SbogWFDn7BHcHjU5zgC0XiPcY04u3/oK2iI6zmZN+ANg3JWqTKcF1pBN/y5u8S8Q5S1ZWsnwg7/VzDZseDRLJVR7r8g83Bnus7oD+nGU8Cibi7I4rJNjfp3k9flKSzysm9EMs+GBuw52ESUyfUpqoMWVlz4KljWWUjgV3dX4OV6bH/UlVHg7I0hcNUkQepweNydiT6J3eQmDLN2msYZs/os8ivZPrsMY4V1SZYtn8iXPzeaW7keCJNtcjh4I9WFf00NE/R0/IWBl6fPOqTfddxgBd7lst+3N47R/pGJBVayRhskYTUPmIBymo065oGoVQiPUKQ3F5cz6OCjuW40GSyxmW5AL+hKQWPqBJossv5RgXP/pYPWW1pluwdCYRbROYfH+JrxWuU5VQJZ49Q7otK+/KEamJwbFg5R115aJS3rrQ4cTmH5uTwvDkQfCJ2VDVvGy5zzLGl96ewY+uOd7HoykjyBUkEe52V01B+MublXrzgXmd5VFcpFPXF6aQ9jxrb6SD5YOXjYneZd20omeOzzKAbFPvuFyYL5dktf75pFqis13z5CleLs7/MupgT8BFuC7cxuZk+tglLQ=
+  gem: rack_middleware_metrics
+  on:
+    tags: true
+    repo: reedjosh/RackMiddlewareMetrics
+    branch: main
+  skip_cleanup: 'true'

data/.~lock.GIST_API.odt#

@@ -0,0 +1 @@
+,jreed,jayr.localdomain,14.07.2017 13:50,file:///home/jreed/.config/libreoffice/4;

data/Cargo.lock

@@ -0,0 +1,47 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+[[package]]
+name = "cstr-macro"
+version = "0.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "db53fddba18cdd35477a7213a3ef6acfbfa333c31b42ce019e544c4a1420a06f"
+
+[[package]]
+name = "helix"
+version = "0.7.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "49a017e3e798ad9386e0a0584e66fd6c04a80ccc1242eb8f689c62ce6f408240"
+dependencies = [
+ "cstr-macro",
+ "libc",
+ "libcruby-sys",
+]
+
+[[package]]
+name = "libc"
+version = "0.2.79"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2448f6066e80e3bfc792e9c98bf705b4b0fc6e8ef5b43e5889aff0eaa9c58743"
+
+[[package]]
+name = "libcruby-sys"
+version = "0.7.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fef6028cdce0c8d55676fd1d66bb810facef8cade0dd71d28511d375e84da4c0"
+dependencies = [
+ "libc",
+]
+
+[[package]]
+name = "md5"
+version = "0.7.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "490cc448043f947bae3cbee9c203358d62dbee0db12107a74be5c30ccfd09771"
+
+[[package]]
+name = "md5_ruby_ext"
+version = "0.1.0"
+dependencies = [
+ "helix",
+ "md5",
+]

data/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+name = "md5_ruby_ext"
+version = "0.1.0"
+authors = ["Reed, Joshua <joshua.reed@intel.com>"]
+edition = "2018"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+[lib]
+crate-type = ["cdylib"]
+
+
+[dependencies]
+md5 = "0.7.0"
+helix = "*"

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in RackMiddlewareMetrics.gemspec
+gemspec
+
+group :development, :test do
+  gem "rspec", "~> 3.9"
+  gem 'solargraph', '~> 0.39.12'
+  gem "rubocop", "~> 0.93.1"
+  gem "thin", "~> 1.7"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 reedjosh
+
+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/README.md

@@ -0,0 +1,54 @@
+# Metrics Reporter
+A minimalist Application Performance Monitoring (APM) library for Ruby on Rails.
+
+[![Build Status](https://travis-ci.com/reedjosh/RackMiddlewareMetrics.svg?branch=main)](https://travis-ci.com/reedjosh/RackMiddlewareMetrics)
+
+Reports: 
+- The time that the request enters the middleware. 
+- The time that it leaves the middleware.
+- Request path
+- The request's parameter list.
+- MD5 hash value of the rendered output.
+- Current thread and process ids.
+
+Appends to a CSV file. 
+
+The location and name of the file are configurable by the user. 
+
+Adds itself to the hosting Ruby on Rails application using Railties AND the agent
+
+Does MD5 calculation in Rust.
+
+Getting Started
+
+
+## Etc... Notes
+TODO: Add the Gem to an open source Ruby on Rails project (RedMine, Discourse, etc) and generate 
+a performance metrics CSV file.
+
+TODO: The Rack middleware should be implemented as a Railtie
+
+The middleware should generate a CSV file with the following fields:
+- Request Time: the timestamp when the request enters the middleware
+- Response Time: the timestamp when the request leaves the middleware
+- Elapsed Time: the time betwen request and response
+- Path: the URI of the request
+- Params: a semi-colon delimited list of GET parameters
+- MD5: the hashed value of the response body
+- Process ID: the process ID of the current request
+- Thread ID: the thread ID of the current request
+
+Done: The filename and path of the generated CSV file should be configurable by the user of the Gem
+Almost Done: generate the MD5 hash in Rust using Helix
+Flesh out further: Write unit tests in RSpec.
+Done: Add Travis CI.
+Partially: Write a README that explains what you built and how to use it.
+
+Goals: 
+- Write idiomatic and well-tested ruby code in a gem.
+- Make sharable among many Ruby on Rails projects even with MD5 generation in rust.
+- Use rvm/Travis to test many ruby versions.
+
+### Build Gem via:
+`gem build metrics_reporter.gemspec`
+

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Rakefile
+require 'rake'
+require 'rspec/core/rake_task'
+import 'lib/tasks/helix_runtime.rake'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = Dir.glob('spec/**/*_spec.rb')
+  t.rspec_opts = '--format documentation'
+end
+
+task :spec => :build
+task default: :spec

data/bin/bundle

@@ -0,0 +1,105 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+    module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1 || ">= 0.a"
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../../Gemfile", __FILE__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_version
+    @bundler_version ||= begin
+      env_var_version || cli_arg_version ||
+        lockfile_version || "#{Gem::Requirement.default}.a"
+    end
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    # must dup string for RG < 1.8 compatibility
+    activate_bundler(bundler_version.dup)
+  end
+
+  def activate_bundler(bundler_version)
+    if Gem::Version.correct?(bundler_version) && Gem::Version.new(bundler_version).release < Gem::Version.new("2.0")
+      bundler_version = "< 2"
+    end
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_version
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_version).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_version}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_version}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end