ethon 0.4.2 → 0.4.3

data/lib/ethon/{easies → easy}/callbacks.rb

@@ -1,5 +1,5 @@
 module Ethon
-  module Easies
+  class Easy
 
     # This module contains all the logic around the callbacks,
     # which are needed to interact with libcurl.

data/lib/ethon/{easies → easy}/form.rb

@@ -1,15 +1,15 @@
-require 'ethon/easies/util'
-require 'ethon/easies/queryable'
+require 'ethon/easy/util'
+require 'ethon/easy/queryable'
 
 module Ethon
-  module Easies
+  class Easy
 
     # This class represents a form and is used to send a payload in the
     # request body via POST/PUT.
     # It handles multipart forms, too.
     class Form
-      include Ethon::Easies::Util
-      include Ethon::Easies::Queryable
+      include Ethon::Easy::Util
+      include Ethon::Easy::Queryable
 
       # Return a new Form.
       #
@@ -92,7 +92,7 @@ module Ethon
                        :form_option, :copyname, :pointer, name,
                        :form_option, :namelength, :long, name.bytesize,
                        :form_option, :copycontents, :pointer, content,
-                       :form_option, :contentslength, :long, content.bytesize,
+                       :form_option, :contentslength, :long, content ? content.bytesize : 0,
                        :form_option, :end
                       )
         end

data/lib/ethon/{easies → easy}/header.rb

@@ -1,5 +1,5 @@
 module Ethon
-  module Easies
+  class Easy
 
     # This module contains the logic around adding headers to libcurl.
     module Header

data/lib/ethon/{easies → easy}/http.rb

@@ -1,14 +1,14 @@
-require 'ethon/easies/http/actionable'
-require 'ethon/easies/http/post'
-require 'ethon/easies/http/get'
-require 'ethon/easies/http/head'
-require 'ethon/easies/http/put'
-require 'ethon/easies/http/delete'
-require 'ethon/easies/http/patch'
-require 'ethon/easies/http/options'
+require 'ethon/easy/http/actionable'
+require 'ethon/easy/http/post'
+require 'ethon/easy/http/get'
+require 'ethon/easy/http/head'
+require 'ethon/easy/http/put'
+require 'ethon/easy/http/delete'
+require 'ethon/easy/http/patch'
+require 'ethon/easy/http/options'
 
 module Ethon
-  module Easies
+  class Easy
 
     # This module contains logic about making valid http requests.
     module Http
@@ -21,6 +21,12 @@ module Ethon
       # @param [ String ] url The url.
       # @param [ String ] action_name The http action name.
       # @param [ Hash ] options The options hash.
+      #
+      # @option options :params [ Hash ] Params hash which
+      #   is attached to the url.
+      # @option options :body [ Hash ] Body hash which
+      #   becomes the request body. It is a PUT body for
+      #   PUT requests and a POST from for everything else.
       def http_request(url, action_name, options = {})
         fabricate(action_name).new(url, options).setup(self)
       end
@@ -36,7 +42,7 @@ module Ethon
       #
       # @return [ Class ] The action class.
       def fabricate(action_name)
-        Ethon::Easies::Http.const_get(action_name.to_s.capitalize)
+        Ethon::Easy::Http.const_get(action_name.to_s.capitalize)
       end
     end
   end

data/lib/ethon/{easies → easy}/http/actionable.rb

@@ -1,8 +1,8 @@
-require 'ethon/easies/http/putable'
-require 'ethon/easies/http/postable'
+require 'ethon/easy/http/putable'
+require 'ethon/easy/http/postable'
 
 module Ethon
-  module Easies
+  class Easy
     module Http
       # This module represents a Http Action and is a factory
       # for more real actions like GET, HEAD, POST and PUT.

data/lib/ethon/{easies → easy}/http/delete.rb

@@ -1,11 +1,11 @@
 module Ethon
-  module Easies
+  class Easy
     module Http
 
       # This class knows everything about making DELETE requests.
       class Delete
