glebtv-httpclient 3.2.7 → 3.2.8

data/lib/httpclient/lru_cache.rb

@@ -4,58 +4,61 @@
 # (MIT Licensed). Thanks!
 
 require "lru_redux"
+require 'thread'
 
-# Not thread-safe!
 class HTTPClient
   class LRUCache
 
     attr_reader :max_size, :ttl, :soft_ttl, :retry_delay
 
     def initialize(opts={})
+      @mutex = Mutex.new
+
       @max_size = Integer(opts[:max_size] || 100)
       @ttl = Float(opts[:ttl] || 0)
       @soft_ttl = Float(opts[:soft_ttl] || 0)
       @retry_delay = Float(opts[:retry_delay] || 0)
+
       raise "max_size must not be negative" if @max_size < 0
       raise "ttl must not be negative" if @ttl < 0
       raise "soft_ttl must not be negative" if @soft_ttl < 0
       raise "retry_delay must not be negative" if @retry_delay < 0
 
+      # we don't use thread safe variant, as we're doing thread safety ourselves
       @data = LruRedux::Cache.new(@max_size)
     end
 
-    def store(key, value)
-      expiration = Time.now + @ttl
-      soft_expiration = Time.now + @soft_ttl
-      @data[key] = Datum.new(value, expiration, soft_expiration)
-      value
-    end
-
-    alias :[]= :store
-
     def fetch(key)
-      datum = @data[key]
-      if datum.nil?
-        store(key, value = yield)
-      elsif datum.expired?
-        @data.delete(key)
-        store(key, value = yield)
-      elsif datum.soft_expired?
-        begin
+      # for now, this means that DNS resolving is single-threaded
+      @mutex.synchronize do
+        datum = @data[key]
+        if datum.nil?
           store(key, value = yield)
-        rescue RuntimeError => e
-          datum.soft_expiration = (Time.now + retry_delay) if retry_delay > 0
+        elsif datum.expired?
+          @data.delete(key)
+          store(key, value = yield)
+        elsif datum.soft_expired?
+          begin
+            store(key, value = yield)
+          rescue RuntimeError => e
+            datum.soft_expiration = (Time.now + retry_delay) if retry_delay > 0
+            datum.value
+          end
+        else
           datum.value
         end
-      else
-        datum.value
       end
     end
 
-    alias :[] :fetch
-
     private
 
+    def store(key, value)
+      expiration = Time.now + @ttl
+      soft_expiration = Time.now + @soft_ttl
+      @data[key] = Datum.new(value, expiration, soft_expiration)
+      value
+    end
+
     class Datum
       attr_reader :value, :expiration, :soft_expiration
       attr_writer :soft_expiration

data/lib/httpclient/ssl_config.rb

@@ -123,9 +123,9 @@ class HTTPClient
     #            use client_key=.
     #
     # Calling this method resets all existing sessions.
-    def set_client_cert_file(cert_file, key_file)
+    def set_client_cert_file(cert_file, key_file, pass = nil)
       @client_cert = X509::Certificate.new(File.open(cert_file) { |f| f.read })
-      @client_key = PKey::RSA.new(File.open(key_file) { |f| f.read })
+      @client_key = PKey::RSA.new(File.open(key_file) { |f| f.read }, pass)
       change_notify
     end
 
@@ -392,6 +392,7 @@ class HTTPClient
 
     def change_notify
       @client.reset_all
+      nil
     end
 
     def load_cacerts(cert_store)

data/lib/httpclient/version.rb

@@ -1,3 +1,4 @@
 class HTTPClient
-  VERSION = '3.2.7' unless defined?(VERSION)
+  VERSION = '3.2.8' unless defined?(VERSION)
 end
+

data/spec/basic_spec.rb

@@ -9,7 +9,7 @@ describe HTTPClient do
   describe 'GET' do
     it 'performs normal GET' do
       HTTPClient.new.get(@srv.u('servlet')) do |s|
