httparty 0.15.7 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8dd9a56f1d2f44c1625e80e31683c4e14d333495
-  data.tar.gz: 41a140c3370a9ce0bceaaff0c07fa1ac32491660
+  metadata.gz: 3b3d9cd5bf2c8c65e7c422ee6424b08fabde5bee
+  data.tar.gz: c5e5164791c0c4ab0c1dca1ad1b87385b382d36a
 SHA512:
-  metadata.gz: 14861c965bdad3631ee5e4ae9e51e044e65f30d5884ce32571e0add19c1fb7ba8962e6119e40cc112928744477c4187ca01e7bd2c8764d7a8f2c69609d1ffbeb
-  data.tar.gz: 2918c91eef01e6f88a6d7cb905998d35a9c18589835cad7b5668ba47a2f549fd1dc15d6db08e73b031701fcd8021d955971e82707e3b8d9d37610da1de4eba6d
+  metadata.gz: 27268caca0723458d76464e7e510eb737feb425a9a9f2007337d9f1e12976b0bfb5c39850a5654f990fe66d1f7a4a53d2de4de80b57bfd670e470c9269c25b1f
+  data.tar.gz: 3c7360f0232df51be5491f3c98bba7998b9321c42a5a845680be055b7929edc024a4a9fdad7aad14501ea3dba8875a5d9debfd24ba31e6a9779accf2e1935a9f

data/Changelog.md

@@ -1,3 +1,7 @@
+## 0.16.0
+
+* [Add multipart support](https://github.com/jnunemaker/httparty/pull/569)
+
 ## 0.15.7
 
 Fixed

data/examples/custom_parsers.rb

@@ -1,3 +1,7 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'httparty')
+require 'pp'
+
 class ParseAtom
   include HTTParty
 

data/examples/headers_and_user_agents.rb

@@ -1,6 +1,10 @@
 # To send custom user agents to identify your application to a web service (or mask as a specific browser for testing), send "User-Agent" as a hash to headers as shown below.
 
-require 'httparty'
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'httparty')
+require 'pp'
 
-APPLICATION_NAME = "Httparty"
-response = HTTParty.get('http://example.com', headers: {"User-Agent" => APPLICATION_NAME})
+response = HTTParty.get('http://example.com', {
+  headers: {"User-Agent" => "Httparty"},
+  debug_output: STDOUT, # To show that User-Agent is Httparty
+})

data/examples/logging.rb

@@ -3,7 +3,7 @@ require File.join(dir, 'httparty')
 require 'logger'
 require 'pp'
 
-my_logger = Logger.new "httparty.log"
+my_logger = Logger.new STDOUT
 
 my_logger.info "Logging can be used on the main HTTParty class. It logs redirects too."
 HTTParty.get "http://google.com", logger: my_logger
@@ -14,7 +14,7 @@ my_logger.info "It can be used also on a custom class."
 
 class Google
   include HTTParty
-  logger ::Logger.new "httparty.log"
+  logger ::Logger.new STDOUT
 end
 
 Google.get "http://google.com"
@@ -30,7 +30,7 @@ my_logger.info '*' * 70
 my_logger.info "These configs are also available on custom classes."
 class Google
   include HTTParty
-  logger ::Logger.new("httparty.log"), :debug, :curl
+  logger ::Logger.new(STDOUT), :debug, :curl
 end
 
 Google.get "http://google.com"

data/lib/httparty/hash_conversions.rb

@@ -24,32 +24,43 @@ module HTTParty
     #
     # @example normalize_param(:name, "Bob Jones") #=> "name=Bob%20Jones&"
     def self.normalize_param(key, value)
-      param = ''
+      normalized_keys = normalize_keys(key, value)
+
+      normalized_keys.inject('') do |string, (k, v)|
+        string + "#{k}=#{ERB::Util.url_encode(v.to_s)}&"
+      end
+    end
+
+    def self.normalize_keys(key, value)
       stack = []
+      normalized_keys = []
 
       if value.respond_to?(:to_ary)
-        param << if value.empty?
-                   "#{key}[]=&"
-                 else
-                   value.to_ary.map { |element| normalize_param("#{key}[]", element) }.join
-                 end
+        if value.empty?
+          normalized_keys << ["#{key}[]", '']
+        else
+          normalized_keys = value.to_ary.flat_map { |element| normalize_keys("#{key}[]", element) }
+        end
       elsif value.respond_to?(:to_hash)
         stack << [key, value.to_hash]
       else
-        param << "#{key}=#{ERB::Util.url_encode(value.to_s)}&"
+        normalized_keys << [key.to_s, value]
       end
 
+
       stack.each do |parent, hash|
-        hash.each do |k, v|
-          if v.respond_to?(:to_hash)
-            stack << ["#{parent}[#{k}]", v.to_hash]
+        hash.each do |key, value|
+          if value.respond_to?(:to_hash)
+            stack << ["#{parent}[#{key}]", value.to_hash]
+          elsif value.respond_to?(:to_ary)
+            value.to_ary.each { |v| normalized_keys << normalize_keys("#{parent}[#{key}][]", v).flatten }
           else