-        include Ethon::Easies::Http::Actionable
-        include Ethon::Easies::Http::Postable
+        include Ethon::Easy::Http::Actionable
+        include Ethon::Easy::Http::Postable
 
         # Setup easy to make a DELETE request.
         #

data/lib/ethon/{easies → easy}/http/get.rb

@@ -1,11 +1,11 @@
 module Ethon
-  module Easies
+  class Easy
     module Http
 
       # This class knows everything about making GET requests.
       class Get
-        include Ethon::Easies::Http::Actionable
-        include Ethon::Easies::Http::Postable
+        include Ethon::Easy::Http::Actionable
+        include Ethon::Easy::Http::Postable
 
         # Setup easy to make a GET request.
         #

data/lib/ethon/{easies → easy}/http/head.rb

@@ -1,11 +1,11 @@
 module Ethon
-  module Easies
+  class Easy
     module Http
 
       # This class knows everything about making HEAD requests.
       class Head
-        include Ethon::Easies::Http::Actionable
-        include Ethon::Easies::Http::Postable
+        include Ethon::Easy::Http::Actionable
+        include Ethon::Easy::Http::Postable
 
         # Setup easy to make a HEAD request.
         #

data/lib/ethon/{easies → easy}/http/options.rb

@@ -1,11 +1,11 @@
 module Ethon
-  module Easies
+  class Easy
     module Http
 
       # This class knows everything about making OPTIONS requests.
       class Options
-        include Ethon::Easies::Http::Actionable
-        include Ethon::Easies::Http::Postable
+        include Ethon::Easy::Http::Actionable
+        include Ethon::Easy::Http::Postable
 
         # Setup easy to make a OPTIONS request.
         #

data/lib/ethon/{easies → easy}/http/patch.rb

@@ -1,11 +1,11 @@
 module Ethon
-  module Easies
+  class Easy
     module Http
 
       # This class knows everything about making PATCH requests.
       class Patch
-        include Ethon::Easies::Http::Actionable
-        include Ethon::Easies::Http::Postable
+        include Ethon::Easy::Http::Actionable
+        include Ethon::Easy::Http::Postable
 
         # Setup easy to make a PATCH request.
         #

data/lib/ethon/{easies → easy}/http/post.rb

@@ -1,10 +1,10 @@
 module Ethon
-  module Easies
+  class Easy
     module Http
       # This class knows everything about making POST requests.
       class Post
-        include Ethon::Easies::Http::Actionable
-        include Ethon::Easies::Http::Postable
+        include Ethon::Easy::Http::Actionable
+        include Ethon::Easy::Http::Postable
 
         # Setup easy to make a POST request.
         #

data/lib/ethon/{easies → easy}/http/postable.rb

@@ -1,5 +1,5 @@
 module Ethon
-  module Easies
+  class Easy
     module Http
 
       # This module contains logic for setting up a [multipart] POST body.

data/lib/ethon/{easies → easy}/http/put.rb

@@ -1,11 +1,11 @@
 module Ethon
-  module Easies
+  class Easy
     module Http
 
       # This class knows everything about making PUT requests.
       class Put
-        include Ethon::Easies::Http::Actionable
-        include Ethon::Easies::Http::Putable
+        include Ethon::Easy::Http::Actionable
+        include Ethon::Easy::Http::Putable
 
         # Setup easy to make a PUT request.
         #

data/lib/ethon/{easies → easy}/http/putable.rb

@@ -1,5 +1,5 @@
 module Ethon
-  module Easies
+  class Easy
     module Http
 
       # This module contains logic about setting up a PUT body.

data/lib/ethon/{easies → easy}/informations.rb

@@ -1,5 +1,5 @@
 module Ethon
-  module Easies
+  class Easy
 
     # This module contains the methods to return informations
     # from the easy handle. See http://curl.haxx.se/libcurl/c/curl_easy_getinfo.html

data/lib/ethon/{easies → easy}/operations.rb

@@ -1,9 +1,19 @@
 module Ethon
-  module Easies
+  class Easy
     # This module contains the logic to prepare and perform
     # an easy.
     module Operations
 
