scnr-ethon 0.15.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6b1ae3b1d9930b0935371b3ee1ce8d233ec0f1d9ef8170380d160ffea2469891
+  data.tar.gz: e10a1aecce685d0729e10aa0f24efd2923736350b0cf8dfa2ff5f5bd0efabbd2
+SHA512:
+  metadata.gz: 1b6f5fbd9c431e207c19d8f6ce4dd8fc5179b147a0b558bf19aa31caa40856e86efa1d63529489f6898604322847b873d192f885f7cc164e59fa72cbf4deca01
+  data.tar.gz: 72db218473814cda2ce29cf6a75700d5e0840a59fefc7f3fb8a07925bbd7e9c745c78175b137d455422b9ee49313d274d376d0fd1a145f5ea03857593d85a511

data/CHANGELOG.md

@@ -0,0 +1,379 @@
+# Changelog
+
+## Master
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.16.0...master)
+
+## 0.16.0
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.15.0...v0.16.0)
+
+* Added `redirect_url` value to available informations and `Easy::Mirror`.
+  ([Adrien Rey-Jarthon](https://github.com/jarthod)
+
+## 0.15.0
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.14.0...v0.15.0)
+
+## 0.12.0
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.11.0...v0.12.0)
+
+- Removed deprecated `CURLE_SSL_CACERT` pinned in curl v7.62.0 ([@arku](https://github.com/arku) in [#158](https://github.com/typhoeus/ethon/pull/158))
+
+
+## 0.11.0
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.10.1...v0.11.0)
+
+## 0.10.1
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.10.0...v0.10.1)
+
+## 0.10.0
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.9.1...v0.10.0)
+
+## 0.9.1
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.9.0...v0.9.1)
+
+## 0.9.0
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.8.1...v0.9.0)
+
+## 0.8.1
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.8.0...v0.8.1)
+
+* Support optional escaping of params.
+  ([Tasos Laskos](https://github.com/zapotek)
+* `Easy::Mirror`: Reduced object allocations and method calls during info handling.
+  ([Tasos Laskos](https://github.com/zapotek)
+
+## 0.8.0
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.7.3...v0.7.4)
+
+* `Easy::Mirror`: Reduced object allocations and method calls during info handling.
+  ([Tasos Laskos](https://github.com/zapotek)
+
+## 0.7.4
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.7.3...v0.7.4)
+
+* Support different array encodings for params.
+  ([Marcello Barnaba](https://github.com/ifad), [\#104](https://github.com/typhoeus/ethon/pull/104))
+* Programtic access to version infos.
+  ([Jonas Wagner](https://github.com/jwagner), [\#90](https://github.com/typhoeus/ethon/pull/90))
+
+
+## 0.7.3
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.7.2...v0.7.3)
+
+* `Ethon::Curl::FDSet`
+    * Set `:fd_array` size to the current MS Windows `FD_SETSIZE` (2048).
+        ([Tasos Laskos](https://github.com/zapotek)
+
+* Added `redirect_time` value to available informations and `Easy::Mirror`.
+  ([Adrien Jarthon](https://github.com/jarthod)
+
+## 0.7.2
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.7.1...v0.7.2)
+
+* FFI data-types updated to be more correct.
+
+## 0.7.1
+
+* MS Windows determination delegated to `Gem.windows?` for better accuracy.
+* FFI data-types updated to work on MS Windows.
+
+## 0.7.0
+
+Not backwards compatible changes:
+
+* `mime-types` are no longer a dependency. The gem will be still used if available to determine the mime type of a file which is uploaded. That means you have to have take care of the gem installation yourself.
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.6.3...v0.7.0)
+
+## 0.6.3
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.6.2...v0.6.3)
+
+## 0.6.2
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.6.1...v0.6.2)
+
+## 0.6.1
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.6.0...v0.6.1)
+
+The changelog entries are coming soon!
+
+## 0.6.0
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.5.12...v0.6.0)
+
+The changelog entries are coming soon!
+
+Bugfixes:
+
+  * URL-encode nullbytes in parameters instead of escaping them to `\\0`.
+    ([Tasos Laskos](https://github.com/zapotek)
+
+## 0.5.12
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.5.11...v0.5.12)
+
+Enhancements:
+
+* Performance optimizations.
+  ([Kyle Oppenheim](https://github.com/koppenheim) and [Richie Vos](https://github.com/richievos), [\#48](https://github.com/typhoeus/ethon/pull/48))
+* Reuse memory pointer.
+  ([Richie Vos](https://github.com/richievos), [\#49](https://github.com/typhoeus/ethon/pull/49))
+
+Bugfixes:
+
+* Fix windows install.
+  ([Derik Olsson](https://github.com/derikolsson), [\#47](https://github.com/typhoeus/ethon/pull/47))
+* Handle urls that already contain query params.
+  ([Turner King](https://github.com/turnerking ), [\#45](https://github.com/typhoeus/ethon/pull/45))
+
+## 0.5.11
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.5.10...v0.5.11)
+
+Enhancements:
+
+* Add support for postredirs, unrestricted_auth.
+* Add support for cookie, cookiejar, cookiefile.
+  ([erwanlr](https://github.com/erwanlr), [\#46](https://github.com/typhoeus/ethon/pull/46))
+* Relax ffi requirements.
+  ([voxik](https://github.com/voxik), [\#40](https://github.com/typhoeus/ethon/pull/40))
+* Various documentation improvements.
+  ([Craig Little](https://github.com/craiglittle))
+
+Bugfixes:
+
+* Fix the memory leaks.
+  ([Richie Vos](https://github.com/richievos), [\#45](https://github.com/typhoeus/ethon/pull/45))
+
+## 0.5.10
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.5.9...v0.5.10)
+
+Enhancements:
+
+* Allow custom requests.
+  ([Nathan Sutton](https://github.com/nate), [\#36](https://github.com/typhoeus/ethon/pull/36))
+* Use updated version of FFI.
+
+Bugfixes:
+
+* Fix windows install issue.
+  ([brainsucker](https://github.com/brainsucker), [\#38](https://github.com/typhoeus/ethon/pull/38))
+
+## 0.5.9
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.5.8...v0.5.9)
+
+Enhancements:
+
+* Allow to set multiple protocols.
+
+## 0.5.8
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.5.7...v0.5.8)
+
+Enhancements:
+
+* Add support for protocols and redir_protocols(
+  [libcurl SASL buffer overflow vulnerability](http://curl.haxx.se/docs/adv_20130206.html)).
+* Add max_send_speed_large and max_recv_speed_large([Paul Schuegraf](https://github.com/pschuegr), [\#33](https://github.com/typhoeus/ethon/pull/33))
+
+## 0.5.7
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.5.6...v0.5.7)
+
+Enhancements:
+
+* Use new version of ffi.
+
+## 0.5.6
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.5.4...v0.5.6)
+
+Bugfixes:
+
+* Easy#reset resets on_complete callbacks.
+
+## 0.5.4
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.5.3...v0.5.4)
+
+Enhancements:
+
+* Use Libc#getdtablesize to get the FDSet size.
+* New libcurl option accept_encoding.
+* Documentation updates.
+
+## 0.5.3
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.5.2...v0.5.3)
+
+Enhancements:
+
+* Deprecate Easy#prepare. It is no longer necessary.
+* Unroll metaprogramming for easy and multi options.
+* More specs.
+
+Bugfixes:
+
+* Correct size for FDSets
+* Add proxytypes to enums.
+
+## 0.5.2
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.5.1...v0.5.2)
+
+Enhancements:
+
+* New libcurl option keypasswd.
+
+Bugfixes:
+
+* Correct request logging when using multi interface.
+* Remove invalid libcurl option sslcertpasswd.
+
+## 0.5.1
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.5.0...v0.5.1)
+
+Bugfixes:
+
+* Mark Curl.select and Curl.easy_perform as blocking so that the GIL is
+  released by ffi.
+
+## 0.5.0
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.4.4...v0.5.0)
+
+Enhancements:
+
+* New libcurl option proxyuserpwd
+* Rename response_header to response_headers
+
+Bugfixes:
+
+* Mark Curl.select and Curl.easy_perform as blocking so that the GIL is
+  released by ffi.
+
+## 0.4.4
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.4.3...v0.4.4)
+
+Enhancements:
+
+* Prepare multi explicit like easy
+
+## 0.4.3
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.4.2...v0.4.3)
+
+Enhancements:
+
+* Remove deprecated libcurl option put
+* More documentation
+* New libcurl option connecttimeout_ms and timeout_ms
+* Support multi options
+
+Bugfixes:
+
+* Handle nil values in query params
+
+## 0.4.2
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.4.1...v0.4.2)
+
+Enhancements:
+
+* New libcurl option forbid_reuse
+* Use libcurls escape instead of CGI::escape
+
+## 0.4.1
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.4.0...v0.4.1)
+
+Bugfixes:
+
+* Handle nested hash in an array in params correct
+  ( [\#201](https://github.com/typhoeus/typhoeus/issues/201) )
+
+## 0.4.0
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.3.0...v0.4.0)
+
+Enhancements:
+
+* ruby 1.8.7 compatible
+* Ethon.logger
+* Deal with string param/body
+* More documentation
+
+Bugfixes:
+
+* Add multi_cleanup to curl
+
+## 0.3.0
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.2.0...v0.3.0)
+
+Enhancements:
+
+* New libcurl option proxyport
+* Raise invalid value error when providing a wrong key for sslversion or httpauth
+
+Bugfixes:
+
+* Libcurl option sslversion is handled correct
+
+## 0.2.0
+
+[Full Changelog](https://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
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.0.2...v0.1.0)
+
+Enhancements:
+
+* Documentation
+  ( [Alex P](https://github.com/ifesdjeen), [\#13](https://github.com/typhoeus/ethon/issues/13) )
+* New libcurl option dns_cache_timeout
+  ( [Chris Heald](https://github.com/cheald), [\#192](https://github.com/typhoeus/typhoeus/pull/192) )
+
+Bugfixes:
+
+* Libcurl option ssl_verifyhost takes an integer.
+* Add space between header key and value.
+
+## 0.0.2
+
+[Full Changelog](https://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.
+* Escape zero bytes.
+
+## 0.0.1 Initial version

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012-2016 Hans Hasselberg
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,118 @@
+[![Gem Version](https://badge.fury.io/rb/ethon.svg)](https://badge.fury.io/rb/ethon)
+[![Build Status](https://github.com/typhoeus/ethon/workflows/Ruby/badge.svg)](https://github.com/typhoeus/ethon/actions/workflows/ruby.yml)
+
+#  Ethon
+
+In Greek mythology, Ethon, the son of Typhoeus and Echidna, is a gigantic eagle. So much for the history.
+In the modern world, Ethon is a very basic libcurl wrapper using ffi.
+
+* [Documentation](http://rubydoc.info/github/typhoeus/ethon/frames/Ethon)
+* [Website](http://typhoeus.github.com/)
+* [Mailing list](http://groups.google.com/group/typhoeus)
+
+## Installation
+
+With bundler:
+
+    gem "ethon"
+
+With rubygems:
+
+    gem install ethon
+
+## Usage
+
+Making the first request is simple:
+
+```ruby
+easy = Ethon::Easy.new(url: "www.example.com")
+easy.perform
+#=> :ok
+```
+
+You have access to various options, such as following redirects:
+
+```ruby
+easy = Ethon::Easy.new(url: "www.example.com", followlocation: true)
+easy.perform
+#=> :ok
+```
+
+Once you're done you can inspect the response code and body:
+
+```ruby
+easy = Ethon::Easy.new(url: "www.example.com", followlocation: true)
+easy.perform
+easy.response_code
+#=> 200
+easy.response_body
+#=> "<!doctype html><html ..."
+```
+
+## Http
+
+In order to make life easier, there are some helpers for making HTTP requests:
+
+```ruby
+easy = Ethon::Easy.new
+easy.http_request("www.example.com", :get, { params: {a: 1} })
+easy.perform
+#=> :ok
+```
+
+```ruby
+easy = Ethon::Easy.new
+easy.http_request("www.example.com", :post, { params: { a: 1 }, body: { b: 2 } })
+easy.perform
+#=> :ok
+```
+
+This is really handy when making requests since you don't have to care about setting
+everything up correctly.
+
+## Http2
+Standard http2 servers require the client to connect once and create a session (multi) and then add simple requests to the multi handler.
+The `perform` method then takes all the requests in the multi handler and sends them to the server.
+
+See the following example
+```ruby
+multi = Ethon::Multi.new
+easy = Ethon::Easy.new
+
+easy.http_request("www.example.com/get", :get, { http_version: :httpv2_0 })
+
+# Sending a request with http version 2 will send an Upgrade header to the server, which many older servers will not support
+# See below for more info: https://everything.curl.dev/http/http2
+# If this is a problem, send the below:
+easy.http_request("www.example.com/get", :get, { http_version: :httpv2_prior_knowledge })
+
+# To set the server to use http2 with https and http1 with http, send the following:
+easy.http_request("www.example.com/get", :get, { http_version: :httpv2_tls })
+
+multi.add(easy)
+multi.perform
+```
+
+##  LICENSE
+
+(The MIT License)
+
+Copyright © 2012-2016 [Hans Hasselberg](http://www.hans.io)
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without
+limitation the rights to use, copy, modify, merge, publish, distribute,
+sublicense, and/or sell copies of the Software, and to permit persons
+to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/ethon.gemspec

@@ -0,0 +1,29 @@
+# encoding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'ethon/version'
+
+Gem::Specification.new do |s|
+  s.name         = "scnr-ethon"
+  s.version      = Ethon::VERSION
+  s.platform     = Gem::Platform::RUBY
+  s.authors      = ["Tasos Laskos", "Hans Hasselberg"]
+  s.email        = ["tasos.laskos@gmail.com", "me@hans.io"]
+  s.homepage     = "https://github.com/typhoeus/ethon/tree/thread-safe-easy-handle-cleanup"
+  s.summary      = "Libcurl wrapper."
+  s.description  = "Very lightweight libcurl wrapper."
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.license = 'MIT'
+
+  s.add_dependency('ffi', ['>= 1.15.0'])
+
+  s.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |file|
+      file.start_with?(*%w[. Gemfile Guardfile Rakefile profile spec])
+    end
+  end
+  s.require_path = 'lib'
+end

data/lib/ethon/curl.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+require 'ethon/curls/codes'
+require 'ethon/curls/options'
+require 'ethon/curls/infos'
+require 'ethon/curls/form_options'
+require 'ethon/curls/messages'
+require 'ethon/curls/functions'
+
+module Ethon
+
+  # FFI Wrapper module for Curl. Holds constants and required initializers.
+  #
+  # @api private
+  module Curl
+    extend ::FFI::Library
+    extend Ethon::Curls::Codes
+    extend Ethon::Curls::Options
+    extend Ethon::Curls::Infos
+    extend Ethon::Curls::FormOptions
+    extend Ethon::Curls::Messages
+
+    # :nodoc:
+    def self.windows?
+      Libc.windows?
+    end
+
+    require 'ethon/curls/constants'
+    require 'ethon/curls/settings'
+    require 'ethon/curls/classes'
+    extend Ethon::Curls::Functions
+
+    @blocking = true
+
+    @@initialized = false
+    @@curl_mutex = Mutex.new
+
+    class << self
+      # This function sets up the program environment that libcurl needs.
+      # Think of it as an extension of the library loader.
+      #
+      # This function must be called at least once within a program (a program is all the
+      # code that shares a memory space) before the program calls any other function in libcurl.
+      # The environment it sets up is constant for the life of the program and is the same for
+      # every program, so multiple calls have the same effect as one call.
+      #
+      # The flags option is a bit pattern that tells libcurl exactly what features to init,
+      # as described below. Set the desired bits by ORing the values together. In normal
+      # operation, you must specify CURL_GLOBAL_ALL. Don't use any other value unless
+      # you are familiar with it and mean to control internal operations of libcurl.
+      #
+      # This function is not thread safe. You must not call it when any other thread in
+      # the program (i.e. a thread sharing the same memory) is running. This doesn't just
+      # mean no other thread that is using libcurl. Because curl_global_init() calls
+      # functions of other libraries that are similarly thread unsafe, it could conflict with
+      # any other thread that uses these other libraries.
+      #
+      # @raise [ Ethon::Errors::GlobalInit ] If Curl.global_init fails.
+      def init
+        @@curl_mutex.synchronize {
+          if not @@initialized
+            raise Errors::GlobalInit.new if Curl.global_init(GLOBAL_ALL) != 0
+            @@initialized = true
+            Ethon.logger.debug("ETHON: Libcurl initialized") if Ethon.logger
+          end
+        }
+      end
+
+      # This function releases resources acquired by curl_global_init.
+      # You should call curl_global_cleanup once for each call you make to
+      # curl_global_init, after you are done using libcurl.
+      # This function is not thread safe. You must not call it when any other thread in the
+      # program (i.e. a thread sharing the same memory) is running. This doesn't just
+      # mean no other thread that is using libcurl. Because curl_global_cleanup calls functions of other
+      # libraries that are similarly thread unsafe, it could conflict with
+      # any other thread that uses these other libraries.
+      # See the description in libcurl of global environment requirements
+      # for details of how to use this function.
+      def cleanup
+        @@curl_mutex.synchronize {
+          if @@initialized
+            Curl.global_cleanup()
+            @@initialized = false
+            Ethon.logger.debug("ETHON: Libcurl cleanup") if Ethon.logger
+          end
+        }
+      end
+
+    end
+  end
+end