httparty 0.16.2 → 0.16.3

data/lib/httparty/logger/curl_formatter.rb

@@ -20,7 +20,7 @@ module HTTParty
         log_request
         log_response
 
-        logger.send level, messages.join("\n")
+        logger.public_send level, messages.join("\n")
       end
 
       private
@@ -80,11 +80,11 @@ module HTTParty
       end
 
       def log(direction, line = '')
-        messages << "[#{TAG_NAME}] [#{time}] #{direction} #{line}"
+        messages << "[#{TAG_NAME}] [#{current_time}] #{direction} #{line}"
       end
 
-      def time
-        @time ||= Time.now.strftime("%Y-%m-%d %H:%M:%S %z")
+      def current_time
+        Time.now.strftime("%Y-%m-%d %H:%M:%S %z")
       end
     end
   end

data/lib/httparty/logger/logger.rb

@@ -1,12 +1,14 @@
 require 'httparty/logger/apache_formatter'
 require 'httparty/logger/curl_formatter'
+require 'httparty/logger/logstash_formatter'
 
 module HTTParty
   module Logger
     def self.formatters
       @formatters ||= {
         :curl => Logger::CurlFormatter,
-        :apache => Logger::ApacheFormatter
+        :apache => Logger::ApacheFormatter,
+        :logstash => Logger::LogstashFormatter,
       }
     end
 

data/lib/httparty/logger/logstash_formatter.rb

@@ -0,0 +1,59 @@
+module HTTParty
+  module Logger
+    class LogstashFormatter #:nodoc:
+      TAG_NAME = HTTParty.name
+
+      attr_accessor :level, :logger
+
+      def initialize(logger, level)
+        @logger = logger
+        @level  = level.to_sym
+      end
+
+      def format(request, response)
+        @request = request
+        @response = response
+
+        logger.public_send level, logstash_message
+      end
+
+      private
+
+      attr_reader :request, :response
+
+      def logstash_message
+        {
+          '@timestamp' => current_time,
+          '@version' => 1,
+          'content_length' => content_length || '-',
+          'http_method' => http_method,
+          'message' => message,
+          'path' => path,
+          'response_code' => response.code,
+          'severity' => level,
+          'tags' => [TAG_NAME],
+        }.to_json
+      end
+
+      def message
+        "[#{TAG_NAME}] #{response.code} \"#{http_method} #{path}\" #{content_length || '-'} "
+      end
+
+      def current_time
+        Time.now.strftime("%Y-%m-%d %H:%M:%S %z")
+      end
+
+      def http_method
+        @http_method ||= request.http_method.name.split("::").last.upcase
+      end
+
+      def path
+        @path ||= request.path.to_s
+      end
+
+      def content_length
+        @content_length ||= response.respond_to?(:headers) ? response.headers['Content-Length'] : response['Content-Length']
+      end
+    end
+  end
+end

data/lib/httparty/module_inheritable_attributes.rb

@@ -9,12 +9,12 @@ module HTTParty
       duplicate = hash.dup
 
       duplicate.each_pair do |key, value|
-        duplicate[key] = if value.is_a?(Hash)
-                           hash_deep_dup(value)
+        if value.is_a?(Hash)
+          duplicate[key] = hash_deep_dup(value)
         elsif value.is_a?(Proc)
           duplicate[key] = value.dup
         else
-          value
+          duplicate[key] = value
         end
       end
 

data/lib/httparty/net_digest_auth.rb

@@ -14,11 +14,11 @@ module Net
 
       authenticator.authorization_header.each do |v|
         add_field('Authorization', v)
-      end 
+      end
 
       authenticator.cookie_header.each do |v|
         add_field('Cookie', v)
-      end      
+      end
     end
 
     class DigestAuthenticator
@@ -64,7 +64,8 @@ module Net
 
       def parse(response_header)
         header = response_header['www-authenticate']
-                 .gsub(/qop=(auth(?:-int)?)/, 'qop="\\1"')
+
+        header = header.gsub(/qop=(auth(?:-int)?)/, 'qop="\\1"')
 
         header =~ /Digest (.*)/
         params = {}
@@ -113,11 +114,11 @@ module Net
       def algorithm_present?
         @response.key?('algorithm') && !@response['algorithm'].empty?
       end
-      
+
       def use_md5_sess?
         algorithm_present? && @response['algorithm'] == 'MD5-sess'
       end
-      
+
       def a1
         a1_user_realm_pwd =  [@username, @response['realm'], @password].join(':')
         if use_md5_sess?

data/lib/httparty/request.rb

@@ -14,6 +14,8 @@ module HTTParty
       Net::HTTP::Move,
       Net::HTTP::Copy,
       Net::HTTP::Mkcol,
+      Net::HTTP::Lock,
+      Net::HTTP::Unlock,
     ]
 
     SupportedURISchemes  = ['http', 'https', 'webcal', nil]
