httparty 0.16.2 → 0.16.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 255d54a6f0cad04486f09e887f8787725421fece
-  data.tar.gz: d1b74c09b4ef625e5fc4ef791dc896c792a79e19
+  metadata.gz: d2efd166a0534991fe03c8f0ae6a72424c9e8c3d
+  data.tar.gz: 41ec81b8fbd9ae18ae51f8b93ce0a36e6b1174c8
 SHA512:
-  metadata.gz: 6ba5c551dec574810d6e2fe84b639660d7f6c36b2ee667bcf91cae9eb978567d0a076eaff3d80886c0d8b9f225c018561d28f51a09ebbe7102b62fcff17ec8f1
-  data.tar.gz: e5a1beb085744c890aff8cb42f238a1f2d5e041328d94cc2a5fafab75ca6f21385d4d4fa50a60c4033cedbcf611e10d4809c6337de2b98ce4a42fe32719773a4
+  metadata.gz: 53473b5f6b517e590cf7cd5937dee78c6493226ad6508865e9e57efe844b62218473e7137ea83a902de113221f53e0626f163eea39ac5d1094a65a7253e6a7ff
+  data.tar.gz: 4490aaf02f3bbf8eee7568bf62e37ea0c1d23caef64338b1dd09688efa8fe1b3b9047c3891d6e822f88b61b16ad9aa27618437d307b722d8b52e90f9016db8a9

data/.editorconfig

@@ -0,0 +1,18 @@
+; This file is for unifying the coding style for different editors and IDEs.
+; More information at http://EditorConfig.org
+
+root = true
+[*]
+end_of_line = lf
+trim_trailing_whitespace = true
+
+[**.rb]
+indent_size = 2
+indent_style = spaces
+insert_final_newline = true
+
+[**.xml]
+trim_trailing_whitespace = false
+
+[**.html]
+trim_trailing_whitespace = false

data/.gitignore

@@ -10,3 +10,4 @@ pkg/
 .rvmrc
 coverage
 *.gem
+.idea

data/Changelog.md

