RubyGems - ethon - Versions diffs - 0.5.0 → 0.5.1 - Mend

ethon 0.5.0 → 0.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (23) hide show

data/CHANGELOG.md +14 -0
data/README.md +36 -26
data/lib/ethon.rb +2 -0
data/lib/ethon/curl.rb +4 -0
data/lib/ethon/curls/auth_types.rb +1 -1
data/lib/ethon/curls/functions.rb +2 -0
data/lib/ethon/easy.rb +12 -2
data/lib/ethon/easy/callbacks.rb +2 -0
data/lib/ethon/easy/form.rb +2 -0
data/lib/ethon/easy/header.rb +2 -0
data/lib/ethon/easy/http/actionable.rb +1 -0
data/lib/ethon/easy/operations.rb +4 -0
data/lib/ethon/easy/options.rb +8 -0
data/lib/ethon/easy/params.rb +2 -0
data/lib/ethon/easy/queryable.rb +1 -1
data/lib/ethon/easy/response_callbacks.rb +2 -0
data/lib/ethon/easy/util.rb +2 -0
data/lib/ethon/errors/multi_fdset.rb +0 -1
data/lib/ethon/multi.rb +4 -0
data/lib/ethon/multi/operations.rb +26 -4
data/lib/ethon/multi/stack.rb +2 -2
data/lib/ethon/version.rb +3 -1
metadata +3 -3

data/CHANGELOG.md CHANGED

@@ -2,6 +2,15 @@
 ## Master
