lhc 4.0.2 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a045e9c4ec6bd59f9113d07c47ab443e950d0351
-  data.tar.gz: f9f7eeab4930f67f6ad781ff6e90a7a42cb00b7b
+  metadata.gz: f2ce43cdeb1c391d2f2b81ebbe646bab845cae94
+  data.tar.gz: b4ab6318f46cc2ea75b0d0ebe767804babe27075
 SHA512:
-  metadata.gz: 456aee147439c9b397742524744f29883a51cf1fcd834c1397b855416655313e30ba430cef40e766b99111c778f846fe632272422e33dbe3fda023092684c232
-  data.tar.gz: 729fd32780eeb613feaeabf884a262ffd83899fe77bfd0e1846355e35ed2431b88753107f48a5a3792bea603cd88ee1a6d2b5d4c65cfc63242fbff9ef2c40d6e
+  metadata.gz: 81713512c7970b84015e1bc4e3b473baab7616e947f81183cd1c32532a623d575ff71faa2d72992c2721f7c3355b61097e5675cbbee2dbeeba32585c922bd004
+  data.tar.gz: a4ba86f473787d058eb036a5f8657e1c8236be6deb34176801f277a6d8cf40972512c52e6489ef13ce59d42693665d16f04a9fb6519b2b9d84b82310676873b4

data/docs/interceptors/caching.md

@@ -13,7 +13,6 @@ You can configure your own cache (default Rails.cache) and logger (default Rails
   LHC::Caching.logger = Logger.new(STDOUT)
 ```
 
-
 Caching is not enabled by default, although you added it to your basic set of interceptors.
 If you want to have requests served/stored and stored in/from cache, you have to enable it by request.
 
@@ -29,6 +28,12 @@ You can also enable caching when configuring an endpoint in LHS.
   end
 ```
 
+Only GET requests are cached by default. If you want to cache any other request method, just configure it:
+
+```ruby
+  LHC.get('http://local.ch', cache: true, cached_methods: [:post, :head])
+```
+
 ## Options
 
 ```ruby

data/lib/lhc/interceptors/caching.rb

@@ -14,6 +14,7 @@ class LHC::Caching < LHC::Interceptor
   def before_request(request)
     return unless cache
     return unless request.options[:cache]
+    return unless cached_method?(request.method, request.options[:cache_methods])
     cached_response_data = cache.fetch(key(request))
     return unless cached_response_data
     logger.info "Served from cache: #{key(request)}" if logger
@@ -23,6 +24,7 @@ class LHC::Caching < LHC::Interceptor
   def after_response(response)
     return unless cache
     request = response.request
+    return unless cached_method?(request.method, request.options[:cache_methods])
     return if !request.options[:cache] || !response.success?
     cache.write(key(request), to_cache(response), options(request.options))
   end
@@ -56,6 +58,12 @@ class LHC::Caching < LHC::Interceptor
     "LHC_CACHE(v#{CACHE_VERSION}): #{key}"
   end
 
+  # Checks if the provided method should be cached
+  # in regards of the provided options.
+  def cached_method?(method, cached_methods)
+    (cached_methods || [:get]).include?(method)
+  end
+
   def options(input = {})
     options = {}
     FORWARDED_OPTIONS.each do |k, v|

data/lib/lhc/version.rb

@@ -1,3 +1,3 @@
 module LHC
-  VERSION ||= "4.0.2"
+  VERSION ||= "5.0.0"
 end

data/spec/interceptors/caching/main_spec.rb

@@ -28,7 +28,6 @@ describe LHC::Caching do
     expect(original_response.body).to eq cached_response.body
     expect(original_response.code).to eq cached_response.code
     expect(original_response.headers).to eq cached_response.headers
-    expect(original_response.headers).to eq cached_response.headers
     assert_requested stub, times: 1
   end
 

data/spec/interceptors/caching/methods_spec.rb

@@ -0,0 +1,41 @@
+require 'rails_helper'
+
+describe LHC::Caching do
+  before(:each) do
+    LHC.config.interceptors = [LHC::Caching]
+    LHC::Caching.cache = Rails.cache
+    Rails.cache.clear
+  end
+
+  let!(:stub) { stub_request(:post, 'http://local.ch').to_return(status: 200, body: 'The Website') }
+
+  before(:each) do
+    LHC.config.endpoint(:local, 'http://local.ch', cache: true, cache_expires_in: 5.minutes)
+  end
+
+  it 'only caches GET requests by default' do
+    expect(Rails.cache).not_to receive(:write)
+    LHC.post(:local)
+    assert_requested stub, times: 1
+  end
+
+  it 'also caches other methods, when explicitly enabled' do
+    expect(Rails.cache).to receive(:write)
+      .with(
+        "LHC_CACHE(v#{LHC::Caching::CACHE_VERSION}): POST http://local.ch",
+        {
+          body: 'The Website',
+          code: 200,
+          headers: nil,
+          return_code: nil
+        }, { expires_in: 5.minutes }
+      )
+      .and_call_original
+    original_response = LHC.post(:local, cache_methods: [:post])
+    cached_response = LHC.post(:local, cache_methods: [:post])
+    expect(original_response.body).to eq cached_response.body
+    expect(original_response.code).to eq cached_response.code
+    expect(original_response.headers).to eq cached_response.headers
+    assert_requested stub, times: 1
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhc
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 5.0.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhc/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-24 00:00:00.000000000 Z
+date: 2017-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -260,6 +260,7 @@ files:
 - spec/interceptors/before_request_spec.rb
 - spec/interceptors/before_response_spec.rb
 - spec/interceptors/caching/main_spec.rb
+- spec/interceptors/caching/methods_spec.rb
 - spec/interceptors/caching/parameters_spec.rb
 - spec/interceptors/caching/response_status_spec.rb
 - spec/interceptors/caching/to_cache_spec.rb
@@ -384,6 +385,7 @@ test_files:
 - spec/interceptors/before_request_spec.rb
 - spec/interceptors/before_response_spec.rb
 - spec/interceptors/caching/main_spec.rb
+- spec/interceptors/caching/methods_spec.rb
 - spec/interceptors/caching/parameters_spec.rb
 - spec/interceptors/caching/response_status_spec.rb
 - spec/interceptors/caching/to_cache_spec.rb