+      # Returns a pointer to the curl easy handle.
+      #
+      # @example Return the handle.
+      #   easy.handle
+      #
+      # @return [ FFI::Pointer ] A pointer to the curl easy handle.
+      def handle
+        @handle ||= Curl.easy_init
+      end
+
       # Perform the easy request.
       #
       # @example Perform the request.

data/lib/ethon/{easies → easy}/options.rb

@@ -1,5 +1,5 @@
 module Ethon
-  module Easies
+  class Easy
 
     # This module contains the logic and knowledge about the
     # available options on easy.
@@ -9,11 +9,11 @@ module Ethon
       def self.included(base)
         base.extend ClassMethods
         base.const_set(:AVAILABLE_OPTIONS, [
-          :dns_cache_timeout, :httppost, :put, :httpget, :nobody, :upload,
-          :customrequest, :cainfo, :capath, :connecttimeout,
+          :dns_cache_timeout, :httppost, :httpget, :nobody, :upload,
+          :customrequest, :cainfo, :capath, :connecttimeout, :connecttimeout_ms,
           :forbid_reuse, :followlocation, :httpauth, :infilesize, :interface,
           :maxredirs, :nosignal, :postfieldsize, :copypostfields, :proxy,
-          :proxyauth, :proxyport, :proxytype, :timeout, :readdata, :sslcert,
+          :proxyauth, :proxyport, :proxytype, :timeout, :timeout_ms, :readdata, :sslcert,
           :ssl_verifypeer, :ssl_verifyhost, :sslcerttype, :sslkey, :sslkeytype,
           :sslversion, :url, :useragent, :userpwd, :verbose, :readfunction
         ])
@@ -63,8 +63,8 @@ module Ethon
         # @return [ Array ] The int options.
         def int_options
           [
-            :connecttimeout, :dns_cache_timeout, :infilesize, :maxredirs,
-            :postfieldsize, :proxyport, :ssl_verifyhost, :timeout
+            :connecttimeout, :connecttimeout_ms, :dns_cache_timeout, :infilesize, :maxredirs,
+            :postfieldsize, :proxyport, :ssl_verifyhost, :timeout, :timeout_ms
           ]
         end
       end

data/lib/ethon/{easies → easy}/params.rb

@@ -1,13 +1,13 @@
-require 'ethon/easies/util'
-require 'ethon/easies/queryable'
+require 'ethon/easy/util'
+require 'ethon/easy/queryable'
 
 module Ethon
-  module Easies
+  class Easy
 
     # This class represents http request parameters.
     class Params
-      include Ethon::Easies::Util
-      include Ethon::Easies::Queryable
+      include Ethon::Easy::Util
+      include Ethon::Easy::Queryable
 
       # Create a new Params.
       #

data/lib/ethon/{easies → easy}/queryable.rb

@@ -1,5 +1,5 @@
 module Ethon
-  module Easies
+  class Easy
 
     # This module contains logic about building
     # query parameters for url or form.

data/lib/ethon/{easies → easy}/response_callbacks.rb

@@ -1,5 +1,5 @@
 module Ethon
-  module Easies
+  class Easy
 
     # This module contains the logic for the response callbacks.
     # The on_complete callback is the only one at the moment.

data/lib/ethon/{easies → easy}/util.rb

@@ -1,5 +1,5 @@
 module Ethon
-  module Easies # :nodoc:
+  class Easy # :nodoc:
 
     # This module contains small helpers.
     module Util

data/lib/ethon/multi.rb

@@ -1,12 +1,14 @@
-require 'ethon/multies/stack'
-require 'ethon/multies/operations'
+require 'ethon/multi/stack'
+require 'ethon/multi/operations'
+require 'ethon/multi/options'
 
 module Ethon
 
   # This class represents libcurl multi.
   class Multi
-    include Ethon::Multies::Stack
-    include Ethon::Multies::Operations
+    include Ethon::Multi::Stack
+    include Ethon::Multi::Operations
+    include Ethon::Multi::Options
 
     class << self
 
@@ -27,21 +29,30 @@ module Ethon
     # it didn't happen before.
     #
     # @return [ Multi ] The new multi.
