readme-metrics 2.1.0 → 2.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.rubocop.yml +5 -0
- data/Gemfile +0 -1
- data/Gemfile.lock +28 -33
- data/Makefile +8 -2
- data/README.md +1 -1
- data/examples/metrics-rails/.gitattributes +7 -0
- data/examples/metrics-rails/.gitignore +20 -0
- data/examples/metrics-rails/.ruby-version +1 -0
- data/examples/metrics-rails/Gemfile +29 -0
- data/examples/metrics-rails/Gemfile.lock +184 -0
- data/examples/metrics-rails/README.md +38 -0
- data/examples/metrics-rails/Rakefile +6 -0
- data/examples/metrics-rails/app/controllers/application_controller.rb +2 -0
- data/examples/metrics-rails/app/controllers/metrics_controller.rb +34 -0
- data/examples/metrics-rails/app/models/application_record.rb +3 -0
- data/examples/metrics-rails/bin/bundle +116 -0
- data/examples/metrics-rails/bin/rails +4 -0
- data/examples/metrics-rails/bin/rake +4 -0
- data/examples/metrics-rails/bin/setup +33 -0
- data/examples/metrics-rails/config/application.rb +52 -0
- data/examples/metrics-rails/config/boot.rb +3 -0
- data/examples/metrics-rails/config/credentials.yml.enc +1 -0
- data/examples/metrics-rails/config/database.yml +25 -0
- data/examples/metrics-rails/config/environment.rb +5 -0
- data/examples/metrics-rails/config/environments/development.rb +56 -0
- data/examples/metrics-rails/config/environments/production.rb +68 -0
- data/examples/metrics-rails/config/environments/test.rb +50 -0
- data/examples/metrics-rails/config/initializers/cors.rb +16 -0
- data/examples/metrics-rails/config/initializers/filter_parameter_logging.rb +8 -0
- data/examples/metrics-rails/config/initializers/inflections.rb +16 -0
- data/examples/metrics-rails/config/locales/en.yml +33 -0
- data/examples/metrics-rails/config/puma.rb +43 -0
- data/examples/metrics-rails/config/routes.rb +5 -0
- data/examples/metrics-rails/config.ru +6 -0
- data/examples/metrics-rails/db/seeds.rb +7 -0
- data/examples/metrics-rails/public/robots.txt +1 -0
- data/lib/readme/errors.rb +1 -1
- data/lib/readme/har/collection.rb +3 -1
- data/lib/readme/har/serializer.rb +2 -2
- data/lib/readme/http_request.rb +38 -7
- data/lib/readme/http_response.rb +2 -2
- data/lib/readme/metrics/version.rb +2 -2
- data/lib/readme/metrics.rb +4 -4
- data/lib/readme/payload.rb +9 -3
- data/lib/readme/webhook.rb +42 -0
- data/readme-metrics.gemspec +1 -1
- metadata +49 -11
@@ -0,0 +1,52 @@
|
|
1
|
+
require_relative 'boot'
|
2
|
+
|
3
|
+
require 'rails'
|
4
|
+
# Pick the frameworks you want:
|
5
|
+
require 'active_model/railtie'
|
6
|
+
# require "active_job/railtie"
|
7
|
+
require 'active_record/railtie'
|
8
|
+
# require "active_storage/engine"
|
9
|
+
require 'action_controller/railtie'
|
10
|
+
# require "action_mailer/railtie"
|
11
|
+
# require "action_mailbox/engine"
|
12
|
+
# require "action_text/engine"
|
13
|
+
require 'action_view/railtie'
|
14
|
+
# require "action_cable/engine"
|
15
|
+
# require "rails/test_unit/railtie"
|
16
|
+
|
17
|
+
# Require the gems listed in Gemfile, including any gems
|
18
|
+
# you've limited to :test, :development, or :production.
|
19
|
+
Bundler.require(*Rails.groups)
|
20
|
+
|
21
|
+
unless ENV['README_API_KEY']
|
22
|
+
warn('Missing `README_API_KEY` environment variable')
|
23
|
+
exit(1)
|
24
|
+
end
|
25
|
+
|
26
|
+
module MetricsRails
|
27
|
+
class Application < Rails::Application
|
28
|
+
# Initialize configuration defaults for originally generated Rails version.
|
29
|
+
config.load_defaults 7.0
|
30
|
+
|
31
|
+
# Configuration for the application, engines, and railties goes here.
|
32
|
+
#
|
33
|
+
# These settings can be overridden in specific environments using the files
|
34
|
+
# in config/environments, which are processed later.
|
35
|
+
#
|
36
|
+
# config.time_zone = "Central Time (US & Canada)"
|
37
|
+
# config.eager_load_paths << Rails.root.join("extras")
|
38
|
+
|
39
|
+
# Only loads a smaller set of middleware suitable for API only apps.
|
40
|
+
# Middleware like session, flash, cookies can be added back manually.
|
41
|
+
# Skip views, helpers and assets when generating a new resource.
|
42
|
+
config.api_only = true
|
43
|
+
|
44
|
+
config.middleware.use Readme::Metrics, { api_key: ENV.fetch('README_API_KEY', nil) } do |_env|
|
45
|
+
{
|
46
|
+
api_key: 'owlbert-api-key',
|
47
|
+
label: 'Owlbert',
|
48
|
+
email: 'owlbert@example.com'
|
49
|
+
}
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|
@@ -0,0 +1 @@
|
|
1
|
+
WUpk/vtruP+ILrYagtEbnThH7rgtMyjoYDklX/UTNVGBpFNvMUJEDLTSOVtS51bg9F4MJv5Z9C8k3fvr1cNCrJS1GuU1hBuqawb9UM5PrzPVskYt3d/+uTiaZAC8GCcbbVL0W5WK097OIASiMGztTsUe2Q8EF+7G9oCnak/EQiV6aSz/hQMuFhsLzqBPonSrOkyzuBnyrerNwQp8KmqPL1acD1OgyPe9iCD4ZDJtY75wMge8vOPpbUE5qU+OSVM9P3iGAd6FN6BK7lj7udDRz+KndKPl8rNwQcNwQSbPgvjt4fG7Wy4XJAHwBigXsmBsFHb75Q2yxt9Llm4CUpOxzyd04ArrdJOZq4tvAFbrj4RGVdpAz6ZXkHguwzdDWZKLhAEHTHrxLBaBM8WzenIi9eCVwgFVQW1fHZhh--JCC5l4U+wO+RX/ou--pLo5LzM5ZxUtRyDfhjrSyw==
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# SQLite. Versions 3.8.0 and up are supported.
|
2
|
+
# gem install sqlite3
|
3
|
+
#
|
4
|
+
# Ensure the SQLite 3 gem is defined in your Gemfile
|
5
|
+
# gem "sqlite3"
|
6
|
+
#
|
7
|
+
default: &default
|
8
|
+
adapter: sqlite3
|
9
|
+
pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
|
10
|
+
timeout: 5000
|
11
|
+
|
12
|
+
development:
|
13
|
+
<<: *default
|
14
|
+
database: db/development.sqlite3
|
15
|
+
|
16
|
+
# Warning: The database defined as "test" will be erased and
|
17
|
+
# re-generated from your development database when you run "rake".
|
18
|
+
# Do not set this db to the same as development or production.
|
19
|
+
test:
|
20
|
+
<<: *default
|
21
|
+
database: db/test.sqlite3
|
22
|
+
|
23
|
+
production:
|
24
|
+
<<: *default
|
25
|
+
database: db/production.sqlite3
|
@@ -0,0 +1,56 @@
|
|
1
|
+
require 'active_support/core_ext/integer/time'
|
2
|
+
|
3
|
+
Rails.application.configure do
|
4
|
+
# Settings specified here will take precedence over those in config/application.rb.
|
5
|
+
|
6
|
+
# In the development environment your application's code is reloaded any time
|
7
|
+
# it changes. This slows down response time but is perfect for development
|
8
|
+
# since you don't have to restart the web server when you make code changes.
|
9
|
+
config.cache_classes = false
|
10
|
+
|
11
|
+
# Do not eager load code on boot.
|
12
|
+
config.eager_load = false
|
13
|
+
|
14
|
+
# Show full error reports.
|
15
|
+
config.consider_all_requests_local = true
|
16
|
+
|
17
|
+
# Enable server timing
|
18
|
+
config.server_timing = true
|
19
|
+
|
20
|
+
# Enable/disable caching. By default caching is disabled.
|
21
|
+
# Run rails dev:cache to toggle caching.
|
22
|
+
if Rails.root.join('tmp/caching-dev.txt').exist?
|
23
|
+
config.cache_store = :memory_store
|
24
|
+
config.public_file_server.headers = {
|
25
|
+
'Cache-Control' => "public, max-age=#{2.days.to_i}"
|
26
|
+
}
|
27
|
+
else
|
28
|
+
config.action_controller.perform_caching = false
|
29
|
+
|
30
|
+
config.cache_store = :null_store
|
31
|
+
end
|
32
|
+
|
33
|
+
# Print deprecation notices to the Rails logger.
|
34
|
+
config.active_support.deprecation = :log
|
35
|
+
|
36
|
+
# Raise exceptions for disallowed deprecations.
|
37
|
+
config.active_support.disallowed_deprecation = :raise
|
38
|
+
|
39
|
+
# Tell Active Support which deprecation messages to disallow.
|
40
|
+
config.active_support.disallowed_deprecation_warnings = []
|
41
|
+
|
42
|
+
# Raise an error on page load if there are pending migrations.
|
43
|
+
config.active_record.migration_error = :page_load
|
44
|
+
|
45
|
+
# Highlight code that triggered database queries in logs.
|
46
|
+
config.active_record.verbose_query_logs = true
|
47
|
+
|
48
|
+
# Raises error for missing translations.
|
49
|
+
# config.i18n.raise_on_missing_translations = true
|
50
|
+
|
51
|
+
# Annotate rendered view with file names.
|
52
|
+
# config.action_view.annotate_rendered_view_with_filenames = true
|
53
|
+
|
54
|
+
# Uncomment if you wish to allow Action Cable access from any origin.
|
55
|
+
# config.action_cable.disable_request_forgery_protection = true
|
56
|
+
end
|
@@ -0,0 +1,68 @@
|
|
1
|
+
require 'active_support/core_ext/integer/time'
|
2
|
+
|
3
|
+
Rails.application.configure do
|
4
|
+
# Settings specified here will take precedence over those in config/application.rb.
|
5
|
+
|
6
|
+
# Code is not reloaded between requests.
|
7
|
+
config.cache_classes = true
|
8
|
+
|
9
|
+
# Eager load code on boot. This eager loads most of Rails and
|
10
|
+
# your application in memory, allowing both threaded web servers
|
11
|
+
# and those relying on copy on write to perform better.
|
12
|
+
# Rake tasks automatically ignore this option for performance.
|
13
|
+
config.eager_load = true
|
14
|
+
|
15
|
+
# Full error reports are disabled and caching is turned on.
|
16
|
+
config.consider_all_requests_local = false
|
17
|
+
|
18
|
+
# Ensures that a master key has been made available in either ENV["RAILS_MASTER_KEY"]
|
19
|
+
# or in config/master.key. This key is used to decrypt credentials (and other encrypted files).
|
20
|
+
# config.require_master_key = true
|
21
|
+
|
22
|
+
# Disable serving static files from the `/public` folder by default since
|
23
|
+
# Apache or NGINX already handles this.
|
24
|
+
config.public_file_server.enabled = ENV['RAILS_SERVE_STATIC_FILES'].present?
|
25
|
+
|
26
|
+
# Enable serving of images, stylesheets, and JavaScripts from an asset server.
|
27
|
+
# config.asset_host = "http://assets.example.com"
|
28
|
+
|
29
|
+
# Specifies the header that your server uses for sending files.
|
30
|
+
# config.action_dispatch.x_sendfile_header = "X-Sendfile" # for Apache
|
31
|
+
# config.action_dispatch.x_sendfile_header = "X-Accel-Redirect" # for NGINX
|
32
|
+
|
33
|
+
# Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
|
34
|
+
# config.force_ssl = true
|
35
|
+
|
36
|
+
# Include generic and useful information about system operation, but avoid logging too much
|
37
|
+
# information to avoid inadvertent exposure of personally identifiable information (PII).
|
38
|
+
config.log_level = :info
|
39
|
+
|
40
|
+
# Prepend all log lines with the following tags.
|
41
|
+
config.log_tags = [:request_id]
|
42
|
+
|
43
|
+
# Use a different cache store in production.
|
44
|
+
# config.cache_store = :mem_cache_store
|
45
|
+
|
46
|
+
# Enable locale fallbacks for I18n (makes lookups for any locale fall back to
|
47
|
+
# the I18n.default_locale when a translation cannot be found).
|
48
|
+
config.i18n.fallbacks = true
|
49
|
+
|
50
|
+
# Don't log any deprecations.
|
51
|
+
config.active_support.report_deprecations = false
|
52
|
+
|
53
|
+
# Use default logging formatter so that PID and timestamp are not suppressed.
|
54
|
+
config.log_formatter = Logger::Formatter.new
|
55
|
+
|
56
|
+
# Use a different logger for distributed setups.
|
57
|
+
# require "syslog/logger"
|
58
|
+
# config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new "app-name")
|
59
|
+
|
60
|
+
if ENV['RAILS_LOG_TO_STDOUT'].present?
|
61
|
+
logger = ActiveSupport::Logger.new($stdout)
|
62
|
+
logger.formatter = config.log_formatter
|
63
|
+
config.logger = ActiveSupport::TaggedLogging.new(logger)
|
64
|
+
end
|
65
|
+
|
66
|
+
# Do not dump schema after migrations.
|
67
|
+
config.active_record.dump_schema_after_migration = false
|
68
|
+
end
|
@@ -0,0 +1,50 @@
|
|
1
|
+
require 'active_support/core_ext/integer/time'
|
2
|
+
|
3
|
+
# The test environment is used exclusively to run your application's
|
4
|
+
# test suite. You never need to work with it otherwise. Remember that
|
5
|
+
# your test database is "scratch space" for the test suite and is wiped
|
6
|
+
# and recreated between test runs. Don't rely on the data there!
|
7
|
+
|
8
|
+
Rails.application.configure do
|
9
|
+
# Settings specified here will take precedence over those in config/application.rb.
|
10
|
+
|
11
|
+
# Turn false under Spring and add config.action_view.cache_template_loading = true.
|
12
|
+
config.cache_classes = true
|
13
|
+
|
14
|
+
# Eager loading loads your whole application. When running a single test locally,
|
15
|
+
# this probably isn't necessary. It's a good idea to do in a continuous integration
|
16
|
+
# system, or in some way before deploying your code.
|
17
|
+
config.eager_load = ENV['CI'].present?
|
18
|
+
|
19
|
+
# Configure public file server for tests with Cache-Control for performance.
|
20
|
+
config.public_file_server.enabled = true
|
21
|
+
config.public_file_server.headers = {
|
22
|
+
'Cache-Control' => "public, max-age=#{1.hour.to_i}"
|
23
|
+
}
|
24
|
+
|
25
|
+
# Show full error reports and disable caching.
|
26
|
+
config.consider_all_requests_local = true
|
27
|
+
config.action_controller.perform_caching = false
|
28
|
+
config.cache_store = :null_store
|
29
|
+
|
30
|
+
# Raise exceptions instead of rendering exception templates.
|
31
|
+
config.action_dispatch.show_exceptions = false
|
32
|
+
|
33
|
+
# Disable request forgery protection in test environment.
|
34
|
+
config.action_controller.allow_forgery_protection = false
|
35
|
+
|
36
|
+
# Print deprecation notices to the stderr.
|
37
|
+
config.active_support.deprecation = :stderr
|
38
|
+
|
39
|
+
# Raise exceptions for disallowed deprecations.
|
40
|
+
config.active_support.disallowed_deprecation = :raise
|
41
|
+
|
42
|
+
# Tell Active Support which deprecation messages to disallow.
|
43
|
+
config.active_support.disallowed_deprecation_warnings = []
|
44
|
+
|
45
|
+
# Raises error for missing translations.
|
46
|
+
# config.i18n.raise_on_missing_translations = true
|
47
|
+
|
48
|
+
# Annotate rendered view with file names.
|
49
|
+
# config.action_view.annotate_rendered_view_with_filenames = true
|
50
|
+
end
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# Be sure to restart your server when you modify this file.
|
2
|
+
|
3
|
+
# Avoid CORS issues when API is called from the frontend app.
|
4
|
+
# Handle Cross-Origin Resource Sharing (CORS) in order to accept cross-origin AJAX requests.
|
5
|
+
|
6
|
+
# Read more: https://github.com/cyu/rack-cors
|
7
|
+
|
8
|
+
# Rails.application.config.middleware.insert_before 0, Rack::Cors do
|
9
|
+
# allow do
|
10
|
+
# origins "example.com"
|
11
|
+
#
|
12
|
+
# resource "*",
|
13
|
+
# headers: :any,
|
14
|
+
# methods: [:get, :post, :put, :patch, :delete, :options, :head]
|
15
|
+
# end
|
16
|
+
# end
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# Be sure to restart your server when you modify this file.
|
2
|
+
|
3
|
+
# Configure parameters to be filtered from the log file. Use this to limit dissemination of
|
4
|
+
# sensitive information. See the ActiveSupport::ParameterFilter documentation for supported
|
5
|
+
# notations and behaviors.
|
6
|
+
Rails.application.config.filter_parameters += %i[
|
7
|
+
passw secret token _key crypt salt certificate otp ssn
|
8
|
+
]
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# Be sure to restart your server when you modify this file.
|
2
|
+
|
3
|
+
# Add new inflection rules using the following format. Inflections
|
4
|
+
# are locale specific, and you may define rules for as many different
|
5
|
+
# locales as you wish. All of these examples are active by default:
|
6
|
+
# ActiveSupport::Inflector.inflections(:en) do |inflect|
|
7
|
+
# inflect.plural /^(ox)$/i, "\\1en"
|
8
|
+
# inflect.singular /^(ox)en/i, "\\1"
|
9
|
+
# inflect.irregular "person", "people"
|
10
|
+
# inflect.uncountable %w( fish sheep )
|
11
|
+
# end
|
12
|
+
|
13
|
+
# These inflection rules are supported but not enabled by default:
|
14
|
+
# ActiveSupport::Inflector.inflections(:en) do |inflect|
|
15
|
+
# inflect.acronym "RESTful"
|
16
|
+
# end
|
@@ -0,0 +1,33 @@
|
|
1
|
+
# Files in the config/locales directory are used for internationalization
|
2
|
+
# and are automatically loaded by Rails. If you want to use locales other
|
3
|
+
# than English, add the necessary files in this directory.
|
4
|
+
#
|
5
|
+
# To use the locales, use `I18n.t`:
|
6
|
+
#
|
7
|
+
# I18n.t "hello"
|
8
|
+
#
|
9
|
+
# In views, this is aliased to just `t`:
|
10
|
+
#
|
11
|
+
# <%= t("hello") %>
|
12
|
+
#
|
13
|
+
# To use a different locale, set it with `I18n.locale`:
|
14
|
+
#
|
15
|
+
# I18n.locale = :es
|
16
|
+
#
|
17
|
+
# This would use the information in config/locales/es.yml.
|
18
|
+
#
|
19
|
+
# The following keys must be escaped otherwise they will not be retrieved by
|
20
|
+
# the default I18n backend:
|
21
|
+
#
|
22
|
+
# true, false, on, off, yes, no
|
23
|
+
#
|
24
|
+
# Instead, surround them with single quotes.
|
25
|
+
#
|
26
|
+
# en:
|
27
|
+
# "true": "foo"
|
28
|
+
#
|
29
|
+
# To learn more, please read the Rails Internationalization guide
|
30
|
+
# available at https://guides.rubyonrails.org/i18n.html.
|
31
|
+
|
32
|
+
en:
|
33
|
+
hello: "Hello world"
|
@@ -0,0 +1,43 @@
|
|
1
|
+
# Puma can serve each request in a thread from an internal thread pool.
|
2
|
+
# The `threads` method setting takes two numbers: a minimum and maximum.
|
3
|
+
# Any libraries that use thread pools should be configured to match
|
4
|
+
# the maximum value specified for Puma. Default is set to 5 threads for minimum
|
5
|
+
# and maximum; this matches the default thread size of Active Record.
|
6
|
+
#
|
7
|
+
max_threads_count = ENV.fetch('RAILS_MAX_THREADS', 5)
|
8
|
+
min_threads_count = ENV.fetch('RAILS_MIN_THREADS') { max_threads_count }
|
9
|
+
threads min_threads_count, max_threads_count
|
10
|
+
|
11
|
+
# Specifies the `worker_timeout` threshold that Puma will use to wait before
|
12
|
+
# terminating a worker in development environments.
|
13
|
+
#
|
14
|
+
worker_timeout 3600 if ENV.fetch('RAILS_ENV', 'development') == 'development'
|
15
|
+
|
16
|
+
# Specifies the `port` that Puma will listen on to receive requests; default is 8000.
|
17
|
+
#
|
18
|
+
port ENV.fetch('PORT', 8000)
|
19
|
+
|
20
|
+
# Specifies the `environment` that Puma will run in.
|
21
|
+
#
|
22
|
+
environment ENV.fetch('RAILS_ENV') { 'development' }
|
23
|
+
|
24
|
+
# Specifies the `pidfile` that Puma will use.
|
25
|
+
pidfile ENV.fetch('PIDFILE') { 'tmp/pids/server.pid' }
|
26
|
+
|
27
|
+
# Specifies the number of `workers` to boot in clustered mode.
|
28
|
+
# Workers are forked web server processes. If using threads and workers together
|
29
|
+
# the concurrency of the application would be max `threads` * `workers`.
|
30
|
+
# Workers do not work on JRuby or Windows (both of which do not support
|
31
|
+
# processes).
|
32
|
+
#
|
33
|
+
# workers ENV.fetch("WEB_CONCURRENCY") { 2 }
|
34
|
+
|
35
|
+
# Use the `preload_app!` method when specifying a `workers` number.
|
36
|
+
# This directive tells Puma to first boot the application and load code
|
37
|
+
# before forking the application. This takes advantage of Copy On Write
|
38
|
+
# process behavior so workers use less memory.
|
39
|
+
#
|
40
|
+
# preload_app!
|
41
|
+
|
42
|
+
# Allow puma to be restarted by `bin/rails restart` command.
|
43
|
+
plugin :tmp_restart
|
@@ -0,0 +1,7 @@
|
|
1
|
+
# This file should contain all the record creation needed to seed the database with its default values.
|
2
|
+
# The data can then be loaded with the bin/rails db:seed command (or created alongside the database with db:setup).
|
3
|
+
#
|
4
|
+
# Examples:
|
5
|
+
#
|
6
|
+
# movies = Movie.create([{ name: "Star Wars" }, { name: "Lord of the Rings" }])
|
7
|
+
# Character.create(name: "Luke", movie: movies.first)
|
@@ -0,0 +1 @@
|
|
1
|
+
# See https://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file
|
data/lib/readme/errors.rb
CHANGED
@@ -1,3 +1,5 @@
|
|
1
|
+
require 'json'
|
2
|
+
|
1
3
|
module Readme
|
2
4
|
module Har
|
3
5
|
class Collection
|
@@ -11,7 +13,7 @@ module Readme
|
|
11
13
|
end
|
12
14
|
|
13
15
|
def to_a
|
14
|
-
filtered_hash.map { |name, value| { name: name, value: value } }
|
16
|
+
filtered_hash.map { |name, value| { name: name, value: value.is_a?(Hash) ? value.to_json : value } }
|
15
17
|
end
|
16
18
|
|
17
19
|
private
|
@@ -1,4 +1,4 @@
|
|
1
|
-
#
|
1
|
+
# frozen_string_literal: true
|
2
2
|
|
3
3
|
require 'rack'
|
4
4
|
require 'readme/metrics'
|
@@ -46,7 +46,7 @@ module Readme
|
|
46
46
|
timings: timings,
|
47
47
|
request: request,
|
48
48
|
response: response,
|
49
|
-
startedDateTime: @start_time.iso8601,
|
49
|
+
startedDateTime: @start_time.utc.iso8601(3),
|
50
50
|
time: elapsed_time
|
51
51
|
}
|
52
52
|
]
|
data/lib/readme/http_request.rb
CHANGED
@@ -6,15 +6,29 @@ module Readme
|
|
6
6
|
class HttpRequest
|
7
7
|
include ContentTypeHelper
|
8
8
|
|
9
|
+
IS_RACK_V3 = Gem.loaded_specs['rack'].version > Gem::Version.create('3.0')
|
10
|
+
|
11
|
+
# rubocop:disable Style/MutableConstant
|
9
12
|
HTTP_NON_HEADERS = [
|
10
13
|
Rack::HTTP_COOKIE,
|
11
|
-
Rack::HTTP_VERSION,
|
12
14
|
Rack::HTTP_HOST,
|
13
15
|
Rack::HTTP_PORT
|
14
|
-
]
|
16
|
+
]
|
17
|
+
# rubocop:enable Style/MutableConstant
|
18
|
+
|
19
|
+
if IS_RACK_V3
|
20
|
+
HTTP_NON_HEADERS.push(Rack::SERVER_PROTOCOL)
|
21
|
+
else
|
22
|
+
HTTP_NON_HEADERS.push(Rack::HTTP_VERSION)
|
23
|
+
end
|
24
|
+
|
25
|
+
HTTP_NON_HEADERS.freeze
|
15
26
|
|
16
27
|
def initialize(env)
|
17
28
|
@request = Rack::Request.new(env)
|
29
|
+
return unless IS_RACK_V3
|
30
|
+
|
31
|
+
@input = Rack::RewindableInput.new(@request.body)
|
18
32
|
end
|
19
33
|
|
20
34
|
def url
|
@@ -30,7 +44,11 @@ module Readme
|
|
30
44
|
end
|
31
45
|
|
32
46
|
def http_version
|
33
|
-
|
47
|
+
if IS_RACK_V3
|
48
|
+
@request.get_header(Rack::SERVER_PROTOCOL)
|
49
|
+
else
|
50
|
+
@request.get_header(Rack::HTTP_VERSION)
|
51
|
+
end
|
34
52
|
end
|
35
53
|
|
36
54
|
def request_method
|
@@ -60,14 +78,21 @@ module Readme
|
|
60
78
|
.to_h
|
61
79
|
.transform_keys { |header| normalize_header_name(header) }
|
62
80
|
.merge unprefixed_headers
|
81
|
+
.merge host_header
|
63
82
|
end
|
64
83
|
|
65
84
|
def body
|
66
|
-
|
67
|
-
|
68
|
-
|
85
|
+
if IS_RACK_V3
|
86
|
+
body = @input.read
|
87
|
+
@input.rewind
|
88
|
+
body
|
89
|
+
else
|
90
|
+
@request.body.rewind
|
91
|
+
content = @request.body.read
|
92
|
+
@request.body.rewind
|
69
93
|
|
70
|
-
|
94
|
+
content
|
95
|
+
end
|
71
96
|
end
|
72
97
|
|
73
98
|
def parsed_form_data
|
@@ -99,5 +124,11 @@ module Readme
|
|
99
124
|
'Content-Length' => @request.content_length
|
100
125
|
}.compact
|
101
126
|
end
|
127
|
+
|
128
|
+
def host_header
|
129
|
+
{
|
130
|
+
'Host' => @request.host
|
131
|
+
}.compact
|
132
|
+
end
|
102
133
|
end
|
103
134
|
end
|
data/lib/readme/http_response.rb
CHANGED
@@ -13,12 +13,12 @@ module Readme
|
|
13
13
|
def body
|
14
14
|
if raw_body.respond_to?(:rewind)
|
15
15
|
raw_body.rewind
|
16
|
-
content = raw_body.each.
|
16
|
+
content = raw_body.each.sum('')
|
17
17
|
raw_body.rewind
|
18
18
|
|
19
19
|
content
|
20
20
|
else
|
21
|
-
raw_body.each.
|
21
|
+
raw_body.each.sum('')
|
22
22
|
end
|
23
23
|
end
|
24
24
|
|
data/lib/readme/metrics.rb
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
#
|
1
|
+
# frozen_string_literal: true
|
2
2
|
|
3
3
|
require 'readme/metrics/version'
|
4
4
|
require 'readme/har/serializer'
|
@@ -15,7 +15,7 @@ module Readme
|
|
15
15
|
class Metrics
|
16
16
|
SDK_NAME = 'readme-metrics'
|
17
17
|
DEFAULT_BUFFER_LENGTH = 1
|
18
|
-
ENDPOINT = 'https://metrics.readme.io/v1/request'
|
18
|
+
ENDPOINT = URI.join(ENV['README_METRICS_SERVER'] || 'https://metrics.readme.io', '/v1/request')
|
19
19
|
|
20
20
|
def self.logger
|
21
21
|
@@logger
|
@@ -136,9 +136,9 @@ module Readme
|
|
136
136
|
|
137
137
|
# rubocop:disable Style/InverseMethods
|
138
138
|
def user_info_valid?(user_info)
|
139
|
-
!user_info.nil? &&
|
139
|
+
(!user_info.nil? &&
|
140
140
|
!user_info.values.any?(&:nil?) &&
|
141
|
-
user_info.key?(:api_key) || user_info.key?(:id)
|
141
|
+
user_info.key?(:api_key)) || user_info.key?(:id)
|
142
142
|
end
|
143
143
|
# rubocop:enable Style/InverseMethods
|
144
144
|
end
|
data/lib/readme/payload.rb
CHANGED
@@ -1,5 +1,11 @@
|
|
1
1
|
require 'socket'
|
2
|
-
require '
|
2
|
+
require 'securerandom'
|
3
|
+
|
4
|
+
def validate_uuid(uuid)
|
5
|
+
return if uuid.nil?
|
6
|
+
|
7
|
+
uuid.match(/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i)
|
8
|
+
end
|
3
9
|
|
4
10
|
module Readme
|
5
11
|
class Payload
|
@@ -13,12 +19,12 @@ module Readme
|
|
13
19
|
@ignore = info[:ignore]
|
14
20
|
@ip_address = ip_address
|
15
21
|
@development = development
|
16
|
-
@uuid =
|
22
|
+
@uuid = SecureRandom.uuid
|
17
23
|
end
|
18
24
|
|
19
25
|
def to_json(*_args)
|
20
26
|
{
|
21
|
-
|
27
|
+
_id: validate_uuid(@log_id) ? @log_id : @uuid,
|
22
28
|
group: @user_info,
|
23
29
|
clientIPAddress: @ip_address,
|
24
30
|
development: @development,
|
@@ -0,0 +1,42 @@
|
|
1
|
+
require 'readme/metrics'
|
2
|
+
|
3
|
+
module Readme
|
4
|
+
class MissingSignatureError < ArgumentError
|
5
|
+
def message
|
6
|
+
'Missing Signature'
|
7
|
+
end
|
8
|
+
end
|
9
|
+
|
10
|
+
class ExpiredSignatureError < RuntimeError
|
11
|
+
def message
|
12
|
+
'Expired Signature'
|
13
|
+
end
|
14
|
+
end
|
15
|
+
|
16
|
+
class InvalidSignatureError < RuntimeError
|
17
|
+
def message
|
18
|
+
'Invalid Signature'
|
19
|
+
end
|
20
|
+
end
|
21
|
+
|
22
|
+
class Webhook
|
23
|
+
def self.verify(body, signature, secret)
|
24
|
+
raise MissingSignatureError unless signature
|
25
|
+
|
26
|
+
parsed = signature.split(',').each_with_object({ time: -1, readme_signature: '' }) do |item, accum|
|
27
|
+
k, v = item.split('=')
|
28
|
+
accum[:time] = v if k.eql? 't'
|
29
|
+
accum[:readme_signature] = v if k.eql? 'v0'
|
30
|
+
end
|
31
|
+
|
32
|
+
# Make sure timestamp is recent to prevent replay attacks
|
33
|
+
thirty_minutes = 30 * 60
|
34
|
+
raise ExpiredSignatureError if Time.now.utc - Time.at(0, parsed[:time].to_i, :millisecond).utc > thirty_minutes
|
35
|
+
|
36
|
+
# Verify the signature is valid
|
37
|
+
unsigned = "#{parsed[:time]}.#{body}"
|
38
|
+
mac = OpenSSL::HMAC.hexdigest('SHA256', secret, unsigned)
|
39
|
+
raise InvalidSignatureError if mac != parsed[:readme_signature]
|
40
|
+
end
|
41
|
+
end
|
42
|
+
end
|
data/readme-metrics.gemspec
CHANGED