ethon 0.1.0 → 0.2.0

data/CHANGELOG.md

@@ -2,7 +2,19 @@
 
 ## Master
 
-[Full Changelog](http://github.com/typhoeus/ethon/compare/v0.1.0...master)
+[Full Changelog](http://github.com/typhoeus/ethon/compare/v0.2.0...master)
+
+## 0.2.0
+
+[Full Changelog](http://github.com/typhoeus/ethon/compare/v0.1.0...v0.2.0)
+
+Enhancements:
+
+* GET requests are using custom requests only when there is a request body
+* Easy#on_complete takes multiple callbacks
+* raise Errors::GlobalInit when libcurls global_init failed instead of
+  runtime error
+* raise Errors::InvalidOption if option is invalid
 
 ## 0.1.0
 
@@ -22,6 +34,8 @@ Bugfixes:
 
 ## 0.0.2
 
+[Full Changelog](http://github.com/typhoeus/ethon/compare/v0.0.1...v0.0.2)
+
 Bugfixes:
 
 * Add libcurl.so.4 to ffi_lib in order to load correct lib on Debian.

data/README.md

@@ -9,7 +9,11 @@ In the modern world Ethon is a very basic libcurl wrapper using ffi.
 
 With bundler:
 
-    gem "ethon", :git => "https://github.com/typhoeus/ethon.git", :branch => "master"
+    gem "ethon"
+
+With rubygems:
+
+    gem install ethon
 
 ## Usage
 

data/Rakefile

@@ -28,7 +28,7 @@ end
 
 desc "Start up the test servers"
 task :start do
-  require 'spec/support/boot'
+  require_relative 'spec/support/boot'
   begin
     Boot.start_servers(:rake)
   rescue Exception

data/lib/ethon.rb

@@ -12,7 +12,11 @@ require 'ethon/easy'
 require 'ethon/multi'
 require 'ethon/version'
 
-# The toplevel namespace which includes everything
-# belonging to ethon.
+# Ethon is a very simple libcurl.
+# It provides direct access to libcurl functionality
+# as well as some helpers for doing http requests.
+#
+# Ethon was extracted from Typhoeus. If you want to
+# see how others use Ethon look at the Typhoeus code.
 module Ethon
 end

data/lib/ethon/curl.rb

@@ -490,7 +490,7 @@ module Ethon
       def init
         @@init_mutex.synchronize {
           if not @@initialized
-            raise RuntimeError.new('curl failed to initialise') if Curl.global_init(GLOBAL_ALL) != 0
+            raise Errors::GlobalInit.new if Curl.global_init(GLOBAL_ALL) != 0
             @@initialized = true
           end
         }

data/lib/ethon/easies/callbacks.rb

@@ -5,6 +5,7 @@ module Ethon
     # which are needed to interact with libcurl.
     module Callbacks
 
+      # :nodoc:
       def self.included(base)
         base.send(:attr_accessor, *[:response_body, :response_header])
       end

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

@@ -19,7 +19,7 @@ module Ethon
         # @return [ Action ] A new action.
         def initialize(url, options)
           @url = url
-          @options = options
+          @options = options.dup
         end
 
         # Return the url.
@@ -49,7 +49,7 @@ module Ethon
         #
         # @return [ Params ] The params.
         def params
-          @params ||= Params.new(options[:params])
+          @params ||= Params.new(options.delete(:params))
         end
 
         # Return the form.
@@ -59,7 +59,7 @@ module Ethon
         #
         # @return [ Form ] The form.
         def form
-          @form ||= Form.new(options[:body])
+          @form ||= Form.new(options.delete(:body))
         end
 
         # Setup everything necessary for a proper request.

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

@@ -15,7 +15,7 @@ module Ethon
         # @param [ Easy ] easy The easy to setup.
         def setup(easy)
           super
-          easy.customrequest = "GET"
+          easy.customrequest = "GET" unless form.empty?
         end
       end
     end

data/lib/ethon/easies/response_callbacks.rb

@@ -3,22 +3,45 @@ module Ethon
 
     # This module contains the logic for the response callbacks.
     # The on_complete callback is the only one at the moment.
+    #
+    # You can set multiple callbacks, which are then executed
+    # in the same order.
+    #
+    #   easy.on_complete { p 1 }
+    #   easy.on_complete { p 2 }
+    #   easy.complete
+    #   #=> 1
+    #   #=> 2
+    #
+    # You can clear the callbacks:
+    #
+    #   easy.on_complete { p 1 }
+    #   easy.on_complete { p 2 }
+    #   easy.on_complete.clear
+    #   easy.on_complete
+    #   #=> []
     module ResponseCallbacks
-      # Execute preset complete callback.
+
+      # Set on_complete callback.
       #
-      # @example Execute complete callback.
-      #   easy.complete
-      def complete
-        return if !defined?(@complete) || @complete.nil?
-        @complete.call(self)
+      # @example Set on_complete.
+      #   request.on_complete { p "yay" }
+      #
+      # @param [ Block ] block The block to execute.
+      def on_complete(&block)
+        @on_complete ||= []
+        @on_complete << block if block_given?
+        @on_complete
       end
 
-      # Set complete callback.
+      # Execute on_complete callbacks.
       #
-      # @example Set complete callback.
-      #   easy.on_complete = block
-      def on_complete(&block)
-        @complete = block
+      # @example Execute on_completes.
+      #   request.complete
+      def complete
+        if defined?(@on_complete)
+          @on_complete.map{ |callback| callback.call(self) }
+        end
       end
     end
   end

data/lib/ethon/easy.rb

@@ -13,6 +13,24 @@ module Ethon
 
   # This is the class representing the libcurl easy interface
   # See http://curl.haxx.se/libcurl/c/libcurl-easy.html for more informations.
+  #
+  # @example You can access the libcurl easy interface through this class, every request is based on it. The simplest setup looks like that:
+  #
+  #   e = Ethon::Easy.new(url: "www.example.com")
+  #   e.prepare
+  #   e.perform
+  #   #=> :ok
+  #
+  # @example You can the reuse this Easy for the next request:
+  #
+  #   e.reset # reset easy handle
+  #   e.url = "www.google.com"
+  #   e.followlocation = true
+  #   e.prepare
+  #   e.perform
+  #   #=> :ok
+  #
+  # @see initialize
   class Easy
     include Ethon::Easies::Informations
     include Ethon::Easies::Callbacks
@@ -133,10 +151,15 @@ module Ethon
     #
     # @param [ Hash ] options The options.
     #
+    # @raise InvalidOption
+    #
     # @see initialize
     def set_attributes(options)
       options.each_pair do |key, value|
-        method("#{key}=").call(value) if respond_to?("#{key}=")
+        unless respond_to?("#{key}=")
+          raise Errors::InvalidOption.new(key)
+        end
+        method("#{key}=").call(value)
       end
     end
 

data/lib/ethon/errors.rb

@@ -1,9 +1,11 @@
 require 'ethon/errors/ethon_error'
+require 'ethon/errors/global_init'
 require 'ethon/errors/multi_timeout'
 require 'ethon/errors/multi_fdset'
 require 'ethon/errors/multi_add'
 require 'ethon/errors/multi_remove'
 require 'ethon/errors/select'
+require 'ethon/errors/invalid_option'
 
 module Ethon
 

data/lib/ethon/errors/global_init.rb

@@ -0,0 +1,12 @@
+module Ethon
+  module Errors
+
+    # Raises when global_init failed.
+    class GlobalInit < EthonError
+      def initialize
+        super("An error occured initializing curl.")
+      end
+    end
+  end
+end
+

data/lib/ethon/errors/invalid_option.rb

@@ -0,0 +1,12 @@
+module Ethon
+  module Errors
+
+    # Raises when option is invalid.
+    class InvalidOption < EthonError
+      def initialize(option)
+        super("The option: #{option} is invalid.")
+      end
+    end
+  end
+end
+

data/lib/ethon/errors/multi_add.rb

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

data/lib/ethon/version.rb

@@ -1,5 +1,5 @@
 module Ethon
 
   # Ethon version.
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ethon
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-26 00:00:00.000000000 Z
+date: 2012-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -171,6 +171,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.3
 description: Very lightweight libcurl wrapper.
 email:
 - me@hans.io
@@ -201,6 +217,8 @@ files:
 - lib/ethon/easies/util.rb
 - lib/ethon/easy.rb
 - lib/ethon/errors/ethon_error.rb
+- lib/ethon/errors/global_init.rb
+- lib/ethon/errors/invalid_option.rb
 - lib/ethon/errors/multi_add.rb
 - lib/ethon/errors/multi_fdset.rb
 - lib/ethon/errors/multi_remove.rb
@@ -233,7 +251,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4546024795644378522
+      hash: -2145906903079108779
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: