resterl 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ba291d5cad21d29e786dffb4c29f6f95af7ac42a
-  data.tar.gz: 849817253c65f4c23edde761e654d7f3ad70144c
+SHA256:
+  metadata.gz: b9ade8f52c4e1a0ff6e52069668fa41a3f0e573ea8ab0016115d7fd849ca1684
+  data.tar.gz: 07722b8b4c023e328dfc4ba313f23fdef5790df4a0f168d77d1fb82cc489c8e6
 SHA512:
-  metadata.gz: a51fef712af70ca0cd8d3c47ca5ce522461d8de13d902c157b39fb434b30b1a7053ca965fc8b772c0af3d18d23f42fd39eaa177143146e8f82a87c1309d6bc36
-  data.tar.gz: 15bfd502fc79be97912caae50d42c9899b4ef5d42836b13bf7813e13555b8e6e77603abbc927cd4b5aeb478da039927ca8942442d9d720a6f3e50a4e9c561284
+  metadata.gz: 1411bfc88816e1e9e2fc551e6a119da9960a57ae2d443a39738399e4bedcd15fa21a3b59bfa825a06395a45c0602d161a3a9f45bec6f11ca19a3b66c8bfc2b37
+  data.tar.gz: 62d40715c602a4e425e6bc91b6c531c94b4b9dd45ad8a8ed1c15365a2c343549a5af2120ca4c52129a5eb8034e4b0411847986b721286b69a33ee2e6556caf61

data/.ruby-version

@@ -0,0 +1 @@
+2.7.6

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/generic_request.rb

@@ -1,4 +1,5 @@
 require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/hash'
 
 module Resterl
   class GenericRequest
@@ -29,11 +30,7 @@ module Resterl
     end
 
     def query_param_string
-      @query_param_string ||= begin
-        @query_params.collect do |key, value|
-          "#{URI.escape(key.to_s)}=#{URI.escape(value.to_s)}"
-        end.join('&')
-      end
+      @query_param_string ||= @query_params.to_query
     end
 
     def apply_basic_auth request

data/lib/resterl/version.rb

@@ -1,3 +1,3 @@
 module Resterl
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.3'.freeze
 end

data/lib/resterl.rb

@@ -1,6 +1,5 @@
 require 'net/http'
 require 'net/https'
-require 'yajl/json_gem'
 ################################################################################
 module Resterl
   module Caches; end
@@ -14,6 +13,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/resterl.gemspec

@@ -16,7 +16,6 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'activesupport', '>= 3.2.0'
   s.add_runtime_dependency 'hashie', '~> 3.5.7'
-  s.add_runtime_dependency 'yajl-ruby', '~> 1.1'
   s.add_development_dependency 'rspec', '~> 3.7'
   s.add_development_dependency 'webmock', '~> 3.4.1'
   s.add_development_dependency 'timecop', '~> 0.9.1'

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

data/spec/lib/resterl/client_spec.rb

@@ -4,6 +4,8 @@ require 'webmock/rspec'
 require 'timecop'
 
 describe Resterl::Client do
+  subject(:client) { Resterl::Client.new }
+
   describe 'minimum cache lifetime' do
     before do
       Timecop.freeze(Time.parse('2015-01-01 01:00'))
@@ -14,7 +16,6 @@ describe Resterl::Client do
         headers: { cache_control: 'max-age=0, private, must-revalidate' }
       ).then.to_raise('2 requests')
     end
-    let(:client) { Resterl::Client.new }
 
     it 'is used in "max-age=0" case' do
       response = client.get 'http://www.example.com/', {}, {}
@@ -31,4 +32,12 @@ describe Resterl::Client do
       end.not_to raise_error
     end
   end
+
+  it 'encodes url params' do
+    stub_request(
+      :get, "http://www.example.com/?text=Ein%20gro%C3%9Fer%20Spa%C3%9F!"
+    ).to_return(status: 200, body: '', headers: {})
+
+    client.get 'http://www.example.com/', { text: 'Ein großer Spaß!' }, {}
+  end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: resterl
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Florian Dütsch
 - Stefan Hoffmann
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-05-22 00:00:00.000000000 Z
+date: 2022-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -39,20 +39,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.5.7
-- !ruby/object:Gem::Dependency
-  name: yajl-ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -123,7 +109,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - florian.duetsch@nix-wie-weg.de
 - stefan.hoffmann@nix-wie-weg.de
@@ -134,6 +120,7 @@ files:
 - ".document"
 - ".gitignore"
 - ".rubocop.yml"
+- ".ruby-version"
 - Gemfile
 - LICENSE
 - README.rdoc
@@ -141,6 +128,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
@@ -157,12 +145,13 @@ 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
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -177,12 +166,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 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