faraday-cdn-metrics 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c86baef6a57498196107f84d5238eb3f82e0b64
+  data.tar.gz: 25826f2b5283099093116ec87b02f61cdbc47335
+SHA512:
+  metadata.gz: 3082622a60a1bc7578b05b5d164f1f2f38947b8c1c9999885eb7838944b5a35263524c64ca30e7f259cdd968dd5aadc0cd235263ff07436df8c223bbedee62c0
+  data.tar.gz: cdd357e460e675d5a1ef8e74338396a5806a4256802955adf815b8a681750e832f1b5eff2c3be78afca95dc8fac946a2d7e0bd41434a108f80ee0a7667029eb6

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in faraday-cdn-metrics.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Anson Kelly
+
+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,46 @@
+# Faraday::Cdn::Metrics
+
+Adds instrumentation to a faraday stack to capture server cache hits / misses. Currently only supports fastly.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faraday-cdn-metrics'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install faraday-cdn-metrics
+
+## Usage
+
+Initialise the middleware with an instrumentation class. It must respond to :instrument (eg ActiveSupport::Notifications)
+
+Use as faraday middleware:
+```
+Faraday.new do |b|
+  b.use :cdn_metrics, instrumenter: ActiveSupport::Notifications
+
+  b.adapter :typhoeus
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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-cdn-metrics.
+
+## 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,42 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+desc "Upload to rubygems"
+task :upload => :build do
+  if tag_exists?(current_tag_name)
+    puts "Tag exists, did you run rake increase_revision_number after merging with master?"
+    exit 1
+  end
+
+  create_tag(current_tag_name)
+  Rake::Task[:release].invoke
+end
+
+desc "Increase the revision number"
+task :increase_revision_number do
+  version_file = "lib/faraday_cdn_metrics/version.rb"
+  file_content = File.read(version_file)
+  rule = /(\d+\.\d+\.)(\d+)/
+  new_revision_number = rule.match(file_content)[2].to_i + 1
+  new_file_content = file_content.sub(rule, '\1' + new_revision_number.to_s)
+
+  File.open(version_file, 'w') { |file| file.write(new_file_content) }
+end
+
+def tag_exists?(tag_name)
+  result = `git tag | grep #{tag_name}`.strip
+  result == tag_name
+end
+
+def create_tag(tag_name)
+  sh "git tag -a #{tag_name} -m \"Released version #{tag_name}\""
+  sh "git push origin #{tag_name}"
+end
+
+def current_tag_name
+  "v#{FaradayCdnMetrics::VERSION}"
+end

data/bin/console

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

@@ -0,0 +1,8 @@
+#!/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/faraday-cdn-metrics.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "faraday_cdn_metrics/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "faraday-cdn-metrics"
+  spec.version       = FaradayCdnMetrics::VERSION
+  spec.authors       = ["Anson Kelly"]
+  spec.email         = ["anson.kelly@carwow.co.uk"]
+
+  spec.summary       = %q{Metrics requests to a CDN like Fastly}
+  spec.description   = %q{Metrics requests to a CDN like Fastly}
+  spec.homepage      = "https://github.com/carwow/faraday-cdn-metrics"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", '~> 0.11'
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/faraday_cdn_metrics.rb

@@ -0,0 +1,74 @@
+require 'faraday'
+require 'faraday_cdn_metrics/version'
+require 'faraday_cdn_metrics/server_caches/fastly'
+
+module FaradayCdnMetrics
+  class CdnMetrics < Faraday::Middleware
+
+    # Cache status' shamelessly copied from faraday-http-cache
+    CACHE_STATUSES = [
+      # The request was not cacheable.
+      :unacceptable,
+
+      # The response was cached and can still be used.
+      :fresh,
+
+      # The response was cached and the server has validated it with a 304 response.
+      :valid,
+
+      # The response was cache but was revalidated by the sserver.
+      :invalid,
+
+      # No response was found in the cache.
+      :miss,
+
+      # The response can't be cached.
+      :uncacheable,
+
+      # The request decided to ignore the cache.
+      :bypass
+    ].freeze
+
+    EVENT_NAME = 'cdn_metrics.http_cache'.freeze
+
+    def initialize(app, instrumenter: nil, instrument_name: EVENT_NAME, server_cache: FaradayCdnMetrics::ServerCaches::Fastly)
+      super(app)
+
+      @instrumenter = instrumenter
+      @instrument_name = instrument_name
+      @server_cache_class = server_cache
+    end
+
+    def call(request_env)
+      @app.call(request_env).on_complete do |response_env|
+        client_cache_status = find_client_cache_status(response_env)
+        server_cache_status = find_server_cache_status(response_env)
+
+        @instrumenter.instrument(@instrument_name, { env: response_env, client_cache_status: client_cache_status, server_cache_status: server_cache_status })
+      end
+    end
+
+    private
+
+    def find_client_cache_status(env)
+      trace = (env[:http_cache_trace] || [])
+      CACHE_STATUSES.find { |status| trace.include?(status) } || :unknown
+    end
+
+    def find_server_cache_status(env)
+      server_cache = @server_cache_class.new(env[:response_headers])
+
+      return :pass if server_cache.pass?
+      return :valid if server_cache.hit_while_revalidate?
+      return :fresh if server_cache.hit?
+      return :miss if server_cache.miss?
+      :unknown
+    end
+  end
+end
+
+if Faraday.respond_to?(:register_middleware)
+  Faraday.register_middleware cdn_metrics: FaradayCdnMetrics::CdnMetrics
+elsif Faraday::Middleware.respond_to?(:register_middleware)
+  Faraday::Middleware.register_middleware cdn_metrics: FaradayCdnMetrics::CdnMetrics
+end

data/lib/faraday_cdn_metrics/server_caches/fastly.rb

@@ -0,0 +1,49 @@
+module FaradayCdnMetrics
+  module ServerCaches
+    class Fastly
+
+      def initialize(response_headers = {})
+        @response_headers = response_headers
+      end
+
+      def hit?
+        x_cache_hit?
+      end
+
+      def miss?
+        x_cache_miss?
+      end
+
+      def pass?
+        x_cache_miss? && fetch_age.nil?
+      end
+
+      def hit_while_revalidate?
+        max_age = fetch_max_age.to_i
+        age = fetch_age.to_i
+
+        x_cache_hit? && max_age > 0 && age > max_age
+      end
+
+      private
+
+      attr_reader :response_headers
+
+      def x_cache_hit?
+        response_headers.fetch('X-Cache', nil) == 'HIT'
+      end
+
+      def x_cache_miss?
+        response_headers.fetch('X-Cache', nil) == 'MISS'
+      end
+
+      def fetch_max_age
+        response_headers.fetch('Cache-Control', '').match(/max-age=(\d+)/)&.captures&.first
+      end
+
+      def fetch_age
+        response_headers.fetch('Age', nil)
+      end
+    end
+  end
+end

data/lib/faraday_cdn_metrics/version.rb

@@ -0,0 +1,3 @@
+module FaradayCdnMetrics
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: faraday-cdn-metrics
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anson Kelly
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Metrics requests to a CDN like Fastly
+email:
+- anson.kelly@carwow.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- faraday-cdn-metrics.gemspec
+- lib/faraday_cdn_metrics.rb
+- lib/faraday_cdn_metrics/server_caches/fastly.rb
+- lib/faraday_cdn_metrics/version.rb
+homepage: https://github.com/carwow/faraday-cdn-metrics
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Metrics requests to a CDN like Fastly
+test_files: []