faraday-http-cache 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31653854fcef7bc7fb46c6ba9f92e83d5450a681
-  data.tar.gz: 90b06cc78065d338fa1216292eb124ae3f70b18f
+  metadata.gz: ed664b05e7052722cfb0f9d0ba7336b6de8ea5b7
+  data.tar.gz: fece9174d01e39d9e63c92f0ae6ba28c676a3504
 SHA512:
-  metadata.gz: b10e5f35769cff0522aeef88f465dffe522cc4da8e4a8d7719d024c963f05dd09d3ab6ad2404da8586198acff5da94da8287308f015e373f4d081c2d619fc456
-  data.tar.gz: 7429b49fc0db0619cb4c1d87914c2bbb464547c3fd5d581ce2da93e3b0d380a21d0586c38973c2cd39f2fee86b185f0cbd40c9f97d3d06e0d7a6a375884b6218
+  metadata.gz: db36959ac2578e4f9559aece670ab1a8fcc58d33d87bceb24dd9ea6871260d0af88ad570907198e01a4d733e146e884d5fca62ffec2223b61d1b2bd6aba8d399
+  data.tar.gz: de95b997afd0c83d6e1b344e5e00f9bd0e2a6ce57c7d81bbde0bc5a8ac6f4efbe804087c2565c89ec879145c5e06e00ced67d491e77cfe2515c9900817063676

data/README.md

@@ -84,7 +84,7 @@ client.get('http://site/api/users')
 In addition to logging you can instrument the middleware by passing in an `:instrumenter` option
 such as ActiveSupport::Notifications (compatible objects are also allowed).
 
-The event `process_request.http_cache.faraday` will be published every time the middleware
+The event `http_cache.faraday` will be published every time the middleware
 processes a request. In the event payload, `:env` contains the response Faraday env and
 `:cache_status` contains a Symbol indicating the status of the cache processing for that request:
 
@@ -102,18 +102,18 @@ client = Faraday.new do |builder|
 end
 
 # Subscribes to all events from Faraday::HttpCache.
-ActiveSupport::Notifications.subscribe "process_request.http_cache.faraday" do |*args|
+ActiveSupport::Notifications.subscribe "http_cache.faraday" do |*args|
   event = ActiveSupport::Notifications::Event.new(*args)
-  cache_status = event.payload.fetch(:cache_status)
+  cache_status = event.payload[:cache_status]
   statsd = Statsd.new
 
   case cache_status
   when :fresh, :valid
-    statsd.increment("api-calls.cache_hits")
+    statsd.increment('api-calls.cache_hits')
   when :invalid, :miss
-    statsd.increment("api-calls.cache_misses")
+    statsd.increment('api-calls.cache_misses')
   when :unacceptable
