ethon 0.6.1 → 0.6.2

data/.travis.yml

@@ -4,8 +4,15 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - ree
   - jruby-head
   - jruby-18mode
   - jruby-19mode
   - rbx-18mode
   - rbx-19mode
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head

data/CHANGELOG.md

@@ -2,7 +2,19 @@
 
 ## Master
 
-[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.6.0...master)
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.6.2...master)
+
+## 0.6.2
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.6.1...v0.6.2)
+
+The changelog entries are coming soon!
+
+## 0.6.1
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.6.0...v0.6.1)
+
+The changelog entries are coming soon!
 
 ## 0.6.0
 

data/README.md

@@ -1,4 +1,4 @@
-#  Ethon [![Build Status](https://secure.travis-ci.org/typhoeus/ethon.png?branch=master)](http://travis-ci.org/typhoeus/ethon)
+#  Ethon [![Build Status](https://secure.travis-ci.org/typhoeus/ethon.png?branch=master)](http://travis-ci.org/typhoeus/ethon) [![Gem Version](https://badge.fury.io/rb/ethon.png)](http://badge.fury.io/rb/ethon)
 
 In Greek mythology, Ethon, the son of Typhoeus and Echidna, is a gigantic eagle. So much for the history.
 In the modern world, Ethon is a very basic libcurl wrapper using ffi.
@@ -90,3 +90,7 @@ THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 OTHER DEALINGS IN THE SOFTWARE.
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/typhoeus/ethon/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+

data/ethon.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.description  = "Very lightweight libcurl wrapper."
 
   s.required_rubygems_version = ">= 1.3.6"
-  s.rubyforge_project         = '[none]'
+  s.license = 'MIT'
 
   s.add_dependency('ffi', ['>= 1.3.0'])
   s.add_dependency('mime-types', ['~> 1.18'])

data/lib/ethon/curls/infos.rb

@@ -105,7 +105,8 @@ module Ethon
       # @return [ String ] The info.
       def get_info_string(option, handle)
         if easy_getinfo(handle, option, string_ptr) == :ok
-          string_ptr.read_pointer.read_string
+          ptr=string_ptr.read_pointer
+          ptr.null? ? nil : ptr.read_string
         end
       end
 

data/lib/ethon/curls/options.rb

@@ -10,7 +10,7 @@ module Ethon
         raise NameError, "Ethon::Curls::Options unknown type #{type}." unless respond_to?("#{type.to_s.downcase}_options")
         opthash=send("#{type.to_s.downcase}_options")
         raise Errors::InvalidOption.new(option) unless opthash.include?(option)
-        
+
         case opthash[option][:type]
         when :none
           return if value.nil?
@@ -78,7 +78,7 @@ module Ethon
 
         send("#{type}_setopt_#{func}", handle, opthash[option][:opt], value)
       end
