httpserious 0.13.5.lstoll1

data/lib/httparty/connection_adapter.rb

@@ -0,0 +1,190 @@
+module HTTParty
+  # Default connection adapter that returns a new Net::HTTP each time
+  #
+  # == Custom Connection Factories
+  #
+  # If you like to implement your own connection adapter, subclassing
+  # HTTPParty::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
+  # Net::HTTP interface as this is what HTTParty expects.
+  #
+  # @example log the uri and options
+  #   class LoggingConnectionAdapter < HTTParty::ConnectionAdapter
+  #     def connection
+  #       puts uri
+  #       puts options
+  #       Net::HTTP.new(uri)
+  #     end
+  #   end
+  #
+  # @example count number of http calls
+  #   class CountingConnectionAdapter < HTTParty::ConnectionAdapter
+  #     @@count = 0
+  #
+  #     self.count
+  #       @@count
+  #     end
+  #
+  #     def connection
+  #       self.count += 1
+  #       super
+  #     end
+  #   end
+  #
+  # === Configuration
+  # There is lots of configuration data available for your connection adapter
+  # 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.
+  # Some things that are probably interesting are as follows:
+  # * :+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.
+  # * :+pem+: contains pem data. see HTTParty::ClassMethods.pem.
+  # * :+verify+: verify the server’s certificate against the ca certificate.
+  # * :+verify_peer+: set to false to turn off server verification but still send client certificate
+  # * :+ssl_ca_file+: see HTTParty::ClassMethods.ssl_ca_file.
+  # * :+ssl_ca_path+: see HTTParty::ClassMethods.ssl_ca_path.
+  # * :+connection_adapter_options+: contains the hash you passed to HTTParty.connection_adapter when you configured your connection adapter
+  class ConnectionAdapter
+    # Private: Regex used to strip brackets from IPv6 URIs.
+    StripIpv6BracketsRegex = /\A\[(.*)\]\z/
+
+    # Public
+    def self.call(uri, options)
+      new(uri, options).connection
+    end
+
+    attr_reader :uri, :options
+
+    def initialize(uri, options = {})
+      uri_adapter = options[:uri_adapter] || URI
+      raise ArgumentError, "uri must be a #{uri_adapter}, not a #{uri.class}" unless uri.is_a? uri_adapter
+
+      @uri = uri
+      @options = options
+    end
+
+    def connection
+      host = clean_host(uri.host)
+      port = uri.port || (uri.scheme == 'https' ? 443 : 80)
+      if options[:http_proxyaddr]
+        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
+
+      http.use_ssl = ssl_implied?(uri)
+
+      attach_ssl_certificates(http, options)
+
+      if options[:timeout] && (options[:timeout].is_a?(Integer) || options[:timeout].is_a?(Float))
+        http.open_timeout = options[:timeout]
+        http.read_timeout = options[:timeout]
+      end
+
+      if options[:read_timeout] && (options[:read_timeout].is_a?(Integer) || options[:read_timeout].is_a?(Float))
+        http.read_timeout = options[:read_timeout]
+      end
+
+      if options[:open_timeout] && (options[:open_timeout].is_a?(Integer) || options[:open_timeout].is_a?(Float))
+        http.open_timeout = options[:open_timeout]
+      end
+
+      if options[:debug_output]
+        http.set_debug_output(options[:debug_output])
+      end
+
+      if options[:ciphers]
+        http.ciphers = options[:ciphers]
+      end
+
+      # Bind to a specific local address or port
+      #
+      # @see https://bugs.ruby-lang.org/issues/6617
+      if options[:local_host]
+        if RUBY_VERSION >= "2.0.0"
+          http.local_host = options[:local_host]
+        else
+          Kernel.warn("Warning: option :local_host requires Ruby version 2.0 or later")
+        end
+      end
+
+      if options[:local_port]
+        if RUBY_VERSION >= "2.0.0"
+          http.local_port = options[:local_port]
+        else
+          Kernel.warn("Warning: option :local_port requires Ruby version 2.0 or later")
+        end
+      end
+
+      http
+    end
+
+    private
+
+    def clean_host(host)
+      strip_ipv6_brackets(host)
+    end
+
+    def strip_ipv6_brackets(host)
+      StripIpv6BracketsRegex =~ host ? $1 : host
+    end
+
+    def ssl_implied?(uri)
+      uri.port == 443 || uri.scheme == 'https'
+    end
+
+    def attach_ssl_certificates(http, options)
+      if http.use_ssl?
+        if options.fetch(:verify, true)
+          http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+          if options[:cert_store]
+            http.cert_store = options[:cert_store]
+          else
+            # Use the default cert store by default, i.e. system ca certs
+            http.cert_store = OpenSSL::X509::Store.new
+            http.cert_store.set_default_paths
+          end
+        else
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+
+        # Client certificate authentication
+        # Note: options[:pem] must contain the content of a PEM file having the private key appended
+        if options[:pem]
+          http.cert = OpenSSL::X509::Certificate.new(options[:pem])
+          http.key = OpenSSL::PKey::RSA.new(options[:pem], options[:pem_password])
+          http.verify_mode = options[:verify_peer] == false ? OpenSSL::SSL::VERIFY_NONE : OpenSSL::SSL::VERIFY_PEER
+        end
+
+        # PKCS12 client certificate authentication
+        if options[:p12]
+          p12 = OpenSSL::PKCS12.new(options[:p12], options[:p12_password])
+          http.cert = p12.certificate
+          http.key = p12.key
+          http.verify_mode = options[:verify_peer] == false ? OpenSSL::SSL::VERIFY_NONE : OpenSSL::SSL::VERIFY_PEER
+        end
+
+        # SSL certificate authority file and/or directory
+        if options[:ssl_ca_file]
+          http.ca_file = options[:ssl_ca_file]
+          http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        end
+
+        if options[:ssl_ca_path]
+          http.ca_path = options[:ssl_ca_path]
+          http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        end
+
+        # This is only Ruby 1.9+
+        if options[:ssl_version] && http.respond_to?(:ssl_version=)
+          http.ssl_version = options[:ssl_version]
+        end
+      end
+    end
+  end
+end

