ethon 0.3.0 → 0.4.0

data/lib/ethon/easies/form.rb

@@ -1,4 +1,5 @@
 require 'ethon/easies/util'
+require 'ethon/easies/queryable'
 
 module Ethon
   module Easies
@@ -8,7 +9,7 @@ module Ethon
     # It handles multipart forms, too.
     class Form
       include Ethon::Easies::Util
-      attr_accessor :escape
+      include Ethon::Easies::Queryable
 
       # Return a new Form.
       #
@@ -61,38 +62,7 @@ module Ethon
       #
       # @return [ Boolean ] True if form is multipart, else false.
       def multipart?
-        query_pairs.any?{|pair| pair.last.is_a?(Array)}
-      end
-
-      # Return the query pairs.
-      #
-      # @example Return the query pairs.
-      #   form.query_pairs
-      #
-      # @return [ Array ] The query pairs.
-      def query_pairs
-        @query_pairs ||= build_query_pairs(@params)
-      end
-
-      # Return the string representation of the form. This makes only
-      # sense when the form is not multipart.
-      #
-      # @example Return string representation.
-      #   form.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 wether there are elements in the form or not.
-      #
-      # @example Return if form is empty.
-      #   form.empty?
-      #
-      # @return [ Boolean ] True if form is empty, else false.
-      def empty?
-        @params.empty?
+        query_pairs.any?{|pair| pair.respond_to?(:last) && pair.last.is_a?(Array)}
       end
 
       # Add form elements to libcurl.

data/lib/ethon/easies/operations.rb

@@ -13,6 +13,7 @@ module Ethon
       def perform
         @return_code = Curl.easy_perform(handle)
         complete
+        Ethon.logger.debug("ETHON: performed #{self.log_inspect}") if Ethon.logger
         @return_code
       end
 

data/lib/ethon/easies/params.rb

@@ -1,4 +1,5 @@
 require 'ethon/easies/util'
+require 'ethon/easies/queryable'
 
 module Ethon
   module Easies
@@ -6,7 +7,7 @@ module Ethon
     # This class represents http request parameters.
     class Params
       include Ethon::Easies::Util
-      attr_accessor :escape
+      include Ethon::Easies::Queryable
 
       # Create a new Params.
       #
@@ -19,36 +20,6 @@ module Ethon
       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(@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/queryable.rb

@@ -0,0 +1,100 @@
+module Ethon
+  module Easies
+
+    # This module contains logic about building
+    # query parameters for url or form.
+    module Queryable
+
+      # :nodoc:
+      def self.included(base)
+        base.send(:attr_accessor, :escape)
+      end
+
+      # Return wether there are elements in the form or not.
+      #
+      # @example Return if form is empty.
+      #   form.empty?
+      #
+      # @return [ Boolean ] True if form is empty, else false.
+      def empty?
+        @params.empty?
+      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|
+          return pair if pair.is_a?(String)
+
+          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(@params)
+      end
+
+      # 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)
+        return [hash] if hash.is_a?(String)
+
+        pairs = []
+        recursive = Proc.new do |h, prefix|
+          h.each_pair do |k,v|
+            key = prefix == '' ? k : "#{prefix}[#{k}]"
+            case v
+            when Hash
+              recursive.call(v, key)
+            when Array
+              v.each { |x| pairs << [key, x]  }
+            when File, Tempfile
+              pairs << [Util.escape_zero_byte(key), file_info(v)]
+            else
+              pairs << [Util.escape_zero_byte(key), Util.escape_zero_byte(v)]
+            end
+          end
+        end
+        recursive.call(hash, '')
+        pairs
+      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)
+        [
+          filename,
+          types.empty? ? 'application/octet-stream' : types[0].to_s,
+          File.expand_path(file.path)
+        ]
+      end
+    end
+  end
+end

data/lib/ethon/easies/util.rb

@@ -4,54 +4,6 @@ module Ethon
     # This module contains small helpers.
     module Util
 