-        s.should eq 'get'
+        expect(s).to eq 'get'
       end
     end
     
@@ -21,13 +21,13 @@ describe HTTPClient do
       it 'writes to file' do
         file = Tempfile.new('httpcl')
         HTTPClient.new.download_file(@srv.u('largebody'), file.path)
-        file.read.length.should eq 1_000_000
+        expect(file.read.length).to eq 1_000_000
       end
 
       it 'compressed' do
         file = Tempfile.new('httpcl')
         @client.download_file(@srv.u('compressed?enc=gzip'), file.path)
-        file.read.length.should eq 25
+        expect(file.read.length).to eq 25
       end
 
       it 'compressed transparent' do
@@ -36,13 +36,13 @@ describe HTTPClient do
         file = Tempfile.new('httpcl')
         @client.download_file(@srv.u('compressed?enc=gzip'), file.path)
         cnt = file.read
-        cnt.length.should eq 5
-        cnt.should eq 'hello'
+        expect(cnt.length).to eq 5
+        expect(cnt).to eq 'hello'
 
         @client.download_file(@srv.u('compressed?enc=deflate'), file.path)
         cnt = file.read
-        cnt.length.should eq 5
-        cnt.should eq 'hello'
+        expect(cnt.length).to eq 5
+        expect(cnt).to eq 'hello'
       end
 
       it 'compressed large' do
@@ -50,25 +50,25 @@ describe HTTPClient do
         @client.transparent_gzip_decompression = true
 
         content = @client.download_file(@srv.u('compressed_large?enc=gzip'), file.path)
-        file.read.should eq LARGE_STR
+        expect(file.read).to eq LARGE_STR
 
         content = @client.download_file(@srv.u('compressed_large?enc=deflate'), file.path)
-        file.read.should eq LARGE_STR
+        expect(file.read).to eq LARGE_STR
       end
     end
 
     describe '#get_content' do
       it 'normal' do
-        @client.get_content(@srv.u('hello')).should eq 'hello'
-        @client.get_content(@srv.u('redirect1')).should eq 'hello'
-        @client.get_content(@srv.u('redirect2')).should eq 'hello'
+        expect(@client.get_content(@srv.u('hello'))).to eq 'hello'
+        expect(@client.get_content(@srv.u('redirect1'))).to eq 'hello'
+        expect(@client.get_content(@srv.u('redirect2'))).to eq 'hello'
       end
 
       it '127.0.0.1' do
         url = @srv.u.sub(/localhost/, '127.0.0.1')
-        @client.get_content(url + 'hello').should eq 'hello'
-        @client.get_content(url + 'redirect1').should eq 'hello'
-        @client.get_content(url + 'redirect2').should eq 'hello'
+        expect(@client.get_content(url + 'hello')).to eq 'hello'
+        expect(@client.get_content(url + 'redirect1')).to eq 'hello'
+        expect(@client.get_content(url + 'redirect2')).to eq 'hello'
       end
 
       it 'redirect callback' do
@@ -79,8 +79,8 @@ describe HTTPClient do
           newuri
         }
 
-        @client.get_content(@srv.u('relative_redirect')).should eq 'hello'
-        called.should be_true
+        expect(@client.get_content(@srv.u('relative_redirect'))).to eq 'hello'
+        expect(called).to be_truthy
       end
 
       it 'errors' do
@@ -95,13 +95,13 @@ describe HTTPClient do
 
       it 'with block' do
         @client.get_content(@srv.u 'hello') do |str|
-          str.should eq 'hello' 
+          expect(str).to eq 'hello' 
         end
         @client.get_content(@srv.u + 'redirect1') do |str|
-          str.should eq 'hello' 
+          expect(str).to eq 'hello' 
         end
         @client.get_content(@srv.u + 'redirect2') do |str|
-          str.should eq 'hello' 
+          expect(str).to eq 'hello' 
         end
       end
 
