faraday-gzip 0.1.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '051489969db6aaa4791f080d6128042153c109f0e12ff479aa183a84f97410aa'
+  data.tar.gz: e077af7059120447e3e108743b7b39a9be75e2e75674e4d0a52471956678857c
+SHA512:
+  metadata.gz: 31cfe83b44cd5ec13f2eb86ab4769ac4c18d11676104528cbac006f5e88ab6c71056ff91c8be1e978693b15957cb41a8420aa0bcc99170354ff7a66f9769987a
+  data.tar.gz: f617a27db54e84099aeed3db1fd671a4c80c3b9c83883b904cee142eb186d90a1eb9325aaae2c807e83022027af74dc1fc9b8405c32a81128151ea29b5fa49bb

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.0.rc1
+
+* Initial release.

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+<% require 'date' %>
+Copyright (c) 2022 Ilya Bodrov-Krukowski
+
+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,57 @@
+# Faraday Gzip
+
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/lostisland/faraday-gzip/ci)](https://github.com/lostisland/faraday-gzip/actions?query=branch%3Amain)
+[![Gem](https://img.shields.io/gem/v/faraday-gzip.svg?style=flat-square)](https://rubygems.org/gems/faraday-gzip)
+[![License](https://img.shields.io/github/license/lostisland/faraday-gzip.svg?style=flat-square)](LICENSE.md)
+
+The `Gzip` middleware adds the necessary `Accept-Encoding` headers and automatically decompresses the response. If the "Accept-Encoding" header wasn't set in the request, this sets it to "gzip,deflate" and appropriately handles the compressed response from the server. This resembles what Ruby does internally in Net::HTTP#get. If Brotli is added to the Gemfile, it will also add "br" to the header.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faraday-gzip'
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+Or install it yourself as:
+
+```shell
+gem install faraday-gzip
+```
+
+## Usage
+
+```ruby
+require 'faraday/gzip'
+
+conn = Faraday.new(...) do |f|
+  f.request :gzip
+  #...
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+Then, run `bin/test` to run the tests.
+
+To install this gem onto your local machine, run `rake build`.
+
+To release a new version, make a commit with a message such as "Bumped to 0.0.2" and then run `rake release`.
+See how it works [here](https://bundler.io/guides/creating_gem.html#releasing-the-gem).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/faraday/gzip/middleware.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require 'zlib'
+
+module Faraday
+  module Gzip
+    # Middleware to automatically decompress response bodies. If the
+    # "Accept-Encoding" header wasn't set in the request, this sets it to
+    # "gzip,deflate" and appropriately handles the compressed response from the
+    # server. This resembles what Ruby 1.9+ does internally in Net::HTTP#get.
+
+    class Middleware < Faraday::Middleware
+      def self.optional_dependency(lib = nil)
+        lib ? require(lib) : yield
+        true
+      rescue LoadError, NameError
+        false
+      end
+
+      BROTLI_SUPPORTED = optional_dependency 'brotli'
+
+      def self.supported_encodings
+        encodings = %w[gzip deflate]
+        encodings << 'br' if BROTLI_SUPPORTED
+        encodings
+      end
+
+      ACCEPT_ENCODING = 'Accept-Encoding'
+      CONTENT_ENCODING = 'Content-Encoding'
+      CONTENT_LENGTH = 'Content-Length'
+      SUPPORTED_ENCODINGS = supported_encodings.join(',').freeze
+
+      def call(env)
+        env[:request_headers][ACCEPT_ENCODING] ||= SUPPORTED_ENCODINGS
+        @app.call(env).on_complete do |response_env|
+          if response_env[:body].empty?
+            reset_body(response_env) { |body| raw_body(body) }
+          else
+            case response_env[:response_headers][CONTENT_ENCODING]
+            when 'gzip'
+              reset_body(response_env) { |body| uncompress_gzip(body) }
+            when 'deflate'
+              reset_body(response_env) { |body| inflate(body) }
+            when 'br'
+              reset_body(response_env) { |body| brotli_inflate(body) }
+            end
+          end
+        end
+      end
+
+      def reset_body(env)
+        env[:body] = yield(env[:body])
+        env[:response_headers].delete(CONTENT_ENCODING)
+        env[:response_headers][CONTENT_LENGTH] = env[:body].length
+      end
+
+      def uncompress_gzip(body)
+        io = StringIO.new(body)
+        gzip_reader = Zlib::GzipReader.new(io, encoding: 'ASCII-8BIT')
+        gzip_reader.read
+      end
+
+      def inflate(body)
+        # Inflate as a DEFLATE (RFC 1950+RFC 1951) stream
+        Zlib::Inflate.inflate(body)
+      rescue Zlib::DataError
+        # Fall back to inflating as a "raw" deflate stream which
+        # Microsoft servers return
+        inflate = Zlib::Inflate.new(-Zlib::MAX_WBITS)
+        begin
+          inflate.inflate(body)
+        ensure
+          inflate.close
+        end
+      end
+
+      def brotli_inflate(body)
+        Brotli.inflate(body)
+      end
+
+      def raw_body(body)
+        body
+      end
+    end
+  end
+end

data/lib/faraday/gzip/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Faraday
+  module Gzip
+    VERSION = '0.1.0.rc1'
+  end
+end

data/lib/faraday/gzip.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require_relative 'gzip/middleware'
+require_relative 'gzip/version'
+
+module Faraday
+  # Middleware main module.
+  module Gzip
+    Faraday::Request.register_middleware(gzip: Faraday::Gzip::Middleware)
+  end
+end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: faraday-gzip
+version: !ruby/object:Gem::Version
+  version: 0.1.0.rc1
+platform: ruby
+authors:
+- Ilya Bodrov-Krukowski
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: zlib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.25.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.25.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-packaging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 'Faraday plugin to automatically set compression headers (GZip, Deflate,
+  Brotli) and decompress the response.
+
+  '
+email:
+- golosizpru@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- lib/faraday/gzip.rb
+- lib/faraday/gzip/middleware.rb
+- lib/faraday/gzip/version.rb
+homepage: https://github.com/lostisland/faraday-gzip
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/lostisland/faraday-gzip/issues
+  changelog_uri: https://github.com/lostisland/faraday-gzip/blob/v0.1.0.rc1/CHANGELOG.md
+  documentation_uri: http://www.rubydoc.info/gems/faraday-gzip/0.1.0.rc1
+  homepage_uri: https://github.com/lostisland/faraday-gzip
+  source_code_uri: https://github.com/lostisland/faraday-gzip
+  wiki_uri: https://github.com/lostisland/faraday-gzip/wiki
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.3.5
+signing_key:
+specification_version: 4
+summary: Automatically sets compression headers and decompresses the response
+test_files: []