-            param << normalize_param("#{parent}[#{k}]", v)
+            normalized_keys << normalize_keys("#{parent}[#{key}]", value).flatten
           end
         end
       end
 
-      param
+      normalized_keys
     end
   end
 end

data/lib/httparty/request.rb

@@ -1,4 +1,5 @@
 require 'erb'
+require 'httparty/request/body'
 
 module HTTParty
   class Request #:nodoc:
@@ -176,10 +177,6 @@ module HTTParty
       connection_adapter.call(uri, options)
     end
 
-    def body
-      options[:body].respond_to?(:to_hash) ? normalize_query(options[:body]) : options[:body]
-    end
-
     def credentials
       (options[:basic_auth] || options[:digest_auth]).to_hash
     end
@@ -206,8 +203,17 @@ module HTTParty
 
     def setup_raw_request
       @raw_request = http_method.new(request_uri(uri))
-      @raw_request.body = body if body
       @raw_request.body_stream = options[:body_stream] if options[:body_stream]
+
+      if options[:body]
+        body = Body.new(options[:body], query_string_normalizer: query_string_normalizer)
+        if body.multipart?
+          content_type = "multipart/form-data; boundary=#{body.boundary}"
+          @raw_request.initialize_http_header('Content-Type' => content_type)
+        end
+        @raw_request.body = body.call
+      end
+
       if options[:headers].respond_to?(:to_hash)
         headers_hash = options[:headers].to_hash
 
@@ -220,6 +226,7 @@ module HTTParty
           @raw_request['accept-encoding'] = @raw_request['accept-encoding']
         end
       end
+
       if options[:basic_auth] && send_authorization_header?
         @raw_request.basic_auth(username, password)
         @credentials_sent = true

data/lib/httparty/request/body.rb

@@ -0,0 +1,77 @@
+require_relative 'multipart_boundary'
+
+module HTTParty
+  class Request
+    class Body
+      def initialize(params, query_string_normalizer: nil)
+        @params = params
+        @query_string_normalizer = query_string_normalizer
+      end
+
+      def call
+        if params.respond_to?(:to_hash)
+          multipart? ? generate_multipart : normalize_query(params)
+        else
+          params
+        end
+      end
+
+      def boundary
+        @boundary ||= MultipartBoundary.generate
+      end
+
+      def multipart?
+        params.respond_to?(:to_hash) && has_file?(params.to_hash)
+      end
+
+      private
+
+      def generate_multipart
+        normalized_params = params.flat_map { |key, value| HashConversions.normalize_keys(key, value) }
+
+        multipart = normalized_params.inject('') do |memo, (key, value)|
+          memo += "--#{boundary}\r\n"
+          memo += %(Content-Disposition: form-data; name="#{key}")
+          memo += %(; filename="#{File.basename(value)}") if file?(value)
+          memo += "\r\n"
+          memo += "Content-Type: application/octet-stream\r\n" if file?(value)
+          memo += "\r\n"
+          memo += file?(value) ? value.read : value
+          memo += "\r\n"
+        end
+
+        multipart += "--#{boundary}--\r\n"
+      end
+
+      def has_file?(hash)
+        hash.detect do |key, value|
+          if value.respond_to?(:to_hash) || includes_hash?(value)
+            has_file?(value)
+          elsif value.respond_to?(:to_ary)
+            value.any? { |e| file?(e) }
+          else
+            file?(value)
+          end
+        end
+      end
+
+      def file?(object)
+        object.respond_to?(:path) && object.respond_to?(:read) # add memoization
+      end
+
+      def includes_hash?(object)
+        object.respond_to?(:to_ary) && object.any? { |e| e.respond_to?(:hash) }
+      end
+
+      def normalize_query(query)
+        if query_string_normalizer
+          query_string_normalizer.call(query)
+        else
+          HashConversions.to_params(query)
+        end
+      end
+
+      attr_reader :params, :query_string_normalizer
+    end
+  end
+end

data/lib/httparty/request/multipart_boundary.rb

@@ -0,0 +1,11 @@
+require 'securerandom'
+
+module HTTParty
+  class Request
+    class MultipartBoundary
+      def self.generate
+        "------------------------#{SecureRandom.urlsafe_base64(12)}"
+      end
+    end
+  end
+end

data/lib/httparty/version.rb

@@ -1,3 +1,3 @@
 module HTTParty
-  VERSION = "0.15.7"
+  VERSION = "0.16.0"
 end

data/spec/httparty/request/body_spec.rb

