rest-man 1.0.0 → 1.1.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest-man
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Hopper Gee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-19 00:00:00.000000000 Z
+date: 2023-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webmock
@@ -98,14 +98,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.49'
+        version: 1.50.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.49'
+        version: 1.50.2
 - !ruby/object:Gem::Dependency
   name: http-accept
   requirement: !ruby/object:Gem::Requirement
@@ -152,7 +152,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
@@ -162,7 +162,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
@@ -180,6 +180,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: active_method
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 description: 'A simple HTTP and REST client for Ruby, inspired by the Sinatra microframework
   style of specifying actions: get, put, post, delete.'
 email: hopper.gee@hey.com
@@ -190,7 +204,7 @@ extra_rdoc_files:
 - README.md
 - CHANGELOG.md
 files:
-- ".github/workflows/multi-matrix-test.yml"
+- ".github/workflows/ci.yml"
 - ".github/workflows/single-matrix-test.yml"
 - ".gitignore"
 - ".mailmap"
@@ -204,23 +218,103 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- _doc/lib/restman.rdoc
+- _doc/lib/restman/abstract_response/_follow_redirection.rdoc
+- _doc/lib/restman/abstract_response/beautify_headers.rdoc
+- _doc/lib/restman/abstract_response/cookie_jar.rdoc
+- _doc/lib/restman/abstract_response/cookies.rdoc
+- _doc/lib/restman/abstract_response/follow_get_redirection.rdoc
+- _doc/lib/restman/abstract_response/follow_redirection.rdoc
+- _doc/lib/restman/abstract_response/headers.rdoc
+- _doc/lib/restman/abstract_response/response_set_vars.rdoc
+- _doc/lib/restman/abstract_response/return.rdoc
+- _doc/lib/restman/add_before_execution_proc.rdoc
+- _doc/lib/restman/create_log.rdoc
+- _doc/lib/restman/exception.rdoc
+- _doc/lib/restman/exceptions.rdoc
+- _doc/lib/restman/exceptions/timeout.rdoc
+- _doc/lib/restman/log=.rdoc
+- _doc/lib/restman/params_array.rdoc
+- _doc/lib/restman/params_array/new.rdoc
+- _doc/lib/restman/params_array/process_pair.rdoc
+- _doc/lib/restman/platform/jruby?.rdoc
+- _doc/lib/restman/platform/mac_mri?.rdoc
+- _doc/lib/restman/proxy.rdoc
+- _doc/lib/restman/proxy_set?.rdoc
+- _doc/lib/restman/raw_response.rdoc
+- _doc/lib/restman/raw_response/new.rdoc
+- _doc/lib/restman/request.rdoc
+- _doc/lib/restman/request/cookie_jar.rdoc
+- _doc/lib/restman/request/cookies.rdoc
+- _doc/lib/restman/request/default_headers.rdoc
+- _doc/lib/restman/request/default_ssl_cert_store.rdoc
+- _doc/lib/restman/request/init/cookie_jar.rdoc
+- _doc/lib/restman/request/init/http_method.rdoc
+- _doc/lib/restman/request/make_cookie_header.rdoc
+- _doc/lib/restman/request/make_headers.rdoc
+- _doc/lib/restman/request/maybe_convert_extension.rdoc
+- _doc/lib/restman/request/process_result.rdoc
+- _doc/lib/restman/request/proxy_uri.rdoc
+- _doc/lib/restman/request/stringify_headers.rdoc
+- _doc/lib/restman/request/use_ssl.rdoc
+- _doc/lib/restman/reset_before_execution_procs.rdoc
+- _doc/lib/restman/resource.rdoc
+- _doc/lib/restman/resource/[].rdoc
+- _doc/lib/restman/response/body.rdoc
+- _doc/lib/restman/response/create.rdoc
+- _doc/lib/restman/response/fix_encoding.rdoc
+- _doc/lib/restman/statuses.rdoc
+- _doc/lib/restman/utils/cgi_parse_header.rdoc
+- _doc/lib/restman/utils/encode_query_string.rdoc
+- _doc/lib/restman/utils/escape.rdoc
+- _doc/lib/restman/utils/flatten_params.rdoc
+- _doc/lib/restman/utils/get_encoding_from_headers.rdoc
+- bin/console
 - exe/restman
 - lib/rest-man.rb
 - lib/rest_man.rb
 - lib/restman.rb
 - lib/restman/abstract_response.rb