data/lib/httparty/cookie_hash.rb

@@ -0,0 +1,21 @@
+class HTTParty::CookieHash < Hash #:nodoc:
+  CLIENT_COOKIES = %w(path expires domain path secure httponly)
+
+  def add_cookies(value)
+    case value
+    when Hash
+      merge!(value)
+    when String
+      value.split('; ').each do |cookie|
+        array = cookie.split('=', 2)
+        self[array[0].to_sym] = array[1]
+      end
+    else
+      raise "add_cookies only takes a Hash or a String"
+    end
+  end
+
+  def to_cookie_string
+    delete_if { |k, v| CLIENT_COOKIES.include?(k.to_s.downcase) }.collect { |k, v| "#{k}=#{v}" }.join("; ")
+  end
+end

data/lib/httparty/exceptions.rb

@@ -0,0 +1,29 @@
+module HTTParty
+  # @abstact Exceptions raised by HTTParty inherit from Error
+  class Error < StandardError; end
+
+  # Exception raised when you attempt to set a non-existant format
+  class UnsupportedFormat < Error; end
+
+  # Exception raised when using a URI scheme other than HTTP or HTTPS
+  class UnsupportedURIScheme < Error; end
+
+  # @abstract Exceptions which inherit from ResponseError contain the Net::HTTP
+  # response object accessible via the {#response} method.
+  class ResponseError < Error
+    # Returns the response of the last request
+    # @return [Net::HTTPResponse] A subclass of Net::HTTPResponse, e.g.
+    # Net::HTTPOK
+    attr_reader :response
+
+    # Instantiate an instance of ResponseError with a Net::HTTPResponse object
+    # @param [Net::HTTPResponse]
+    def initialize(response)
+      @response = response
+    end
+  end
+
+  # Exception that is raised when request has redirected too many times.
+  # Calling {#response} returns the Net:HTTP response object.
+  class RedirectionTooDeep < ResponseError; end
+end

data/lib/httparty/hash_conversions.rb

@@ -0,0 +1,49 @@
+module HTTParty
+  module HashConversions
+    # @return <String> This hash as a query string
+    #
+    # @example
+    #   { name: "Bob",
+    #     address: {
+    #       street: '111 Ruby Ave.',
+    #       city: 'Ruby Central',
+    #       phones: ['111-111-1111', '222-222-2222']
+    #     }
+    #   }.to_params
+    #     #=> "name=Bob&address[city]=Ruby Central&address[phones][]=111-111-1111&address[phones][]=222-222-2222&address[street]=111 Ruby Ave."
+    def self.to_params(hash)
+      hash.to_hash.map { |k, v| normalize_param(k, v) }.join.chop
+    end
+
+    # @param key<Object> The key for the param.
+    # @param value<Object> The value for the param.
+    #
+    # @return <String> This key value pair as a param
+    #
+    # @example normalize_param(:name, "Bob Jones") #=> "name=Bob%20Jones&"
+    def self.normalize_param(key, value)
+      param = ''
+      stack = []
+
+      if value.respond_to?(:to_ary)
+        param << value.to_ary.map { |element| normalize_param("#{key}[]", element) }.join
+      elsif value.respond_to?(:to_hash)
+        stack << [key, value.to_hash]
+      else
+        param << "#{key}=#{ERB::Util.url_encode(value.to_s)}&"
+      end
+
+      stack.each do |parent, hash|
+        hash.each do |k, v|
+          if v.respond_to?(:to_hash)
+            stack << ["#{parent}[#{k}]", v.to_hash]
+          else
+            param << normalize_param("#{parent}[#{k}]", v)
+          end
+        end
+      end
+
+      param
+    end
+  end
+end

