resterl 0.0.17 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: eefda67e9d4b1b634f09e64d6744a43a6733dfd4
-  data.tar.gz: 302093e3f36f08d49d1918759047255aa9c28867
+SHA256:
+  metadata.gz: e9d8e9eaf831b7bda085200459577fc210e7b91fa5fdc5491d5eec3d2e07d7dc
+  data.tar.gz: fb2ce9cd828dd55f21fb78920dbaf9da9b180d3392d60c318fd5f3f8da70d64f
 SHA512:
-  metadata.gz: 1ccf4876bf18424c64528b8a257d651b531ce92979f52ebbc9cf54e51a4372f881b5e7072accf557b56f5b0385b47c553f52d9df5ef6b07429a348639815f473
-  data.tar.gz: 654b12d576e911c072d58426edb17b37cbd97ce3626b179cebb7a837536d32c93867387e93cdaca8a6e5acefe4a1d15ce9976968bfcbfb2ff2bea1e14d3a98be
+  metadata.gz: eb6c0ad39ecfaa6246085fae41bf177e5c69b064f109031b39a34c50cb7632c12dd897d4c990b5c50f7c693e38b96b7d3d1e01d819c69be61df977bff518d681
+  data.tar.gz: c98b91ce82439eb45f1ac55c855d9da2fbf36dcf345e77340ae9819cca59e3a959c289ece4497a8d722c1c577e3ff34ddc35ff6e3b3d4b7b7f3041b370aa65d2

data/.gitignore

@@ -21,3 +21,8 @@ pkg
 ## PROJECT::SPECIFIC
 PRIVATE_TODO.rdoc
 nbproject
+
+.bundle
+Gemfile.lock
+*.gem
+pkg

data/.rubocop.yml

@@ -0,0 +1,40 @@
+AllCops:
+  TargetRubyVersion: 2.0
+  Exclude:
+    - 'vendor/bundle/**/*'
+  DisplayCopNames: true
+Rails:
+  Enabled: false
+Style/Encoding:
+  EnforcedStyle: when_needed
+  Enabled: true
+Style/AsciiComments:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Style/MethodDefParentheses:
+  Enabled: false
+Style/MultilineOperationIndentation:
+  EnforcedStyle: aligned
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+Style/MultilineMethodDefinitionBraceLayout:
+  Enabled: true
+Style/MultilineHashBraceLayout:
+  Enabled: true
+Style/SignalException:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Lint/AssignmentInCondition:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+Style/MultilineBlockChain:
+  Enabled: false
+Style/CommentAnnotation:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.7.4

data/Gemfile

@@ -1,2 +1,2 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 gemspec

data/lib/resterl/base_object.rb

@@ -1,98 +1,80 @@
 require 'hashie'
 
-# Idee: If-Match wäre bei .delete_object und .put_object ein interessantes
-#       Feature.
+module Resterl
+  class BaseObject
+    include ClassLevelInheritableAttributes
+    cattr_inheritable :resterl_client, :parser, :composer, :complete_mime_type,
+                      :mapper
+    attr_reader :response
 
-class Resterl::BaseObject #< Hashie::Mash
+    def initialize data = {}, response = nil
+      @data = Hashie::Mash.new data
+      @response = response
+    end
 
-  include ClassLevelInheritableAttributes
-  cattr_inheritable :resterl_client, :parser, :composer, :complete_mime_type,
-                    :mapper
-  attr_reader :response
+    def method_missing sym, *args, &block
+      @data.send sym, *args, &block
+    end
 
-  #self.resterl_client = nil
-  #self.complete_mime_type = 'text/plain'
+    def respond_to? sym, include_private = false
+      super || @data.respond_to?(sym, include_private)
+    end
 
-  def initialize data = {}, response = nil
-    @data = Hashie::Mash.new data
-    @response = response
-  end
+    class << self
+      def get_object url, params = {}
+        response = resterl_client.get(url, params, accept_header)
+        new_from_response(response)
+      end
 
