curb 0.7.15 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dce5f49b09bacccf705e3d25ba29031dd4fc82c2721860eef02bb4a8af2dd0e2
+  data.tar.gz: 9456ed69688f2236bdd17f338e26faaf46b91f0fd4e51b3a48d5551ff8fdc433
+SHA512:
+  metadata.gz: df6ab81576ef567878331724c1600c59ff923be34d3a71bd31d07e4999880743e73c31a502bab8aaece54099fd5142bf954dbf004fffd38f0e6698750e3f9682
+  data.tar.gz: 5b7b867979da88d328e9f71a4a6eb7183430de26902311cb8678b443a6c53cf50aa62952f277bc2c2821bafc2af48c0e28067f7dce512ff7c2912b195bc27ad5

data/README.markdown

@@ -0,0 +1,283 @@
+# Curb - Libcurl bindings for Ruby [![Build Status](https://travis-ci.org/taf2/curb.svg?branch=master)](https://travis-ci.org/taf2/curb)
+
+* [rubydoc rdoc](http://www.rubydoc.info/github/taf2/curb/)
+* [github project](http://github.com/taf2/curb/tree/master)
+
+Curb (probably CUrl-RuBy or something) provides Ruby-language bindings for the
+libcurl(3), a fully-featured client-side URL transfer library.
+cURL and libcurl live at [http://curl.haxx.se/](http://curl.haxx.se/) .
+
+Curb is a work-in-progress, and currently only supports libcurl's `easy` and `multi` modes.
+
+## License
+
+Curb is copyright (c)2006 Ross Bamford, and released under the terms of the
+Ruby license. See the LICENSE file for the gory details.
+
+## You will need
+
+* A working Ruby installation (`1.8.7+` will work but `2.1+` preferred)
+* A working libcurl development installation
+(Ideally one of the versions listed in the compatibility chart below that maps to your `curb` version)
+* A sane build environment (e.g. gcc, make)
+
+## Version Compatibility chart
+
+A **non-exhaustive** set of compatibility versions of the libcurl library
+with this gem are as follows. (Note that these are only the ones that have been
+tested and reported to work across a variety of platforms / rubies)
+
+| Gem Version | Release Date | libcurl versions |
+| ----------- | -----------  | ---------------- |
+| 0.9.8       | Jan 2019     | 7.58 - 7.63      |
+| 0.9.7       | Nov 2018     | 7.56 - 7.60      |
+| 0.9.6       | May 2018     | 7.51 - 7.59      |
+| 0.9.5       | May 2018     | 7.51 - 7.59      |
+| 0.9.4       | Aug 2017     | 7.41 - 7.58      |
+| 0.9.3       | Apr 2016     | 7.26 - 7.58      |
+
+## Installation...
+
+... will usually be as simple as:
+
+    $ gem install curb
+
+On Windows, make sure you're using the [DevKit](http://rubyinstaller.org/downloads/) and
+the [development version of libcurl](http://curl.haxx.se/gknw.net/7.39.0/dist-w32/curl-7.39.0-devel-mingw32.zip). Unzip, then run this in your command
+line (alter paths to your curl location, but remember to use forward slashes):
+
+    gem install curb --platform=ruby -- --with-curl-lib=C:/curl-7.39.0-devel-mingw32/lib --with-curl-include=C:/curl-7.39.0-devel-mingw32/include
+    
+Note that with Windows moving from one method of compiling to another as of Ruby `2.4` (DevKit -> MYSYS2),
+the usage of Ruby `2.4+` with this gem on windows is unlikely to work. It is advised to use the
+latest version of Ruby 2.3 available [HERE](https://dl.bintray.com/oneclick/rubyinstaller/rubyinstaller-2.3.3.exe)
+
+Or, if you downloaded the archive:
+
+    $ rake compile && rake install
+
+If you have a weird setup, you might need extconf options. In this case, pass
+them like so:
+
+    $ rake compile EXTCONF_OPTS='--with-curl-dir=/path/to/libcurl --prefix=/what/ever' && rake install
+
+Curb is tested only on GNU/Linux x86 and Mac OSX - YMMV on other platforms.
+If you do use another platform and experience problems, or if you can
+expand on the above instructions, please report the issue at http://github.com/taf2/curb/issues
+
+On Ubuntu, the dependencies can be satisfied by installing the following packages:
+
+18.04 and onwards
+    
+    $ sudo apt-get install libcurl4 libcurl3-gnutls libcurl4-openssl-dev
+
+< 18.04
+
+    $ sudo apt-get install libcurl3 libcurl3-gnutls libcurl4-openssl-dev
+
+On RedHat:
+
+    $ sudo yum install ruby-devel libcurl-devel openssl-devel
+
+Curb has fairly extensive RDoc comments in the source. You can build the
+documentation with:
+
+    $ rake doc
+
+## Usage & examples
+
+Curb provides two classes:
+
+* `Curl::Easy` - simple API, for day-to-day tasks.
+* `Curl::Multi` - more advanced API, for operating on multiple URLs simultaneously.
+
+To use either, you will need to require the curb gem:
+
+```ruby
+require 'curb'
+```
+
+### Super simple API (less typing)
+
+```ruby
+http = Curl.get("http://www.google.com/")
+puts http.body_str
+
+http = Curl.post("http://www.google.com/", {:foo => "bar"})
+puts http.body_str
+
+http = Curl.get("http://www.google.com/") do |http|
+  http.headers['Cookie'] = 'foo=1;bar=2'
+end
+puts http.body_str
+```
+
+### Simple fetch via HTTP:
+
+```ruby
+c = Curl::Easy.perform("http://www.google.co.uk")
+puts c.body_str
+```
+
+Same thing, more manual:
+
+```ruby
+c = Curl::Easy.new("http://www.google.co.uk")
+c.perform
+puts c.body_str
+```
+
+### Additional config:
+
+```ruby
+Curl::Easy.perform("http://www.google.co.uk") do |curl|
+  curl.headers["User-Agent"] = "myapp-0.0"
+  curl.verbose = true
+end
+```
+
+Same thing, more manual:
+
+```ruby
+c = Curl::Easy.new("http://www.google.co.uk") do |curl|
+  curl.headers["User-Agent"] = "myapp-0.0"
+  curl.verbose = true
+end
+
+c.perform
+```
+
+### HTTP basic authentication:
+
+```ruby
+c = Curl::Easy.new("http://github.com/")
+c.http_auth_types = :basic
+c.username = 'foo'
+c.password = 'bar'
+c.perform
+```
+
+### HTTP "insecure" SSL connections (like curl -k, --insecure) to avoid Curl::Err::SSLCACertificateError:
+
+```ruby
+c = Curl::Easy.new("https://github.com/")
+c.ssl_verify_peer = false
+c.perform
+```
+
+### Supplying custom handlers:
+
+```ruby
+c = Curl::Easy.new("http://www.google.co.uk")
+
+c.on_body { |data| print(data) }
+c.on_header { |data| print(data) }
+
+c.perform
+```
+
+### Reusing Curls:
+
+```ruby
+c = Curl::Easy.new
+
+["http://www.google.co.uk", "http://www.ruby-lang.org/"].map do |url|
+  c.url = url
+  c.perform
+  c.body_str
+end
+```
+
+### HTTP POST form:
+
+```ruby
+c = Curl::Easy.http_post("http://my.rails.box/thing/create",
+                         Curl::PostField.content('thing[name]', 'box'),
+                         Curl::PostField.content('thing[type]', 'storage'))
+```
+
+### HTTP POST file upload:
+
+```ruby
+c = Curl::Easy.new("http://my.rails.box/files/upload")
+c.multipart_form_post = true
+c.http_post(Curl::PostField.file('thing[file]', 'myfile.rb'))
+```
+
+### Using HTTP/2
+
+```ruby
+c = Curl::Easy.new("https://http2.akamai.com")
+c.set(:HTTP_VERSION, Curl::HTTP_2_0)
+
+c.perform
+puts (c.body_str.include? "You are using HTTP/2 right now!") ? "HTTP/2" : "HTTP/1.x"
+```
+
+### Multi Interface (Basic HTTP GET):
+
+```ruby
+# make multiple GET requests
+easy_options = {:follow_location => true}
+# Use Curl::CURLPIPE_MULTIPLEX for HTTP/2 multiplexing
+multi_options = {:pipeline => Curl::CURLPIPE_HTTP1}
+
+Curl::Multi.get(['url1','url2','url3','url4','url5'], easy_options, multi_options) do|easy|
+  # do something interesting with the easy response
+  puts easy.last_effective_url
+end
+```
+
+### Multi Interface (Basic HTTP POST):
+
+```ruby
+# make multiple POST requests
+easy_options = {:follow_location => true, :multipart_form_post => true}
+multi_options = {:pipeline => Curl::CURLPIPE_HTTP1}
+
+
+url_fields = [
+  { :url => 'url1', :post_fields => {'f1' => 'v1'} },
+  { :url => 'url2', :post_fields => {'f1' => 'v1'} },
+  { :url => 'url3', :post_fields => {'f1' => 'v1'} }
+]
+
+Curl::Multi.post(url_fields, easy_options, multi_options) do|easy|
+  # do something interesting with the easy response
+  puts easy.last_effective_url
+end
+```
+
+### Multi Interface (Advanced):
+
+```ruby
+responses = {}
+requests = ["http://www.google.co.uk/", "http://www.ruby-lang.org/"]
+m = Curl::Multi.new
+# add a few easy handles
+requests.each do |url|
+  responses[url] = ""
+  c = Curl::Easy.new(url) do|curl|
+    curl.follow_location = true
+    curl.on_body{|data| responses[url] << data; data.size }
+    curl.on_success {|easy| puts "success, add more easy handles" }
+  end
+  m.add(c)
+end
+
+m.perform do
+  puts "idling... can do some work here"
+end
+
+requests.each do|url|
+  puts responses[url]
+end
+```
+
+### Easy Callbacks
+
+* `on_success`  is called when the response code is 2xx
+* `on_redirect` is called when the response code is 3xx
+* `on_missing` is called when the response code is 4xx
+* `on_failure` is called when the response code is 5xx
+* `on_complete` is called in all cases.

data/Rakefile

@@ -2,15 +2,30 @@
 # 
 require 'rake/clean'
 require 'rake/testtask'
-require 'rake/rdoctask'
 
 CLEAN.include '**/*.o'
-CLEAN.include "**/*.#{Config::MAKEFILE_CONFIG['DLEXT']}"
+CLEAN.include "**/*.#{(defined?(RbConfig) ? RbConfig : Config)::MAKEFILE_CONFIG['DLEXT']}"
 CLOBBER.include 'doc'
 CLOBBER.include '**/*.log'
 CLOBBER.include '**/Makefile'
 CLOBBER.include '**/extconf.h'
 
+# Not available for really old rubies, but that's ok.
+begin
+  require 'pry'
+rescue LoadError
+  puts "Failed to load pry."
+end
+
+# Load support ruby and rake files (in this order)
+Dir.glob('tasks/*.rb').each { |r| load r}
+Dir.glob('tasks/*.rake').each { |r| load r}
+
+desc 'Print Ruby major version (ie "2_5")'
+task :ruby_version do
+  print current_ruby_major
+end
+
 def announce(msg='')
   $stderr.puts msg
 end
@@ -39,40 +54,31 @@ end
 make_program = (/mswin/ =~ RUBY_PLATFORM) ? 'nmake' : 'make'
 MAKECMD = ENV['MAKE_CMD'] || make_program
 MAKEOPTS = ENV['MAKE_OPTS'] || ''
-
-CURB_SO = "ext/curb_core.#{Config::MAKEFILE_CONFIG['DLEXT']}"
+CURB_SO = "ext/curb_core.#{(defined?(RbConfig) ? RbConfig : Config)::MAKEFILE_CONFIG['DLEXT']}"
 
 file 'ext/Makefile' => 'ext/extconf.rb' do
-  Dir.chdir('ext') do
-    ruby "extconf.rb #{ENV['EXTCONF_OPTS']}"
-  end
+  shell(['ruby', 'extconf.rb', ENV['EXTCONF_OPTS'].to_s],
+        { :live_stdout => STDOUT , :cwd => "#{Dir.pwd}/ext" }
+       ).error!
 end
 
 def make(target = '')
-  Dir.chdir('ext') do 
-    pid = system("#{MAKECMD} #{MAKEOPTS} #{target}")
-    $?.exitstatus
-  end    
+  shell(["#{MAKECMD}", "#{MAKEOPTS}", "#{target}"].reject(&:empty?),
+        { :live_stdout => STDOUT, :cwd => "#{Dir.pwd}/ext" }
+       ).error!
 end
 
 # Let make handle dependencies between c/o/so - we'll just run it. 
 file CURB_SO => (['ext/Makefile'] + Dir['ext/*.c'] + Dir['ext/*.h']) do
-  m = make
-  fail "Make failed (status #{m})" unless m == 0
+  make
 end
 
 desc "Compile the shared object"
 task :compile => [CURB_SO]
 
-desc "Create the markdown file"
-task :markdown do
-  cp "README", "README.markdown"
-end
-
 desc "Install to your site_ruby directory"
-task :install => :alltests do
-  m = make 'install' 
-  fail "Make install failed (status #{m})" unless m == 0
+task :install do
+  make 'install'
 end
 
 # Test Tasks ---------------------------------------------------------
@@ -90,12 +96,12 @@ if ENV['RELTEST']
 else
   task :alltests => [:unittests, :bugtests]
 end
-                    
+
 Rake::TestTask.new(:unittests) do |t|
   t.test_files = FileList['tests/tc_*.rb']
   t.verbose = false
 end
-                          
+
 Rake::TestTask.new(:bugtests) do |t|
   t.test_files = FileList['tests/bug_*.rb']
   t.verbose = false
@@ -137,6 +143,12 @@ end
 
 desc "Publish the RDoc documentation to project web site"
 task :doc_upload => [ :doc ] do
+  begin
+    require 'rdoc/task'
+  rescue LoadError => e
+    require 'rake/rdoctask'
+  end
+
   if ENV['RELTEST']
     announce "Release Task Testing, skipping doc upload"
   else    
@@ -167,13 +179,13 @@ else
 
   desc 'Build gem'
   task :package => :gemspec do
-    require 'rubygems/specification'
+    require 'rubygems/package'
     spec_source = File.read File.join(File.dirname(__FILE__),'curb.gemspec')
     spec = nil
     # see: http://gist.github.com/16215
-    Thread.new { spec = eval("$SAFE = 3\n#{spec_source}") }.join
+    Thread.new { spec = eval("#{spec_source}") }.join
     spec.validate
-    Gem::Builder.new(spec).build
+    Gem::Package.build(spec)
   end
 
   task :static do

data/ext/banned.h

@@ -0,0 +1,32 @@
+#ifndef BANNED_H
+#define BANNED_H
+
+/*
+ * This header lists functions that have been banned from our code base,
+ * because they're too easy to misuse (and even if used correctly,
+ * complicate audits). Including this header turns them into compile-time
+ * errors.
+ */
+
+#define BANNED(func) sorry_##func##_is_a_banned_function
+
+#undef strcpy
+#define strcpy(x,y) BANNED(strcpy)
+#undef strcat
+#define strcat(x,y) BANNED(strcat)
+#undef strncpy
+#define strncpy(x,y,n) BANNED(strncpy)
+#undef strncat
+#define strncat(x,y,n) BANNED(strncat)
+
+#undef sprintf
+#undef vsprintf
+#ifdef HAVE_VARIADIC_MACROS
+#define sprintf(...) BANNED(sprintf)
+#define vsprintf(...) BANNED(vsprintf)
+#else
+#define sprintf(buf,fmt,arg) BANNED(sprintf)
+#define vsprintf(buf,fmt,arg) BANNED(sprintf)
+#endif
+
+#endif /* BANNED_H */