curl_ffi 0.0.2

data/lib/curl_ffi/easy.rb

@@ -0,0 +1,86 @@
+require "curl_ffi"
+
+module CurlFFI
+  class Easy
+    attr_reader :pointer
+
+    def initialize
+      @pointer = FFI::AutoPointer.new(CurlFFI.easy_init, CurlFFI.method(:easy_cleanup))
+    end
+
+    def reset
+      CurlFFI.easy_reset(@pointer)
+    end
+
+    def initialize_copy(other)
+      @pointer = FFI::AutoPointer.new(CurlFFI.easy_duphandle(other.pointer), CurlFFI.method(:easy_cleanup))
+    end
+
+    def escape(string)
+      str_pointer = CurlFFI.easy_escape(@pointer, string, string.length)
+      result = str_pointer.null? ? nil : str_pointer.read_string
+      CurlFFI.free(str_pointer)
+      result
+    end
+
+    def unescape(string)
+      int_pointer = FFI::MemoryPointer.new(:int)
+      str_pointer = CurlFFI.easy_unescape(@pointer, string, string.length, int_pointer)
+      result = str_pointer.read_string(int_pointer.read_int)
+      CurlFFI.free(str_pointer)
+      result
+    end
+
+    def error_string(error_code)
+      CurlFFI.easy_strerror(error_code)
+    end
+
+    def perform
+      check_code(CurlFFI.easy_perform(@pointer))
+    end
+
+    def setopt(option, value)
+      check_code(CurlFFI.easy_setopt(@pointer, option, value))
+    end
+
+    def getinfo(info)
+      info = INFO[info] if info.is_a?(Symbol)
+
+      if info > CurlFFI::INFO_SLIST
+        raise "Not implemented yet"
+      elsif info > CurlFFI::INFO_DOUBLE
+        getinfo_double(info)
+      elsif info > CurlFFI::INFO_LONG
+        getinfo_long(info)
+      elsif info > CurlFFI::INFO_STRING
+        getinfo_string(info)
+      end
+    end
+
+    protected
+      def check_code(result)
+        if result != :OK
+          raise "Error - #{result}"
+        end
+      end
+
+      def getinfo_double(info)
+        double_ptr = FFI::MemoryPointer.new(:double)
+        check_code(CurlFFI.easy_getinfo(@pointer, info, double_ptr))
+        double_ptr.read_double
+      end
+
+      def getinfo_string(info)
+        pointer = FFI::MemoryPointer.new(:pointer)
+        check_code(CurlFFI.easy_getinfo(@pointer, info, pointer))
+        string_ptr = pointer.read_pointer
+        string_ptr.null? ? nil : string_ptr.read_string
+      end
+
+      def getinfo_long(info)
+        long_ptr = FFI::MemoryPointer.new(:long)
+        check_code(CurlFFI.easy_getinfo(@pointer, info, long_ptr))
+        long_ptr.read_long
+      end
+  end
+end

data/lib/curl_ffi/multi.rb

@@ -0,0 +1,66 @@
+require "curl_ffi"
+
+module CurlFFI
+  class Multi
+    attr_reader :pointer, :running
+
+    def initialize
+      @pointer = FFI::AutoPointer.new(CurlFFI.multi_init, CurlFFI.method(:multi_cleanup))
+      @running = -1
+      @handles = []
+      @messages_in_queue = 0
+    end
+
+    # @todo handle return code
+    def add_handle(easy)
+      CurlFFI.multi_add_handle(@pointer, easy.pointer)
+      @handles << easy # Save the handle so it won't be gc'ed
+    end
+
+    # @todo handle return code
+    def remove_handle(easy)
+      CurlFFI.multi_remove_handle(@pointer, easy.pointer)
+      @handles.delete(easy) # Save the handle so it won't be gc'ed
+    end
+
+    def setopt(option, param)
+      CurlFFI.multi_setopt(@pointer, option, param)
+    end
+
+    def info_read_all()
+      messages = []
+      while message = info_read_next
+        messages << message
+      end
+      messages
+    end
+
+    def info_read_next()
+      int_pointer = FFI::MemoryPointer.new(:int)
+      message_pointer = CurlFFI.multi_info_read(@pointer, int_pointer)
+      @messages_in_queue = int_pointer.read_int
+      message_pointer.null? ? nil : CurlFFI::Message.new(message_pointer)
+    end
+
+    # @todo handle return code
+    def socket_action(sockfd, ev_bitmask = 0)
+      int_pointer = FFI::MemoryPointer.new(:int)
+      result = CurlFFI.multi_socket_action(@pointer, sockfd, ev_bitmask, int_pointer)
+      @running = int_pointer.read_int
+      result
+    end
+
+    def perform()
+      int_pointer = FFI::MemoryPointer.new(:int)
+      result = CurlFFI.multi_perform(@pointer, int_pointer)
+      @running = int_pointer.read_int
+      result
+    end
+
+    def timeout
+      long_pointer = FFI::MemoryPointer.new(:long)
+      result = CurlFFI.multi_timeout(@pointer, long_pointer)
+      long_pointer.read_long
+    end
+  end
+end

data/lib/curl_ffi/version.rb

@@ -0,0 +1,3 @@
+module CurlFFI
+  VERSION = "0.0.2"
+end

data/lib/curl_ffi.rb

@@ -0,0 +1,13 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'ffi'
+
+require "curl_ffi/ffi_bindings"
+
+module CurlFFI
+  extend CurlFFI::CurlBindings
+
+  autoload :Easy,   "curl_ffi/easy"
+  autoload :Multi,  "curl_ffi/multi"
+end