-  def method_missing sym, *args, &block
-    # Vielleicht lassen sich auch feste Attribute delegieren, das wäre als
-    # method_missing.
-    @data.send sym, *args, &block
-  end
+      def post_to_object url, params = {}, data = {}
+        post_put_object(:post, url, params, data)
+      end
 
-  protected
+      def delete_object url
+        resterl_client.delete(url, {}, accept_header, {})
+      end
 
-  def self.get_object url, params = {}
-    headers = { 'Accept' => complete_mime_type }
-    response = resterl_client.get(url, params, headers)
-    doc = response.body
-    doc = parser.call(doc)
-    doc = mapper.map(doc) if @mapper
-    new(doc, response)
-  end
-  
-  def self.post_to_object url, params = {}, data = {}
-    # TODO: Refactoring
+      def put_object url, params = {}, data = {}
+        post_put_object(:put, url, params, data)
+      end
 
-    headers = {
-      'Accept' => complete_mime_type,
-      'Content-Type' => complete_mime_type
-    }
-    data = composer.call(data)
-    response = resterl_client.post(url, params, data, headers)
-    
-    doc = response.body
-    doc = parser.call(doc)
-    doc = mapper.map(doc) if @mapper
-    new(doc, response)
-  end
-  
-  def self.delete_object url
-    headers = {
-      'Accept' => complete_mime_type,
-    }
-    resterl_client.delete(url, {}, headers, {})
-    # TODO: Antwort parsen?
-  end
-  
-  def self.put_object url, params = {}, data
-    # TODO: Refactoring
-    
-    headers = {
-      'Accept' => complete_mime_type,
-      'Content-Type' => complete_mime_type
-    }
-    data = composer.call(data)
-    response = resterl_client.put(url, params, data, headers)
-    
-    doc = response.body
-    doc = parser.call(doc)
-    doc = mapper.map(doc) if @mapper
-    
-    # TODO: In Ordnung?
-    new(doc, response)
-  end
-  
+      def mime_type= t
+        self.parser, self.composer, self.complete_mime_type =
+          case t
+          when :json
+            [proc { |str| JSON.parse(str) },
+             proc(&:to_json),
+             'application/json'
+            ]
+          when :xml
+            [proc { |str| Hash.from_xml(str) },
+             proc(&:to_xml),
+             'application/xml'
+            ]
+          end
+      end
+
+      private
 
-  def self.mime_type= t
-    self.parser, self.composer, self.complete_mime_type = case t
-    when :json
-      # TODO prio 2: Only works when Rails is loaded?
-      [ proc {|str| JSON.parse(str)},
-        proc(&:to_json),
-        'application/json'
-      ]
-    when :xml
-      # TODO prio 2: Only works when Rails is loaded?
-      [ proc {|str| Hash.from_xml(str)},
-        proc(&:to_xml),
-        'application/xml'
-      ]
+      def post_put_object method, url, params, data
+        headers = accept_header.merge(
+          'Content-Type' => complete_mime_type
+        )
+        data = composer.call(data)
+        response = resterl_client.send(method, url, params, data, headers)
+        new_from_response response
+      end
+
+      def new_from_response response
+        doc = response.body
+        doc = parser.call(doc)
+        doc = mapper.map(doc) if @mapper
+        new(doc, response)
+      end
+
+      def accept_header
+        { 'Accept' => complete_mime_type }
+      end
     end
   end
-
 end

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.0.17'
+  VERSION = '0.1.2'.freeze
 end

data/lib/resterl.rb

@@ -2,8 +2,9 @@ require 'net/http'
 require 'net/https'
 require 'yajl/json_gem'
 ################################################################################
-module Resterl; end
-module Resterl::Caches; end
+module Resterl
+  module Caches; end
+end
 ################################################################################
 require 'resterl/class_level_inheritable_attributes'
 
@@ -13,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'
@@ -23,7 +25,3 @@ require 'resterl/put_request'
 require 'resterl/delete_request'
 require 'resterl/response'
 require 'resterl/base_object'