-      # 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|
-            key = prefix == '' ? k : "#{prefix}[#{k}]"
-            case v
-            when Hash
-              recursive.call(v, key)
-            when Array
-              v.each { |x| pairs << [key, x]  }
-            when File, Tempfile
-              pairs << [Util.escape_zero_byte(key), file_info(v)]
-            else
-              pairs << [Util.escape_zero_byte(key), Util.escape_zero_byte(v)]
-            end
-          end
-        end
-        recursive.call(hash, '')
-        pairs
-      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)
-        [
-          filename,
-          types.empty? ? 'application/octet-stream' : types[0].to_s,
-          File.expand_path(file.path)
-        ]
-      end
-
       # Escapes zero bytes in strings.
       #
       # @example Escape zero bytes.
@@ -62,10 +14,12 @@ module Ethon
       #
       # @return [ String, Object ] Escaped String if
       #   zero byte found, original object if not.
-      def self.escape_zero_byte(value)
+      def escape_zero_byte(value)
         return value unless value.to_s.include?(0.chr)
         value.to_s.gsub(0.chr, '\\\0')
       end
+
+      extend self
     end
   end
 end

data/lib/ethon/easy.rb

@@ -192,14 +192,32 @@ module Ethon
     #
     # @return [ Hash ] The informations hash.
     def to_hash
-      hash = {}
-      hash[:return_code] = return_code
-      hash[:response_header] = response_header
-      hash[:response_body] = response_body
+      return @hash if defined?(@hash) && @hash
+      @hash = {
+        :return_code => return_code,
+        :response_header => response_header,
+        :response_body => response_body
+      }
       Easies::Informations::AVAILABLE_INFORMATIONS.keys.each do |info|
-        hash[info] = method(info).call
+        @hash[info] = method(info).call
       end
-      hash
+      @hash
+    end
+
+    # Return pretty log out.
+    #
+    # @example Return log out.
+    #   easy.log_inspect
+    #
+    # @return [ String ] The log out.
+    def log_inspect
+      hash = {
+        :url => url,
+        :response_code => response_code,
+        :return_code => return_code,
+        :total_time => total_time
+      }
+      "EASY #{hash.map{|k, v| "#{k}=#{v}"}.flatten.join(' ')}"
     end
   end
 end

data/lib/ethon/loggable.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+module Ethon
+
+  # Contains logging behaviour.
+  module Loggable
+
+    # Get the logger.
+    #
+    # @note Will try to grab Rails' logger first before creating a new logger
+    #   with stdout.
+    #
+    # @example Get the logger.
+    #   Loggable.logger
+    #
+    # @return [ Logger ] The logger.
+    def logger
+      return @logger if defined?(@logger)
+      @logger = rails_logger || default_logger
+    end
+
+    # Set the logger.
+    #
+    # @example Set the logger.
+    #   Loggable.logger = Logger.new($stdout)
+    #
+    # @param [ Logger ] logger The logger to set.
+    #
+    # @return [ Logger ] The new logger.
+    def logger=(logger)
+      @logger = logger
+    end
+
+    private
+
+    # Gets the default Ethon logger - stdout.
+    #
+    # @example Get the default logger.
+    #   Loggable.default_logger
+    #
+    # @return [ Logger ] The default logger.
+    def default_logger
+      logger = Logger.new($stdout)
+      logger.level = Logger::INFO
+      logger
+    end
+
+    # Get the Rails logger if it's defined.
+    #
+    # @example Get Rails' logger.
+    #   Loggable.rails_logger
+    #
+    # @return [ Logger ] The Rails logger.
+    def rails_logger
+      defined?(::Rails) && ::Rails.respond_to?(:logger) && ::Rails.logger
+    end
+  end
+  extend Loggable
+end

data/lib/ethon/multies/operations.rb

@@ -32,6 +32,7 @@ module Ethon
       # @example Perform multi.
       #   multi.perform
       def perform
+        Ethon.logger.debug("ETHON: started MULTI") if Ethon.logger
         while ongoing?
           run
           timeout = get_timeout
@@ -39,6 +40,8 @@ module Ethon
           reset_fds
           set_fds(timeout)
         end