data/lib/httparty/logger/apache_formatter.rb

@@ -0,0 +1,22 @@
+module HTTParty
+  module Logger
+    class ApacheFormatter #:nodoc:
+      TAG_NAME = HTTParty.name
+
+      attr_accessor :level, :logger, :current_time
+
+      def initialize(logger, level)
+        @logger = logger
+        @level  = level.to_sym
+      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 || '-'} "
+      end
+    end
+  end
+end

data/lib/httparty/logger/curl_formatter.rb

@@ -0,0 +1,48 @@
+module HTTParty
+  module Logger
+    class CurlFormatter #:nodoc:
+      TAG_NAME = HTTParty.name
+      OUT = ">"
+      IN = "<"
+
+      attr_accessor :level, :logger, :current_time
+
+      def initialize(logger, level)
+        @logger = logger
+        @level  = level.to_sym
+      end
+
+      def format(request, response)
+        messages        = []
+        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
+
+        messages << print(time, OUT, "#{http_method} #{path}")
+
+        if request.options[:headers] && request.options[:headers].size > 0
+          request.options[:headers].each do |k, v|
+            messages << print(time, OUT, "#{k}: #{v}")
+          end
+        end
+
+        messages << print(time, OUT, request.raw_body)
+        messages << print(time, OUT, "")
+        messages << print(time, IN, "HTTP/#{response.http_version} #{response.code}")
+
+        headers = response.respond_to?(:headers) ? response.headers : response
+        response.each_header do |response_header|
+          messages << print(time, IN, "#{response_header.capitalize}: #{headers[response_header]}")
+        end
+
+        messages << print(time, IN, "\n#{response.body}")
+
+        @logger.send @level, messages.join("\n")
+      end
+
+      def print(time, direction, line)
+        "[#{TAG_NAME}] [#{time}] #{direction} #{line}"
+      end
+    end
+  end
+end

data/lib/httparty/logger/logger.rb

@@ -0,0 +1,26 @@
+require 'httparty/logger/apache_formatter'
+require 'httparty/logger/curl_formatter'
+
+module HTTParty
+  module Logger
+    def self.formatters
+      @formatters ||= {
+        :curl => Logger::CurlFormatter,
+        :apache => Logger::ApacheFormatter
+      }
+    end
+
+    def self.add_formatter(name, formatter)
+      raise HTTParty::Error.new("Log Formatter with name #{name} already exists") if formatters.include?(name)
+      formatters.merge!(name.to_sym => formatter)
+    end
+
+    def self.build(logger, level, formatter)
+      level ||= :info
+      formatter ||= :apache
+
+      logger_klass = formatters[formatter] || Logger::ApacheFormatter
+      logger_klass.new(logger, level)
+    end
+  end
+end

data/lib/httparty/module_inheritable_attributes.rb

@@ -0,0 +1,56 @@
+module HTTParty
+  module ModuleInheritableAttributes #:nodoc:
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    # borrowed from Rails 3.2 ActiveSupport
+    def self.hash_deep_dup(hash)
+      duplicate = hash.dup
+
+      duplicate.each_pair do |key, value|
+        duplicate[key] = if value.is_a?(Hash)
+                           hash_deep_dup(value)
+        elsif value.is_a?(Proc)
+          duplicate[key] = value.dup
+        else
+          value
+        end
+      end
+
+      duplicate
+    end
+
+    module ClassMethods #:nodoc:
+      def mattr_inheritable(*args)
+        @mattr_inheritable_attrs ||= [:mattr_inheritable_attrs]
+        @mattr_inheritable_attrs += args
+
+        args.each do |arg|
+          module_eval %(class << self; attr_accessor :#{arg} end)
+        end
+
+        @mattr_inheritable_attrs
+      end
+
+      def inherited(subclass)
+        super
+        @mattr_inheritable_attrs.each do |inheritable_attribute|
+          ivar = "@#{inheritable_attribute}"
+          subclass.instance_variable_set(ivar, instance_variable_get(ivar).clone)
+
+          if instance_variable_get(ivar).respond_to?(:merge)
+            method = <<-EOM
+              def self.#{inheritable_attribute}
+                duplicate = ModuleInheritableAttributes.hash_deep_dup(#{ivar})
+                #{ivar} = superclass.#{inheritable_attribute}.merge(duplicate)
+              end
+            EOM
+
+            subclass.class_eval method
+          end
+        end
+      end
+    end
+  end
+end