-- lib/restman/exceptions.rb
+- lib/restman/exception.rb
+- lib/restman/exceptions/exception_with_response.rb
+- lib/restman/exceptions/exceptions_map.rb
+- lib/restman/exceptions/request_failed.rb
+- lib/restman/exceptions/server_broke_connection.rb
+- lib/restman/exceptions/timeout.rb
 - lib/restman/params_array.rb
+- lib/restman/params_array/process_pair.rb
 - lib/restman/payload.rb
+- lib/restman/payload/base.rb
+- lib/restman/payload/multipart.rb
+- lib/restman/payload/multipart/write_content_disposition.rb
+- lib/restman/payload/streamed.rb
+- lib/restman/payload/url_encoded.rb
 - lib/restman/platform.rb
 - lib/restman/raw_response.rb
 - lib/restman/request.rb
+- lib/restman/request/default_ssl_cert_store.rb
+- lib/restman/request/fetch_body_to_tempfile.rb
+- lib/restman/request/init.rb
+- lib/restman/request/init/cookie_jar.rb
+- lib/restman/request/init/ssl_opts.rb
+- lib/restman/request/init/url.rb
+- lib/restman/request/init/url/add_query_from_headers.rb
+- lib/restman/request/init/url/normalize_url.rb
+- lib/restman/request/log_request.rb
+- lib/restman/request/make_cookie_header.rb
+- lib/restman/request/make_headers.rb
+- lib/restman/request/maybe_convert_extension.rb
+- lib/restman/request/net_http_object.rb
+- lib/restman/request/process_result.rb
+- lib/restman/request/proxy_uri.rb
+- lib/restman/request/stringify_headers.rb
+- lib/restman/request/transmit.rb
 - lib/restman/resource.rb
 - lib/restman/response.rb
+- lib/restman/statuses.rb
+- lib/restman/statuses_compatibility.rb
 - lib/restman/utils.rb
 - lib/restman/version.rb
-- lib/restman/windows.rb
-- lib/restman/windows/root_certs.rb
 - matrixeval.yml
 - rest-man.gemspec
 - spec/ISS.jpg
@@ -255,17 +349,28 @@ files:
 - spec/spec_helper.rb
 - spec/unit/_lib.rb
 - spec/unit/abstract_response_spec.rb
-- spec/unit/exceptions_spec.rb
+- spec/unit/exception_spec.rb
+- spec/unit/exceptions/backwards_campatibility_spec.rb
+- spec/unit/exceptions/exceptions_map_spec.rb
+- spec/unit/exceptions/request_failed_spec.rb
+- spec/unit/exceptions/server_broke_connection_spec.rb
+- spec/unit/exceptions/timeout_spec.rb
+- spec/unit/params_array/process_pair_spec.rb
 - spec/unit/params_array_spec.rb
+- spec/unit/payload/multipart_spec.rb
+- spec/unit/payload/streamed_spec.rb
+- spec/unit/payload/url_encoded_spec.rb
 - spec/unit/payload_spec.rb
 - spec/unit/raw_response_spec.rb
+- spec/unit/request/init/url/add_query_from_headers_spec.rb
+- spec/unit/request/init/url/normalize_url_spec.rb
+- spec/unit/request/init_spec.rb
 - spec/unit/request2_spec.rb
 - spec/unit/request_spec.rb
 - spec/unit/resource_spec.rb
 - spec/unit/response_spec.rb
 - spec/unit/restclient_spec.rb
 - spec/unit/utils_spec.rb
-- spec/unit/windows/root_certs_spec.rb
 homepage: https://github.com/rest-man/rest-man
 licenses:
 - MIT
@@ -278,14 +383,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Simple HTTP and REST client for Ruby, inspired by microframework syntax for
@@ -323,14 +428,25 @@ test_files:
 - spec/spec_helper.rb
 - spec/unit/_lib.rb
 - spec/unit/abstract_response_spec.rb
-- spec/unit/exceptions_spec.rb
+- spec/unit/exception_spec.rb
+- spec/unit/exceptions/backwards_campatibility_spec.rb
+- spec/unit/exceptions/exceptions_map_spec.rb
+- spec/unit/exceptions/request_failed_spec.rb
+- spec/unit/exceptions/server_broke_connection_spec.rb
+- spec/unit/exceptions/timeout_spec.rb
+- spec/unit/params_array/process_pair_spec.rb
 - spec/unit/params_array_spec.rb