@@ -109,25 +109,25 @@ describe HTTPClient do
         @client.transparent_gzip_decompression = false
 
         content = @client.get_content(@srv.u 'compressed?enc=gzip')
-        content.should_not eq 'hello'
-        content.should eq GZIP_CONTENT
+        expect(content).not_to eq 'hello'
+        expect(content).to eq GZIP_CONTENT
         @client.transparent_gzip_decompression = true
 
         content = @client.get_content(@srv.u 'compressed?enc=gzip')
-        content.should eq 'hello'
+        expect(content).to eq 'hello'
 
         content = @client.get_content(@srv.u 'compressed?enc=deflate')
-        content.should eq 'hello'
+        expect(content).to eq 'hello'
       end
 
       it 'compressed large' do
         @client.transparent_gzip_decompression = true
 
         content = @client.get_content(@srv.u 'compressed_large?enc=gzip')
-        content.should eq LARGE_STR
+        expect(content).to eq LARGE_STR
 
         content = @client.get_content(@srv.u 'compressed_large?enc=deflate')
-        content.should eq LARGE_STR
+        expect(content).to eq LARGE_STR
       end
     end
   end
@@ -135,13 +135,13 @@ describe HTTPClient do
     describe 'get with block' do
       it 'works with filter_block: true' do
         @client.request(:get, @srv.u('hello')) do |str|
-          str.should eq 'hello' 
+          expect(str).to eq 'hello' 
         end
       end
       it 'works with filter_block: false' do
         @client.request(:get, @srv.u('hello'), filter_block: false) do |req, str|
-          req.class.name.should eq 'HTTP::Message' 
-          str.should eq 'hello' 
+          expect(req.class.name).to eq 'HTTP::Message' 
+          expect(str).to eq 'hello' 
         end
       end
     end
@@ -152,8 +152,8 @@ describe HTTPClient do
       @client.debug_dev = str
       @client.get(@srv.u)
       lines = str.split(/(?:\r?\n)+/)
-      lines[0].should eq '= Request'
-      lines[4].should eq "User-Agent: HTTPClient #{HTTPClient::VERSION}"
+      expect(lines[0]).to eq '= Request'
+      expect(lines[4]).to eq "User-Agent: HTTPClient #{HTTPClient::VERSION}"
     end
 
     it 'custom' do
@@ -162,8 +162,8 @@ describe HTTPClient do
       client.debug_dev = str
       client.get(@srv.u)
       lines = str.split(/(?:\r?\n)+/)
-      lines[0].should eq '= Request'
-      lines[4].should eq 'User-Agent: agent_name_foo'
+      expect(lines[0]).to eq '= Request'
+      expect(lines[4]).to eq 'User-Agent: agent_name_foo'
     end
   end
 
@@ -173,62 +173,62 @@ describe HTTPClient do
       @client.debug_dev = str = ''
       @client.test_loopback_http_response << "hello\nworld\n"
       res = @client.get(@srv.u 'hello')
-      res.http_version.should eq '0.9' 
-      res.status.should be_nil 
-      res.reason.should be_nil 
-      res.content.should eq "hello\nworld\n" 
+      expect(res.http_version).to eq '0.9' 
+      expect(res.status).to be_nil 
+      expect(res.reason).to be_nil 
+      expect(res.content).to eq "hello\nworld\n" 
       lines = str.split(/(?:\r?\n)+/)
-      lines[0].should eq "= Request" 
-      lines[2].should eq "! CONNECTION ESTABLISHED" 
-      lines[3].should eq "GET /hello HTTP/0.9" 
-      lines[7].should eq "Connection: close" 
-      lines[8].should eq "= Response" 
-      lines[9].should match /^hello$/ 
-      lines[10].should match /^world$/ 
+      expect(lines[0]).to eq "= Request" 
+      expect(lines[2]).to eq "! CONNECTION ESTABLISHED" 
+      expect(lines[3]).to eq "GET /hello HTTP/0.9" 
+      expect(lines[7]).to eq "Connection: close" 
+      expect(lines[8]).to eq "= Response" 
+      expect(lines[9]).to match /^hello$/ 
+      expect(lines[10]).to match /^world$/ 
     end
 
     it '1.0' do