-    def initialize
+    def initialize(options = {})
       Curl.init
       ObjectSpace.define_finalizer(self, self.class.finalizer(self))
+      set_attributes(options)
       init_vars
     end
 
-    # Return the multi handle. Inititialize multi handle,
-    # in case it didn't happened already.
+    # Set given options.
     #
-    # @example Return multi handle.
-    #   multi.handle
+    # @example Set options.
+    #   multi.set_attributes(options)
     #
-    # @return [ ::FFI::Pointer ] The multi handle.
-    def handle
-      @handle ||= Curl.multi_init
+    # @param [ Hash ] options The options.
+    #
+    # @raise InvalidOption
+    #
+    # @see initialize
+    def set_attributes(options)
+      options.each_pair do |key, value|
+        unless respond_to?("#{key}=")
+          raise Errors::InvalidOption.new(key)
+        end
+        method("#{key}=").call(value)
+      end
     end
   end
 end

data/lib/ethon/{multies → multi}/operations.rb

@@ -1,9 +1,20 @@
 module Ethon
-  module Multies # :nodoc
+  class Multi # :nodoc
 
     # This module contains logic to run a multi.
     module Operations
 
+      # Return the multi handle. Inititialize multi handle,
+      # in case it didn't happened already.
+      #
+      # @example Return multi handle.
+      #   multi.handle
+      #
+      # @return [ ::FFI::Pointer ] The multi handle.
+      def handle
+        @handle ||= Curl.multi_init
+      end
+
       # Initialize variables.
       #
       # @example Initialize variables.
@@ -32,6 +43,7 @@ module Ethon
       # @example Perform multi.
       #   multi.perform
       def perform
+        set_options
         Ethon.logger.debug("ETHON: started MULTI") if Ethon.logger
         while ongoing?
           run

data/lib/ethon/multi/options.rb

@@ -0,0 +1,86 @@
+module Ethon
+  class Multi
+
+    # This module contains the logic and knowledge about the
+    # available options on multi.
+    module Options
+
+      # :nodoc:
+      def self.included(base)
+        base.extend ClassMethods
+        base.const_set(:AVAILABLE_OPTIONS, [
+          :socketfunction, :socketdata, :pipelining,
+          :timerfunction, :timerdata, :maxconnects
+        ])
+        base.send(:attr_accessor, *Ethon::Multi::AVAILABLE_OPTIONS)
+      end
+
+      module ClassMethods # :nodoc:
+
+        # Return the available options.
+        #
+        # @example Return the available options.
+        #   multi.available_options
+        #
+        # @return [ Array ]  The available options.
+        def available_options
+          Ethon::Multi::AVAILABLE_OPTIONS
+        end
+
+        # Return the options which need to set as 0 or 1 for multi.
+        #
+        # @example Return the bool options.
+        #   multi.bool_options
+        #
+        # @return [ Array ] The bool options.
+        def bool_options
+          [
+            :pipelining
+          ]
+        end
+
+        # Return the options which need to set as an integer for multi.
+        #
+        # @example Return the int options.
+        #   multi.int_options
+        #
+        # @return [ Array ] The int options.
+        def int_options
+          [
+            :maxconnects
+          ]
+        end
+      end
+
+      # Set specified options on multi handle.
+      #
+      # @example Set options.
+      #   multi.set_options
+      def set_options
+        self.class.available_options.each do |option|
+          Curl.set_option(option, value_for(option), handle, :multi)
+        end
+      end
+
+      # Return the value to set to multi handle. It is converted with the help
+      # of bool_options, enum_options and int_options.
+      #
+      # @example Return casted the value.
+      #   multi.value_for(:verbose)
+      #
+      # @return [ Object ] The casted value.
+      def value_for(option)
+        value = method(option).call
+        return nil if value.nil?
+
+        if self.class.bool_options.include?(option)
+          value ? 1 : 0
+        elsif self.class.int_options.include?(option)
+          value.to_i
+        else
+          value
+        end
+      end
+    end
+  end
+end