http-form_data 2.3.0 → 3.0.0

data/sig/http/form_data.rbs

@@ -0,0 +1,30 @@
+# Type signatures for the http-form_data gem
+
+module HTTP
+  module FormData
+    CRLF: String
+
+    class Error < StandardError
+    end
+
+    type formdata = Multipart | Urlencoded
+
+    # Selects encoder type based on given data
+    def self.create: (untyped data, ?encoder: _Encoder?) -> formdata
+
+    # Coerces obj to Hash
+    def self.ensure_hash: (untyped obj) -> Hash[untyped, untyped]
+
+    # Coerces obj to an Enumerable of key-value pairs
+    def self.ensure_data: (untyped obj) -> untyped
+
+    private
+
+    # Checks if data contains multipart data
+    def self.multipart?: (untyped data) -> bool
+
+    interface _Encoder
+      def call: (untyped data) -> String
+    end
+  end
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: http-form_data
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Aleksey V Zapparov
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-09 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Utility-belt to build form data request bodies. Provides support for
   `application/x-www-form-urlencoded` and `multipart/form-data` types.
@@ -18,19 +17,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
-- ".yardopts"
-- CHANGES.md
-- Gemfile
-- Guardfile
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- appveyor.yml
 - http-form_data.gemspec
 - lib/http/form_data.rb
 - lib/http/form_data/composite_io.rb
@@ -41,21 +30,25 @@ files:
 - lib/http/form_data/readable.rb
 - lib/http/form_data/urlencoded.rb
 - lib/http/form_data/version.rb
-- spec/fixtures/expected-multipart-body.tpl
-- spec/fixtures/the-http-gem.info
-- spec/lib/http/form_data/composite_io_spec.rb
-- spec/lib/http/form_data/file_spec.rb
-- spec/lib/http/form_data/multipart_spec.rb
-- spec/lib/http/form_data/part_spec.rb
-- spec/lib/http/form_data/urlencoded_spec.rb
-- spec/lib/http/form_data_spec.rb
-- spec/spec_helper.rb
-- spec/support/fixtures_helper.rb
-homepage: https://github.com/httprb/form_data.rb
+- sig/http/form_data.rbs
+- sig/http/form_data/composite_io.rbs
+- sig/http/form_data/file.rbs
+- sig/http/form_data/multipart.rbs
+- sig/http/form_data/multipart/param.rbs
+- sig/http/form_data/part.rbs
+- sig/http/form_data/readable.rbs
+- sig/http/form_data/urlencoded.rbs
+- sig/http/form_data/version.rbs
+homepage: https://github.com/httprb/form_data
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/httprb/form_data
+  source_code_uri: https://github.com/httprb/form_data/tree/v3.0.0
+  bug_tracker_uri: https://github.com/httprb/form_data/issues
+  changelog_uri: https://github.com/httprb/form_data/blob/v3.0.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/http-form_data/3.0.0
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -63,26 +56,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 4.0.3
 specification_version: 4
-summary: http-form_data-2.3.0
-test_files:
-- spec/fixtures/expected-multipart-body.tpl
-- spec/fixtures/the-http-gem.info
-- spec/lib/http/form_data/composite_io_spec.rb
-- spec/lib/http/form_data/file_spec.rb
-- spec/lib/http/form_data/multipart_spec.rb
-- spec/lib/http/form_data/part_spec.rb
-- spec/lib/http/form_data/urlencoded_spec.rb
-- spec/lib/http/form_data_spec.rb
-- spec/spec_helper.rb
-- spec/support/fixtures_helper.rb
+summary: Build form data request bodies
+test_files: []

data/.editorconfig

@@ -1,9 +0,0 @@
-root = true
-
-[*]
-indent_style = space
-indent_size = 2
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true

data/.gitignore

@@ -1,15 +0,0 @@
-/.bundle/
-/.yardoc
-/.ruby-version
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log

data/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

data/.rubocop.yml

@@ -1,64 +0,0 @@
-AllCops:
-  DisplayCopNames: true
-  TargetRubyVersion: 2.4
-
-## Metrics #####################################################################
-
-Metrics/BlockLength:
-  Exclude:
-    - "Guardfile"
-    - "spec/**/*"
-
-Metrics/MethodLength:
-  CountComments: false
-  Max: 15
-
-## Styles ######################################################################
-
-Style/AlignParameters:
-  EnforcedStyle: with_fixed_indentation
-
-Style/BracesAroundHashParameters:
-  Enabled: false
-
-Style/EmptyLineBetweenDefs:
-  AllowAdjacentOneLineDefs: true
-
-Style/Encoding:
-  EnforcedStyle: when_needed
-
-Style/HashSyntax:
-  EnforcedStyle: hash_rockets
-
-Style/IndentHash:
-  EnforcedStyle: consistent
-
-Style/IndentArray:
-  EnforcedStyle: consistent
-
-# New lambda syntax is as ugly to me as new syntax of Hash.
-Style/Lambda:
-  Enabled: false
-
-Style/MultilineOperationIndentation:
-  EnforcedStyle: indented
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/EmptyCaseCondition:
-  Enabled: false
-
-# Not all trivial readers/writers can be defined with attr_* methods
-#
-#   class Example < SimpleDelegator
-#     def __getobj__
-#       @obj
-#     end
-#
-#     def __setobj__(obj)
-#       @obj = obj
-#     end
-#   end
-Style/TrivialAccessors:
-  Enabled: false