@@ -1,3 +1,14 @@
+
+## 0.16.3
+* [Add Logstash-compatible formatter](https://github.com/jnunemaker/httparty/pull/612)
+* [Add support for headers specified with symbols](https://github.com/jnunemaker/httparty/pull/622)
+* [Fix response object marshalling](https://github.com/jnunemaker/httparty/pull/618)
+* [Add ability to send multipart, without passing file](https://github.com/jnunemaker/httparty/pull/615)
+* [Fix detection of content_type for multipart payload](https://github.com/jnunemaker/httparty/pull/616)
+* [Process dynamic headers before making actual request](https://github.com/jnunemaker/httparty/pull/606)
+* [Fix multipart uploads with ActionDispatch::Http::UploadedFile TempFile by using original_filename](https://github.com/jnunemaker/httparty/pull/598)
+* [Added support for lock and unlock http requests](https://github.com/jnunemaker/httparty/pull/596)
+
 ## 0.16.2
 
 * [Support ActionDispatch::Http::UploadedFile again](https://github.com/jnunemaker/httparty/pull/585)

data/README.md

@@ -64,7 +64,7 @@ httparty "https://api.stackexchange.com/2.2/questions?site=stackoverflow"
 
 * [Docs](https://github.com/jnunemaker/httparty/tree/master/docs)
 * https://groups.google.com/forum/#!forum/httparty-gem
-* http://rdoc.info/projects/jnunemaker/httparty
+* https://www.rubydoc.info/github/jnunemaker/httparty
 * http://stackoverflow.com/questions/tagged/httparty
 
 ## Contributing

data/examples/README.md

@@ -13,22 +13,22 @@
     * Creates a custom parser for XML using crack gem
     * Uses `get` request
 
-* [Create HTML Nokogiri parser](nokogiri_html_parser.rb)   
+* [Create HTML Nokogiri parser](nokogiri_html_parser.rb)
     * Adds Html as a format
     * passed the body of request to Nokogiri
-    
+
 * [More Custom Parsers](custom_parsers.rb)
   * Create an additional parser for atom or make it the ONLY parser
-  
+
 * [Basic Auth, Delicious](delicious.rb)
   * Basic Auth, shows how to merge those into options
   * Uses `get` requests
-  
+
 * [Passing Headers, User Agent](headers_and_user_agents.rb)
   * Use the class method of Httparty
   * Pass the User-Agent in the headers
   * Uses `get` requests
-  
+
 * [Basic Post Request](basic.rb)
     * Httparty included into poro class
     * Uses `post` requests
@@ -36,7 +36,7 @@
 * [Access Rubyurl Shortener](rubyurl.rb)
   * Httparty included into poro class
   * Uses `post` requests
-  
+
 * [Add a custom log file](logging.rb)
   * create a log file and have httparty log requests
 
@@ -44,23 +44,23 @@
   * Httparty included into poro class
   * Creates methods for different endpoints
   * Uses `get` requests
-  
+
 * [Accessing Tripit](tripit_sign_in.rb)
   * Httparty included into poro class
   * Example of using `debug_output` to see headers/urls passed
   * Getting and using Cookies
   * Uses `get` requests
-  
+
 * [Accessing Twitter](twitter.rb)
   * Httparty included into poro class
   * Basic Auth
-  * Loads settings from a config file 
+  * Loads settings from a config file
   * Uses `get` requests
   * Uses `post` requests
-  
+
 * [Accessing WhoIsMyRep](whoismyrep.rb)
   * Httparty included into poro class
-  * Uses `get` requests     
+  * Uses `get` requests
   * Two ways to pass params to get, inline on the url or in query hash
 
 * [Rescue Json Error](rescue_json.rb)
@@ -70,3 +70,14 @@
   * Uses `get` requests
   * Uses `stream_body` mode
   * Download file without using the memory
+
+* [Microsoft graph](microsoft_graph.rb)
+  * Basic Auth
+  * Uses `post` requests
+  * Uses multipart
+
+* [Multipart](multipart.rb)
+  * Multipart data upload _(with and without file)_
+
+* [Uploading File](body_stream.rb)
+  * Uses `body_stream` to upload file

data/examples/body_stream.rb

@@ -0,0 +1,14 @@
+# To upload file to a server use :body_stream
+
+HTTParty.put(
+  'http://localhost:3000/train',
+  body_stream: File.open('sample_configs/config_train_server_md.yml', 'r')
+)
+
+
+# Actually, it works with any IO object
+
+HTTParty.put(
+  'http://localhost:3000/train',
+  body_stream: StringIO.new('foo')
+)

data/examples/microsoft_graph.rb

@@ -0,0 +1,52 @@
+require 'httparty'
+
+class MicrosoftGraph
+  MS_BASE_URL = "https://login.microsoftonline.com".freeze
+  TOKEN_REQUEST_PATH = "oauth2/v2.0/token".freeze
+
+  def initialize(tenant_id)
+    @tenant_id = tenant_id
+  end
+
+  # Make a request to the Microsoft Graph API, for instance https://graph.microsoft.com/v1.0/users
+  def request(url)
+    return false unless (token = bearer_token)
+
+    response = HTTParty.get(
+      url,
+      headers: {
+        Authorization: "Bearer #{token}"
+      }
+    )
+
+    return false unless response.code == 200
+
+    return JSON.parse(response.body)
+  end
+
+  private
+
+  # A post to the Microsoft Graph to get a bearer token for the specified tenant.  In this example
+  # our Rails application has already been given permission to request these tokens by the admin of
+  # the specified tenant_id.
+  #
+  # See here for more information https://developer.microsoft.com/en-us/graph/docs/concepts/auth_v2_service
+  #
+  # This request also makes use of the multipart/form-data post body.
+  def bearer_token
+    response = HTTParty.post(
+      "#{MS_BASE_URL}/#{@tenant_id}/#{TOKEN_REQUEST_PATH}",
+      multipart: true,
+      body: {
+        client_id: Rails.application.credentials[Rails.env.to_sym][:microsoft_client_id],
+        client_secret: Rails.application.credentials[Rails.env.to_sym][:microsoft_client_secret],
+        scope: 'https://graph.microsoft.com/.default',
+        grant_type: 'client_credentials'
+      }
+    )
+
+    return false unless response.code == 200
+
+    JSON.parse(response.body)['access_token']
+  end
+end

data/examples/multipart.rb

@@ -0,0 +1,22 @@
+# If you are uploading file in params, multipart will used as content-type automatically
+
+HTTParty.post(
+  'http://localhost:3000/user',
+  body: {
+    name: 'Foo Bar',
+    email: 'example@email.com',
+    avatar: File.open('/full/path/to/avatar.jpg')
+  }
+)
+
+
+# However, you can force it yourself
+
+HTTParty.post(
+  'http://localhost:3000/user',
+  multipart: true,
+  body: {
+    name: 'Foo Bar',
+    email: 'example@email.com'
+  }
+)

data/features/steps/mongrel_helper.rb

@@ -95,7 +95,7 @@ module DigestAuthenticationUsingMD5Sess
   def self.extended(base)
     base.custom_headers["WWW-Authenticate"] = %(Digest realm="#{REALM}",qop="#{QOP}",algorithm="MD5-sess",nonce="#{NONCE}",opaque="opaque"')
   end
-  
+
   def process(request, response)
     if authorized?(request)
       super
@@ -103,11 +103,11 @@ module DigestAuthenticationUsingMD5Sess
       reply_with(response, 401, "Incorrect.  You have 20 seconds to comply.")
     end
   end
-  
+
   def md5(str)
     Digest::MD5.hexdigest(str)
   end
-  
+
   def authorized?(request)
     auth = request.params["HTTP_AUTHORIZATION"]
     params = {}

data/httparty.gemspec

@@ -9,13 +9,14 @@ Gem::Specification.new do |s|
   s.licenses    = ['MIT']
   s.authors     = ["John Nunemaker", "Sandro Turriate"]
   s.email       = ["nunemaker@gmail.com"]
-  s.homepage    = "http://jnunemaker.github.com/httparty"
+  s.homepage    = "https://github.com/jnunemaker/httparty"
   s.summary     = 'Makes http fun! Also, makes consuming restful web services dead easy.'
   s.description = 'Makes http fun! Also, makes consuming restful web services dead easy.'
 
   s.required_ruby_version     = '>= 2.0.0'
 
   s.add_dependency 'multi_xml', ">= 0.5.2"
+  s.add_dependency('mime-types', "~> 3.0")
 
   # If this line is removed, all hard partying will cease.
   s.post_install_message = "When you HTTParty, you must party hard!"

data/lib/httparty.rb

@@ -4,6 +4,7 @@ require 'net/https'
 require 'uri'
 require 'zlib'
 require 'multi_xml'
+require 'mime/types'
 require 'json'
 require 'csv'
 
@@ -40,6 +41,7 @@ module HTTParty
   # [:+local_port:] Local port to bind to before connecting.
   # [:+body_stream:] Allow streaming to a REST server to specify a body_stream.
   # [:+stream_body:] Allow for streaming large files without loading them into memory.
+  # [:+multipart:] Force content-type to be multipart
   #
   # There are also another set of options with names corresponding to various class methods. The methods in question are those that let you set a class-wide default, and the options override the defaults on a request-by-request basis. Those options are:
   # * :+base_uri+: see HTTParty::ClassMethods.base_uri.
@@ -546,6 +548,14 @@ module HTTParty
       perform_request Net::HTTP::Mkcol, path, options, &block
     end
 
+    def lock(path, options = {}, &block)
+      perform_request Net::HTTP::Lock, path, options, &block
+    end
+
+    def unlock(path, options = {}, &block)
+      perform_request Net::HTTP::Unlock, path, options, &block
+    end
+
     attr_reader :default_options
 
     private
@@ -566,6 +576,14 @@ module HTTParty
     def process_headers(options)
       if options[:headers] && headers.any?
         options[:headers] = headers.merge(options[:headers])
+        options[:headers] = Utils.stringify_keys(process_dynamic_headers(options[:headers]))
+      end
+    end
+
+    def process_dynamic_headers(headers)
+      headers.each_with_object({}) do |header, processed_headers|
+        key, value = header
+        processed_headers[key] = value.respond_to?(:call) ? value.call : value
       end
     end
 
@@ -577,7 +595,8 @@ module HTTParty
 
     def validate_format
       if format && parser.respond_to?(:supports_format?) && !parser.supports_format?(format)
-        raise UnsupportedFormat, "'#{format.inspect}' Must be one of: #{parser.supported_formats.map(&:to_s).sort.join(', ')}"
+        supported_format_names = parser.supported_formats.map(&:to_s).sort.join(', ')
+        raise UnsupportedFormat, "'#{format.inspect}' Must be one of: #{supported_format_names}"
       end
     end
   end
@@ -635,6 +654,7 @@ module HTTParty
 end
 
 require 'httparty/hash_conversions'
+require 'httparty/utils'
 require 'httparty/exceptions'
 require 'httparty/parser'
 require 'httparty/request'

data/lib/httparty/connection_adapter.rb

@@ -4,7 +4,7 @@ module HTTParty
   # == Custom Connection Factories
   #
   # If you like to implement your own connection adapter, subclassing
-  # HTTPParty::ConnectionAdapter will make it easier. Just override
+  # HTTParty::ConnectionAdapter will make it easier. Just override
   # the #connection method. The uri and options attributes will have
   # all the info you need to construct your http connection. Whatever
   # you return from your connection method needs to adhere to the
@@ -38,12 +38,12 @@ module HTTParty
   # in the #options attribute. It is up to you to interpret them within your
   # connection adapter. Take a look at the implementation of
   # HTTParty::ConnectionAdapter#connection for examples of how they are used.
-  # The keys used in options are 
+  # The keys used in options are
   # * :+timeout+: timeout in seconds
   # * :+open_timeout+: http connection open_timeout in seconds, overrides timeout if set
   # * :+read_timeout+: http connection read_timeout in seconds, overrides timeout if set
   # * :+debug_output+: see HTTParty::ClassMethods.debug_output.
-  # * :+cert_store+: contains certificate data. see method 'attach_ssl_certificates' 
+  # * :+cert_store+: contains certificate data. see method 'attach_ssl_certificates'
   # * :+pem+: contains pem client certificate data. see method 'attach_ssl_certificates'
   # * :+p12+: contains PKCS12 client client certificate data.  see method 'attach_ssl_certificates'
   # * :+verify+: verify the server’s certificate against the ca certificate.
@@ -91,7 +91,14 @@ module HTTParty
       host = clean_host(uri.host)
       port = uri.port || (uri.scheme == 'https' ? 443 : 80)
       if options.key?(:http_proxyaddr)
-        http = Net::HTTP.new(host, port, options[:http_proxyaddr], options[:http_proxyport], options[:http_proxyuser], options[:http_proxypass])
+        http = Net::HTTP.new(
+          host,
+          port,
+          options[:http_proxyaddr],
+          options[:http_proxyport],
+          options[:http_proxyuser],
+          options[:http_proxypass]
+        )
       else
         http = Net::HTTP.new(host, port)
       end

data/lib/httparty/hash_conversions.rb

@@ -39,7 +39,9 @@ module HTTParty
         if value.empty?
           normalized_keys << ["#{key}[]", '']
         else
-          normalized_keys = value.to_ary.flat_map { |element| normalize_keys("#{key}[]", element) }
+          normalized_keys = value.to_ary.flat_map do |element|
+            normalize_keys("#{key}[]", element)
+          end
         end
       elsif value.respond_to?(:to_hash)
         stack << [key, value.to_hash]
@@ -52,7 +54,9 @@ module HTTParty
           if child_value.respond_to?(:to_hash)
             stack << ["#{parent}[#{child_key}]", child_value.to_hash]
           elsif child_value.respond_to?(:to_ary)
-            child_value.to_ary.each { |v| normalized_keys << normalize_keys("#{parent}[#{child_key}][]", v).flatten }
+            child_value.to_ary.each do |v|
+              normalized_keys << normalize_keys("#{parent}[#{child_key}][]", v).flatten
+            end
           else
             normalized_keys << normalize_keys("#{parent}[#{child_key}]", child_value).flatten
           end

data/lib/httparty/logger/apache_formatter.rb

@@ -3,7 +3,7 @@ module HTTParty
     class ApacheFormatter #:nodoc:
       TAG_NAME = HTTParty.name
 
-      attr_accessor :level, :logger, :current_time
+      attr_accessor :level, :logger
 
       def initialize(logger, level)
         @logger = logger
@@ -11,11 +11,34 @@ module HTTParty
       end
 
       def format(request, response)
-        current_time   = Time.now.strftime("%Y-%m-%d %H:%M:%S %z")
-        http_method    = request.http_method.name.split("::").last.upcase
-        path           = request.path.to_s
-        content_length = response.respond_to?(:headers) ? response.headers['Content-Length'] : response['Content-Length']
-        @logger.send @level, "[#{TAG_NAME}] [#{current_time}] #{response.code} \"#{http_method} #{path}\" #{content_length || '-'} "
+        @request = request
+        @response = response
+
+        logger.public_send level, message
+      end
+
+      private
+
+      attr_reader :request, :response
+
+      def message
+        "[#{TAG_NAME}] [#{current_time}] #{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
+        request.http_method.name.split("::").last.upcase
+      end
+
+      def path
+        request.path.to_s
+      end
+
+      def content_length
+        response.respond_to?(:headers) ? response.headers['Content-Length'] : response['Content-Length']
       end
     end
   end