-
-################################################################################
-Net::HTTP.version_1_1 if RUBY_VERSION < '1.9.3'
-################################################################################

data/resterl.gemspec

@@ -1,25 +1,25 @@
 # encoding: utf-8
-$:.push File.expand_path("../lib", __FILE__)
-require "resterl/version"
-
+require File.expand_path('../lib/resterl/version', __FILE__)
 
 Gem::Specification.new do |s|
   s.name = 'resterl'
   s.version = Resterl::VERSION
-  s.authors = ["Florian Dütsch"]
-  s.email = 'florian.duetsch@nix-wie-weg.de'
-  s.homepage = 'http://github.com/Nix-wie-weg/resterl'
+  s.authors = ['Florian Dütsch', 'Stefan Hoffmann']
+  s.email = ['florian.duetsch@nix-wie-weg.de', 'stefan.hoffmann@nix-wie-weg.de']
+  s.homepage = 'https://github.com/Nix-wie-weg/resterl'
   s.summary = 'Rudimentary HTTP client with focus on caching'
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{|f|File.basename(f)}
-  #s.require_paths = ["lib"]
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.executables   = s.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+  s.required_ruby_version = '>= 2.0.0'
 
-  s.add_runtime_dependency 'activesupport', '>= 2.3.18'
-  s.add_runtime_dependency 'hashie', '~> 0.4.0'
+  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.1'
-  s.add_development_dependency 'webmock', '~> 1.20.4'
-  s.add_development_dependency 'timecop', '~> 0.7.1'
+  s.add_development_dependency 'rspec', '~> 3.7'
+  s.add_development_dependency 'webmock', '~> 3.4.1'
+  s.add_development_dependency 'timecop', '~> 0.9.1'
+  s.add_development_dependency 'rubocop', '~> 0.39.0'
   s.add_development_dependency 'pry'
 end

data/spec/lib/resterl/base_object_spec.rb

@@ -0,0 +1,23 @@
+require_relative '../../spec_helper'
+require 'active_support/core_ext/object/try'
+
+describe Resterl::BaseObject do
+  subject { described_class.new(foo: :bar) }
+
+  context '#try from ActiveSupport' do
+    it 'returns a value if the key exists' do
+      expect(subject.try(:foo)).to eq :bar
+    end
+    it 'returns nil if the key does not exist' do
+      expect(subject.try(:fox)).not_to be
+    end
+  end
+
+  it { is_expected.to respond_to(:response) }
+  it { is_expected.to respond_to(:foo) }
+  it { is_expected.not_to respond_to(:fox) }
+
+  it 'supports respond_to with private methods' do
+    expect(subject.respond_to?(:log_built_in_message, true)).to be_truthy
+  end
+end

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,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: resterl
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.1.2
 platform: ruby
 authors:
 - Florian Dütsch
-autorequire: 
+- Stefan Hoffmann
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-08-06 00:00:00.000000000 Z
+date: 2022-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,28 +17,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.18
+        version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.18
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 3.5.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 3.5.7
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -58,42 +59,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.20.4
+        version: 3.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.20.4
+        version: 3.4.1
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.39.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.39.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -108,22 +123,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
-email: florian.duetsch@nix-wie-weg.de
+description:
+email:
+- florian.duetsch@nix-wie-weg.de
+- stefan.hoffmann@nix-wie-weg.de
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".document"
 - ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
 - Gemfile
 - LICENSE
 - README.rdoc
 - Rakefile
-- TODO.rdoc
 - 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
@@ -139,12 +158,14 @@ files:
 - lib/resterl/response.rb
 - 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: http://github.com/Nix-wie-weg/resterl
+homepage: https://github.com/Nix-wie-weg/resterl
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -152,19 +173,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.2
-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
-has_rdoc: 

data/TODO.rdoc

@@ -1,7 +0,0 @@
-* Edit README.rdoc
-* Tests!
-* Use technoweenie's faraday as base (http://github.com/technoweenie/faraday)
-* Secure caching with tests
-* Store parsed objects in cache (instead of the plain response)
-* Persistent connections
-* Documentation