+- spec/unit/payload/multipart_spec.rb
+- spec/unit/payload/streamed_spec.rb
+- spec/unit/payload/url_encoded_spec.rb
 - spec/unit/payload_spec.rb
 - spec/unit/raw_response_spec.rb
+- spec/unit/request/init/url/add_query_from_headers_spec.rb
+- spec/unit/request/init/url/normalize_url_spec.rb
+- spec/unit/request/init_spec.rb
 - spec/unit/request2_spec.rb
 - spec/unit/request_spec.rb
 - spec/unit/resource_spec.rb
 - spec/unit/response_spec.rb
 - spec/unit/restclient_spec.rb
 - spec/unit/utils_spec.rb
-- spec/unit/windows/root_certs_spec.rb

data/lib/restman/exceptions.rb

@@ -1,238 +0,0 @@
-module RestMan
-
-  # Hash of HTTP status code => message.
-  #
-  # 1xx: Informational - Request received, continuing process
-  # 2xx: Success - The action was successfully received, understood, and
-  #      accepted
-  # 3xx: Redirection - Further action must be taken in order to complete the
-  #      request
-  # 4xx: Client Error - The request contains bad syntax or cannot be fulfilled
-  # 5xx: Server Error - The server failed to fulfill an apparently valid
-  #      request
-  #
-  # @see
-  #   http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
-  #
-  STATUSES = {100 => 'Continue',
-              101 => 'Switching Protocols',
-              102 => 'Processing', #WebDAV
-
-              200 => 'OK',
-              201 => 'Created',
-              202 => 'Accepted',
-              203 => 'Non-Authoritative Information', # http/1.1
-              204 => 'No Content',
-              205 => 'Reset Content',
-              206 => 'Partial Content',
-              207 => 'Multi-Status', #WebDAV
-              208 => 'Already Reported', # RFC5842
-              226 => 'IM Used', # RFC3229
-
-              300 => 'Multiple Choices',
-              301 => 'Moved Permanently',
-              302 => 'Found',
-              303 => 'See Other', # http/1.1
-              304 => 'Not Modified',
-              305 => 'Use Proxy', # http/1.1
-              306 => 'Switch Proxy', # no longer used
-              307 => 'Temporary Redirect', # http/1.1
-              308 => 'Permanent Redirect', # RFC7538
-
-              400 => 'Bad Request',
-              401 => 'Unauthorized',
-              402 => 'Payment Required',
-              403 => 'Forbidden',
-              404 => 'Not Found',
-              405 => 'Method Not Allowed',
-              406 => 'Not Acceptable',
-              407 => 'Proxy Authentication Required',
-              408 => 'Request Timeout',
-              409 => 'Conflict',
-              410 => 'Gone',
-              411 => 'Length Required',
-              412 => 'Precondition Failed',
-              413 => 'Payload Too Large', # RFC7231 (renamed, see below)
-              414 => 'URI Too Long', # RFC7231 (renamed, see below)
-              415 => 'Unsupported Media Type',
-              416 => 'Range Not Satisfiable', # RFC7233 (renamed, see below)
-              417 => 'Expectation Failed',
-              418 => 'I\'m A Teapot', #RFC2324
-              421 => 'Too Many Connections From This IP',
-              422 => 'Unprocessable Entity', #WebDAV
-              423 => 'Locked', #WebDAV
-              424 => 'Failed Dependency', #WebDAV
-              425 => 'Unordered Collection', #WebDAV
-              426 => 'Upgrade Required',
-              428 => 'Precondition Required', #RFC6585
-              429 => 'Too Many Requests', #RFC6585
-              431 => 'Request Header Fields Too Large', #RFC6585
-              449 => 'Retry With', #Microsoft
-              450 => 'Blocked By Windows Parental Controls', #Microsoft
-
-              500 => 'Internal Server Error',
-              501 => 'Not Implemented',
-              502 => 'Bad Gateway',
-              503 => 'Service Unavailable',
-              504 => 'Gateway Timeout',
-              505 => 'HTTP Version Not Supported',
-              506 => 'Variant Also Negotiates',
-              507 => 'Insufficient Storage', #WebDAV
-              508 => 'Loop Detected', # RFC5842
-              509 => 'Bandwidth Limit Exceeded', #Apache
-              510 => 'Not Extended',
-              511 => 'Network Authentication Required', # RFC6585
-  }
-
-  STATUSES_COMPATIBILITY = {
-    # The RFCs all specify "Not Found", but "Resource Not Found" was used in
-    # earlier RestMan releases.
-    404 => ['ResourceNotFound'],
-
-    # HTTP 413 was renamed to "Payload Too Large" in RFC7231.
-    413 => ['RequestEntityTooLarge'],
-
-    # HTTP 414 was renamed to "URI Too Long" in RFC7231.
-    414 => ['RequestURITooLong'],
-
-    # HTTP 416 was renamed to "Range Not Satisfiable" in RFC7233.
-    416 => ['RequestedRangeNotSatisfiable'],
-  }
-
-
-  # This is the base RestMan exception class. Rescue it if you want to
-  # catch any exception that your request might raise
-  # You can get the status code by e.http_code, or see anything about the
-  # response via e.response.
-  # For example, the entire result body (which is
-  # probably an HTML error page) is e.response.
-  class Exception < RuntimeError
-    attr_accessor :response
-    attr_accessor :original_exception
-    attr_writer :message
-
-    def initialize response = nil, initial_response_code = nil
-      @response = response
-      @message = nil
-      @initial_response_code = initial_response_code
-    end
-
-    def http_code
-      # return integer for compatibility
-      if @response
-        @response.code.to_i
-      else
-        @initial_response_code
-      end
-    end
-
-    def http_headers
-      @response.headers if @response
-    end
-
-    def http_body
-      @response.body if @response
-    end
-
-    def to_s
-      message
-    end
-
-    def message
-      @message || default_message
-    end
-
-    def default_message
-      self.class.name
-    end
-  end
-
-  # Compatibility
-  class ExceptionWithResponse < RestMan::Exception
-  end
-
-  # The request failed with an error code not managed by the code
-  class RequestFailed < ExceptionWithResponse
-
-    def default_message
-      "HTTP status code #{http_code}"
-    end
-
-    def to_s
-      message
-    end
-  end
-
-  # RestMan exception classes. TODO: move all exceptions into this module.
-  #
-  # We will a create an exception for each status code, see
-  # http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
-  #
-  module Exceptions
-    # Map http status codes to the corresponding exception class
-    EXCEPTIONS_MAP = {}
-  end
-
-  # Create HTTP status exception classes
-  STATUSES.each_pair do |code, message|
-    klass = Class.new(RequestFailed) do
-      send(:define_method, :default_message) {"#{http_code ? "#{http_code} " : ''}#{message}"}
-    end
-    klass_constant = const_set(message.delete(' \-\''), klass)
-    Exceptions::EXCEPTIONS_MAP[code] = klass_constant
-  end
-
-  # Create HTTP status exception classes used for backwards compatibility
-  STATUSES_COMPATIBILITY.each_pair do |code, compat_list|
-    klass = Exceptions::EXCEPTIONS_MAP.fetch(code)
-    compat_list.each do |old_name|
-      const_set(old_name, klass)
-    end
-  end
-
-  module Exceptions
-    # We have to split the Exceptions module like we do here because the
-    # EXCEPTIONS_MAP is under Exceptions, but we depend on
-    # RestMan::RequestTimeout below.
-
-    # Base class for request timeouts.
-    #
-    # NB: Previous releases of rest-man would raise RequestTimeout both for
-    # HTTP 408 responses and for actual connection timeouts.
-    class Timeout < RestMan::RequestTimeout
-      def initialize(message=nil, original_exception=nil)
-        super(nil, nil)
-        self.message = message if message
-        self.original_exception = original_exception if original_exception
-      end
-    end
-
-    # Timeout when connecting to a server. Typically wraps Net::OpenTimeout (in
-    # ruby 2.0 or greater).
-    class OpenTimeout < Timeout
-      def default_message
-        'Timed out connecting to server'
-      end
-    end
-
-    # Timeout when reading from a server. Typically wraps Net::ReadTimeout (in
-    # ruby 2.0 or greater).
-    class ReadTimeout < Timeout
-      def default_message
-        'Timed out reading data from server'
-      end
-    end
-  end
-
-
-  # The server broke the connection prior to the request completing.  Usually
-  # this means it crashed, or sometimes that your network connection was
-  # severed before it could complete.
-  class ServerBrokeConnection < RestMan::Exception
-    def initialize(message = 'Server broke connection')
-      super nil, nil
-      self.message = message
-    end
-  end
-
-end

data/lib/restman/windows/root_certs.rb

@@ -1,105 +0,0 @@
-require 'openssl'
-require 'ffi'
-
-# Adapted from Puppet, Copyright (c) Puppet Labs Inc,
-# licensed under the Apache License, Version 2.0.
-#
-# https://github.com/puppetlabs/puppet/blob/bbe30e0a/lib/puppet/util/windows/root_certs.rb
-
-# Represents a collection of trusted root certificates.
-#
-# @api public
-class RestMan::Windows::RootCerts
-  include Enumerable
-  extend FFI::Library
-
-  typedef :ulong, :dword
-  typedef :uintptr_t, :handle
-
-  def initialize(roots)
-    @roots = roots
-  end
-
-  # Enumerates each root certificate.
-  # @yieldparam cert [OpenSSL::X509::Certificate] each root certificate
-  # @api public
-  def each
-    @roots.each {|cert| yield cert}
-  end
-
-  # Returns a new instance.
-  # @return [RestMan::Windows::RootCerts] object constructed from current root certificates
-  def self.instance
-    new(self.load_certs)
-  end
-
-  # Returns an array of root certificates.
-  #
-  # @return [Array<[OpenSSL::X509::Certificate]>] an array of root certificates
-  # @api private
-  def self.load_certs
-    certs = []
-
-    # This is based on a patch submitted to openssl:
-    # http://www.mail-archive.com/openssl-dev@openssl.org/msg26958.html
-    ptr = FFI::Pointer::NULL
-    store = CertOpenSystemStoreA(nil, "ROOT")
-    begin
-      while (ptr = CertEnumCertificatesInStore(store, ptr)) and not ptr.null?
-        context = CERT_CONTEXT.new(ptr)
-        cert_buf = context[:pbCertEncoded].read_bytes(context[:cbCertEncoded])
-        begin
-          certs << OpenSSL::X509::Certificate.new(cert_buf)
-        rescue => detail
-          warn("Failed to import root certificate: #{detail.inspect}")
-        end
-      end
-    ensure
-      CertCloseStore(store, 0)
-    end
-
-    certs
-  end
-
-  private
-
-  # typedef ULONG_PTR HCRYPTPROV_LEGACY;
-  # typedef void *HCERTSTORE;
-
-  class CERT_CONTEXT < FFI::Struct
-    layout(
-      :dwCertEncodingType, :dword,
-      :pbCertEncoded,      :pointer,
-      :cbCertEncoded,      :dword,
-      :pCertInfo,          :pointer,
-      :hCertStore,         :handle
-    )
-  end
-
-  # HCERTSTORE
-  # WINAPI
-  # CertOpenSystemStoreA(
-  #   __in_opt HCRYPTPROV_LEGACY hProv,
-  #   __in LPCSTR szSubsystemProtocol
-  #   );
-  ffi_lib :crypt32
-  attach_function :CertOpenSystemStoreA, [:pointer, :string], :handle
-
-  # PCCERT_CONTEXT
-  # WINAPI
-  # CertEnumCertificatesInStore(
-  #   __in HCERTSTORE hCertStore,
-  #   __in_opt PCCERT_CONTEXT pPrevCertContext
-  #   );
-  ffi_lib :crypt32
-  attach_function :CertEnumCertificatesInStore, [:handle, :pointer], :pointer
-
-  # BOOL
-  # WINAPI
-  # CertCloseStore(
-  #   __in_opt HCERTSTORE hCertStore,
-  #   __in DWORD dwFlags
-  #   );
-  ffi_lib :crypt32
-  attach_function :CertCloseStore, [:handle, :dword], :bool
-end

data/lib/restman/windows.rb

@@ -1,8 +0,0 @@
-module RestMan
-  module Windows
-  end
-end
-
-if RestMan::Platform.windows?
-  require_relative './windows/root_certs'
-end