RubyGems - ethon - Versions diffs - 0.0.2 → 0.0.3 - Mend

ethon 0.0.2 → 0.0.3

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 (25) hide show

data/CHANGELOG.md +19 -1
data/README.md +34 -31
data/lib/ethon/curl.rb +16 -10
data/lib/ethon/easies/callbacks.rb +4 -0
data/lib/ethon/easies/form.rb +1 -1
data/lib/ethon/easies/header.rb +1 -1
data/lib/ethon/easies/http/actionable.rb +41 -29
data/lib/ethon/easies/http/delete.rb +3 -2
data/lib/ethon/easies/http/get.rb +3 -2
data/lib/ethon/easies/http/head.rb +3 -2
data/lib/ethon/easies/http/options.rb +5 -4
data/lib/ethon/easies/http/patch.rb +4 -3
data/lib/ethon/easies/http/post.rb +8 -1
data/lib/ethon/easies/http/postable.rb +2 -0
data/lib/ethon/easies/http/put.rb +8 -1
data/lib/ethon/easies/http/putable.rb +2 -0
data/lib/ethon/easies/options.rb +7 -4
data/lib/ethon/easies/params.rb +1 -1
data/lib/ethon/easies/util.rb +27 -2
data/lib/ethon/easy.rb +77 -1
data/lib/ethon/extensions/string.rb +8 -1
data/lib/ethon/multies/operations.rb +5 -0
data/lib/ethon/multies/stack.rb +4 -0
data/lib/ethon/version.rb +1 -1
metadata +3 -3

data/CHANGELOG.md CHANGED

