overall_request_times 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21db3bfd26c2c2cebb6b344e468704450133544a
+  data.tar.gz: e675a9386b2aa8f9d2c69378afe201e834c959a9
+SHA512:
+  metadata.gz: 00e5b953fa78e1835a292108f983e06ac0af827a688a538966f8d782b3a239ef7757d139f7388597395e4da0b2a16af266cd1a046ca427f2e620a50f60f91a04
+  data.tar.gz: d8ad75c0158ef47116dc8622674916a9c0096a6c2c26335673fa8819984f1fdad4a9ca92f573f459ca8077154914772b9bc4f62baa4459ecf3149d0d2028a528

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Donald Plummer
+
+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,84 @@
+# OverallRequestTimes
+
+[![Build Status](https://travis-ci.org/dplummer/overall_request_times.svg?branch=master)](https://travis-ci.org/dplummer/overall_request_times)
+
+A library for recording the total time spent each request on the HTTP request
+for a given service. Useful if you use several HTTP backends in each request
+and want to log the total time spent in each in your Rails log, like the db
+time.
+
+Includes a [Faraday](https://github.com/lostisland/faraday) middleware and
+generic implimentation.
+
+## WARNING
+
+I do not know if this is threadsafe yet. Assume it is not.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'overall_request_times'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install overall_request_times
+
+## Usage
+
+```ruby
+RemoteService.connection do |conn|
+  conn.use OverallRequestTimes::FaradayMiddleware, :remote_service_name
+end
+```
+
+or just
+
+```ruby
+OverallRequestTimes.bm(:remote_service_name) do
+  # remote service call
+end
+```
+
+Then to extract the totals to log:
+
+```ruby
+OverallRequestTimes.total_for(:remote_service_name)
+```
+
+And reset the totals at the start of your request cycle:
+
+```ruby
+OverallRequestTimes.reset!
+```
+
+If you're using Rails, the reset call isn't needed, since there's a Railtie
+that adds a middleware to do that.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake rspec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/[USERNAME]/faraday_overall_request_times.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "overall_request_times"
+
+# 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

data/bin/setup

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

data/lib/overall_request_times/faraday_middleware.rb

@@ -0,0 +1,19 @@
+require 'faraday'
+
+module OverallRequestTimes
+  class FaradayMiddleware < ::Faraday::Middleware
+    include Timer
+
+    def initialize(app, remote_app_name)
+      super(app)
+      timer_setup(remote_app_name)
+    end
+
+    def call(request_env)
+      start
+      @app.call(request_env).on_complete do |response_env|
+        stop
+      end
+    end
+  end
+end

data/lib/overall_request_times/generic_timer.rb

@@ -0,0 +1,9 @@
+module OverallRequestTimes
+  class GenericTimer
+    include Timer
+
+    def initialize(remote_app_name)
+      timer_setup(remote_app_name)
+    end
+  end
+end

data/lib/overall_request_times/rails_middleware.rb

@@ -0,0 +1,12 @@
+module OverallRequestTimes
+  class RailsMiddleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      OverallRequestTimes.reset!
+      @app.call(env)
+    end
+  end
+end

data/lib/overall_request_times/railtie.rb

@@ -0,0 +1,7 @@
+module OverallRequestTimes
+  class Railtie < Rails::Railtie
+    initializer "overall_request_times.configure_rails_initialization" do |app|
+      app.middleware.use OverallRequestTimes::RailsMiddleware
+    end
+  end
+end

data/lib/overall_request_times/timer.rb

@@ -0,0 +1,33 @@
+module OverallRequestTimes
+  module Timer
+    attr_reader :remote_app_name
+
+    def timer_setup(remote_app_name)
+      @remote_app_name = remote_app_name
+      reset!
+      OverallRequestTimes.register(self)
+    end
+
+    def total
+      @total
+    end
+
+    def reset!
+      @total = 0
+    end
+
+    def add(some_time)
+      @total += some_time
+    end
+
+    def start
+      @started_at = Time.now
+    end
+
+    def stop
+      return unless @started_at
+      ended_at = Time.now
+      add(ended_at - @started_at)
+    end
+  end
+end

data/lib/overall_request_times/version.rb

@@ -0,0 +1,3 @@
+module OverallRequestTimes
+  VERSION = "0.2.0"
+end

data/lib/overall_request_times.rb

@@ -0,0 +1,39 @@
+require "overall_request_times/version"
+require "overall_request_times/timer"
+require "overall_request_times/faraday_middleware"
+require "overall_request_times/generic_timer"
+require "overall_request_times/rails_middleware"
+require "overall_request_times/railtie" if defined?(Rails)
+
+module OverallRequestTimes
+  def self.wipeout_registry
+    @registry = nil
+  end
+
+  def self.registry
+    @registry ||= {}
+  end
+
+  def self.reset!
+    registry.each { |_, timer| timer.reset! }
+  end
+
+  def self.register(timer)
+    registry[timer.remote_app_name] ||= timer
+  end
+
+  def self.total_for(remote_app_name)
+    timer = registry[remote_app_name]
+    timer ? timer.total : 0
+  end
+
+  def self.bm(remote_app_name, &block)
+    registry[remote_app_name] ||= GenericTimer.new(remote_app_name)
+    registry[remote_app_name].start
+    begin
+      block.call
+    ensure
+      registry[remote_app_name].stop
+    end
+  end
+end

data/overall_request_times.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'overall_request_times/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "overall_request_times"
+  spec.version       = OverallRequestTimes::VERSION
+  spec.authors       = ["Donald Plummer"]
+  spec.email         = ["donald.plummer@gmail.com"]
+
+  spec.summary       = %q{For recording overall times using remote services.}
+  spec.homepage      = "https://github.com/dplummer/overall_request_times"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 0.8.9"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "timecop"
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: overall_request_times
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Donald Plummer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.9
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- donald.plummer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/overall_request_times.rb
+- lib/overall_request_times/faraday_middleware.rb
+- lib/overall_request_times/generic_timer.rb
+- lib/overall_request_times/rails_middleware.rb
+- lib/overall_request_times/railtie.rb
+- lib/overall_request_times/timer.rb
+- lib/overall_request_times/version.rb
+- overall_request_times.gemspec
+homepage: https://github.com/dplummer/overall_request_times
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: For recording overall times using remote services.
+test_files: []