@@ -219,7 +221,12 @@ module HTTParty
       end
 
       if options[:body]
-        body = Body.new(options[:body], query_string_normalizer: query_string_normalizer)
+        body = Body.new(
+          options[:body],
+          query_string_normalizer: query_string_normalizer,
+          force_multipart: options[:multipart]
+        )
+
         if body.multipart?
           content_type = "multipart/form-data; boundary=#{body.boundary}"
           @raw_request['Content-Type'] = content_type

data/lib/httparty/request/body.rb

@@ -3,9 +3,10 @@ require_relative 'multipart_boundary'
 module HTTParty
   class Request
     class Body
-      def initialize(params, query_string_normalizer: nil)
+      def initialize(params, query_string_normalizer: nil, force_multipart: false)
         @params = params
         @query_string_normalizer = query_string_normalizer
+        @force_multipart = force_multipart
       end
 
       def call
@@ -21,7 +22,7 @@ module HTTParty
       end
 
       def multipart?
-        params.respond_to?(:to_hash) && has_file?(params.to_hash)
+        params.respond_to?(:to_hash) && (force_multipart || has_file?(params.to_hash))
       end
 
       private
@@ -34,9 +35,9 @@ module HTTParty
           memo += %(Content-Disposition: form-data; name="#{key}")
           # value.path is used to support ActionDispatch::Http::UploadedFile
           # https://github.com/jnunemaker/httparty/pull/585
-          memo += %(; filename="#{File.basename(value.path)}") if file?(value)
+          memo += %(; filename="#{file_name(value)}") if file?(value)
           memo += "\r\n"
-          memo += "Content-Type: application/octet-stream\r\n" if file?(value)
+          memo += "Content-Type: #{content_type(value)}\r\n" if file?(value)
           memo += "\r\n"
           memo += file?(value) ? value.read : value.to_s
           memo += "\r\n"
@@ -73,7 +74,17 @@ module HTTParty
         end
       end
 
-      attr_reader :params, :query_string_normalizer
+      def content_type(object)
+        return object.content_type if object.respond_to?(:content_type)
+        mime = MIME::Types.type_for(object.path)
+        mime.empty? ? 'application/octet-stream' : mime[0].content_type
+      end
+
+      def file_name(object)
+        object.respond_to?(:original_filename) ? object.original_filename : File.basename(object.path)
+      end
+
+      attr_reader :params, :query_string_normalizer, :force_multipart
     end
   end
 end

data/lib/httparty/response.rb

@@ -4,6 +4,12 @@ module HTTParty
       string.gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').gsub(/([a-z])([A-Z])/, '\1_\2').downcase
     end
 
+    def self._load(data)
+      req, resp, parsed_resp, resp_body = Marshal.load(data)
+
+      new(req, resp, -> { parsed_resp }, body: resp_body)
+    end
+
     attr_reader :request, :response, :body, :headers
 
     def initialize(request, response, parsed_block, options = {})
@@ -14,7 +20,11 @@ module HTTParty
       @headers      = Headers.new(response.to_hash)
 
       if request.options[:logger]
-        logger = ::HTTParty::Logger.build(request.options[:logger], request.options[:log_level], request.options[:log_format])
+        logger = ::HTTParty::Logger.build(
+          request.options[:logger],
+          request.options[:log_level],
+          request.options[:log_format]
+        )
         logger.format(request, self)
       end
 
@@ -59,10 +69,10 @@ module HTTParty
       response.nil? || response.body.nil? || response.body.empty?
     end
 
-    def to_s      
+    def to_s
       if !response.nil? && !response.body.nil? && response.body.respond_to?(:to_s)
         response.body.to_s
-      else 
+      else
         inspect
       end
     end
@@ -80,7 +90,7 @@ module HTTParty
         parsed_response.display(port)
       elsif !response.nil? && !response.body.nil? && response.body.respond_to?(:display)
         response.body.display(port)
-      else 
+      else
         port.write(inspect)
       end
     end
@@ -89,7 +99,11 @@ module HTTParty
       return true if super
       parsed_response.respond_to?(name) || response.respond_to?(name)
     end
-    
+
+    def _dump(_level)
+      Marshal.dump([request, response, parsed_response, body])
+    end
+
     protected
 
     def method_missing(name, *args, &block)

data/lib/httparty/response/headers.rb

@@ -22,10 +22,10 @@ module HTTParty
       end
 
       def ==(other)
-        if other.is_a?(::Net::HTTPHeader) 
+        if other.is_a?(::Net::HTTPHeader)
           @header == other.instance_variable_get(:@header)
         elsif other.is_a?(Hash)
-          @header == other || @header == Headers.new(other).instance_variable_get(:@header)           
+          @header == other || @header == Headers.new(other).instance_variable_get(:@header)
         end
       end
     end