data/.travis.yml

@@ -1,34 +0,0 @@
-language: ruby
-sudo: false
-
-cache: bundler
-
-before_install:
-  - gem update --system
-  - gem --version
-  - gem install bundler --no-document
-  - bundle --version
-
-install: bundle install --without development doc
-
-script: bundle exec rake
-
-env: JRUBY_OPTS="$JRUBY_OPTS --debug"
-
-rvm:
-  # Include JRuby first because it takes the longest
-  - jruby-9.1.13.0
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-
-matrix:
-  fast_finish: true
-  include:
-  - rvm: 2.7
-    env: SUITE="rubocop"
-
-branches:
-  only:
-    - master

data/.yardopts

@@ -1,2 +0,0 @@
---markup-provider=redcarpet
---markup=markdown

data/CHANGES.md

@@ -1,96 +0,0 @@
-## 2.3.0 (2020-03-08)
-
-* [#29](https://github.com/httprb/form_data/pull/29)
-  Enhance HTTP::FormData::Urlencoded with per-instance encoder.
-  [@summera][]
-
-
-## 2.2.0 (2020-01-09)
-
-* [#28](https://github.com/httprb/form_data/pull/28)
-  Ruby 2.7 compatibility.
-  [@janko][]
-
-
-## 2.1.1 (2018-06-01)
-
-* [#23](https://github.com/httprb/form_data/pull/23)
-  Allow override urlencoded form data encoder.
-  [@FabienChaynes][]
-
-
-## 2.1.0 (2018-03-05)
-
-* [#21](https://github.com/httprb/form_data/pull/21)
-  Rewind content at the end of `Readable#to_s`.
-  [@janko-m][]
-
-* [#19](https://github.com/httprb/form_data/pull/19)
-  Fix buffer encoding.
-  [@HoneyryderChuck][]
-
-
-## 2.0.0 (2017-10-01)
-
-* [#17](https://github.com/httprb/form_data/pull/17)
-  Add CRLF character to end of multipart body.
-  [@mhickman][]
-
-
-## 2.0.0.pre2 (2017-05-11)
-
-* [#14](https://github.com/httprb/form_data/pull/14)
-  Enable streaming for urlencoded form data.
-  [@janko-m][]
-
-
-## 2.0.0.pre1 (2017-05-10)
-
-* [#12](https://github.com/httprb/form_data.rb/pull/12)
-  Enable form data streaming.
-  [@janko-m][]
-
-
-## 1.0.2 (2017-05-08)
-
-* [#5](https://github.com/httprb/form_data.rb/issues/5)
-  Allow setting Content-Type non-file parts
-  [@abotalov][]
-
-* [#6](https://github.com/httprb/form_data.rb/issues/6)
-  Creation of file parts without filename
-  [@abotalov][]
-
-* [#11](https://github.com/httprb/form_data.rb/pull/11)
-  Deprecate `HTTP::FormData::File#mime_type`. Use `#content_type` instead.
-  [@ixti][]
-
-
-## 1.0.1 (2015-03-31)
-
-* Fix usage of URI module.
-
-
-## 1.0.0 (2015-01-04)
-
-* Gem renamed to `http-form_data` as `FormData` is not top-level citizen
-  anymore: `FormData -> HTTP::FormData`.
-
-
-## 0.1.0 (2015-01-02)
-
-* Move repo under `httprb` organization on GitHub.
-* Add `nil` support to `FormData#ensure_hash`.
-
-
-## 0.0.1 (2014-12-15)
-
-* First release ever!
-
-[@ixti]: https://github.com/ixti
-[@abotalov]: https://github.com/abotalov
-[@janko-m]: https://github.com/janko-m
-[@mhickman]: https://github.com/mhickman
-[@HoneyryderChuck]: https://github.com/HoneyryderChuck
-[@FabienChaynes]: https://github.com/FabienChaynes
-[@summera]: https://github.com/summera

data/Gemfile

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gem "rake"
-
-group :development do
-  gem "guard"
-  gem "guard-rspec", :require => false
-  gem "pry"
-end
-
-group :test do
-  gem "coveralls"
-  gem "rspec",      "~> 3.1"
-  gem "rubocop",    "= 0.48.1"
-  gem "simplecov",  ">= 0.9"
-end
-
-group :doc do
-  gem "redcarpet", :platform => :mri
-  gem "yard"
-end
-
-# Specify your gem's dependencies in form_data.gemspec
-gemspec

data/Guardfile

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-guard :rspec, :cmd => "bundle exec rspec" do
-  require "guard/rspec/dsl"
-  dsl = Guard::RSpec::Dsl.new(self)
-
-  # RSpec files
-  rspec = dsl.rspec
-  watch(rspec.spec_helper)  { rspec.spec_dir }
-  watch(rspec.spec_support) { rspec.spec_dir }
-  watch(rspec.spec_files)
-
-  # Ruby files
-  ruby = dsl.ruby
-  dsl.watch_spec_files_for(ruby.lib_files)
-end

data/Rakefile

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-
-require "rspec/core/rake_task"
-RSpec::Core::RakeTask.new
-
-begin
-  require "rubocop/rake_task"
-  RuboCop::RakeTask.new
-rescue LoadError
-  task :rubocop do
-    $stderr.puts "RuboCop is disabled"
-  end
-end
-
-if ENV["CI"].nil?
-  task :default => %i[spec rubocop]
-else
-  case ENV["SUITE"]
-  when "rubocop" then task :default => :rubocop
-  else                task :default => :spec
-  end
-end

data/appveyor.yml

@@ -1,8 +0,0 @@
-version: "#{build}"
-build: off
-install:
-  - set PATH=C:\Ruby23\bin;%PATH%
-  - bundle install
-test_script:
-  - bundle exec rake
-skip_tags: true

data/spec/fixtures/the-http-gem.info

@@ -1 +0,0 @@
-The HTTP Gem is an easy-to-use client library for making requests from Ruby.

data/spec/lib/http/form_data/composite_io_spec.rb

@@ -1,109 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe HTTP::FormData::CompositeIO do
-  subject(:composite_io) { HTTP::FormData::CompositeIO.new(ios) }
-
-  let(:ios) { ["Hello", " ", "", "world", "!"].map { |s| StringIO.new(s) } }
-
-  describe "#initialize" do
-    it "accepts IOs and strings" do
-      io = HTTP::FormData::CompositeIO.new(["Hello ", StringIO.new("world!")])
-      expect(io.read).to eq "Hello world!"
-    end
-
-    it "fails if an IO is neither a String nor an IO" do
-      expect { HTTP::FormData::CompositeIO.new %i[hello world] }
-        .to raise_error(ArgumentError)
-    end
-  end
-
-  describe "#read" do
-    it "reads all data" do
-      expect(composite_io.read).to eq "Hello world!"
-    end
-
-    it "reads partial data" do
-      expect(composite_io.read(3)).to eq "Hel"
-      expect(composite_io.read(2)).to eq "lo"
-      expect(composite_io.read(1)).to eq " "
-      expect(composite_io.read(6)).to eq "world!"
-    end
-
-    it "returns empty string when no data was retrieved" do
-      composite_io.read
-      expect(composite_io.read).to eq ""
-    end
-
-    it "returns nil when no partial data was retrieved" do
-      composite_io.read
-      expect(composite_io.read(3)).to eq nil
-    end
-
-    it "reads partial data with a buffer" do
-      outbuf = String.new
-      expect(composite_io.read(3, outbuf)).to eq "Hel"
-      expect(composite_io.read(2, outbuf)).to eq "lo"
-      expect(composite_io.read(1, outbuf)).to eq " "
-      expect(composite_io.read(6, outbuf)).to eq "world!"
-    end
-
-    it "fills the buffer with retrieved content" do
-      outbuf = String.new
-      composite_io.read(3, outbuf)
-      expect(outbuf).to eq "Hel"
-      composite_io.read(2, outbuf)
-      expect(outbuf).to eq "lo"
-      composite_io.read(1, outbuf)
-      expect(outbuf).to eq " "
-      composite_io.read(6, outbuf)
-      expect(outbuf).to eq "world!"
-    end
-
-    it "returns nil when no partial data was retrieved with a buffer" do
-      outbuf = String.new("content")
-      composite_io.read
-      expect(composite_io.read(3, outbuf)).to eq nil
-      expect(outbuf).to eq ""
-    end
-
-    it "returns data in binary encoding" do
-      io = HTTP::FormData::CompositeIO.new(%w[Janko Marohnić])
-
-      expect(io.read(5).encoding).to eq Encoding::BINARY
-      expect(io.read(9).encoding).to eq Encoding::BINARY
-
-      io.rewind
-      expect(io.read.encoding).to eq Encoding::BINARY
-      expect(io.read.encoding).to eq Encoding::BINARY
-    end
-
-    it "reads data in bytes" do
-      emoji = "😃"
-      io = HTTP::FormData::CompositeIO.new([emoji])
-
-      expect(io.read(1)).to eq emoji.b[0]
-      expect(io.read(1)).to eq emoji.b[1]
-      expect(io.read(1)).to eq emoji.b[2]
-      expect(io.read(1)).to eq emoji.b[3]
-    end
-  end
-
-  describe "#rewind" do
-    it "rewinds all IOs" do
-      composite_io.read
-      composite_io.rewind
-      expect(composite_io.read).to eq "Hello world!"
-    end
-  end
-
-  describe "#size" do
-    it "returns sum of all IO sizes" do
-      expect(composite_io.size).to eq 12
-    end
-
-    it "returns 0 when there are no IOs" do
-      empty_composite_io = HTTP::FormData::CompositeIO.new []
-      expect(empty_composite_io.size).to eq 0
-    end
-  end
-end