data/spec/curl/easy_spec.rb

@@ -0,0 +1,84 @@
+require "spec_helper"
+
+module Curl
+  describe Easy, ".new" do
+    it "should return a new Curl::Easy object" do
+      Easy.new.should be_a(Easy)
+    end
+  end
+
+  describe Easy do
+    before :each do
+      @easy = Easy.new
+    end
+
+    describe "#dup" do
+      it "should return a new Curl::Easy object" do
+        @easy.dup.should be_a(Easy)
+      end
+
+      it "should have a seperate libCurl handle" do
+        @easy.dup.pointer.should_not equal(@easy.pointer)
+      end
+    end
+
+    describe "#reset" do
+      it "should reset all set options" do
+        # TODO how would one test that?
+        @easy.should respond_to(:reset)
+      end
+    end
+
+    describe "#setopt" do
+      it "should correctly set string options" do
+        @easy.setopt(OPTION[:URL], "http://google.de")
+      end
+
+      it "should correctly set string options" do
+        @easy.setopt(OPTION[:PORT], 123)
+      end
+    end
+
+    describe "#getinfo" do
+      it "should return internal information" do
+        @easy.getinfo(INFO[:EFFECTIVE_URL]).should == ""
+
+        @easy.setopt(OPTION[:URL], "http://google.de")
+        @easy.getinfo(INFO[:EFFECTIVE_URL]).should == "http://google.de"
+      end
+    end
+
+    describe "#perform" do
+#      it "should perform the request" do
+#        @easy.setopt(OPTION[:URL], "http://google.de")
+#        @easy.perform
+#      end
+    end
+
+    describe "#escape" do
+      it "should escape the passed string" do
+        str = @easy.escape("Hello World!")
+        str.should == "Hello%20World%21"
+      end
+    end
+
+    describe "#unescape" do
+      it "should unescape the passed string" do
+        str = @easy.unescape("Hello%20World%21")
+        str.should == "Hello World!"
+      end
+
+      it "should correctly unescape strings containing '%00'" do
+        str = @easy.unescape("%00Test")
+        str.should == "\00Test"
+      end
+    end
+
+    describe "#error_string" do
+      it "should return a string describing the passed error code" do
+        @easy.error_string(:OK).should == "No error"
+        @easy.error_string(:UNSUPPORTED_PROTOCOL).should == "Unsupported protocol"
+      end
+    end
+  end
+end

data/spec/curl/multi_spec.rb

@@ -0,0 +1,81 @@
+require "spec_helper"
+
+module Curl
+  describe Multi, ".new" do
+    it "should return a new Curl::Easy object" do
+      Multi.new.should be_a(Multi)
+    end
+  end
+
+  describe Multi do
+    before :each do
+      @multi = Multi.new
+      @easy = Easy.new
+      @easy.setopt(OPTION[:PROXY], "")
+    end
+
+    describe "#add_handle" do
+      it "should add the easy object to this multi objects handles" do
+        @multi.add_handle(@easy)
+      end
+    end
+
+    describe "#info_read_next" do
+      it "should return nil if there are no messages" do
+        @multi.info_read_next.should be_nil
+      end
+
+      it "should return Curl::Message objects when messages are available" do
+        @easy.setopt(OPTION[:URL], "http://google.de")
+        @multi.add_handle(@easy)
+
+        @multi.perform while @multi.running != 0
+        message = @multi.info_read_next
+        message.should be_a(Curl::Message)
+        message[:msg].should == :DONE
+      end
+    end
+
+    describe "#info_read_all" do
+      it "should return an empty array if there are no messages" do
+        @multi.info_read_all.should == []
+      end
+
+      it "should return an array of Curl::Message objects when messages are available" do
+        @easy.setopt(OPTION[:URL], "http://google.de")
+        @multi.add_handle(@easy)
+
+        @multi.perform while @multi.running != 0
+        messages = @multi.info_read_all
+        messages.size.should == 1
+
+        messages.first.should be_a(Curl::Message)
+        messages.first[:msg].should == :DONE
+      end
+    end
+
+    describe "#timeout" do
+      it "should return -1 if there is no timer set yet" do
+        @multi.timeout.should == -1
+      end
+
+      it "should return the timeout till the next call to #perform" do
+        @easy.setopt(OPTION[:URL], "http://google.de")
+        @multi.add_handle(@easy)
+
+        @multi.timeout.should == 1
+        @multi.perform
+        @multi.timeout.should == 1
+      end
+    end
+
+    describe "#perform" do
+      before :each do
+        @easy.setopt(OPTION[:URL], "http://google.de")
+        @multi.add_handle(@easy)
+      end
+
+      it "should perform the request"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require "rubygems"
+
+require "lib/curl"

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: curl_ffi
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Arthur Schreiber
+- Scott Gonyea
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-05 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ffi
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: An FFI based libCurl interface, intended to serve as a common backend for existing interfaces to libcurl
+email: 
+- schreiber.arthur@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- curl_ffi.gemspec
+- examples/evented_multi.rb
+- examples/perform_multi.rb
+- examples/select_multi.rb
+- lib/curl_ffi.rb
+- lib/curl_ffi/curl_bindings.rb
+- lib/curl_ffi/easy.rb
+- lib/curl_ffi/multi.rb
+- lib/curl_ffi/version.rb
+- spec/curl/easy_spec.rb
+- spec/curl/multi_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/nokarma/curl-ffi
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: curl-ffi
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: An FFI based libCurl interface
+test_files: 
+- spec/curl/easy_spec.rb
+- spec/curl/multi_spec.rb
+- spec/spec_helper.rb