@@ -1,6 +1,24 @@
+# Changelog
+## 0.0.3
+[Full Changelog](http://github.com/typhoeus/ethon/compare/v0.0.2...master)
+Enhancements:
+* Documentation
+  ( [Alex P](https://github.com/ifesdjeen), [\#13](https://github.com/typhoeus/ethon/issues/13) )
+* New libcurl option dns_cache_timeout
+  ( [Chris Heald](https://github.com/cheald), [\#192](https://github.com/typhoeus/typhoeus/pull/192) )
+Bugfixes:
+* Libcurl option ssl_verifyhost takes an integer.
+* Add space between header key and value.
 ## 0.0.2
-### Resolved Issues
+Bugfixes:
 * Add libcurl.so.4 to ffi_lib in order to load correct lib on Debian.
 * Escape zero bytes.

data/README.md CHANGED

@@ -5,10 +5,6 @@ In the modern world Ethon is a very basic libcurl wrapper using ffi.
 * [Documentation](http://rubydoc.info/github/typhoeus/ethon)
-## Caution
-This is __alpha__!
 ## Installation
 With bundler:
@@ -19,43 +15,50 @@ With bundler:
 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.google.de")
+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.google.com", :follow_location => 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.google.de")
+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.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
+```
 This really handy when doing requests since you don't have to care about setting
 everything up correct.

data/lib/ethon/curl.rb CHANGED

@@ -1,5 +1,6 @@
 module Ethon
-  # :nodoc:
+  # FFI Wrapper module for Curl. Holds constants and required initializers.
   module Curl
     # :nodoc:
     def Curl.windows?
@@ -11,16 +12,17 @@ module Ethon
     # :nodoc:
     VERSION_NOW = 3
-    # :nodoc:
+    # Flag. Initialize SSL.
     GLOBAL_SSL     = 0x01
-    # :nodoc:
+    # Flag. Initialize win32 socket libraries.
     GLOBAL_WIN32   = 0x02
-    # :nodoc:
+    # Flag. Initialize everything possible.
     GLOBAL_ALL     = (GLOBAL_SSL | GLOBAL_WIN32)
-    # :nodoc:
+    # Flag. Initialize everything by default.
     GLOBAL_DEFAULT = GLOBAL_ALL
-    # :nodoc:
+    # Libcurl error codes, refer
+    # https://github.com/bagder/curl/blob/master/include/curl/curl.h for details
     EasyCode = enum :easy_code, [
       :ok,
       :unsupported_protocol,
@@ -113,7 +115,8 @@ module Ethon
       :chunk_failed,
       :last]
-    # :nodoc:
+    # Curl-Multi socket error codes, refer
+    # https://github.com/bagder/curl/blob/master/include/curl/multi.h for details
     MultiCode = enum :multi_code, [
       :call_multi_perform, -1,
       :ok,
@@ -132,7 +135,8 @@ module Ethon
       :function_point, 20000,
       :off_t,          30000]
-    # :nodoc:
+    # Curl options, refer
+    # https://github.com/bagder/curl/blob/master/src/tool_cfgable.h for details
     Option = enum :option, [
       :file,                         OptionType[:object_point]   + 1,
       :writedata,                    OptionType[:object_point]   + 1,
@@ -282,7 +286,8 @@ module Ethon
       :double, 0x300000,
       :slist,  0x400000]
-    # :nodoc:
+    # Info details, refer
+    # https://github.com/bagder/curl/blob/master/src/tool_writeout.c#L66 for details
     Info = enum :info, [
       :effective_url,           InfoType[:string] + 1,
       :response_code,           InfoType[:long]   + 2,
@@ -328,7 +333,8 @@ module Ethon
       :local_port,              InfoType[:long]   + 42,
       :last, 42]
-    # :nodoc:
+    # Form options, used by FormAdd for temporary storage, refer
+    # https://github.com/bagder/curl/blob/master/lib/formdata.h#L51 for details
     FormOption = enum :form_option, [
       :none,
       :copyname,

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

@@ -5,6 +5,10 @@ module Ethon
     # which are needed to interact with libcurl.
     module Callbacks
+      def self.included(base)
+        base.send(:attr_accessor, *[:response_body, :response_header])
+      end
       # Set writefunction and headerfunction callback.
       # They are called by libcurl in order to provide the header and
       # the body from the request.

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

@@ -71,7 +71,7 @@ module Ethon
       #
       # @return [ Array ] The query pairs.
       def query_pairs
-        @query_pairs ||= build_query_pairs_from_hash(@params)
+        @query_pairs ||= build_query_pairs(@params)
       end
       # Return the string representation of the form. This makes only

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

@@ -58,7 +58,7 @@ module Ethon
       #
       # @return [ String ] The composed header.
       def compose_header(key, value)
-        Util.escape_zero_byte("#{key}:#{value}")
+        Util.escape_zero_byte("#{key}: #{value}")
       end
     end
   end

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

@@ -8,38 +8,61 @@ module Ethon
       # for more real actions like GET, HEAD, POST and PUT.
       module Actionable
+        # Create a new action.
+        #
+        # @example Create a new action.
+        #   Action.new("www.example.com", {})
+        #
+        # @param [ String ] url The url.
+        # @param [ Hash ] options The options.
+        #
+        # @return [ Action ] A new action.
+        def initialize(url, options)
+          @url = url
+          @options = options
+        end
+        # Return the url.
+        #
+        # @example Return url.
+        #   action.url
+        #
+        # @return [ String ] The url.
         def url
           @url
         end
+        # Return the options hash.
+        #
+        # @example Return options.
+        #   action.options
+        #
+        # @return [ Hash ] The options.
         def options
           @options
         end
+        # Return the params.
+        #
+        # @example Return params.
+        #   action.params
+        #
+        # @return [ Params ] The params.
         def params
           @params ||= Params.new(options[:params])
         end
-        def form
-          @form ||= Form.new(options[:body])
-        end
-        # Create a new action.
-        #
-        # @example Create a new action.
-        #   Action.new("www.example.com", {})
+        # Return the form.
         #
-        # @param [ String ] url The url.
-        # @param [ Hash ] options The options.
+        # @example Return form.
+        #   action.form
         #
-        # @return [ Action ] A new action.
-        def initialize(url, options)
-          @url = url
-          @options = options
+        # @return [ Form ] The form.
+        def form
+          @form ||= Form.new(options[:body])
         end
-        # Setup everything what is necessary for a proper
-        # request.
+        # Setup everything necessary for a proper request.
         #
         # @example setup.
         #   action.setup(easy)
@@ -49,7 +72,6 @@ module Ethon
           set_nothing(easy) if params.empty? && form.empty?
           set_params(easy) unless params.empty?
           set_form(easy) unless form.empty?
-          set_customs(easy)
           easy.set_attributes(options)
         end
@@ -63,7 +85,7 @@ module Ethon
           easy.url = url
         end
-        # Setup request as with params.
+        # Setup request with params.
         #
         # @example Setup nothing.
         #   action.set_params(easy)
@@ -74,7 +96,7 @@ module Ethon
           easy.url = "#{url}?#{params.to_s}"
         end
-        # Setup request as with form.
+        # Setup request with form.
         #
         # @example Setup nothing.
         #   action.set_form(easy)
@@ -82,16 +104,6 @@ module Ethon
         # @param [ Easy ] easy The easy to setup.
         def set_form(easy)
         end
-        # Setup custom things eg. override the i
-        # action for delete.
-        #
-        # @example Setup custom things.
-        #   action.set_customs(easy)
-        #
-        # @param [ Easy ] easy The easy to setup.
-        def set_customs(easy)
-        end
       end
     end
   end

data/lib/ethon/easies/http/delete.rb CHANGED

@@ -7,13 +7,14 @@ module Ethon
         include Ethon::Easies::Http::Actionable
         include Ethon::Easies::Http::Postable
-        # Setup customrequest in order to make a delete.
+        # Setup easy to make a DELETE request.
         #
         # @example Setup customrequest.
         #   delete.setup(easy)
         #
         # @param [ Easy ] easy The easy to setup.
-        def set_customs(easy)
+        def setup(easy)
+          super
           easy.customrequest = "DELETE"
         end
       end

data/lib/ethon/easies/http/get.rb CHANGED

@@ -7,13 +7,14 @@ module Ethon
         include Ethon::Easies::Http::Actionable
         include Ethon::Easies::Http::Postable
-        # Setup url with escaped params and httpget.
+        # Setup easy to make a GET request.
         #
         # @example Setup.
         #   get.set_params(easy)
         #
         # @param [ Easy ] easy The easy to setup.
-        def set_customs(easy)
+        def setup(easy)
+          super
           easy.customrequest = "GET"
         end
       end

data/lib/ethon/easies/http/head.rb CHANGED

@@ -7,13 +7,14 @@ module Ethon
         include Ethon::Easies::Http::Actionable
         include Ethon::Easies::Http::Postable
-        # Setup url with escaped params and nobody.
+        # Setup easy to make a HEAD request.
         #
         # @example Setup.
         #   get.set_params(easy)
         #
         # @param [ Easy ] easy The easy to setup.
-        def set_customs(easy)
+        def setup(easy)
+          super
           easy.nobody = true
         end
       end

data/lib/ethon/easies/http/options.rb CHANGED

@@ -2,18 +2,19 @@ module Ethon
   module Easies
     module Http
-      # This class knows everything about making GET requests.
+      # This class knows everything about making OPTIONS requests.
       class Options
         include Ethon::Easies::Http::Actionable
         include Ethon::Easies::Http::Postable
-        # Setup url with escaped params and httpget.
+        # Setup easy to make a OPTIONS request.
         #
         # @example Setup.
-        #   get.set_params(easy)
+        #   options.setup(easy)
         #
         # @param [ Easy ] easy The easy to setup.
-        def set_customs(easy)
+        def setup(easy)
+          super
           easy.customrequest = "OPTIONS"
         end
       end

data/lib/ethon/easies/http/patch.rb CHANGED

@@ -7,13 +7,14 @@ module Ethon
         include Ethon::Easies::Http::Actionable
         include Ethon::Easies::Http::Postable
-        # Setup url with escaped params and httpget.
+        # Setup easy to make a PATCH request.
         #
         # @example Setup.
-        #   get.set_params(easy)
+        #   patch.setup(easy)
         #
         # @param [ Easy ] easy The easy to setup.
-        def set_customs(easy)
+        def setup(easy)
+          super
           easy.customrequest = "PATCH"
         end
       end

data/lib/ethon/easies/http/post.rb CHANGED

@@ -6,7 +6,14 @@ module Ethon
         include Ethon::Easies::Http::Actionable
         include Ethon::Easies::Http::Postable
-        def set_customs(easy)
+        # Setup easy to make a POST request.
+        #
+        # @example Setup.
+        #   post.setup(easy)
+        #
+        # @param [ Easy ] easy The easy to setup.
+        def setup(easy)
+          super
           if form.empty?
             easy.postfieldsize = 0
             easy.copypostfields = ""

data/lib/ethon/easies/http/postable.rb CHANGED

@@ -1,6 +1,8 @@
 module Ethon
   module Easies
     module Http
+      # This module contains logic for setting up a [multipart] POST body.
       module Postable
         # Set things up when form is provided.
         # Deals with multipart forms.

data/lib/ethon/easies/http/put.rb CHANGED

@@ -7,7 +7,14 @@ module Ethon
         include Ethon::Easies::Http::Actionable
         include Ethon::Easies::Http::Putable
-        def set_customs(easy)
+        # Setup easy to make a PUT request.
+        #
+        # @example Setup.
+        #   put.setup(easy)
+        #
+        # @param [ Easy ] easy The easy to setup.
+        def setup(easy)
+          super
           if form.empty?
             easy.upload = true
             easy.infilesize = 0

data/lib/ethon/easies/http/putable.rb CHANGED

@@ -1,6 +1,8 @@
 module Ethon
   module Easies
     module Http
+      # This module contains logic about setting up a PUT body.
       module Putable
         # Set things up when form is provided.
         # Deals with multipart forms.

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

@@ -9,8 +9,8 @@ module Ethon
       def self.included(base)
         base.extend ClassMethods
         base.const_set(:AVAILABLE_OPTIONS, [
-          :httppost, :put, :httpget, :nobody, :upload, :customrequest,
-          :cainfo, :capath, :connecttimeout,
+          :dns_cache_timeout, :httppost, :put, :httpget, :nobody, :upload,
+          :customrequest, :cainfo, :capath, :connecttimeout,
           :followlocation, :httpauth, :infilesize, :interface,
           :maxredirs, :nosignal, :postfieldsize, :copypostfields, :proxy,
           :proxyauth, :proxytype, :timeout, :readdata, :sslcert, :ssl_verifypeer, :ssl_verifyhost,
@@ -40,7 +40,7 @@ module Ethon
         # @return [ Array ] The bool options.
         def bool_options
           [
-            :followlocation, :nosignal, :ssl_verifypeer, :ssl_verifyhost,
+            :followlocation, :nosignal, :ssl_verifypeer,
             :verbose, :httpget, :nobody, :upload
           ]
         end
@@ -62,7 +62,10 @@ module Ethon
         #
         # @return [ Array ] The int options.
         def int_options
-          [ :connecttimeout, :infilesize, :maxredirs, :postfieldsize, :timeout ]
+          [
+            :connecttimeout, :dns_cache_timeout, :infilesize, :maxredirs,
+            :postfieldsize, :ssl_verifyhost, :timeout
+          ]
         end
       end

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

@@ -37,7 +37,7 @@ module Ethon
       #
       # @return [ Array ] The query pairs.
       def query_pairs
-        @query_pairs ||= build_query_pairs_from_hash(@params)
+        @query_pairs ||= build_query_pairs(@params)
       end
       # Return wether there are elements in the params or not.

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

@@ -4,8 +4,16 @@ module Ethon
     # This module contains small helpers.
     module Util
-      # Return query pairs from hash.
-      def build_query_pairs_from_hash(hash)
+      # Return query pairs build from a hash.
+      #
+      # @example Build query pairs.
+      #   action.build_query_pairs({:a => 1, :b => 2})
+      #   #=> [[:a, 1], [:b, 2]]
+      #
+      # @param [ Hash ] hash The hash to go through.
+      #
+      # @return [ Array ] The array of query pairs.
+      def build_query_pairs(hash)
         pairs = []
         recursive = Proc.new do |h, prefix|
           h.each_pair do |k,v|
@@ -27,6 +35,13 @@ module Ethon
       end
       # Return file info for a file.
+      #
+      # @example Return file info.
+      #   action.file_info(File.open('fubar', 'r'))
+      #
+      # @param [ File ] file The file to handle.
+      #
+      # @return [ Array ] Array of informations.
       def file_info(file)
         filename = File.basename(file.path)
         types = MIME::Types.type_for(filename)
@@ -37,6 +52,16 @@ module Ethon
         ]
       end
+      # Escapes zero bytes in strings.
+      #
+      # @example Escape zero bytes.
+      #   Util.escape_zero_byte("1\0")
+      #   #=> "1\\0"
+      #
+      # @param [ Object ] value The value to escape.
+      #
+      # @return [ String, Object ] Escaped String if
+      #   zero byte found, original object if not.
       def self.escape_zero_byte(value)
         return value unless value.to_s.include?(0.chr)
         value.to_s.gsub(0.chr, '\\\0')

data/lib/ethon/easy.rb CHANGED

@@ -22,7 +22,6 @@ module Ethon
     include Ethon::Easies::Operations
     include Ethon::Easies::ResponseCallbacks
-    attr_reader :response_body, :response_header
     attr_accessor :return_code
     class << self
@@ -49,6 +48,77 @@ module Ethon
     #
     # @param [ Hash ] options The options to set.
     #
+    # @option options :cainfo [String] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTCAINFO.
+    # @option options :capath [String] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTCAPATH.
+    # @option options :connecttimeout [Integer] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTCONNECTTIMEOUT.
+    # @option options :copypostfields [String] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTCOPYPOSTFIELDS.
+    # @option options :customrequest [String] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTCUSTOMREQUEST.
+    # @option options :dns_cache_timeout [Integer] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTDNSCACHETIMEOUT.
+    # @option options :followlocation [Boolean] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTFOLLOWLOCATION.
+    # @option options :httpauth [String] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTHTTPAUTH.
+    # @option options :httpget [Boolean] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTHTTPGET.
+    # @option options :httppost [String] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTHTTPPOST.
+    # @option options :infilesize [Integer] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTINFILESIZE.
+    # @option options :interface [String] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTINTERFACE.
+    # @option options :maxredirs [Integer] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTMAXREDIRS.
+    # @option options :nobody [Boolean] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTNOBODY.
+    # @option options :nosignal [Boolean] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTNOSIGNAL.
+    # @option options :postfieldsize [Integer] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTPOSTFIELDSIZE.
+    # @option options :proxy [String] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTPROXY.
+    # @option options :proxyauth [String] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTPROXYAUTH.
+    # @option options :proxytype [String] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTPROXYTYPE.
+    # @option options :put [String] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTPUT.
+    # @option options :readdata [String] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTREADDATA.
+    # @option options :readfunction [String] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTREADFUNCTION.
+    # @option options :ssl_verifyhost [Integer] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTSSLVERIFYHOST.
+    # @option options :ssl_verifypeer [Boolean] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTSSLVERIFYPEER.
+    # @option options :sslcert [String] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTSSLCERT.
+    # @option options :sslcerttype [String] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTSSLCERTTYPE.
+    # @option options :sslkey [String] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTSSLKEY.
+    # @option options :sslkeytype [String] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTSSLKEYTYPE.
+    # @option options :sslversion [String] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTSSLVERSION.
+    # @option options :timeout [Integer] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTTIMEOUT.
+    # @option options :upload [Boolean] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTUPLOAD.
+    # @option options :url [String] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTURL.
+    # @option options :useragent [String] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTUSERAGENT.
+    # @option options :userpwd [String] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTUSERPWD.
+    # @option options :verbose [Boolean] See
+    #  http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTVERBOSE.
+    #
     # @return [ Easy ] A new Easy.
     def initialize(options = {})
       Curl.init
@@ -62,6 +132,8 @@ module Ethon
     #   easy.set_attributes(options)
     #
     # @param [ Hash ] options The options.
+    #
+    # @see initialize
     def set_attributes(options)
       options.each_pair do |key, value|
         method("#{key}=").call(value) if respond_to?("#{key}=")
@@ -90,6 +162,10 @@ module Ethon
       @handle ||= Curl.easy_init
     end
+    # Returns the informations available through libcurl as
+    # a hash.
+    #
+    # @return [ Hash ] The informations hash.
     def to_hash
       hash = {}
       hash[:return_code] = return_code

data/lib/ethon/extensions/string.rb CHANGED

@@ -1,6 +1,13 @@
 module Ethon
+  # This module contains all core extensions ethon
+  # needs.
   module Extensions
-    module String
+    module String # :nodoc:
+      # Return part of the string.
+      #
+      # @return [ String ] Part of the string.
       def byteslice(*args)
         self[*args]
       end

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

@@ -45,6 +45,8 @@ module Ethon
       #
       # @example Get timeout.
       #   multi.get_timeout
+      #
+      # @raise [Ethon::Errors::MultiTimeout] when getting the timeout failed.
       def get_timeout
         code = Curl.multi_timeout(handle, @timeout)
         raise Errors::MultiTimeout.new(code) unless code == :ok
@@ -67,6 +69,9 @@ 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.
       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

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

@@ -20,6 +20,8 @@ module Ethon
       #   multi.add(easy)
       #
       # @param [ Easy ] easy The easy to add.
+      #
+      # @raise [Ethon::Errors::MultiAdd] when adding an easy failed.
       def add(easy)
         return nil if easy_handles.include?(easy)
         code = Curl.multi_add_handle(handle, easy.handle)
@@ -32,6 +34,8 @@ module Ethon
       # @example Delete easy from stack.
       #
       # @param [ Easy ] easy The easy to delete.
+      #
+      # @raise [Ethon::Errors::MultiRemove] when 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,5 @@
 module Ethon
   # Ethon version.
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata CHANGED

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ethon
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease:
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-06-21 00:00:00.000000000 Z
+date: 2012-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -233,7 +233,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4039343008781597148
+      hash: -1256508423117646856
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: