resterl 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e927695ca56a351455ca5ea51eab5201f4663ba3
-  data.tar.gz: 24d36643d33e40fe72f08496b27874bb8cccb1bd
+  metadata.gz: 065a5323c4a08bb01e76e6985f2d7c119633526b
+  data.tar.gz: b2d8eee11d66bdecb0c7cf82ab86ba4c48062965
 SHA512:
-  metadata.gz: d3c59e6dd212727d2c538d5fe1cc530eef15d45303c385c8f273f0df8977d1e8800022eb760aaeb399e0dc20454f5c581fecb1a327f07c77d26339d2015bad88
-  data.tar.gz: 34313e88f25883f86d235fca6c5467a0b124c3d07f4493643e1941ae7e553510ae314cfd0f36d120bc7dd3341f16b35e7084d91dded394176ddbf0083be39006
+  metadata.gz: 986afceceddfdc2fb116c3a4fdc7c2d0653b80c66bf52487d472f4ce12f2b0b943a7485eb7675f98ab9bcd60390067268bbdda00aa60b621012880a0a0f449d4
+  data.tar.gz: 19ea49a89a3022dc99ad064b83c4a9ac3501c9d5000ea34fbb159919ac8c84250f296cff78ea9db116360d3d8e6302cb6a8ada33fa58d19db2fcb56164aa1fb8

data/lib/resterl/client.rb

@@ -66,38 +66,33 @@ module Resterl
     private
 
     def new_get_request url, cache_key, params, headers, old_response
-      # Ggf. ETag und Last-Modified auslesen
-      if old_response
-        etag = old_response.net_http_response['ETag']
-        headers['If-None-Match'] = etag if etag
-
-        last_modified = old_response.net_http_response['Last-Modified']
-        headers['If-Modified-Since'] = last_modified if last_modified
-      end
+      apply_conditional_headers(headers, old_response)
 
       # Anfrage stellen, ggf. ETag mit übergeben
       request = Resterl::GetRequest.new(self, url, params, headers)
       new_response = request.perform.response
 
-      response, max_age_seconds = case new_response
-                                  when Net::HTTPClientError,
-                                       Net::HTTPServerError
-                                    # Aus dem Cache muss nichts entfernt werden,
-                                    # weil ja auch kein Eintrag (mehr) drin ist.
-                                    new_response.error!
-                                  when Net::HTTPNotModified
-                                    # Wenn "304 Not Modified", dann altes
-                                    # Ergebnis als neues Ergebnis verwenden
-                                    r_temp = Resterl::Response.new(new_response)
-                                    old_response.update_expires_at(
-                                      r_temp.expires_at)
-                                    [old_response, r_temp.expires_at - Time.now]
-                                  when Net::HTTPSuccess
-                                    r = Resterl::Response.new(new_response)
-                                    [r, r.expires_at - Time.now]
-                                  else
-                                    raise 'unknown response'
-                                  end
+      response, max_age_seconds =
+        case new_response
+        when Net::HTTPClientError,
+             Net::HTTPServerError
+          # Aus dem Cache muss nichts entfernt werden,
+          # weil ja auch kein Eintrag (mehr) drin ist.
+          new_response.error!
+        when Net::HTTPNotModified
+          # Wenn "304 Not Modified", dann altes
+          # Ergebnis als neues Ergebnis verwenden
+          r_temp = Resterl::Response.new(new_response)
+          old_response.update_expires_at(
+            r_temp.expires_at)
+          [old_response, r_temp.expires_at - Time.now]
+        when Net::HTTPSuccess
+          r = Resterl::Response.new(new_response,
+                                    options[:minimum_cache_lifetime])
+          [r, r.expires_at - Time.now]
+        else
+          raise 'unknown response'
+        end
 
       # Cachezeit berechnen
       expiry = [
@@ -111,6 +106,16 @@ module Resterl
       response
     end
 
+    # Ggf. ETag und Last-Modified auslesen
+    def apply_conditional_headers(headers, old_response)
+      return unless old_response
+      etag = old_response.net_http_response['ETag']
+      headers['If-None-Match'] = etag if etag
+
+      last_modified = old_response.net_http_response['Last-Modified']
+      headers['If-Modified-Since'] = last_modified if last_modified
+    end
+
     def setup_url url
       if url =~ /^http/
         url

data/lib/resterl/delete_request.rb

@@ -6,7 +6,7 @@ class Resterl::DeleteRequest < Resterl::GenericRequest
     @data = data
   end
   def perform
-    http, path = get_http_object_and_query_path
+    http, path = http_object_and_query_path
     request = Net::HTTP::Delete.new path, @headers
     apply_basic_auth request
     self.response = http.request(request)

data/lib/resterl/generic_request.rb

@@ -1,45 +1,53 @@
-class Resterl::GenericRequest
-  attr_accessor :rest_client, :url, :body, :response
-  DEFAULT_HEADERS = {}
-  
-  def initialize client, url, query_params, headers
-    @rest_client = client
-    @url = url
-    @query_params = query_params
-    @headers = DEFAULT_HEADERS.merge headers
-  end
-    
-  private
-  
-  def get_http_object_and_query_path
-    uri = URI.parse(url)
-    http = Net::HTTP.new(uri.host, uri.port)
-    apply_ssl http, uri
-    
-    path_with_query = uri.path
-    path_with_query << "?#{query_param_string}" unless query_param_string.blank?
-    
-    [http, path_with_query]
-  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('&')
+require 'active_support/core_ext/object/blank'
+
+module Resterl
+  class GenericRequest
+    attr_accessor :rest_client, :url, :body, :response
+    DEFAULT_HEADERS = {}
+
+    def initialize client, url, query_params, headers
+      @rest_client = client
+      @url = url
+      @query_params = query_params
+      @headers = DEFAULT_HEADERS.merge headers
     end
-  end
-  def apply_basic_auth request
-    ba = rest_client.options[:basic_auth]
-    request.basic_auth(ba[:username], ba[:password]) if ba
-  end
-  def apply_ssl http, uri
-    if uri.is_a? URI::HTTPS
+
+    private
+
+    def http_object_and_query_path
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      apply_ssl http, uri
+
+      path_with_query = uri.path
+      unless query_param_string.blank?
+        path_with_query << "?#{query_param_string}"
+      end
+
+      [http, path_with_query]
+    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
+    end
+
+    def apply_basic_auth request
+      ba = rest_client.options[:basic_auth]
+      request.basic_auth(ba[:username], ba[:password]) if ba
+    end
+
+    def apply_ssl http, uri
+      return unless uri.is_a? URI::HTTPS
       http.use_ssl = true
       http.verify_mode = rest_client.options[:ssl_verify_mode]
     end
+
+    def redirect_url
+      response['location'] || response.body.match(/<a href=\"([^>]+)\">/i)[1]
+    end
   end
-  def redirect_url
-    response['location'] || response.body.match(/<a href=\"([^>]+)\">/i)[1]
-  end  
 end

data/lib/resterl/get_request.rb

@@ -11,7 +11,7 @@ class Resterl::GetRequest < Resterl::GenericRequest
   def perform
     raise TooManyRedirects if redirect_limit < 0
 
-    http, path = get_http_object_and_query_path
+    http, path = http_object_and_query_path
     request = Net::HTTP::Get.new path, @headers
     apply_basic_auth request
     self.response = http.request(request)

data/lib/resterl/post_request.rb

@@ -4,7 +4,7 @@ class Resterl::PostRequest < Resterl::GenericRequest
     @data = data
   end
   def perform
-    http, path = get_http_object_and_query_path
+    http, path = http_object_and_query_path
     request = Net::HTTP::Post.new path, @headers
     apply_basic_auth request
     request.body = @data

data/lib/resterl/put_request.rb

@@ -6,7 +6,7 @@ class Resterl::PutRequest < Resterl::GenericRequest
     @data = data
   end
   def perform
-    http, path = get_http_object_and_query_path
+    http, path = http_object_and_query_path
     request = Net::HTTP::Put.new path, @headers
     apply_basic_auth request
     request.body = @data

data/lib/resterl/response.rb

@@ -1,33 +1,36 @@
-class Resterl::Response
-  attr_reader :body, :expires_at, :net_http_response
+module Resterl
+  class Response
+    attr_reader :body, :expires_at, :net_http_response
 
-  def initialize(r)
-    @net_http_response = r
-    @body = r.body
-    #@expires_in = extract_max_age
-    @expires_at = Time.now + extract_max_age
-  end
+    def initialize(r, minimum_cache_lifetime)
+      @net_http_response = r
+      @body = r.body
+      @expires_at = Time.now + [extract_max_age, minimum_cache_lifetime].max
+    end
 
-  def expired?
-    @expires_at < Time.now
-  end
+    def expired?
+      @expires_at < Time.now
+    end
 
-  def update_expires_at t
-    @expires_at = t
-  end
+    # rubocop:disable Style/TrivialAccessors
+    def update_expires_at t
+      @expires_at = t
+    end
+    # rubocop:enable Style/TrivialAccessors
 
-  def header h
-    @net_http_response[h]
-  end
+    def header h
+      @net_http_response[h]
+    end
 
-  def expires_in
-    extract_max_age
-  end
+    def expires_in
+      extract_max_age
+    end
+
+    private
 
-  private
-  
-  def extract_max_age
-    cc = @net_http_response['Cache-Control']
-    cc.is_a?(String) ? cc[/max-age=(\d+)/, 1].to_i : 0
+    def extract_max_age
+      cc = @net_http_response['Cache-Control']
+      cc.is_a?(String) ? cc[/max-age=(\d+)/, 1].to_i : 0
+    end
   end
 end

data/lib/resterl/version.rb

@@ -1,3 +1,3 @@
 module Resterl
-  VERSION = '0.0.14'
+  VERSION = '0.0.15'
 end

data/resterl.gemspec

@@ -15,8 +15,11 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{|f|File.basename(f)}
   #s.require_paths = ["lib"]
 
+  s.add_runtime_dependency 'activesupport', '>= 2.3.18'
   s.add_runtime_dependency 'hashie', '~> 0.4.0'
   s.add_runtime_dependency 'yajl-ruby', '~> 1.1'
-  s.add_development_dependency 'shoulda'
+  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 'pry'
 end
-

data/spec/lib/resterl/client.rb

@@ -0,0 +1,36 @@
+require_relative '../../spec_helper'
+
+require 'webmock/rspec'
+require 'timecop'
+
+describe Resterl::Client do
+
+  describe 'minimum cache lifetime' do
+
+    before do
+      Timecop.freeze(Time.parse('2015-01-01 01:00'))
+
+      stub_request(:get, 'http://www.example.com/').to_return(
+        status: 200,
+        body: 'hello world',
+        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/', {}, {}
+      expect(response.expires_at).to eq Time.parse('2015-01-01 01:05')
+    end
+
+    it 'uses the caches' do
+      client.get 'http://www.example.com/', {}, {}
+
+      Timecop.freeze(Time.parse('2015-01-01 01:00:10'))
+
+      expect do
+        client.get 'http://www.example.com/', {}, {}
+      end.not_to raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require_relative '../lib/resterl'
+require 'pry'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: resterl
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - Florian Dütsch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-21 00:00:00.000000000 Z
+date: 2015-02-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.18
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.18
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +53,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: shoulda
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.20.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.20.4
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -83,8 +139,8 @@ files:
 - lib/resterl/response.rb
 - lib/resterl/version.rb
 - resterl.gemspec
-- test/helper.rb
-- test/test_resterl.rb
+- spec/lib/resterl/client.rb
+- spec/spec_helper.rb
 homepage: http://github.com/Nix-wie-weg/resterl
 licenses: []
 metadata: {}
@@ -109,6 +165,6 @@ signing_key:
 specification_version: 4
 summary: Rudimentary HTTP client with focus on caching
 test_files:
-- test/helper.rb
-- test/test_resterl.rb
+- spec/lib/resterl/client.rb
+- spec/spec_helper.rb
 has_rdoc: 

data/test/helper.rb

@@ -1,10 +0,0 @@
-require 'rubygems'
-require 'test/unit'
-require 'shoulda'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'resterl'
-
-class Test::Unit::TestCase
-end

data/test/test_resterl.rb

@@ -1,57 +0,0 @@
-require 'helper'
-
-class TestResterl < Test::Unit::TestCase
-
-  should 'load successfully' do
-    dummy = nil
-    cache = Resterl::Caches::KeyPrefixDecorator.new(
-      Resterl::Caches::RailsMemcachedCache.new(dummy),
-      'prefix_'
-    )
-
-
-    ODIN_CLIENT = Resterl::Client.new(
-      :base_uri => 'http://www.google.com/',
-      :cache => cache
-    )
-  end
-
-  context 'BaseObject' do
-    should 'provide class level inheritable attributes' do
-
-      assert_nil Resterl::BaseObject.resterl_client
-      assert_nil Resterl::BaseObject.complete_mime_type
-
-      assert_nothing_raised do
-        class Test < Resterl::BaseObject
-          self.resterl_client = nil
-          self.complete_mime_type = 'text/plain'
-        end
-      end
-
-    end
-
-    should 'work with deeper nestings (cattr_inheritable)' do
-
-      assert_nothing_raised do
-
-        class Test::BaseObject < Resterl::BaseObject
-          self.mime_type = :json
-          self.resterl_client = 1
-        end
-
-        class Test::T1 < Test::BaseObject
-
-        end
-
-        
-        Test::T1.complete_mime_type
-        Test::T1.resterl_client
-
-      end
-
-    end
-    
-  end
-
-end