headerable_etag 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56de96e5367d2340b61add48309eda53ee123007
+  data.tar.gz: b2a5edd35fae33a476d625fa2fd5b89f62dc10e5
+SHA512:
+  metadata.gz: 08500824bfc399ee19e760c131b975b13cdfe741e91a4b226bf7c72c4e52188738b6af64ba34126702875309476fc9c50e041c61569bdaefce37a94b058a2ee3
+  data.tar.gz: 74358d10769f26a1d53dc1404b3fe9c1a877ad4e0eaef2676ca693d46e92d7eb12abcb921eb4b4bc63150ac9574e496b4ef787758e61f9cb00cb9e9f442e28e9

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.5
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/README.md

@@ -0,0 +1,39 @@
+# HeaderableEtag
+
+Use additional headers to caculate ETag
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'headerable_etag'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install headerable_etag
+
+## Usage
+
+Example of adding Cache-Control header into calculating ETag:
+
+```ruby
+config.middleware.insert_before(Rack::ETag, ::HeaderableEtag::Middleware, ['Cache-Control'])
+```
+
+
+## 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/liuming/headerable_etag.
+

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 "headerable_etag"
+
+# 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,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/headerable_etag.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'headerable_etag/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "headerable_etag"
+  spec.version       = HeaderableEtag::VERSION
+  spec.authors       = ["Ming Liu"]
+  spec.email         = ["liuming@lmws.net"]
+
+  spec.summary       = %q{ Use additional headers to caculate ETag }
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/liuming/headerable_etag"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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 "rack", ">= 1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/headerable_etag.rb

@@ -0,0 +1,35 @@
+require "headerable_etag/version"
+require 'digest/sha2'
+
+module HeaderableEtag
+  def self.headers_string(current_headers, header_keys_for_etag)
+    header_values_for_etag = current_headers.values_at(*header_keys_for_etag)
+    headers_string = header_values_for_etag.sort.join
+    return headers_string
+  end
+
+  def self.etag_with_headers(current_headers, header_keys_for_etag)
+    headers_string_for_etag = headers_string(current_headers, header_keys_for_etag)
+    new_etag = digest(headers_string_for_etag + current_headers['ETag'])
+    return new_etag
+  end
+
+  def self.digest(string)
+    Digest::SHA256.hexdigest(string).byteslice(0,32)
+  end
+
+  class Middleware
+    def initialize(app, header_keys_for_etag=[], options={})
+      @app = app
+      @header_keys_for_etag = header_keys_for_etag
+    end
+
+    def call(env)
+      status, headers, body = @app.call(env)
+      if headers['ETag']
+        headers['ETag'] = HeaderableEtag.etag_with_headers(headers, @header_keys_for_etag)
+      end
+      [status, headers, body]
+    end
+  end
+end

data/lib/headerable_etag/version.rb

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

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: headerable_etag
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ming Liu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: Use additional headers to caculate ETag
+email:
+- liuming@lmws.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- headerable_etag.gemspec
+- lib/headerable_etag.rb
+- lib/headerable_etag/version.rb
+homepage: https://github.com/liuming/headerable_etag
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.6
+signing_key: 
+specification_version: 4
+summary: Use additional headers to caculate ETag
+test_files: []