jwagener/httmultiparty

View on GitHub
lib/httmultiparty.rb

Summary

Maintainability
A
2 hrs
Test Coverage
require 'tempfile'
require 'httparty'
require 'net/http/post/multipart'
require 'mimemagic'

module HTTMultiParty
  def self.included(base)
    base.send :include, HTTParty
    base.extend ClassMethods
  end

  def self.file_to_upload_io(file, detect_mime_type = false)
    if file.respond_to? :original_filename
      filename = file.original_filename
    else
      filename =  File.split(file.path).last
    end
    content_type = detect_mime_type ? MimeMagic.by_path(filename) : 'application/octet-stream'
    UploadIO.new(file, content_type, filename)
  end

  def self.query_string_normalizer(options = {})
    detect_mime_type = options.fetch(:detect_mime_type, false)
    proc do |params|
      HTTMultiParty.flatten_params(params).map do |(k, v)|
        if file_present?(params)
          v = prepare_value!(v, detect_mime_type)
          [k, v]
        else
          "#{k}=#{v}"
        end
      end
    end
  end

  def self.flatten_params(params = {}, prefix = '')
    flattened = []
    params.each do |(k, v)|
      if params.is_a?(Array)
        v = k
        k = ''
      end

      flattened_key = prefix == '' ? "#{k}" : "#{prefix}[#{k}]"
      if v.is_a?(Hash) || v.is_a?(Array)
        flattened += flatten_params(v, flattened_key)
      else
        flattened << [flattened_key, v]
      end
    end
    flattened
  end

  def self.prepare_value!(value, detect_mime_type)
    return value if does_not_need_conversion?(value)
    HTTMultiParty.file_to_upload_io(value, detect_mime_type)
  end

  def self.get(*args)
    Basement.get(*args)
  end

  def self.post(*args)
    Basement.post(*args)
  end

  def self.put(*args)
    Basement.put(*args)
  end

  def self.patch(*args)
    Basement.patch(*args)
  end

  def self.delete(*args)
    Basement.delete(*args)
  end

  def self.head(*args)
    Basement.head(*args)
  end

  def self.options(*args)
    Basement.options(*args)
  end

  private

  def self.file_present?(params)
    if params.is_a? Array
      file_present_in_array?(params)
    elsif params.is_a? Hash
      file_present_in_array?(params.values)
    else
      file?(params)
    end
  end

  def self.file_present_in_array?(ary)
    ary.any? { |a| file_present?(a) }
  end

  def self.file?(value)
    value.respond_to?(:read)
  end

  def self.not_a_file?(value)
    !file?(value)
  end

  def self.upload_io?(value)
    value.is_a?(UploadIO)
  end

  def self.does_not_need_conversion?(value)
    not_a_file?(value) ||
      upload_io?(value)
  end

  module ClassMethods
    def post(path, options = {})
      method = Net::HTTP::Post
      options[:body] ||= options.delete(:query)
      if hash_contains_files?(options[:body])
        method = MultipartPost
        options[:query_string_normalizer] = HTTMultiParty.query_string_normalizer(options)
      end
      perform_request method, path, options
    end

    def put(path, options = {})
      method = Net::HTTP::Put
      options[:body] ||= options.delete(:query)
      if hash_contains_files?(options[:body])
        method = MultipartPut
        options[:query_string_normalizer] = HTTMultiParty.query_string_normalizer(options)
      end
      perform_request method, path, options
    end

    def patch(path, options={})
      method = Net::HTTP::Patch
      options[:body] ||= options.delete(:query)
      if hash_contains_files?(options[:body])
        method = MultipartPatch
        options[:query_string_normalizer] = HTTMultiParty.query_string_normalizer(options)
      end
      perform_request method, path, options
    end

    private

    def hash_contains_files?(hash)
      HTTMultiParty.file_present?(hash)
    end
  end

  class Basement
    include HTTMultiParty
  end
end

require 'httmultiparty/version'
require 'httmultiparty/multipartable'
require 'httmultiparty/multipart_post'
require 'httmultiparty/multipart_put'
require 'httmultiparty/multipart_patch'