+        Ethon.logger.debug("ETHON: performed MULTI") if Ethon.logger
+        nil
       end
 
       # Get timeout.
@@ -100,6 +103,7 @@ module Ethon
           easy.return_code = msg[:data][:code]
           delete(easy)
           easy.complete
+          Ethon.logger.debug("ETHON:         performed #{easy.log_inspect}") if Ethon.logger
         end
       end
 

data/lib/ethon/version.rb

@@ -1,5 +1,5 @@
 module Ethon
 
   # Ethon version.
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/ethon.rb

@@ -1,3 +1,4 @@
+require 'logger'
 require 'ffi'
 require 'rbconfig'
 require 'thread'
@@ -5,11 +6,11 @@ require 'mime/types'
 require 'cgi'
 require 'tempfile'
 
-require 'ethon/extensions'
 require 'ethon/curl'
 require 'ethon/errors'
 require 'ethon/easy'
 require 'ethon/multi'
+require 'ethon/loggable'
 require 'ethon/version'
 
 # Ethon is a very simple libcurl.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ethon
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-02 00:00:00.000000000 Z
+date: 2012-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -195,6 +195,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/ethon/curl.rb
+- lib/ethon/curls/auth_types.rb
+- lib/ethon/curls/classes.rb
+- lib/ethon/curls/codes.rb
+- lib/ethon/curls/constants.rb
+- lib/ethon/curls/form_options.rb
+- lib/ethon/curls/functions.rb
+- lib/ethon/curls/infos.rb
+- lib/ethon/curls/messages.rb
+- lib/ethon/curls/options.rb
+- lib/ethon/curls/proxy_types.rb
+- lib/ethon/curls/settings.rb
+- lib/ethon/curls/ssl_versions.rb
 - lib/ethon/easies/callbacks.rb
 - lib/ethon/easies/form.rb
 - lib/ethon/easies/header.rb
@@ -213,6 +225,7 @@ files:
 - lib/ethon/easies/operations.rb
 - lib/ethon/easies/options.rb
 - lib/ethon/easies/params.rb
+- lib/ethon/easies/queryable.rb
 - lib/ethon/easies/response_callbacks.rb
 - lib/ethon/easies/util.rb
 - lib/ethon/easy.rb
@@ -226,8 +239,7 @@ files:
 - lib/ethon/errors/multi_timeout.rb
 - lib/ethon/errors/select.rb
 - lib/ethon/errors.rb
-- lib/ethon/extensions/string.rb
-- lib/ethon/extensions.rb
+- lib/ethon/loggable.rb
 - lib/ethon/multi.rb
 - lib/ethon/multies/operations.rb
 - lib/ethon/multies/stack.rb
@@ -252,7 +264,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1054475577707452411
+      hash: 2336974979301889597
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/lib/ethon/extensions/string.rb

@@ -1,40 +0,0 @@
-module Ethon
-
-  # This module contains all core extensions ethon
-  # needs.
-  module Extensions
-    module String # :nodoc:
-
-      unless ''.respond_to?(:byteslice)
-        # Return part of the string.
-        #
-        # @return [ String ] Part of the string.
-        def byteslice(*args)
-          self[*args]
-        end
-      end
-
-      # Convert string to underscore. Taken from
-      # activesupport, renamed in order to no collide
-      # with it.
-      #
-      # @example Underscore.
-      #   "ClassName".underscr
-      #   #=> "class_name"
-      #
-      # @return [ String ] Underscore string.
-      def underscr
-        word = self.dup
-        word.gsub!('::', '_')
-        word.gsub!(/(?:([A-Za-z\d])|^)(#{/(?=a)b/})(?=\b|[^a-z])/) { "#{$1}#{$1 && '_'}#{$2.downcase}" }
-        word.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
-        word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
-        word.tr!("-", "_")
-        word.downcase!
-        word
-      end
-    end
-  end
-end
-
-::String.__send__(:include, Ethon::Extensions::String)

data/lib/ethon/extensions.rb

@@ -1 +0,0 @@
-require 'ethon/extensions/string.rb'