-      @client.protocol_version.should be_nil 
+      expect(@client.protocol_version).to be_nil 
       @client.protocol_version = 'HTTP/1.0'
-      @client.protocol_version.should eq 'HTTP/1.0' 
+      expect(@client.protocol_version).to eq 'HTTP/1.0' 
       str = ""
       @client.debug_dev = str
       @client.get(@srv.u 'hello')
       lines = str.split(/(?:\r?\n)+/)
-      lines[0].should eq "= Request"
-      lines[2].should eq "! CONNECTION ESTABLISHED"
-      lines[3].should eq "GET /hello HTTP/1.0"
-      lines[7].should eq "Connection: close"
-      lines[8].should eq "= Response"
+      expect(lines[0]).to eq "= Request"
+      expect(lines[2]).to eq "! CONNECTION ESTABLISHED"
+      expect(lines[3]).to eq "GET /hello HTTP/1.0"
+      expect(lines[7]).to eq "Connection: close"
+      expect(lines[8]).to eq "= Response"
     end
 
     it '1.1' do
-      @client.protocol_version.should be_nil 
+      expect(@client.protocol_version).to be_nil 
       str = ""
       @client.debug_dev = str
       @client.get(@srv.u)
       lines = str.split(/(?:\r?\n)+/)
-      lines[0].should eq "= Request" 
-      lines[2].should eq "! CONNECTION ESTABLISHED" 
-      lines[3].should eq "GET / HTTP/1.1" 
-      lines[7].should eq "Host: localhost:#{@srv.port}" 
+      expect(lines[0]).to eq "= Request" 
+      expect(lines[2]).to eq "! CONNECTION ESTABLISHED" 
+      expect(lines[3]).to eq "GET / HTTP/1.1" 
+      expect(lines[7]).to eq "Host: localhost:#{@srv.port}" 
       @client.protocol_version = 'HTTP/1.1'
-      @client.protocol_version.should eq 'HTTP/1.1' 
+      expect(@client.protocol_version).to eq 'HTTP/1.1' 
       str = ""
       @client.debug_dev = str
       @client.get(@srv.u)
       lines = str.split(/(?:\r?\n)+/)
-      lines[0].should eq "= Request" 
-      lines[2].should eq "! CONNECTION ESTABLISHED" 
-      lines[3].should eq "GET / HTTP/1.1" 
+      expect(lines[0]).to eq "= Request" 
+      expect(lines[2]).to eq "! CONNECTION ESTABLISHED" 
+      expect(lines[3]).to eq "GET / HTTP/1.1" 
       @client.protocol_version = 'HTTP/1.0'
       str = ""
       @client.debug_dev = str
       @client.get(@srv.u)
       lines = str.split(/(?:\r?\n)+/)
-      lines[0].should eq "= Request" 
-      lines[2].should eq "! CONNECTION ESTABLISHED" 
-      lines[3].should eq "GET / HTTP/1.0" 
+      expect(lines[0]).to eq "= Request" 
+      expect(lines[2]).to eq "! CONNECTION ESTABLISHED" 
+      expect(lines[3]).to eq "GET / HTTP/1.0" 
     end
   end
 
@@ -238,7 +238,7 @@ describe HTTPClient do
       @client.debug_dev = str
       @client.get(@srv.u)
       lines = str.split(/(?:\r?\n)+/)
-      lines[5].should eq "Accept: */*" 
+      expect(lines[5]).to eq "Accept: */*" 
     end
 
     it 'sets properly' do
@@ -246,9 +246,9 @@ describe HTTPClient do
       @client.debug_dev = str
       @client.get(@srv.u, :header => {:Accept => 'text/html'})
       lines = str.split(/(?:\r?\n)+/)