-      
+
       OPTION_TYPE_BASE = {
         :long => 0,
         :objectpoint => 10000,
@@ -125,7 +125,7 @@ module Ethon
           elsif not opts.is_a? Hash then
             raise TypeError, "Ethon::Curls::Options #{ftype} #{name} Expected opts to be an Array or a Hash."
           end
-        
+
         when :bitmask
           if opts.is_a? Array then
             if opts.last.is_a? Hash then
@@ -151,14 +151,14 @@ module Ethon
               opts[k]=v.map { |b| opts[b] }.inject :|
             end
           end
-          
+
         when :buffer
           raise TypeError, "Ethon::Curls::Options #{ftype} #{name} Expected opts to be an Array or a Hash." unless opts.is_a? Integer
-          
+
         else
           raise ArgumentError, "Ethon::Curls::Options #{ftype} #{name} Expected no opts." unless opts.nil?
         end
-        
+
         opthash=const_get("#{ftype.to_s.upcase}_OPTIONS")
         opthash[name]={:type=>type, :opt=>OPTION_TYPE_BASE[OPTION_TYPE_MAP[type]]+num, :opts=>opts}
       end
@@ -178,12 +178,12 @@ module Ethon
           end
         >
       end
-      
+
       # Curl multi options, refer
       # Defined @ https://github.com/bagder/curl/blob/master/include/curl/multi.h
       # Documentation @ http://curl.haxx.se/libcurl/c/curl_multi_setopt.html
       option_type :multi
-      
+
       option :multi, :socketfunction, :callback, 1
       option :multi, :socketdata, :cbdata, 2
       option :multi, :pipelining, :bool, 3
@@ -280,7 +280,7 @@ module Ethon
       option :easy, :username, :string, 173
       option :easy, :password, :string, 174
       option :easy, :proxyusername, :string, 175
-      option :easy, :proxypassword, :string, 176 
+      option :easy, :proxypassword, :string, 176
       option :easy, :httpauth, :bitmask, 107, [:none, :basic, :digest, :gssnegotiate, :ntlm, :digest_ie, :ntlm_wb, {:only => 1<<31, :any => ~0x10, :anysafe => ~0x11, :auto => 0x1f}]
       option :easy, :tlsauth_type, :enum, 206, [:none, :srp]
       option :easy, :tlsauth_username, :string, 204

data/lib/ethon/easy.rb

@@ -248,6 +248,8 @@ module Ethon
       @url = nil
       @hash = nil
       @on_complete = nil
+      @on_headers = nil
+      @on_body = nil
       @procs = nil
       @mirror = nil
       Curl.easy_reset(handle)

data/lib/ethon/easy/callbacks.rb

@@ -24,6 +24,7 @@ module Ethon
         Curl.set_option(:debugfunction, debug_callback, handle)
         @response_body = ""
         @response_headers = ""
+        @headers_called = false
         @debug_info = Ethon::Easy::DebugInfo.new
       end
 
@@ -35,7 +36,13 @@ module Ethon
       # @return [ Proc ] The callback.
       def body_write_callback
         @body_write_callback ||= proc {|stream, size, num, object|
-          @response_body << stream.read_string(size * num)
+          unless @headers_called
+            @headers_called = true
+            headers
+          end
+          if :unyielded == body(chunk = stream.read_string(size * num))
+            @response_body << chunk
+          end
           size * num
         }
       end

data/lib/ethon/easy/response_callbacks.rb

@@ -22,6 +22,28 @@ module Ethon
     #   #=> []
     module ResponseCallbacks
 
+      # Set on_headers callback.
+      #
+      # @example Set on_headers.
+      #   request.on_headers { p "yay" }
+      #
+      # @param [ Block ] block The block to execute.
+      def on_headers(&block)
+        @on_headers ||= []
+        @on_headers << block if block_given?
+        @on_headers
+      end
+
+      # Execute on_headers callbacks.
+      #
+      # @example Execute on_headers.
+      #   request.headers
+      def headers
+        if defined?(@on_headers) and not @on_headers.nil?
+          @on_headers.each{ |callback| callback.call(self) }
+        end
+      end
+
       # Set on_complete callback.
       #
       # @example Set on_complete.
@@ -39,10 +61,36 @@ module Ethon
       # @example Execute on_completes.
       #   request.complete
       def complete
-        if @on_complete
+        if defined?(@on_complete) and not @on_complete.nil?
           @on_complete.each{ |callback| callback.call(self) }
         end
       end
+
+      # Set on_body callback.
+      #
+      # @example Set on_body.
+      #   request.on_body { |chunk| p "yay" }
+      #
+      # @param [ Block ] block The block to execute.
+      def on_body(&block)
+        @on_body ||= []
+        @on_body << block if block_given?
+        @on_body
+      end
+
+      # Execute on_body callbacks.
+      #
+      # @example Execute on_body.
+      #   request.body("This data came from HTTP.")
+      #
+      # @return [ Object ] If there are no on_body callbacks, returns the symbol :unyielded.
+      def body(chunk)
+        if defined?(@on_body) and not @on_body.nil?
+          @on_body.each{ |callback| callback.call(chunk, self) }
+        else
+          :unyielded
+        end
+      end
     end
   end
 end

data/lib/ethon/multi/options.rb

@@ -14,7 +14,7 @@ module Ethon
       #
       # @return [ void ]
       def maxconnects=(value)
-        Curl.set_option(:maxconnects, value_for(value, :int), handle)
+        Curl.set_option(:maxconnects, value_for(value, :int), handle, :multi)
       end
 
       # Sets pipelining option.
@@ -26,7 +26,7 @@ module Ethon
       #
       # @return [ void ]
       def pipelining=(value)
-        Curl.set_option(:pipelining, value_for(value, :bool), handle)
+        Curl.set_option(:pipelining, value_for(value, :bool), handle, :multi)
       end
 
       # Sets socketdata option.
@@ -38,7 +38,7 @@ module Ethon
       #
       # @return [ void ]
       def socketdata=(value)
-        Curl.set_option(:socketdata, value_for(value, :string), handle)
+        Curl.set_option(:socketdata, value_for(value, :string), handle, :multi)
       end
 
       # Sets socketfunction option.
@@ -50,7 +50,7 @@ module Ethon
       #
       # @return [ void ]
       def socketfunction=(value)
-        Curl.set_option(:socketfunction, value_for(value, :string), handle)
+        Curl.set_option(:socketfunction, value_for(value, :string), handle, :multi)
       end
 
       # Sets timerdata option.
@@ -62,7 +62,7 @@ module Ethon
       #
       # @return [ void ]
       def timerdata=(value)
-        Curl.set_option(:timerdata, value_for(value, :string), handle)
+        Curl.set_option(:timerdata, value_for(value, :string), handle, :multi)
       end
 
       # Sets timerfunction option.
@@ -74,7 +74,7 @@ module Ethon
       #
       # @return [ void ]
       def timerfunction=(value)
-        Curl.set_option(:timerfunction, value_for(value, :string), handle)
+        Curl.set_option(:timerfunction, value_for(value, :string), handle, :multi)
       end
 
       private

data/lib/ethon/version.rb

@@ -1,5 +1,5 @@
 module Ethon
 
   # Ethon version.
-  VERSION = '0.6.1'
+  VERSION = '0.6.2'
 end

data/spec/ethon/easy/http_spec.rb

@@ -31,6 +31,25 @@ describe Ethon::Easy::Http do
             easy.perform
             expect(easy.response_body).to include("\"REQUEST_METHOD\":\"#{action.to_s.upcase}\"")
           end
+
+          it "streams the response body from the #{action.to_s.upcase} request" do
+            bytes_read = 0
+            easy.on_body { |chunk, response| bytes_read += chunk.bytesize }
+            easy.http_request(url, action, options)
+            easy.perform
+            content_length = ((easy.response_headers =~ /Content-Length: (\d+)/) && $1.to_i)
+            expect(bytes_read).to eq(content_length)
+            expect(easy.response_body).to eq("")
+          end
+
+          it "notifies when headers are ready" do
+            headers = []
+            easy.on_headers { |r| headers << r.response_headers }
+            easy.http_request(url, action, options)
+            easy.perform
+            expect(headers).to eq([easy.response_headers])
+            expect(headers.first).to match(/Content-Length: (\d+)/)
+          end
         end
       end
 

data/spec/ethon/easy/response_callbacks_spec.rb

@@ -3,29 +3,31 @@ require 'spec_helper'
 describe Ethon::Easy::ResponseCallbacks do
   let(:easy) { Ethon::Easy.new }
 
-  describe "#on_complete" do
-    it "responds" do
-      expect(easy).to respond_to(:on_complete)
-    end
+  [:on_complete, :on_headers, :on_body].each do |callback_type|
+    describe "##{callback_type}" do
+      it "responds" do
+        expect(easy).to respond_to("#{callback_type}")
+      end
 
-    context "when no block given" do
-      it "returns @on_complete" do
-        expect(easy.on_complete).to eq([])
+      context "when no block given" do
+        it "returns @#{callback_type}" do
+          expect(easy.send("#{callback_type}")).to eq([])
+        end
       end
-    end
 
-    context "when block given" do
-      it "stores" do
-        easy.on_complete { p 1 }
-        expect(easy.instance_variable_get(:@on_complete)).to have(1).items
+      context "when block given" do
+        it "stores" do
+          easy.send(callback_type) { p 1 }
+          expect(easy.instance_variable_get("@#{callback_type}")).to have(1).items
+        end
       end
-    end
 
-    context "when multiple blocks given" do
-      it "stores" do
-        easy.on_complete { p 1 }
-        easy.on_complete { p 2 }
-        expect(easy.instance_variable_get(:@on_complete)).to have(2).items
+      context "when multiple blocks given" do
+        it "stores" do
+          easy.send(callback_type) { p 1 }
+          easy.send(callback_type) { p 2 }
+          expect(easy.instance_variable_get("@#{callback_type}")).to have(2).items
+        end
       end
     end
   end
@@ -47,4 +49,47 @@ describe Ethon::Easy::ResponseCallbacks do
       end
     end
   end
+
+  describe "#headers" do
+    before do
+      easy.on_headers {|r| String.new(r.url) }
+    end
+
+    it "executes blocks and passes self" do
+      String.should_receive(:new).with(easy.url)
+      easy.headers
+    end
+
+    context "when @on_headers nil" do
+      it "doesn't raise" do
+        easy.instance_variable_set(:@on_headers, nil)
+        expect{ easy.headers }.to_not raise_error(NoMethodError)
+      end
+    end
+  end
+
+  describe "#body" do
+    before do
+      @chunk = nil
+      @r = nil
+      easy.on_body { |chunk, r| @chunk = chunk ; @r = r }
+    end
+
+    it "executes blocks and passes self" do
+      easy.body("the chunk")
+      expect(@r).to be(easy)
+    end
+
+    it "executes blocks and passes chunk" do
+      easy.body("the chunk")
+      expect(@chunk).to eq("the chunk")
+    end
+
+    context "when @on_body nil" do
+      it "doesn't raise" do
+        easy.instance_variable_set(:@on_body, nil)
+        expect{ easy.body("the chunk") }.to_not raise_error(NoMethodError)
+      end
+    end
+  end
 end

data/spec/ethon/easy_spec.rb

@@ -82,6 +82,18 @@ describe Ethon::Easy do
       easy.reset
       expect(easy.on_complete).to be_empty
     end
+
+    it "resets on_headers" do
+      easy.on_headers { p 1 }
+      easy.reset
+      expect(easy.on_headers).to be_empty
+    end
+
+    it "resets on_body" do
+      easy.on_body { p 1 }
+      easy.reset
+      expect(easy.on_body).to be_empty
+    end
   end
 
   describe "#mirror" do

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: ethon
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
+  prerelease: 
 platform: ruby
 authors:
 - Hans Hasselberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-22 00:00:00.000000000 Z
+date: 2013-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -27,6 +30,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -146,27 +151,32 @@ files:
 - spec/support/localhost_server.rb
 - spec/support/server.rb
 homepage: https://github.com/typhoeus/ethon
-licenses: []
-metadata: {}
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1717729668424310423
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubyforge_project: ! '[none]'
-rubygems_version: 2.0.3
+rubyforge_project: 
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Libcurl wrapper.
 test_files:
 - spec/ethon/curl_spec.rb

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    N2ZhYTYzYzNiNDAwMzdkYzk5YTcxYzEyMmNkZTI1ODliMGM4ZTViZg==
-  data.tar.gz: !binary |-
-    YzYwYmM2OTAzM2UyOTQ5YjMzNTRkNTc3NDE5ZjdiMTNmMGY3MmYxZg==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    ZDJmYzExYjM4N2NkODQxMWE2YTMzNjAyNjg0MzFlMDFiZDI1ZDFiYzFlMWU2
-    ZDU5ZjM5YTNlZDk4NTJkYTMxNzYwMzgwZDY1MWFkOTA1Y2FhNDJhZmVlMzVm
-    NGMwODBlOTE0YjUyNjhjMTdiMDdmNDM2M2E5ZDQxNDdlOWMwOTc=
-  data.tar.gz: !binary |-
-    YmVkMmY3NjFkZTY0YTUzOWYyZGU2YjRlMjgwNDk4ZDkzMjk0MzI0ZTYxNWRh
-    MDU3ZDliMGQ0ZTAwYTg0YmQ0NGVjNTJmZjM2YzNmZDg0MGY3NWU3MzMzYjdi
-    YTIxMmQxMmI0OGY0N2ExYzAyOWY4YTU0YThmYWY0MWZlYmUzZWI=