resterl 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34e6d5fb43fdcc446afac5ab06419e2632dac2bc2806a1528725d6165b492ab2
-  data.tar.gz: b6038c9b94e3db6134ec0de6cbc1763573c429f5c412186e59e6dd6af8de1dc2
+  metadata.gz: e9d8e9eaf831b7bda085200459577fc210e7b91fa5fdc5491d5eec3d2e07d7dc
+  data.tar.gz: fb2ce9cd828dd55f21fb78920dbaf9da9b180d3392d60c318fd5f3f8da70d64f
 SHA512:
-  metadata.gz: c4371977339943f3a99831519bc1927724fa4b068902ccd86c2130e5566be7917d9693f0ac2fefd24ea70481f2854daaa1514d59bff59fd8464ece2fee0ea78e
-  data.tar.gz: 64f8c76852a4cd99e033910229f26fbb3be74e4c9162440cd5c47ccd11d7294247f19f15c414a52ff0f6289309827cf10048ade5557df08a58e67d29f450a098
+  metadata.gz: eb6c0ad39ecfaa6246085fae41bf177e5c69b064f109031b39a34c50cb7632c12dd897d4c990b5c50f7c693e38b96b7d3d1e01d819c69be61df977bff518d681
+  data.tar.gz: c98b91ce82439eb45f1ac55c855d9da2fbf36dcf345e77340ae9819cca59e3a959c289ece4497a8d722c1c577e3ff34ddc35ff6e3b3d4b7b7f3041b370aa65d2

data/lib/resterl/caches/cache_key_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Resterl
+  module Caches
+    class CacheKeyGenerator
+      def self.generate(url, params, headers)
+        normalized = [url, params, headers].map do |part|
+          part.is_a?(Hash) ? part.sort : part
+        end.each_with_object(+'') { |e, acc| acc << e.inspect }
+
+        Digest::SHA1.hexdigest(normalized)
+      end
+    end
+  end
+end

data/lib/resterl/client.rb

@@ -97,8 +97,8 @@ module Resterl
       end
     end
 
-    def data_to_cache_key *args
-      args.hash
+    def data_to_cache_key url, params, headers
+      Caches::CacheKeyGenerator.generate(url, params, headers)
     end
 
     def get_response(request, old_response)

data/lib/resterl/version.rb

@@ -1,3 +1,3 @@
 module Resterl
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

data/lib/resterl.rb

@@ -14,6 +14,7 @@ require 'resterl/caches/redis_cache'
 require 'resterl/caches/simple_cache'
 require 'resterl/caches/rails_memcached_cache'
 require 'resterl/caches/key_prefix_decorator'
+require 'resterl/caches/cache_key_generator'
 require 'resterl/caches/nil_cache'
 
 require 'resterl/client'

data/spec/lib/resterl/caches/cache_key_generator_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe Resterl::Caches::CacheKeyGenerator do
+  it 'generates a stable digest for the same url' do
+    a = described_class.generate('http://example.com', {}, {})
+    b = described_class.generate('http://example.com', {}, {})
+
+    expect(a).to eq b
+  end
+
+  it 'generates a stable digest with the same parameters' do
+    a = described_class
+      .generate('http://example.com', { 'foo' => 'bar' }, {})
+    b = described_class
+      .generate('http://example.com', { 'foo' => 'bar' }, {})
+
+    expect(a).to eq b
+  end
+
+  it 'generates a stable digest with the same headers' do
+    a = described_class
+      .generate('http://example.com', {}, 'x-test' => '0.5')
+    b = described_class
+      .generate('http://example.com', {}, 'x-test' => '0.5')
+
+    expect(a).to eq b
+  end
+
+  it 'generates a stable digest with same url, params and headers' do
+    a = described_class
+      .generate('http://example.com', { 'xy' => 'xxx' }, 'x-test' => '0.5')
+    b = described_class
+      .generate('http://example.com', { 'xy' => 'xxx' }, 'x-test' => '0.5')
+
+    expect(a).to eq b
+  end
+
+  it 'generates different digest for different urls' do
+    a = described_class.generate('http://example.net', {}, {})
+    b = described_class.generate('http://example.com', {}, {})
+
+    expect(a).not_to eq b
+  end
+
+  it 'generates different digest with different parameters' do
+    a = described_class.generate('http://example.com', { 'blib' => 'blub' }, {})
+    b = described_class.generate('http://example.com', { 'blib' => 'oopf' }, {})
+    c = described_class.generate('http://example.com', { 'oopf' => 'blip' }, {})
+
+    expect([a, b, c].uniq.length).to eq 3
+  end
+
+  it 'generates different digest with different headers' do
+    a = described_class
+      .generate('http://example.com', {}, 'accept' => 'json')
+    b = described_class
+      .generate('http://example.com', {}, 'accept' => '*/*')
+
+    expect(a).not_to eq b
+  end
+
+  it 'generates the same digest with url parameters and headers ' \
+    'in diffrent order' do
+    a = described_class.generate(
+      'http://example.com',
+      { 'a' => 'aaa', 'b' => 'bbb' },
+      'x-aaa' => 'aaa', 'x-bbb' => 'bbb'
+    )
+    b = described_class .generate(
+      'http://example.com',
+      { 'b' => 'bbb', 'a' => 'aaa' },
+      'x-bbb' => 'bbb', 'x-aaa' => 'aaa'
+    )
+
+    expect(a).to eq b
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resterl
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Florian Dütsch
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-18 00:00:00.000000000 Z
+date: 2022-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -142,6 +142,7 @@ files:
 - lib/resterl.rb
 - lib/resterl/base_object.rb
 - lib/resterl/caches/cache_interface.rb
+- lib/resterl/caches/cache_key_generator.rb
 - lib/resterl/caches/key_prefix_decorator.rb
 - lib/resterl/caches/nil_cache.rb
 - lib/resterl/caches/rails_memcached_cache.rb
@@ -158,6 +159,7 @@ files:
 - lib/resterl/version.rb
 - resterl.gemspec
 - spec/lib/resterl/base_object_spec.rb
+- spec/lib/resterl/caches/cache_key_generator_spec.rb
 - spec/lib/resterl/client_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/Nix-wie-weg/resterl
@@ -184,5 +186,6 @@ specification_version: 4
 summary: Rudimentary HTTP client with focus on caching
 test_files:
 - spec/lib/resterl/base_object_spec.rb
+- spec/lib/resterl/caches/cache_key_generator_spec.rb
 - spec/lib/resterl/client_spec.rb
 - spec/spec_helper.rb