ethon 0.0.1

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

@@ -0,0 +1,22 @@
+module Ethon
+  module Easies
+    module Http
+
+      # This class knows everything about making HEAD requests.
+      class Head
+        include Ethon::Easies::Http::Actionable
+        include Ethon::Easies::Http::Postable
+
+        # Setup url with escaped params and nobody.
+        #
+        # @example Setup.
+        #   get.set_params(easy)
+        #
+        # @param [ Easy ] easy The easy to setup.
+        def set_customs(easy)
+          easy.nobody = true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,22 @@
+module Ethon
+  module Easies
+    module Http
+
+      # This class knows everything about making PATCH requests.
+      class Patch
+        include Ethon::Easies::Http::Actionable
+        include Ethon::Easies::Http::Postable
+
+        # Setup url with escaped params and httpget.
+        #
+        # @example Setup.
+        #   get.set_params(easy)
+        #
+        # @param [ Easy ] easy The easy to setup.
+        def set_customs(easy)
+          easy.customrequest = "PATCH"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Ethon
+  module Easies
+    module Http
+      # This class knows everything about making POST requests.
+      class Post
+        include Ethon::Easies::Http::Actionable
+        include Ethon::Easies::Http::Postable
+
+        def set_customs(easy)
+          if form.empty?
+            easy.postfieldsize = 0
+            easy.copypostfields = ""
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module Ethon
+  module Easies
+    module Http
+      module Postable
+        # Set things up when form is provided.
+        # Deals with multipart forms.
+        #
+        # @example Setup.
+        #   post.set_form(easy)
+        #
+        # @param [ Easy ] easy The easy to setup.
+        def set_form(easy)
+          easy.url ||= url
+          if form.multipart?
+            form.escape = false
+            form.materialize
+            easy.httppost = form.first.read_pointer
+          else
+            form.escape = true
+            easy.copypostfields = form.to_s
+            easy.postfieldsize = easy.copypostfields.bytesize
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Ethon
+  module Easies
+    module Http
+
+      # This class knows everything about making PUT requests.
+      class Put
+        include Ethon::Easies::Http::Actionable
+        include Ethon::Easies::Http::Putable
+
+        def set_customs(easy)
+          if form.empty?
+            easy.upload = true
+            easy.infilesize = 0
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+module Ethon
+  module Easies
+    module Http
+      module Putable
+        # Set things up when form is provided.
+        # Deals with multipart forms.
+        #
+        # @example Setup.
+        #   put.set_form(easy)
+        #
+        # @param [ Easy ] easy The easy to setup.
+        def set_form(easy)
+          easy.url ||= url
+          easy.upload = true
+          form.escape = true
+          easy.infilesize = form.to_s.bytesize
+          easy.set_read_callback(form.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/ethon/easies/informations.rb

@@ -0,0 +1,83 @@
+module Ethon
+  module Easies
+
+    # This module contains the methods to return informations
+    # from the easy handle. See http://curl.haxx.se/libcurl/c/curl_easy_getinfo.html
+    # for more information.
+    module Informations
+
+      AVAILABLE_INFORMATIONS = {
+        # Return the available http auth methods.
+        :httpauth_avail => :long,
+
+        # Return the total time in seconds for the previous
+        # transfer, including name resolving, TCP connect etc.
+        :total_time => :double,
+
+        # Return the time, in seconds, it took from the start
+        # until the first byte is received by libcurl. This
+        # includes pretransfer time and also the time the
+        # server needs to calculate the result.
+        :starttransfer_time => :double,
+
+        # Return the time, in seconds, it took from the start
+        # until the SSL/SSH connect/handshake to the remote
+        # host was completed. This time is most often very near
+        # to the pre transfer time, except for cases such as HTTP
+        # pippelining where the pretransfer time can be delayed
+        # due to waits in line for the pipeline and more.
+        :appconnect_time => :double,
+
+        # Return the time, in seconds, it took from the start
+        # until the file transfer is just about to begin. This
+        # includes all pre-transfer commands and negotiations
+        # that are specific to the particular protocol(s) involved.
+        # It does not involve the sending of the protocol-
+        # specific request that triggers a transfer.
+        :pretransfer_time => :double,
+
+        # Return the time, in seconds, it took from the start
+        # until the connect to the remote host (or proxy) was completed.
+        :connect_time => :double,
+
+        # Return the time, in seconds, it took from the
+        # start until the name resolving was completed.
+        :namelookup_time => :double,
+
+        # Return the last used effective url.
+        :effective_url => :string,
+
+        # Return the string holding the IP address of the most recent
+        # connection done with this curl handle. This string
+        # may be IPv6 if that's enabled.
+        :primary_ip => :string,
+
+        # Return the last received HTTP, FTP or SMTP response code.
+        # The value will be zero if no server response code has
+        # been received. Note that a proxy's CONNECT response should
+        # be read with http_connect_code and not this.
+        :response_code => :long,
+
+        # Return the total number of redirections that were
+        # actually followed
+        :redirect_count => :long
+      }
+
+      AVAILABLE_INFORMATIONS.each do |name, type|
+        define_method(name) do
+          Curl.method("get_info_#{type}").call(name, handle)
+        end
+      end
+
+      # Returns this curl version supports zlib.
+      #
+      # @example Return wether zlib is supported.
+      #   easy.supports_zlib?
+      #
+      # @return [ Boolean ] True if supported, else false.
+      def supports_zlib?
+        !!(Curl.version.match(/zlib/))
+      end
+    end
+  end
+end

data/lib/ethon/easies/operations.rb

@@ -0,0 +1,31 @@
+module Ethon
+  module Easies
+    # This module contains the logic to prepare and perform
+    # an easy.
+    module Operations
+
+      # Perform the easy request.
+      #
+      # @example Perform the request.
+      #   easy.perform
+      #
+      # @return [ Integer ] The return code.
+      def perform
+        @return_code = Curl.easy_perform(handle)
+        complete
+        @return_code
+      end
+
+      # Prepare the easy. Options, headers and callbacks
+      # were set.
+      #
+      # @example Prepare easy.
+      #   easy.prepare
+      def prepare
+        set_options
+        set_headers
+        set_callbacks
+      end
+    end
+  end
+end

data/lib/ethon/easies/options.rb

@@ -0,0 +1,105 @@
+module Ethon
+  module Easies
+
+    # This module contains the logic and knowledge about the
+    # available options on easy.
+    module Options
+
+      # :nodoc:
+      def self.included(base)
+        base.extend ClassMethods
+        base.const_set(:AVAILABLE_OPTIONS, [
+          :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,
+          :sslcerttype, :sslkey, :sslkeytype, :sslversion,
+          :url, :useragent, :userpwd, :verbose, :readfunction
+        ])
+        base.send(:attr_accessor, *Ethon::Easy::AVAILABLE_OPTIONS)
+      end
+
+      module ClassMethods # :nodoc:
+
+        # Return the available options.
+        #
+        # @example Return the available options.
+        #   easy.available_options
+        #
+        # @return [ Array ]  The available options.
+        def available_options
+          Ethon::Easy::AVAILABLE_OPTIONS
+        end
+
+        # Return the options which need to set as 0 or 1 for easy.
+        #
+        # @example Return the bool options.
+        #   easy.bool_options
+        #
+        # @return [ Array ] The bool options.
+        def bool_options
+          [
+            :followlocation, :nosignal, :ssl_verifypeer, :ssl_verifyhost,
+            :verbose, :httpget, :nobody, :upload
+          ]
+        end
+
+        # Return the options which are an enum for easy.
+        #
+        # @example Return the enum options.
+        #   easy.enum_options
+        #
+        # @return [ Hash ] The enum options.
+        def enum_options
+          { :httpauth => Curl::Auth }
+        end
+
+        # Return the options which need to set as an integer for easy.
+        #
+        # @example Return the int options.
+        #   easy.int_options
+        #
+        # @return [ Array ] The int options.
+        def int_options
+          [ :connecttimeout, :infilesize, :maxredirs, :postfieldsize, :timeout ]
+        end
+      end
+
+      # Set specified options on easy handle.
+      #
+      # @example Set options.
+      #   easy.set_options
+      def set_options
+        self.class.available_options.each do |option|
+          value = value_for(option)
+          next if value.nil?
+
+          Curl.set_option(option, value, handle)
+        end
+      end
+
+      # Return the value to set to easy handle. It is converted with the help
+      # of bool_options, enum_options and int_options.
+      #
+      # @example Return casted the value.
+      #   easy.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.enum_options.key?(option)
+          self.class.enum_options[option][value]
+        elsif self.class.int_options.include?(option)
+          value.to_i
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/ethon/easies/params.rb

@@ -0,0 +1,54 @@
+require 'ethon/easies/util'
+
+module Ethon
+  module Easies
+
+    # This class represents http request parameters.
+    class Params
+      include Ethon::Easies::Util
+      attr_accessor :escape
+
+      # Create a new Params.
+      #
+      # @example Create a new Params.
+      #   Params.new({})
+      #
+      # @param [ Hash ] params The params to use.
+      #
+      # @return [ Params ] A new Params.
+      def initialize(params)
+        @params = params || {}
+      end
+
+      # Return the string representation of params.
+      #
+      # @example Return string representation.
+      #   params.to_s
+      #
+      # @return [ String ] The string representation.
+      def to_s
+        query_pairs.map{|pair| pair.map{|e| escape ? CGI::escape(e.to_s) : e }.join("=")}.join('&')
+      end
+
+      # Return the query pairs.
+      #
+      # @example Return the query pairs.
+      #   params.query_pairs
+      #
+      # @return [ Array ] The query pairs.
+      def query_pairs
+        @query_pairs ||= build_query_pairs_from_hash(@params)
+      end
+
+      # Return wether there are elements in the params or not.
+      #
+      # @example Return if params is empty.
+      #   params.empty?
+      #
+      # @return [ Boolean ] True if params is empty, else false.
+      def empty?
+        @params.empty?
+      end
+    end
+  end
+end

data/lib/ethon/easies/response_callbacks.rb

@@ -0,0 +1,25 @@
+module Ethon
+  module Easies
+
+    # This module contains the logic for the response callbacks.
+    # The on_complete callback is the only one at the moment.
+    module ResponseCallbacks
+      # Execute preset complete callback.
+      #
+      # @example Execute complete callback.
+      #   easy.complete
+      def complete
+        return if !defined?(@complete) || @complete.nil?
+        @complete.call(self)
+      end
+
+      # Set complete callback.
+      #
+      # @example Set complete callback.
+      #   easy.on_complete = block
+      def on_complete(&block)
+        @complete = block
+      end
+    end
+  end
+end