rails_server_timings 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c371d112a0e9ec4cedd13ad49092943a9547a23b
-  data.tar.gz: 5c6ac8e59d859be6f3f21aa9c0a5848415c8907b
+  metadata.gz: 5913482ecd3901806522437a90777f68c08b7047
+  data.tar.gz: cfbb869fc27d3e1122fd4904d238ecb570041f25
 SHA512:
-  metadata.gz: 92d8c30669f108e75ad856f08c636dd2b7a67105b15c583399be2eb78dd3f266f68e62a99c308380107f8e329958f92ca28e85e712a21c3874675fd700c479f4
-  data.tar.gz: eed3bade55c62b5866a34f56104fbbb0952104df8a72d4b4aef915b1731443704c1a67c9541bcc68f5169848964d9f6b6f0d69a72fc37b051a223f0f103550c6
+  metadata.gz: 495ae69d7e2ae236a2648c439627a803666d54c9af52aa5cd873c3d28f43add54c58a1e61690917de7216f11fe9d0a19a9071443e18c9ea579bda3f427990f84
+  data.tar.gz: b1cab32b50fe92f9cb222af56c9caa9201a7232226c07c0395affc5a364887d616b8d118bbabb6700d2af0a12c8548d7b4aafca5e88aeec737ce38b1b708781c

data/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+end_of_line = lf
+indent_style = space
+insert_final_newline = true
+charset = utf-8
+trim_trailing_whitespace = true
+indent_size = 2

data/.gitignore

@@ -0,0 +1,30 @@
+*.DS_Store
+*.swp
+*~
+.#*
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+.rvmrc

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,75 @@
+# 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 darryl@dpogue.ca. 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

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in curler.gemspec
+gemspec

data/LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Darryl Pogue
+
+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,43 @@
+rails_server_timings
+====================
+
+Rails support for returning [Server Timing](http://wicg.github.io/server-timing/) headers on requests providing instrumentation information to in-browser developer tools.
+
+
+Download
+--------
+
+* Github: https://github.com/dpogue/rails_server_timings
+
+* Gem:
+
+      $ gem install rails_server_timings
+
+
+Configuration
+-------------
+
+Add `rails_server_timings` to your Gemfile:
+
+```ruby
+gem 'rails_server_timings'
+```
+
+By default, Rails will now include the `Server-Timing` response header on every controller response.
+
+To disable, set `config.server_timings.enabled` to false in your application configuration.
+
+
+Contributing
+------------
+
+Contributions of bug reports, feature requests, and pull requests are greatly appreciated!
+
+Please note that this project is released with a [Contributor Code of Conduct](https://github.com/dpogue/rails_server_timings/blob/master/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
+
+
+Licence
+-------
+
+Copyright © 2017 Darryl Pogue
+Licensed under the MIT Licence.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rails_server_timings.rb

@@ -0,0 +1,5 @@
+require 'rails_server_timings/version'
+require 'rails_server_timings/railtie'
+
+module RailsServerTimings
+end

data/lib/rails_server_timings/controller_runtime.rb

@@ -0,0 +1,26 @@
+module RailsServerTimings
+  module ControllerRuntime
+    def process_action(*args)
+      callback = lambda do |*_|
+        event = ActiveSupport::Notifications::Event.new(*_)
+        payload = event.payload
+        timings = []
+
+        payload.each do |key, value|
+          if idx = key.to_s =~ /_runtime/
+            timings << ("#{key[0, idx]}=%.1f" % value.to_f)
+          end
+        end
+
+        timings << ("total=%.1f" % event.duration.to_f)
+
+        response.headers['Server-Timing'] = timings.join(', ')
+      end
+
+
+      ActiveSupport::Notifications.subscribed(callback, 'process_action.action_controller') do
+        super
+      end
+    end
+  end
+end

data/lib/rails_server_timings/railtie.rb

@@ -0,0 +1,17 @@
+require 'rails'
+require 'rails_server_timings/controller_runtime'
+
+module RailsServerTimings
+  class Railtie < Rails::Railtie
+    config.server_timings = ActiveSupport::OrderedOptions.new
+    config.server_timings.enabled = true
+
+    initializer 'server_timings.subscribe' do |app|
+      if app.config.server_timings.enabled
+        ActiveSupport.on_load(:action_controller) do
+          include RailsServerTimings::ControllerRuntime
+        end
+      end
+    end
+  end
+end

data/lib/rails_server_timings/version.rb

@@ -0,0 +1,4 @@
+
+module RailsServerTimings
+  VERSION = "1.0.1".freeze
+end

data/rails_server_timings.gemspec

@@ -0,0 +1,32 @@
+# encoding: utf-8
+require File.expand_path('../lib/rails_server_timings/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name      = 'rails_server_timings'
+  s.version   = RailsServerTimings::VERSION
+  s.authors   = ['Darryl Pogue']
+  s.email     = 'darryl@dpogue.ca'
+  s.homepage  = 'https://github.com/dpogue/rails_server_timings'
+  s.license   = 'MIT'
+
+  s.summary   = 'Server Timing headers for Rails apps'
+
+  s.files      = [
+    '.editorconfig',
+    '.gitignore',
+    'CODE_OF_CONDUCT.md',
+    'Gemfile',
+    'LICENCE',
+    'README.md',
+    'Rakefile',
+    'lib/rails_server_timings.rb',
+    'lib/rails_server_timings/controller_runtime.rb',
+    'lib/rails_server_timings/railtie.rb',
+    'lib/rails_server_timings/version.rb',
+    'rails_server_timings.gemspec'
+  ]
+  s.executables   = []
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency('railties', '>= 3.0.0')
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_server_timings
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Darryl Pogue
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-19 00:00:00.000000000 Z
+date: 2017-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -29,7 +29,19 @@ email: darryl@dpogue.ca
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENCE
+- README.md
+- Rakefile
+- lib/rails_server_timings.rb
+- lib/rails_server_timings/controller_runtime.rb
+- lib/rails_server_timings/railtie.rb
+- lib/rails_server_timings/version.rb
+- rails_server_timings.gemspec
 homepage: https://github.com/dpogue/rails_server_timings
 licenses:
 - MIT
@@ -50,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Server Timing headers for Rails apps