data/lib/httparty/utils.rb

@@ -0,0 +1,11 @@
+module HTTParty
+  module Utils
+    def self.stringify_keys(hash)
+      return hash.transform_keys(&:to_s) if hash.respond_to?(:transform_keys)
+
+      hash.each_with_object({}) do |(key, value), new_hash|
+        new_hash[key.to_s] = value
+      end
+    end
+  end
+end

data/lib/httparty/version.rb

@@ -1,3 +1,3 @@
 module HTTParty
-  VERSION = "0.16.2"
+  VERSION = "0.16.3"
 end

data/spec/httparty/connection_adapter_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+require 'spec_helper'
 
 RSpec.describe HTTParty::ConnectionAdapter do
   describe "initialization" do
@@ -312,8 +312,12 @@ RSpec.describe HTTParty::ConnectionAdapter do
 
         context 'as well as proxy user and password' do
           let(:options) do
-            {http_proxyaddr: '1.2.3.4', http_proxyport: 8080,
-             http_proxyuser: 'user', http_proxypass: 'pass'}
+            {
+              http_proxyaddr: '1.2.3.4',
+              http_proxyport: 8080,
+              http_proxyuser: 'user',
+              http_proxypass: 'pass'
+            }
           end
 
           describe '#proxy_user' do

data/spec/httparty/cookie_hash_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '../spec_helper'))
+require 'spec_helper'
 
 RSpec.describe HTTParty::CookieHash do
   before(:each) do

data/spec/httparty/exception_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+require 'spec_helper'
 
 RSpec.describe HTTParty::Error do
   subject { described_class }

data/spec/httparty/hash_conversions_spec.rb

@@ -1,3 +1,5 @@
+require 'spec_helper'
+
 RSpec.describe HTTParty::HashConversions do
   describe ".to_params" do
     it "creates a params string from a hash" do

data/spec/httparty/logger/apache_formatter_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'spec_helper'))
+require 'spec_helper'
 
 RSpec.describe HTTParty::Logger::ApacheFormatter do
   let(:subject) { described_class.new(logger_double, :info) }
@@ -7,7 +7,6 @@ RSpec.describe HTTParty::Logger::ApacheFormatter do
   let(:request_time) { Time.new.strftime("%Y-%m-%d %H:%M:%S %z") }
 
   before do
-    subject.current_time = request_time
     expect(logger_double).to receive(:info).with(log_message)
   end
 

data/spec/httparty/logger/curl_formatter_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'spec_helper'))
+require 'spec_helper'
 
 RSpec.describe HTTParty::Logger::CurlFormatter do
   describe "#format" do

data/spec/httparty/logger/logger_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'spec_helper'))
+require 'spec_helper'
 
 RSpec.describe HTTParty::Logger do
   describe ".build" do
@@ -19,6 +19,11 @@ RSpec.describe HTTParty::Logger do
       expect(subject.build(logger_double, nil, :curl)).to be_an_instance_of(HTTParty::Logger::CurlFormatter)
     end
 
+    it "builds :logstash style logger" do
+      logger_double = double
+      expect(subject.build(logger_double, nil, :logstash)).to be_an_instance_of(HTTParty::Logger::LogstashFormatter)
+    end
+
     it "builds :custom style logger" do
       CustomFormatter = Class.new(HTTParty::Logger::CurlFormatter)
       HTTParty::Logger.add_formatter(:custom, CustomFormatter)

data/spec/httparty/logger/logstash_formatter_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+RSpec.describe HTTParty::Logger::LogstashFormatter do
+  let(:severity) { :info }
+  let(:http_method) { 'GET' }
+  let(:path) { 'http://my.domain.com/my_path' }
+  let(:logger_double) { double('Logger') }
+  let(:request_double) { double('Request', http_method: Net::HTTP::Get, path: "#{path}") }
+  let(:request_time) { Time.new.strftime("%Y-%m-%d %H:%M:%S %z") }
+  let(:log_message) do
+    {
+      '@timestamp' => request_time,
+      '@version' => 1,
+      'content_length' => content_length || '-',
+      'http_method' => http_method,
+      'message' => message,
+      'path' => path,
+      'response_code' => response_code,
+      'severity' => severity,
+      'tags' => ['HTTParty'],
+    }.to_json
+  end
+
+  subject { described_class.new(logger_double, severity) }
+
+  before do
+    expect(logger_double).to receive(:info).with(log_message)
+  end
+
+  describe "#format" do
+    let(:response_code) { 302 }
+    let(:content_length) { '-' }
+    let(:message) { "[HTTParty] #{response_code} \"#{http_method} #{path}\" #{content_length} " }
+
+    it "formats a response to be compatible with Logstash" do
+      response_double = double(
+        code: response_code,
+        :[] => nil
+      )
+
+      subject.format(request_double, response_double)
+    end
+  end
+end