-      lines[4].should eq "Accept: text/html" 
+      expect(lines[4]).to eq "Accept: text/html" 
       lines.each do |line|
-        line.should_not eq "Accept: */*" 
+        expect(line).not_to eq "Accept: */*" 
       end
     end
   end
@@ -256,9 +256,9 @@ describe HTTPClient do
   describe 'POST' do
     describe '#post_content' do
       it 'works' do
-        @client.post_content(@srv.u('hello')).should eq 'hello'
-        @client.post_content(@srv.u("redirect1")).should eq 'hello'
-        @client.post_content(@srv.u("redirect2")).should eq 'hello'
+        expect(@client.post_content(@srv.u('hello'))).to eq 'hello'
+        expect(@client.post_content(@srv.u("redirect1"))).to eq 'hello'
+        expect(@client.post_content(@srv.u("redirect2"))).to eq 'hello'
       end
     end
 
@@ -269,8 +269,8 @@ describe HTTPClient do
         called = true
         newuri
       }
-      @client.post_content(@srv.u("relative_redirect")).should eq 'hello'
-      called.should be_true
+      expect(@client.post_content(@srv.u("relative_redirect"))).to eq 'hello'
+      expect(called).to be_truthy
     end
 
     it 'errors' do
@@ -287,40 +287,40 @@ describe HTTPClient do
     describe 'string io' do
       it do
         post_body = StringIO.new("1234567890")
-        @client.post_content(@srv.u("servlet"), post_body).should eq 'post,1234567890'
+        expect(@client.post_content(@srv.u("servlet"), post_body)).to eq 'post,1234567890'
 
         # all browsers use GET for 302
         post_body = StringIO.new("1234567890")
-        @client.post_content(@srv.u("servlet_413"), post_body).should eq '1234567890' 
+        expect(@client.post_content(@srv.u("servlet_413"), post_body)).to eq '1234567890' 
 
-        @client.get_content(@srv.u("servlet_redirect_413")).should eq ''
+        expect(@client.get_content(@srv.u("servlet_redirect_413"))).to eq ''
 
         post_body = StringIO.new("1234567890")
-        @client.post_content(@srv.u("servlet_redirect_413"), post_body).should eq ''
+        expect(@client.post_content(@srv.u("servlet_redirect_413"), post_body)).to eq ''
 
         post_body = StringIO.new("1234567890")
-        @client.post_content(@srv.u("servlet_temporary_redirect"), post_body).should eq 'post,1234567890'
+        expect(@client.post_content(@srv.u("servlet_temporary_redirect"), post_body)).to eq 'post,1234567890'
 
         post_body = StringIO.new("1234567890")
-        @client.post_content(@srv.u("servlet_see_other"), post_body).should eq 'get'
+        expect(@client.post_content(@srv.u("servlet_see_other"), post_body)).to eq 'get'
       end
 
       it 'doesnt rewind' do
         post_body = StringIO.new("1234567890")
         post_body.read(5)
-        @client.post_content(@srv.u("servlet_temporary_redirect"), post_body).should eq 'post,67890' 
+        expect(@client.post_content(@srv.u("servlet_temporary_redirect"), post_body)).to eq 'post,67890' 
       end
     end
   end
 
   describe 'util' do
     it '#urify' do
-      urify(nil).should be_nil
+      expect(urify(nil)).to be_nil
       uri = 'http://foo'
       # urify(uri).class.name.should eq 'HTTPClient::Util::AddressableURI'
-      urify(uri).should eq urify(uri)
-      urify(uri).to_s.should eq uri
-      urify(urify(uri)).should eq urify(uri)
+      expect(urify(uri)).to eq urify(uri)
+      expect(urify(uri).to_s).to eq uri
+      expect(urify(urify(uri))).to eq urify(uri)
     end
   end
 end