+## 0.5.1
+[Full Changelog](http://github.com/typhoeus/ethon/compare/v0.5.0...0.5.1)
+Bugfixes:
+* Mark Curl.select and Curl.easy_perform as blocking so that the GIL is
+  released by ffi.
 ## 0.5.0
 [Full Changelog](http://github.com/typhoeus/ethon/compare/v0.4.4...0.5.0)
@@ -11,6 +20,11 @@ Enhancements:
 * New libcurl option proxyuserpwd
 * Rename response_header to response_headers
+Bugfixes:
+* Mark Curl.select and Curl.easy_perform as blocking so that the GIL is
+  released by ffi.
 ## 0.4.4
 [Full Changelog](http://github.com/typhoeus/ethon/compare/v0.4.3...v0.4.4)

data/README.md CHANGED

@@ -21,43 +21,53 @@ With rubygems:
 Making the first request is realy simple:
-    easy = Ethon::Easy.new(:url => "www.google.de")
-    easy.prepare
-    easy.perform
-    #=> :ok
+```ruby
+easy = Ethon::Easy.new(url: "www.example.com")
+easy.prepare
+easy.perform
+#=> :ok
+```
 You have access to various options like following redirects:
-    easy = Ethon::Easy.new(:url => "www.google.com", :follow_location => true)
-    easy.prepare
-    easy.perform
-    #=> :ok
+```ruby
+easy = Ethon::Easy.new(url: "www.example.com", followlocation: true)
+easy.prepare
+easy.perform
+#=> :ok
+```
 Once you're done you can look at the response code and body:
-    easy = Ethon::Easy.new(:url => "www.google.de")
-    easy.prepare
-    easy.perform
-    easy.response_code
-    #=> 200
-    easy.response_body
-    #=> "<!doctype html><html ..."
+```ruby
+easy = Ethon::Easy.new(url: "www.example.com", followlocation: true)
+easy.prepare
+easy.perform
+easy.response_code
+#=> 200
+easy.response_body
+#=> "<!doctype html><html ..."
+```
 ## Http
 In order to make life easier there are some helpers for doing http requests:
-    easy = Ethon::Easy.new
-    easy.http_request("www.google.de", :get, { :params => {:a => 1} })
-    easy.prepare
-    easy.perform
-    #=> :ok
-    easy = Ethon::Easy.new
-    easy.http_request("www.google.de", :post, { :params => { :a => 1 }, :body => { :b => 2 } })
-    easy.prepare
-    easy.perform
-    #=> :ok
+```ruby
+easy = Ethon::Easy.new
+easy.http_request("www.example.com", :get, { params: {a: 1} })
+easy.prepare
+easy.perform
+#=> :ok
+```
+```ruby
+easy = Ethon::Easy.new
+easy.http_request("www.example.com", :post, { params: { a: 1 }, body: { b: 2 } })
+easy.prepare
+easy.perform
+#=> :ok
+```
 This really handy when doing requests since you don't have to care about setting
 everything up correct.

data/lib/ethon.rb CHANGED

@@ -18,5 +18,7 @@ require 'ethon/version'
 #
 # Ethon was extracted from Typhoeus. If you want to
 # see how others use Ethon look at the Typhoeus code.
+#
+# @see https://www.github.com/typhoeus/typhoeus Typhoeus
 module Ethon
 end

data/lib/ethon/curl.rb CHANGED

@@ -11,6 +11,8 @@ require 'ethon/curls/functions'
 module Ethon
   # FFI Wrapper module for Curl. Holds constants and required initializers.
+  #
+  # @api private
   module Curl
     extend ::FFI::Library
     extend Ethon::Curls::Codes
@@ -58,6 +60,8 @@ module Ethon
       # mean no other thread that is using libcurl. Because curl_global_init() calls
       # functions of other libraries that are similarly thread unsafe, it could conflict with
       # any other thread that uses these other libraries.
+      #
+      # @raise [ Ethon::Errors::GlobalInit ] If Curl.global_init fails.
       def init
         @@init_mutex.synchronize {
           if not @@initialized

data/lib/ethon/curls/auth_types.rb CHANGED

@@ -1,5 +1,5 @@
 module Ethon
-  module Curls
+  module Curls # :nodoc:
     # This module contain available auth types.
     module AuthTypes

data/lib/ethon/curls/functions.rb CHANGED

@@ -19,6 +19,7 @@ module Ethon
         base.attach_function :easy_setopt_fixnum,     :curl_easy_setopt,         [:pointer, :easy_option, :long],     :easy_code
         base.attach_function :easy_setopt_callback,   :curl_easy_setopt,         [:pointer, :easy_option, :callback], :easy_code
         base.attach_function :easy_setopt_proc,       :curl_easy_setopt,         [:pointer, :easy_option, :callback], :easy_code
+        base.instance_variable_set(:@blocking, true)
         base.attach_function :easy_perform,           :curl_easy_perform,        [:pointer],                     :easy_code
         base.attach_function :easy_strerror,          :curl_easy_strerror,       [:int],                         :string
         base.attach_function :easy_escape,            :curl_easy_escape,         [:pointer, :pointer, :int],     :string
@@ -46,6 +47,7 @@ module Ethon
         base.attach_function :version,                :curl_version,             [],                             :string
         base.attach_function :slist_append,           :curl_slist_append,        [:pointer, :string],            :pointer
         base.attach_function :slist_free_all,         :curl_slist_free_all,      [:pointer],                     :void
+        base.instance_variable_set(:@blocking, true)
         base.attach_function :select,                                            [:int, Curl::FDSet.ptr, Curl::FDSet.ptr, Curl::FDSet.ptr, Curl::Timeval.ptr], :int
       end
     end

data/lib/ethon/easy.rb CHANGED

@@ -201,12 +201,16 @@ module Ethon
     class << self
-      # Free libcurl representation from an easy handle.
+      # Frees libcurls easy represantation including its headers if any.
       #
       # @example Free easy handle.
       #   Easy.finalizer(easy)
       #
       # @param [ Easy ] easy The easy to free.
+      #
+      # @see http://curl.haxx.se/libcurl/c/curl_easy_cleanup.html
+      #
+      # @api private
       def finalizer(easy)
         proc {
           Curl.slist_free_all(easy.header_list) if easy.header_list
@@ -219,7 +223,7 @@ module Ethon
     # It initializes curl, if not already done and applies the provided options.
     #
     # @example Create a new Easy.
-    #   Easy.new(:url => "www.google.de")
+    #   Easy.new(url: "www.google.de")
     #
     # @param [ Hash ] options The options to set.
     #
@@ -793,6 +797,8 @@ module Ethon
     # @return [ Easy ] A new Easy.
     #
     # @see http://curl.haxx.se/libcurl/c/curl_easy_setopt.html
+    #
+    # @api public
     def initialize(options = {})
       Curl.init
       ObjectSpace.define_finalizer(self, self.class.finalizer(self))
@@ -809,6 +815,8 @@ module Ethon
     # @raise InvalidOption
     #
     # @see initialize
+    #
+    # @api private
     def set_attributes(options)
       options.each_pair do |key, value|
         unless respond_to?("#{key}=")
@@ -838,6 +846,8 @@ module Ethon
     # @param [ String ] value The value to escape.
     #
     # @return [ String ] The escaped value.
+    #
+    # @api private
     def escape(value)
       Curl.easy_escape(handle, value, 0)
     end

data/lib/ethon/easy/callbacks.rb CHANGED

@@ -3,6 +3,8 @@ module Ethon
     # This module contains all the logic around the callbacks,
     # which are needed to interact with libcurl.
+    #
+    # @api private
     module Callbacks
       # :nodoc:

data/lib/ethon/easy/form.rb CHANGED

@@ -7,6 +7,8 @@ module Ethon
     # This class represents a form and is used to send a payload in the
     # request body via POST/PUT.
     # It handles multipart forms, too.
+    #
+    # @api private
     class Form
       include Ethon::Easy::Util
       include Ethon::Easy::Queryable

data/lib/ethon/easy/header.rb CHANGED

@@ -2,6 +2,8 @@ module Ethon
   class Easy
     # This module contains the logic around adding headers to libcurl.
+    #
+    # @api private
     module Header
       # Return headers, return empty hash if none.

data/lib/ethon/easy/http/actionable.rb CHANGED

@@ -70,6 +70,7 @@ module Ethon
         # @param [ easy ] easy the easy to setup.
         def setup(easy)
           @easy = easy
+          easy.url = url
           set_nothing(easy) if params.empty? && form.empty?
           set_params(easy) unless params.empty?
           set_form(easy) unless form.empty?

data/lib/ethon/easy/operations.rb CHANGED

@@ -20,6 +20,8 @@ module Ethon
       #   easy.perform
       #
       # @return [ Integer ] The return code.
+      #
+      # @api public
       def perform
         @return_code = Curl.easy_perform(handle)
         complete
@@ -32,6 +34,8 @@ module Ethon
       #
       # @example Prepare easy.
       #   easy.prepare
+      #
+      # @api public
       def prepare
         set_options
         set_headers

data/lib/ethon/easy/options.rb CHANGED

@@ -3,6 +3,8 @@ module Ethon
     # This module contains the logic and knowledge about the
     # available options on easy.
+    #
+    # @api private
     module Options
       # :nodoc:
@@ -86,7 +88,13 @@ module Ethon
       # @example Return casted the value.
       #   easy.value_for(:verbose)
       #
+      # @param [ Symbol ] option The option to get the value from.
+      #
       # @return [ Object ] The casted value.
+      #
+      # @raise [ Ethon::Errors::InvalidValue ] If specified option
+      #   points to an enum and the value doen't correspond to
+      #   the valid values.
       def value_for(option)
         value = method(option).call
         return nil if value.nil?

data/lib/ethon/easy/params.rb CHANGED

@@ -5,6 +5,8 @@ module Ethon
   class Easy
     # This class represents http request parameters.
+    #
+    # @api private
     class Params
       include Ethon::Easy::Util
       include Ethon::Easy::Queryable

data/lib/ethon/easy/queryable.rb CHANGED

@@ -49,7 +49,7 @@ module Ethon
       # Return query pairs build from a hash.
       #
       # @example Build query pairs.
-      #   action.build_query_pairs({:a => 1, :b => 2})
+      #   action.build_query_pairs({a: 1, b: 2})
       #   #=> [[:a, 1], [:b, 2]]
       #
       # @param [ Hash ] hash The hash to go through.

data/lib/ethon/easy/response_callbacks.rb CHANGED

@@ -28,6 +28,8 @@ module Ethon
       #   request.on_complete { p "yay" }
       #
       # @param [ Block ] block The block to execute.
+      #
+      # @api public
       def on_complete(&block)
         @on_complete ||= []
         @on_complete << block if block_given?

data/lib/ethon/easy/util.rb CHANGED

@@ -2,6 +2,8 @@ module Ethon
   class Easy # :nodoc:
     # This module contains small helpers.
+    #
+    # @api private
     module Util
       # Escapes zero bytes in strings.

data/lib/ethon/errors/multi_fdset.rb CHANGED

@@ -5,7 +5,6 @@ module Ethon
     class MultiFdset < EthonError
       def initialize(code)
         super("An error occured getting the fdset: #{code}")
-        # "an error occured getting the fdset: #{code}: #{Curl.multi_strerror(code)}"
       end
     end
   end

data/lib/ethon/multi.rb CHANGED

@@ -18,6 +18,8 @@ module Ethon
       #   Multi.finalizer(multi)
       #
       # @param [ Multi ] multi The multi to free.
+      #
+      # @api private
       def finalizer(multi)
         proc {
           Curl.multi_cleanup(multi.handle)
@@ -92,6 +94,8 @@ module Ethon
     # @raise InvalidOption
     #
     # @see initialize
+    #
+    # @api private
     def set_attributes(options)
       options.each_pair do |key, value|
         unless respond_to?("#{key}=")

data/lib/ethon/multi/operations.rb CHANGED

@@ -10,7 +10,7 @@ module Ethon
       # @example Return multi handle.
       #   multi.handle
       #
-      # @return [ ::FFI::Pointer ] The multi handle.
+      # @return [ FFI::Pointer ] The multi handle.
       def handle
         @handle ||= Curl.multi_init
       end
@@ -19,6 +19,8 @@ module Ethon
       #
       # @example Initialize variables.
       #   multi.init_vars
+      #
+      # @return [ void ]
       def init_vars
         @timeout = ::FFI::MemoryPointer.new(:long)
         @timeval = Curl::Timeval.new
@@ -40,8 +42,12 @@ module Ethon
       # Perform multi.
       #
+      # @return [ nil ]
+      #
       # @example Perform multi.
       #   multi.perform
+      #
+      # @api public
       def perform
         Ethon.logger.debug("ETHON: started MULTI")
         while ongoing?
@@ -57,8 +63,12 @@ module Ethon
       # Prepare multi.
       #
+      # @return [ nil ]
+      #
       # @example Prepare multi.
       #   multi.prepare
+      #
+      # @api public
       def prepare
         set_options
       end
@@ -68,7 +78,9 @@ module Ethon
       # @example Get timeout.
       #   multi.get_timeout
       #
-      # @raise [Ethon::Errors::MultiTimeout] when getting the timeout failed.
+      # @return [ Integer ] The timeout.
+      #
+      # @raise [ Ethon::Errors::MultiTimeout ] If getting the timeout fails.
       def get_timeout
         code = Curl.multi_timeout(handle, @timeout)
         raise Errors::MultiTimeout.new(code) unless code == :ok
@@ -81,6 +93,8 @@ module Ethon
       #
       # @example Reset fds.
       #   multi.reset_fds
+      #
+      # @return [ void ]
       def reset_fds
         @fd_read.clear
         @fd_write.clear
@@ -92,8 +106,10 @@ module Ethon
       # @example Set fds.
       #   multi.set_fds
       #
-      # @raise [Ethon::Errors::MultiFdset] when setting the file descriptors failed.
-      # @raise [Ethon::Errors::Select] when select failed.
+      # @return [ void ]
+      #
+      # @raise [ Ethon::Errors::MultiFdset ] If setting the file descriptors fails.
+      # @raise [ Ethon::Errors::Select ] If select fails.
       def set_fds(timeout)
         code = Curl.multi_fdset(handle, @fd_read, @fd_write, @fd_excep, @max_fd)
         raise Errors::MultiFdset.new(code) unless code == :ok
@@ -112,6 +128,8 @@ module Ethon
       #
       # @example Check.
       #   multi.check
+      #
+      # @return [ void ]
       def check
         msgs_left = ::FFI::MemoryPointer.new(:int)
         while true
@@ -130,6 +148,8 @@ module Ethon
       #
       # @example Run
       #   multi.run
+      #
+      # @return [ void ]
       def run
         begin code = trigger end while code == :call_multi_perform
         check
@@ -139,6 +159,8 @@ module Ethon
       #
       # @example Trigger.
       #   multi.trigger
+      #
+      # @return [ Symbol ] The Curl.multi_perform return code.
       def trigger
         running_count = FFI::MemoryPointer.new(:int)
         code = Curl.multi_perform(handle, running_count)

data/lib/ethon/multi/stack.rb CHANGED

@@ -21,7 +21,7 @@ module Ethon
       #
       # @param [ Easy ] easy The easy to add.
       #
-      # @raise [Ethon::Errors::MultiAdd] when adding an easy failed.
+      # @raise [ Ethon::Errors::MultiAdd ] If adding an easy failed.
       def add(easy)
         return nil if easy_handles.include?(easy)
@@ -36,7 +36,7 @@ module Ethon
       #
       # @param [ Easy ] easy The easy to delete.
       #
-      # @raise [Ethon::Errors::MultiRemove] when removing an easy failed.
+      # @raise [ Ethon::Errors::MultiRemove ] If removing an easy failed.
       def delete(easy)
         if easy_handles.delete(easy)
           code = Curl.multi_remove_handle(handle, easy.handle)

data/lib/ethon/version.rb CHANGED

@@ -1,5 +1,7 @@
 module Ethon
   # Ethon version.
-  VERSION = '0.5.0'
+  #
+  # @api public
+  VERSION = '0.5.1'
 end

metadata CHANGED

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ethon
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
   prerelease:
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-09-25 00:00:00.000000000 Z
+date: 2012-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -121,7 +121,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3228494030236225352
+      hash: 2761547586556677808
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: