httpx 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 76ac74f383584bdbf20b60f5a969ceb2827379fb9bd5d58bda52474b4ce22cdb
+  data.tar.gz: 045ae543497d77f74dfc7aea2e317fa5521b3b9bc31d4ca0733298d1555e773c
+SHA512:
+  metadata.gz: f3986c2e0e756b2e41904f33eb3116067557c3eb82852d1d2c222a0d2afdf4281766a331216e3d95e69113cffbe812974b18793b90344dfc97e942d8b6a2fc33
+  data.tar.gz: 97f6ee0db636710c51850d359e82302a49a33c7f05d7584492e7a43e33fb7b04d7fc34e9e8209b4b763044362ef75326aa8b482140e9beda2113748b60a8e729

data/LICENSE.txt

@@ -0,0 +1,191 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        https://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2013-2017 Docker, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       https://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,119 @@
+# HTTPX: A Ruby HTTP HTTPX for tomorrow... and beyond!
+
+[![pipeline status](https://gitlab.com/honeyryderchuck/httpx/badges/master/pipeline.svg)](https://gitlab.com/honeyryderchuck/httpx/commits/master)
+[![coverage report](https://gitlab.com/honeyryderchuck/httpx/badges/master/coverage.svg)](https://honeyryderchuck.gitlab.io/httpx/coverage/#_AllFiles)
+
+HTTPX is an HTTP client library for the Ruby programming language.
+
+Among its features, it supports:
+
+* HTTP/2 and HTTP/1.x protocol versions
+* Concurrent requests by default
+* Simple and chainable API (based on HTTP.rb, itself based on Python Requests)
+* Proxy Support (HTTP(S), Socks4/4a/5)
+* Simple Timeout System
+* Lightweight (explicit feature loading)
+
+And among others
+
+* Compression (gzip, deflate, brotli)
+* Authentication (Basic Auth, Digest Auth)
+* Cookies
+* HTTP/2 Server Push
+* H2C Upgrade
+* Redirect following
+
+## How
+
+Here are some simple examples:
+
+```ruby
+HTTPX.get("https://nghttp2.org").to_s #=> "<!DOCT...."
+```
+
+And that's the simplest one there is.
+
+If you want to do some more things with the response, you can get an `HTTPX::Response`:
+
+```ruby
+response = HTTPX.get("https://nghttp2.org")
+puts response.status #=> 200
+body = response.body
+puts body #=> #<HTTPX::Response ...
+``` 
+
+You can also send as many requests as you want simultaneously:
+
+```ruby
+page1, page2, page3 = HTTPX.get("https://news.ycombinator.com/news", "https://news.ycombinator.com/news?p=2", "https://news.ycombinator.com/news?p=3")
+```
+
+## Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem "httpx"
+```
+
+or install it in your system:
+
+```
+> gem install httpx
+```
+
+and then just require it in your program:
+
+```ruby
+require "httpx"
+```
+
+## Why Should I care?
+
+In Ruby, HTTP client implementations are a known cheap commodity. Why this one?
+
+### Concurrency
+
+This library supports HTTP/2 seamlessly (which means, if the request is secure, and the server support ALPN negotiation AND HTTP/2, the request will be made through HTTP/2). If you pass multiple URIs, and they can utilize the same connection, they will run concurrently in it. 
+
+However if the server supports HTTP/1.1, it will try to use HTTP pipelining, falling back to 1 request at a time if the server doesn't support it (if the server support Keep-Alive connections, it will reuse the same connection).
+
+### Clean API
+
+`HTTPX` acknowledges the ease-of-use of the [http gem](https://github.com/httprb/http) API (itself inspired by python [requests](http://docs.python-requests.org/en/latest/) library). It therefore aims at reusing the same facade, extending it for the use cases which the http gem doesn't support.
+
+### Lightweight
+
+It ships with a plugin system similar to the ones used by [sequel](https://github.com/jeremyevans/sequel), [roda](https://github.com/jeremyevans/roda) or [shrine](https://github.com/janko-m/shrine).
+
+It means that it loads the bare minimum to perform requests, and the user has to explicitly load the plugins, in order to get the features he/she needs.
+
+It also means that it ships with the minimum amount of dependencies.
+
+## Supported Rubies
+
+All Rubies greater or equal to 2.1, and always latest JRuby.
+
+## Resources
+
+| Website       | https://honeyryderchuck.gitlab.io/httpx/            |
+| Documentation | https://honeyryderchuck.gitlab.io/httpx/rdoc/       |
+| Wiki          | https://gitlab.com/honeyryderchuck/httpx/wikis/home |
+| CI            | https://gitlab.com/honeyryderchuck/httpx/pipelines  |
+
+## Caveats
+
+`HTTPS` TLS backend is ruby's own `openssl` gem.
+
+If your requirement is to run requests over HTTP/2 and TLS, make sure you run a version of the gem which compiles OpenSSL 1.0.2 (Ruby 2.3 and higher are guaranteed to).
+
+JRuby's `openssl` is based on Bouncy Castle, which is massively outdated and still doesn't implement ALPN. So HTTP/2 over TLS/ALPN negotiation is off until JRuby figures this out.
+
+## Contributing
+
+* Discuss your contribution in an issue
+* Fork it
+* Make your changes, add some test
+* Ensure all tests pass (`bundle exec rake test`)
+* Open a Merge Request (that's Pull Request in Github-ish)
+* Wait for feedback

data/lib/httpx.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "httpx/version"
+
+require "httpx/extensions"
+
+require "httpx/errors"
+require "httpx/callbacks"
+require "httpx/loggable"
+require "httpx/registry"
+require "httpx/transcoder"
+require "httpx/options"
+require "httpx/timeout"
+require "httpx/connection"
+require "httpx/headers"
+require "httpx/request"
+require "httpx/response"
+require "httpx/chainable"
+require "httpx/client"
+
+# Top-Level Namespace
+#
+module HTTPX
+  # All plugins should be stored under this module/namespace. Can register and load
+  # plugins.
+  #
+  module Plugins
+    @plugins = {}
+
+    # Loads a plugin based on a name. If the plugin hasn't been loaded, tries to load
+    # it from the load path under "httpx/plugins/" directory.
+    #
+    def self.load_plugin(name)
+      h = @plugins
+      unless (plugin = h[name])
+        require "httpx/plugins/#{name}"
+        raise "Plugin #{name} hasn't been registered" unless (plugin = h[name])
+      end
+      plugin
+    end
+
+    # Registers a plugin (+mod+) in the central store indexed by +name+.
+    #
+    def self.register_plugin(name, mod)
+      @plugins[name] = mod
+    end
+  end
+
+  extend Chainable
+end

data/lib/httpx/buffer.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module HTTPX
+  class Buffer
+    extend Forwardable
+
+    def_delegator :@buffer, :<<
+
+    def_delegator :@buffer, :to_s
+
+    def_delegator :@buffer, :to_str
+
+    def_delegator :@buffer, :empty?
+
+    def_delegator :@buffer, :bytesize
+
+    def_delegator :@buffer, :slice!
+
+    def_delegator :@buffer, :clear
+
+    def_delegator :@buffer, :replace
+
+    def initialize(limit)
+      @buffer = "".b
+      @limit = limit
+    end
+
+    def full?
+      @buffer.bytesize >= @limit
+    end
+  end
+end

data/lib/httpx/callbacks.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module HTTPX
+  module Callbacks
+    def on(type, &action)
+      callbacks(type) << action
+    end
+
+    def once(event, &block)
+      on(event) do |*args, &callback|
+        block.call(*args, &callback)
+        :delete
+      end
+    end
+
+    def emit(type, *args)
+      callbacks(type).delete_if { |pr| pr[*args] == :delete }
+    end
+
+    protected
+
+    def inherit_callbacks(callbackable)
+      @callbacks = callbackable.callbacks
+    end
+
+    def callbacks(type = nil)
+      return @callbacks unless type
+      @callbacks ||= Hash.new { |h, k| h[k] = [] }
+      @callbacks[type]
+    end
+  end
+end

data/lib/httpx/chainable.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module HTTPX
+  module Chainable
+    %i[head get post put delete trace options connect patch].each do |meth|
+      define_method meth do |*uri, **options|
+        request(meth, uri, **options)
+      end
+    end
+
+    def request(verb, uri, **options)
+      branch(default_options).request(verb, uri, **options)
+    end
+
+    def timeout(**args)
+      branch(timeout: args)
+    end
+
+    def headers(headers)
+      branch(default_options.with_headers(headers))
+    end
+
+    def accept(type)
+      headers("accept" => String(type))
+    end
+
+    def plugin(*plugins)
+      klass = is_a?(Client) ? self.class : Client
+      klass = Class.new(klass)
+      klass.instance_variable_set(:@default_options, klass.default_options.merge(default_options))
+      klass.plugins(plugins).new
+    end
+    alias_method :plugins, :plugin
+
+    def with(options)
+      branch(default_options.merge(options))
+    end
+
+    private
+
+    def default_options
+      @options || Options.new
+    end
+
+    # :nodoc:
+    def branch(options)
+      return self.class.new(options) if is_a?(Client)
+      Client.new(options)
+    end
+  end
+end