@@ -0,0 +1,55 @@
+require_relative '../../spec_helper'
+
+RSpec.describe HTTParty::Request::Body do
+  describe '#call' do
+    subject { described_class.new(params).call }
+
+    context 'when params is string' do
+      let(:params) { 'name=Bob%20Jones' }
+
+      it { is_expected.to eq params }
+    end
+
+    context 'when params is hash' do
+      let(:params) { { people: ["Bob Jones", "Mike Smith"] } }
+      let(:converted_params) { "people[]=Bob%20Jones&people[]=Mike%20Smith"}
+
+      it { is_expected.to eq converted_params }
+
+      context 'when params has file' do
+        before do
+          allow(HTTParty::Request::MultipartBoundary).
+            to receive(:generate).and_return("------------------------c772861a5109d5ef")
+        end
+
+        let(:params) do
+          {
+            user: {
+              avatar: File.open('spec/fixtures/tiny.gif'),
+              first_name: 'John',
+              last_name: 'Doe'
+            }
+          }
+        end
+        let(:multipart_params) do
+          "--------------------------c772861a5109d5ef\r\n" \
+          "Content-Disposition: form-data; name=\"user[avatar]\"; filename=\"tiny.gif\"\r\n" \
+          "Content-Type: application/octet-stream\r\n" \
+          "\r\n" \
+          "GIF89a\u0001\u0000\u0001\u0000\u0000\xFF\u0000,\u0000\u0000\u0000\u0000\u0001\u0000\u0001\u0000\u0000\u0002\u0000;\r\n" \
+          "--------------------------c772861a5109d5ef\r\n" \
+          "Content-Disposition: form-data; name=\"user[first_name]\"\r\n" \
+          "\r\n" \
+          "John\r\n" \
+          "--------------------------c772861a5109d5ef\r\n" \
+          "Content-Disposition: form-data; name=\"user[last_name]\"\r\n" \
+          "\r\n" \
+          "Doe\r\n" \
+          "--------------------------c772861a5109d5ef--\r\n"
+        end
+
+        it { is_expected.to eq multipart_params }
+      end
+    end
+  end
+end

data/spec/httparty_spec.rb

@@ -188,6 +188,23 @@ RSpec.describe HTTParty do
         @klass.get('', cookies: {type: 'snickerdoodle'}, headers: {baz: 'spax'})
       end
     end
+
+    context 'when posting file' do
+      let(:boundary) { '------------------------c772861a5109d5ef' }
+      let(:headers) do
+        { 'Content-Type'=>"multipart/form-data; boundary=#{boundary}" }
+      end
+
+      before do
+        expect(HTTParty::Request::MultipartBoundary).to receive(:generate).and_return(boundary)
+      end
+
+      it 'changes content-type headers to multipart/form-data' do
+        stub_request(:post, "http://example.com/").with(headers: headers)
+
+        @klass.post('http://example.com', body: { file: File.open('spec/fixtures/tiny.gif')})
+      end
+    end
   end
 
   describe "cookies" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: httparty
 version: !ruby/object:Gem::Version
-  version: 0.15.7
+  version: 0.16.0
 platform: ruby
 authors:
 - John Nunemaker
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-07 00:00:00.000000000 Z
+date: 2018-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_xml
@@ -92,6 +92,8 @@ files:
 - lib/httparty/net_digest_auth.rb
 - lib/httparty/parser.rb
 - lib/httparty/request.rb
+- lib/httparty/request/body.rb
+- lib/httparty/request/multipart_boundary.rb
 - lib/httparty/response.rb
 - lib/httparty/response/headers.rb
 - lib/httparty/version.rb
@@ -107,6 +109,7 @@ files:
 - spec/fixtures/ssl/generated/server.crt
 - spec/fixtures/ssl/generated/server.key
 - spec/fixtures/ssl/openssl-exts.cnf
+- spec/fixtures/tiny.gif
 - spec/fixtures/twitter.csv
 - spec/fixtures/twitter.json
 - spec/fixtures/twitter.xml
@@ -120,6 +123,7 @@ files:
 - spec/httparty/logger/logger_spec.rb
 - spec/httparty/net_digest_auth_spec.rb
 - spec/httparty/parser_spec.rb
+- spec/httparty/request/body_spec.rb
 - spec/httparty/request_spec.rb
 - spec/httparty/response_spec.rb
 - spec/httparty/ssl_spec.rb
@@ -180,6 +184,7 @@ test_files:
 - spec/fixtures/ssl/generated/server.crt
 - spec/fixtures/ssl/generated/server.key
 - spec/fixtures/ssl/openssl-exts.cnf
+- spec/fixtures/tiny.gif
 - spec/fixtures/twitter.csv
 - spec/fixtures/twitter.json
 - spec/fixtures/twitter.xml
@@ -193,6 +198,7 @@ test_files:
 - spec/httparty/logger/logger_spec.rb
 - spec/httparty/net_digest_auth_spec.rb
 - spec/httparty/parser_spec.rb
+- spec/httparty/request/body_spec.rb
 - spec/httparty/request_spec.rb
 - spec/httparty/response_spec.rb
 - spec/httparty/ssl_spec.rb