-    statsd.increment("api-calls.cache_bypass")
+    statsd.increment('api-calls.cache_bypass')
   end
 end
 ```

data/lib/faraday-http-cache.rb

@@ -1 +1 @@
-require 'faraday/http_cache'
+require 'faraday/http_cache' # rubocop:disable Style/FileName

data/lib/faraday/http_cache.rb

@@ -44,14 +44,14 @@ module Faraday
   #   end
   class HttpCache < Faraday::Middleware
     # Internal: valid options for the 'initialize' configuration Hash.
-    VALID_OPTIONS = [:store, :serializer, :logger, :shared_cache, :instrumenter]
+    VALID_OPTIONS = [:store, :serializer, :logger, :shared_cache, :instrumenter, :instrument_name]
 
     UNSAFE_METHODS = [:post, :put, :delete, :patch]
 
     ERROR_STATUSES = 400..499
 
     # The name of the instrumentation event.
-    EVENT_NAME = 'process_request.http_cache.faraday'
+    EVENT_NAME = 'http_cache.faraday'
 
     CACHE_STATUSES = [
       # The request was not cacheable:
@@ -328,8 +328,7 @@ module Faraday
 
       method = @request.method.to_s.upcase
       path = @request.url.request_uri
-      line = "HTTP Cache: [#{method} #{path}] #{@trace.join(', ')}"
-      @logger.debug(line)
+      @logger.debug { "HTTP Cache: [#{method} #{path}] #{@trace.join(', ')}" }
     end
 
     # Internal: instruments the request processing.
@@ -344,13 +343,16 @@ module Faraday
       }
 
       @instrumenter.instrument(@instrument_name, payload)
+      # DEPRECATED: Event name from the 1.1.1 release that isn't compatible
+      # with the `ActiveSupport::LogSubscriber` API.
+      @instrumenter.instrument('process_request.http_cache.faraday', payload)
     end
 
     # Internal: Extracts the cache status from a trace.
     #
     # Returns the Symbol status or nil if none was available.
     def extract_status(trace)
-      CACHE_STATUSES.detect {|status| trace.include?(status) }
+      CACHE_STATUSES.find { |status| trace.include?(status) }
     end
 
     # Internal: Checks if the given 'options' Hash contains only

data/lib/faraday/http_cache/cache_control.rb

@@ -5,7 +5,6 @@ module Faraday
     # It breaks the several directives into keys/values and stores them into
     # a Hash.
     class CacheControl
-
       # Internal: Initialize a new CacheControl.
       def initialize(header)
         @directives = parse(header.to_s)
@@ -74,7 +73,8 @@ module Faraday
       #
       # Returns the Cache Control string.
       def to_s
-        booleans, values = [], []
+        booleans = []
+        values = []
 
         @directives.each do |key, value|
           if value == true

data/lib/faraday/http_cache/request.rb

@@ -2,7 +2,6 @@ module Faraday
   class HttpCache < Faraday::Middleware
     # Internal: A class to represent a request
     class Request
-
       class << self
         def from_env(env)
           hash = env.to_hash
@@ -13,7 +12,7 @@ module Faraday
       attr_reader :method, :url, :headers
 
       def initialize(options)
-        @method, @url, @headers = options[:method], options[:url], options[:headers]
+        @method, @url, @headers = options.values_at(:method, :url, :headers)
       end
 
       # Internal: Validates if the current request method is valid for caching.

data/lib/faraday/http_cache/response.rb

@@ -175,7 +175,7 @@ module Faraday
       #
       # Returns the Time object, or nil if the header isn't present or isn't RFC 2616 compliant.
       def expires
-        @expires ||= headers['Expires'] && Time.httpdate(headers['Expires']) rescue nil
+        @expires ||= headers['Expires'] && Time.httpdate(headers['Expires']) rescue nil # rubocop:disable Style/RescueModifier
       end
 
       # Internal: Gets the 'CacheControl' object.

data/spec/http_cache_spec.rb

@@ -9,6 +9,7 @@ describe Faraday::HttpCache do
       stack.use Faraday::HttpCache, options
       adapter = ENV['FARADAY_ADAPTER']
       stack.headers['X-Faraday-Adapter'] = adapter
+      stack.headers['Content-Type'] = 'application/x-www-form-urlencoded'
       stack.adapter adapter.to_sym
     end
   end
@@ -23,7 +24,7 @@ describe Faraday::HttpCache do
   end
 
   it 'logs that a POST request is unacceptable' do
-    expect(logger).to receive(:debug).with('HTTP Cache: [POST /post] unacceptable, delete')
+    expect(logger).to receive(:debug) { |&block| expect(block.call).to eq('HTTP Cache: [POST /post] unacceptable, delete') }
     client.post('post').body
   end
 
@@ -45,7 +46,7 @@ describe Faraday::HttpCache do
     end
 
     it 'logs that a POST request was deleted from the cache' do
-      expect(logger).to receive(:debug).with('HTTP Cache: [POST /counter] unacceptable, delete')
+      expect(logger).to receive(:debug) { |&block| expect(block.call).to eq('HTTP Cache: [POST /counter] unacceptable, delete') }
       client.post('counter')
     end
 
@@ -62,7 +63,7 @@ describe Faraday::HttpCache do
     end
 
     it 'logs that a PUT request was deleted from the cache' do
-      expect(logger).to receive(:debug).with('HTTP Cache: [PUT /counter] unacceptable, delete')
+      expect(logger).to receive(:debug) { |&block| expect(block.call).to eq('HTTP Cache: [PUT /counter] unacceptable, delete') }
       client.put('counter')
     end
 
@@ -73,7 +74,7 @@ describe Faraday::HttpCache do
     end
 
     it 'logs that a DELETE request was deleted from the cache' do
-      expect(logger).to receive(:debug).with('HTTP Cache: [DELETE /counter] unacceptable, delete')
+      expect(logger).to receive(:debug) { |&block| expect(block.call).to eq('HTTP Cache: [DELETE /counter] unacceptable, delete') }
       client.delete('counter')
     end
 
@@ -84,12 +85,12 @@ describe Faraday::HttpCache do
     end
 
     it 'logs that a PATCH request was deleted from the cache' do
-      expect(logger).to receive(:debug).with('HTTP Cache: [PATCH /counter] unacceptable, delete')
+      expect(logger).to receive(:debug) { |&block| expect(block.call).to eq('HTTP Cache: [PATCH /counter] unacceptable, delete') }
       client.patch('counter')
     end
 
     it 'logs that a response with a bad status code is invalid' do
-      expect(logger).to receive(:debug).with('HTTP Cache: [GET /broken] miss, invalid')
+      expect(logger).to receive(:debug) { |&block| expect(block.call).to eq('HTTP Cache: [GET /broken] miss, invalid') }
       client.get('broken')
     end
 
@@ -115,7 +116,7 @@ describe Faraday::HttpCache do
     end
 
     it 'logs that a private response is invalid' do
-      expect(logger).to receive(:debug).with('HTTP Cache: [GET /private] miss, invalid')
+      expect(logger).to receive(:debug) { |&block| expect(block.call).to eq('HTTP Cache: [GET /private] miss, invalid') }
       client.get('private')
     end
   end
@@ -129,7 +130,7 @@ describe Faraday::HttpCache do
     end
 
     it 'logs that a private response is stored' do
-      expect(logger).to receive(:debug).with('HTTP Cache: [GET /private] miss, store')
+      expect(logger).to receive(:debug) { |&block| expect(block.call).to eq('HTTP Cache: [GET /private] miss, store') }
       client.get('private')
     end
   end
@@ -140,7 +141,7 @@ describe Faraday::HttpCache do
   end
 
   it 'logs that a response with a no-store directive is invalid' do
-    expect(logger).to receive(:debug).with('HTTP Cache: [GET /dontstore] miss, invalid')
+    expect(logger).to receive(:debug) { |&block| expect(block.call).to eq('HTTP Cache: [GET /dontstore] miss, invalid') }
     client.get('dontstore')
   end
 
@@ -168,7 +169,7 @@ describe Faraday::HttpCache do
   end
 
   it 'logs that a request with the "Expires" is fresh and stored' do
-    expect(logger).to receive(:debug).with('HTTP Cache: [GET /expires] miss, store')
+    expect(logger).to receive(:debug) { |&block| expect(block.call).to eq('HTTP Cache: [GET /expires] miss, store') }
     client.get('expires')
   end
 
@@ -190,20 +191,20 @@ describe Faraday::HttpCache do
   end
 
   it 'logs that a GET response is stored' do
-    expect(logger).to receive(:debug).with('HTTP Cache: [GET /get] miss, store')
+    expect(logger).to receive(:debug) { |&block| expect(block.call).to eq('HTTP Cache: [GET /get] miss, store') }
     client.get('get')
   end
 
   it 'differs requests with different query strings in the log' do
-    expect(logger).to receive(:debug).with('HTTP Cache: [GET /get] miss, store')
-    expect(logger).to receive(:debug).with('HTTP Cache: [GET /get?q=what] miss, store')
+    expect(logger).to receive(:debug) { |&block| expect(block.call).to eq('HTTP Cache: [GET /get] miss, store') }
+    expect(logger).to receive(:debug) { |&block| expect(block.call).to eq('HTTP Cache: [GET /get?q=what] miss, store') }
     client.get('get')
     client.get('get', q: 'what')
   end
 
   it 'logs that a stored GET response is fresh' do
     client.get('get')
-    expect(logger).to receive(:debug).with('HTTP Cache: [GET /get] fresh')
+    expect(logger).to receive(:debug) { |&block| expect(block.call).to eq('HTTP Cache: [GET /get] fresh') }
     client.get('get')
   end
 
@@ -214,7 +215,7 @@ describe Faraday::HttpCache do
 
   it 'logs that the request with "Last-Modified" was revalidated' do
     client.get('timestamped')
-    expect(logger).to receive(:debug).with('HTTP Cache: [GET /timestamped] valid, store')
+    expect(logger).to receive(:debug) { |&block| expect(block.call).to eq('HTTP Cache: [GET /timestamped] valid, store') }
     expect(client.get('timestamped').body).to eq('1')
   end
 
@@ -225,7 +226,7 @@ describe Faraday::HttpCache do
 
   it 'logs that the request with "ETag" was revalidated' do
     client.get('etag')
-    expect(logger).to receive(:debug).with('HTTP Cache: [GET /etag] valid, store')
+    expect(logger).to receive(:debug) { |&block| expect(block.call).to eq('HTTP Cache: [GET /etag] valid, store') }
     expect(client.get('etag').body).to eq('1')
   end
 

data/spec/instrumentation_spec.rb

@@ -11,10 +11,10 @@ describe 'Instrumentation' do
   end
 
   let(:events) { [] }
-  let(:subscriber) { lambda {|*args| events << ActiveSupport::Notifications::Event.new(*args) } }
+  let(:subscriber) { lambda { |*args| events << ActiveSupport::Notifications::Event.new(*args) } }
 
   around do |example|
-    ActiveSupport::Notifications.subscribed(subscriber, 'process_request.http_cache.faraday') do
+    ActiveSupport::Notifications.subscribed(subscriber, 'http_cache.faraday') do
       example.run
     end
   end

data/spec/request_spec.rb

@@ -44,5 +44,4 @@ describe Faraday::HttpCache::Request do
     let(:headers) { { 'Cache-Control' => 'no-store' } }
     it { should_not be_cacheable }
   end
-
 end

data/spec/storage_spec.rb

@@ -52,7 +52,9 @@ describe Faraday::HttpCache::Storage do
           logger = double(:logger, warn: nil)
           storage = Faraday::HttpCache::Storage.new(logger: logger)
 
-          expect { storage.write(request, response) }.to raise_error
+          expect {
+            storage.write(request, response)
+          }.to raise_error(Encoding::UndefinedConversionError)
           expect(logger).to have_received(:warn).with(
             'Response could not be serialized: "\xE2" from ASCII-8BIT to UTF-8. Try using Marshal to serialize.'
           )
@@ -125,8 +127,8 @@ describe Faraday::HttpCache::Storage do
 
     it 'is fresh until cached and that 1 second elapses then the response is no longer fresh' do
       headers = {
-          'Date' => (Time.now - 39).httpdate,
-          'Expires' => (Time.now + 40).httpdate,
+        'Date' => (Time.now - 39).httpdate,
+        'Expires' => (Time.now + 40).httpdate
       }
 
       response = Faraday::HttpCache::Response.new(response_headers: headers)
@@ -138,5 +140,4 @@ describe Faraday::HttpCache::Storage do
       expect(cached_response).not_to be_fresh
     end
   end
-
 end

data/spec/support/test_app.rb

@@ -2,7 +2,6 @@ require 'sinatra/base'
 require 'json'
 
 class TestApp < Sinatra::Base
-
   set :environment, :test
   set :server, 'webrick'
   disable :protection
@@ -104,7 +103,7 @@ class TestApp < Sinatra::Base
     tag = settings.counter > 2 ? '1' : '2'
 
     if env['HTTP_IF_NONE_MATCH'] == tag
-      [304, { 'ETag' => tag, 'Cache-Control' => 'max-age=200', 'Date' => Time.now.httpdate, 'Expires' => (Time.now + 200).httpdate, 'Vary' => '*' }, ""]
+      [304, { 'ETag' => tag, 'Cache-Control' => 'max-age=200', 'Date' => Time.now.httpdate, 'Expires' => (Time.now + 200).httpdate, 'Vary' => '*' }, '']
     else
       [200, { 'ETag' => tag, 'Cache-Control' => 'max-age=0', 'Date' => settings.yesterday, 'Expires' => Time.now.httpdate, 'Vary' => 'Accept' }, increment_counter]
     end

data/spec/support/test_server.rb

@@ -27,7 +27,7 @@ class TestServer
       log.sync = true
       webrick_opts = {
        Port: @port,
-       Logger:  WEBrick::Log::new(log),
+       Logger:  WEBrick::Log.new(log),
        AccessLog: [[log, '[%{X-Faraday-Adapter}i] %m  %U  ->  %s %b']]
       }
       Rack::Handler::WEBrick.run(TestApp, webrick_opts)
@@ -38,7 +38,7 @@ class TestServer
     conn = Net::HTTP.new @host, @port
     conn.open_timeout = conn.read_timeout = 0.1
 
-    responsive = lambda { |path|
+    responsive = ->(path) { # rubocop:disable Style/BlockDelimiters
       begin
         res = conn.start { conn.get(path) }
         res.is_a?(Net::HTTPSuccess)
@@ -48,11 +48,12 @@ class TestServer
     }
 
     server_pings = 0
-    begin
+    loop do
+      break if responsive.call('/ping')
       server_pings += 1
       sleep 0.05
       abort 'test server did not managed to start' if server_pings >= 50
-    end until responsive.call('/ping')
+    end
   end
 
   def find_port

data/spec/validation_spec.rb

@@ -11,11 +11,11 @@ describe Faraday::HttpCache do
   end
 
   it 'maintains the "Content-Type" header for cached responses' do
-    backend.get('/test') { [200, { 'ETag' => '123ABC', 'Content-Type' => 'x' }, ""] }
+    backend.get('/test') { [200, { 'ETag' => '123ABC', 'Content-Type' => 'x' }, ''] }
     first_content_type = client.get('/test').headers['Content-Type']
 
     # The Content-Type header of the validation response should be ignored.
-    backend.get('/test') { [304, { 'Content-Type' => 'y' }, ""] }
+    backend.get('/test') { [304, { 'Content-Type' => 'y' }, ''] }
     second_content_type = client.get('/test').headers['Content-Type']
 
     expect(first_content_type).to eq('x')
@@ -23,11 +23,11 @@ describe Faraday::HttpCache do
   end
 
   it 'maintains the "Content-Length" header for cached responses' do
-    backend.get('/test') { [200, { 'ETag' => '123ABC', 'Content-Length' => 1 }, ""] }
+    backend.get('/test') { [200, { 'ETag' => '123ABC', 'Content-Length' => 1 }, ''] }
     first_content_length = client.get('/test').headers['Content-Length']
 
     # The Content-Length header of the validation response should be ignored.
-    backend.get('/test') { [304, { 'Content-Length' => 2 }, ""] }
+    backend.get('/test') { [304, { 'Content-Length' => 2 }, ''] }
     second_content_length = client.get('/test').headers['Content-Length']
 
     expect(first_content_length).to eq(1)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday-http-cache
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Lucas Mazza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-04 00:00:00.000000000 Z
+date: 2015-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday