opinionated_http 0.0.5 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e42aeb5b1a1b2647f48288e3b34b54064b327f72b0cce291ea75a1c0a563eb79
-  data.tar.gz: 533c7d1bf33a594ebb5b910e25a4ebf0b8420d9e5a24d0aac5f99e83e779fbe4
+  metadata.gz: 70883413762ba2277b74061e20f9fd5faa73fccee8a762595a40793a93ed2689
+  data.tar.gz: 45bf3291006a3577a29f5fd603ad27c34b1d6948c54e67f71efb20862c0af613
 SHA512:
-  metadata.gz: e2555937900d00a7b139a1bee2b76de642065b8b0469aeebb7783934c588bd032dc9b72b211e7ba5b04f06d01f55ece6f7a45d44439f14303c051e71cb4207bc
-  data.tar.gz: c78cfe4681bfe65cba9d570878dcf78328059d5835e9de0cbff7d416d7ee5954cc4d4fd831f459373027bff9cf37f096ad12f5108ae40fd32db5502fd02ebd12
+  metadata.gz: eec7f0a191186d29a970284e04dc571a2c8329587a414fa41576852e59d08503928594e14fc8e65f9ebea1570f90e15ad5e878a7b26259eae4adc605e7e9063f
+  data.tar.gz: ac1ce6b6f65d720cf7ddac4d93621c608f609ad1e113ead056e710e0cfe37df70792459940cdd3ca9effe0d8a123e60df11e89cf2a713ab7855c1148ea29e86d

data/README.md

@@ -36,6 +36,10 @@ Parameters:
     Required.
   logger:
     Default: SemanticLogger[OpinionatedHTTP]
+  format: [:json | nil]
+    Optionally set the format for http requests.
+    Currently only supports `:json`, which will format the request and response to/from JSON.
+    It will also set the `Content-Type` http header to `application/json`.
   Other options as supported by PersistentHTTP
   #TODO: Expand PersistentHTTP options here
 

data/Rakefile

@@ -21,3 +21,5 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = true
   t.warning = false
 end
+
+task default: :test

data/lib/opinionated_http/client.rb

@@ -10,18 +10,19 @@ module OpinionatedHTTP
     # 502 Bad Gateway, 503 Service Unavailable, 504 Gateway Timeout
     HTTP_RETRY_CODES = %w[502 503 504].freeze
 
-    attr_reader :secret_config_prefix, :logger, :metric_prefix, :error_class, :driver,
+    attr_reader :secret_config_prefix, :logger, :format, :metric_prefix, :error_class, :driver, :format,
                 :retry_count, :retry_interval, :retry_multiplier, :http_retry_codes,
                 :url, :pool_size, :keep_alive, :proxy, :force_retry, :max_redirects,
-                :open_timeout, :read_timeout, :idle_timeout, :pool_timeout, :warn_timeout
+                :open_timeout, :read_timeout, :idle_timeout, :pool_timeout, :warn_timeout,
+                :after_connect
 
     # Any option supplied here can be overridden if that corresponding value is set in Secret Config.
-    # Except for any values passed directly to Persistent HTTP under `**options`.
     def initialize(
       secret_config_prefix:,
       metric_prefix:,
       error_class:,
       logger: nil,
+      format: nil,
       retry_count: 11,
       retry_interval: 0.01,
       retry_multiplier: 1.8,
@@ -37,93 +38,107 @@ module OpinionatedHTTP
       proxy: :ENV,
       force_retry: true,
       max_redirects: 10,
-      **options
+      after_connect: nil,
+      verify_peer: false, # TODO: PersistentHTTP keeps returning cert expired even when it is valid.
+      certificate: nil,
+      private_key: nil,
+      header: nil
     )
-      @metric_prefix    = metric_prefix
-      @logger           = logger || SemanticLogger[self]
-      @error_class      = error_class
-      @retry_count      = SecretConfig.fetch("#{secret_config_prefix}/retry_count", type: :integer, default: retry_count)
-      @retry_interval   = SecretConfig.fetch("#{secret_config_prefix}/retry_interval", type: :float, default: retry_interval)
-      @retry_multiplier = SecretConfig.fetch("#{secret_config_prefix}/retry_multiplier", type: :float, default: retry_multiplier)
-      @max_redirects    = SecretConfig.fetch("#{secret_config_prefix}/max_redirects", type: :integer, default: max_redirects)
-      http_retry_codes  = SecretConfig.fetch("#{secret_config_prefix}/http_retry_codes", type: :string, default: http_retry_codes)
-      @http_retry_codes = http_retry_codes.split(",").collect(&:strip)
-
-      @url = url.nil? ? SecretConfig["#{secret_config_prefix}/url"] : SecretConfig.fetch("#{secret_config_prefix}/url", default: url)
-
-      @pool_size    = SecretConfig.fetch("#{secret_config_prefix}/pool_size", type: :integer, default: pool_size)
-      @open_timeout = SecretConfig.fetch("#{secret_config_prefix}/open_timeout", type: :float, default: open_timeout)
-      @read_timeout = SecretConfig.fetch("#{secret_config_prefix}/read_timeout", type: :float, default: read_timeout)
-      @idle_timeout = SecretConfig.fetch("#{secret_config_prefix}/idle_timeout", type: :float, default: idle_timeout)
-      @keep_alive   = SecretConfig.fetch("#{secret_config_prefix}/keep_alive", type: :float, default: keep_alive)
-      @pool_timeout = SecretConfig.fetch("#{secret_config_prefix}/pool_timeout", type: :float, default: pool_timeout)
-      @warn_timeout = SecretConfig.fetch("#{secret_config_prefix}/warn_timeout", type: :float, default: warn_timeout)
-      @proxy        = SecretConfig.fetch("#{secret_config_prefix}/proxy", type: :symbol, default: proxy)
-      @force_retry  = SecretConfig.fetch("#{secret_config_prefix}/force_retry", type: :boolean, default: force_retry)
+      @metric_prefix = metric_prefix
+      @logger        = logger || SemanticLogger[self]
+      @error_class   = error_class
+      @format        = format
+      @after_connect = after_connect
+      SecretConfig.configure(secret_config_prefix) do |config|
+        @retry_count      = config.fetch("retry_count", type: :integer, default: retry_count)
+        @retry_interval   = config.fetch("retry_interval", type: :float, default: retry_interval)
+        @retry_multiplier = config.fetch("retry_multiplier", type: :float, default: retry_multiplier)
+        @max_redirects    = config.fetch("max_redirects", type: :integer, default: max_redirects)
+        http_retry_codes  = config.fetch("http_retry_codes", type: :string, default: http_retry_codes)
+        @http_retry_codes = http_retry_codes.split(",").collect(&:strip)
+
+        @url = url.nil? ? config.fetch("url") : config.fetch("url", default: url)
+
+        @pool_size    = config.fetch("pool_size", type: :integer, default: pool_size)
+        @open_timeout = config.fetch("open_timeout", type: :float, default: open_timeout)
+        @read_timeout = config.fetch("read_timeout", type: :float, default: read_timeout)
+        @idle_timeout = config.fetch("idle_timeout", type: :float, default: idle_timeout)
+        @keep_alive   = config.fetch("keep_alive", type: :float, default: keep_alive)
+        @pool_timeout = config.fetch("pool_timeout", type: :float, default: pool_timeout)
+        @warn_timeout = config.fetch("warn_timeout", type: :float, default: warn_timeout)
+        @proxy        = config.fetch("proxy", type: :symbol, default: proxy)
+        @force_retry  = config.fetch("force_retry", type: :boolean, default: force_retry)
+        @certificate  = config.fetch("certificate", type: :string, default: certificate)
+        @private_key  = config.fetch("private_key", type: :string, default: private_key)
+        @verify_peer  = config.fetch("verify_peer", type: :boolean, default: verify_peer)
+      end
 
       internal_logger = OpinionatedHTTP::Logger.new(@logger)
-      new_options     = {
-        logger:       internal_logger,
-        debug_output: internal_logger,
-        name:         "",
-        pool_size:    @pool_size,
-        open_timeout: @open_timeout,
-        read_timeout: @read_timeout,
-        idle_timeout: @idle_timeout,
-        keep_alive:   @keep_alive,
-        pool_timeout: @pool_timeout,
-        warn_timeout: @warn_timeout,
-        proxy:        @proxy,
-        force_retry:  @force_retry
-      }
-
-      url               = SecretConfig["#{secret_config_prefix}/url"]
-      new_options[:url] = url if url
-      @driver           = PersistentHTTP.new(new_options.merge(options))
+      @driver         = PersistentHTTP.new(
+        url:           @url,
+        logger:        internal_logger,
+        debug_output:  internal_logger,
+        name:          "",
+        pool_size:     @pool_size,
+        open_timeout:  @open_timeout,
+        read_timeout:  @read_timeout,
+        idle_timeout:  @idle_timeout,
+        keep_alive:    @keep_alive,
+        pool_timeout:  @pool_timeout,
+        warn_timeout:  @warn_timeout,
+        proxy:         @proxy,
+        force_retry:   @force_retry,
+        after_connect: @after_connect,
+        certificate:   @certificate,
+        private_key:   @private_key,
+        verify_mode:   @verify_peer ? OpenSSL::SSL::VERIFY_PEER | OpenSSL::SSL::VERIFY_FAIL_IF_NO_PEER_CERT : OpenSSL::SSL::VERIFY_NONE,
+        header:        header
+      )
     end
 
-    # Perform an HTTP Get against the supplied path
-    def get(action:, path: "/#{action}", **args)
-      request  = build_request(path: path, verb: "Get", **args)
-      response = request(action: action, request: request)
-      extract_body(response)
+    def get(request: nil, **args)
+      request       ||= Request.new(**args)
+      request.verb  = "Get"
+      http_response = request(request)
+      Response.new(http_response, request)
     end
 
-    def post(action:, path: "/#{action}", **args)
-      request = build_request(path: path, verb: "Post", **args)
-
-      response = request(action: action, request: request)
-      extract_body(response)
-    end
+    def post(request: nil, json: nil, body: nil, **args)
+      raise(ArgumentError, "Either set :json or :body") if json && body
 
-    def build_request(verb:, path:, headers: nil, body: nil, form_data: nil, username: nil, password: nil, parameters: nil)
-      unless headers_and_form_data_compatible?(headers, form_data)
-        raise(ArgumentError, "Setting form data will overwrite supplied content-type")
+      request       ||= Request.new(**args)
+      if json
+        request.format = :json
+        request.body   = json
+      else
+        request.body = body
       end
-      raise(ArgumentError, "Cannot supply both form_data and a body") if body && form_data
-
-      path = "/#{path}" unless path.start_with?("/")
-      path = "#{path}?#{URI.encode_www_form(parameters)}" if parameters
-
-      request = Net::HTTP.const_get(verb).new(path, headers)
+      request.verb  = "Post"
+      http_response = request(request)
+      Response.new(http_response, request)
+    end
 
-      raise(ArgumentError, "#{request.class.name} does not support a request body") if body && !request.request_body_permitted?
-      if parameters && !request.response_body_permitted?
-        raise(ArgumentError, ":parameters cannot be supplied for #{request.class.name}")
-      end
+    def delete(request: nil, **args)
+      request       ||= Request.new(**args)
+      request.verb  = "Delete"
+      http_response = request(request)
+      Response.new(http_response, request)
+    end
 
-      request.body = body if body
-      request.set_form_data form_data if form_data
-      request.basic_auth(username, password) if username && password
-      request
+    def patch(request: nil, **args)
+      request       ||= Request.new(**args)
+      request.verb  = "Patch"
+      http_response = request(request)
+      Response.new(http_response, request)
     end
 
-    # Returns [HTTP Response] after submitting the request
-    #
-    # Notes:
-    # - Does not raise an exception when the http response is not an HTTP OK (200.
-    def request(action:, request:)
-      request_with_retry(action: action, request: request)
+    # Returns [Response] after submitting the [Request]
+    def request(request)
+      request.metric_prefix ||= metric_prefix
+      request.format        ||= format
+      request.error_class   ||= error_class
+      request.logger        ||= logger
+      request_with_retry(action: request.action, request: request.http_request)
     end
 
     private
@@ -134,12 +149,14 @@ module OpinionatedHTTP
         begin
           payload = {}
           if logger.trace?
-            payload[:parameters] = parameters
-            payload[:path]       = request.path
+            # payload[:parameters] = parameters
+            payload[:path] = request.path
           end
           message = "HTTP #{http_method}: #{action}" if logger.debug?
 
-          logger.benchmark_info(message: message, metric: "#{metric_prefix}/#{action}", payload: payload) { driver.request(request) }
+          logger.benchmark_info(message: message, metric: "#{metric_prefix}/#{action}", payload: payload) do
+            driver.request(request)
+          end
         rescue StandardError => e
           message = "HTTP #{http_method}: #{action} Failure: #{e.class.name}: #{e.message}"
           logger.error(message: message, metric: "#{metric_prefix}/exception", exception: e)
@@ -147,33 +164,19 @@ module OpinionatedHTTP
         end
 
       # Retry on http 5xx errors except 500 which means internal server error.
-      if http_retry_codes.include?(response.code)
-        if try_count < retry_count
-          try_count += 1
-          duration = retry_sleep_interval(try_count)
-          logger.warn(message: "HTTP #{http_method}: #{action} Failure: (#{response.code}) #{response.message}. Retry: #{try_count}", metric: "#{metric_prefix}/retry", duration: duration * 1_000)
-          sleep(duration)
-          response = request_with_retry(action: action, request: request, try_count: try_count)
-        else
-          message = "HTTP #{http_method}: #{action} Failure: (#{response.code}) #{response.message}. Retries Exhausted"
-          logger.error(message: message, metric: "#{metric_prefix}/exception")
-          raise(error_class, message)
-        end
-      end
-
-      response
-    end
-
-    def extract_body(response)
-      return response.body if response.is_a?(Net::HTTPSuccess)
+      return response unless http_retry_codes.include?(response.code)
 
-      message = "HTTP #{http_method}: #{action} Failure: (#{response.code}) #{response.message}"
-      logger.error(message: message, metric: "#{metric_prefix}/exception")
-      raise(error_class, message)
-    end
+      if try_count >= retry_count
+        message = "HTTP #{http_method}: #{action} Failure: (#{response.code}) #{response.message}. Retries Exhausted"
+        logger.error(message: message, metric: "#{metric_prefix}/exception")
+        raise(error_class, message)
+      end
 
-    def prefix_path(path)
-      path.start_with?("/") ? path : "/#{path}"
+      try_count += 1
+      duration  = retry_sleep_interval(try_count)
+      logger.warn(message: "HTTP #{http_method}: #{action} Failure: (#{response.code}) #{response.message}. Retry: #{try_count}", metric: "#{metric_prefix}/retry", duration: duration * 1_000)
+      sleep(duration)
+      request_with_retry(action: action, request: request, try_count: try_count)
     end
 
     # First retry is immediate, next retry is after `retry_interval`,
@@ -181,13 +184,7 @@ module OpinionatedHTTP
     def retry_sleep_interval(retry_count)
       return 0 if retry_count <= 1
 
-      (retry_multiplier**(retry_count - 1)) * retry_interval
-    end
-
-    def headers_and_form_data_compatible?(headers, form_data)
-      return true if headers.nil? || form_data.nil?
-
-      !headers.keys.map(&:downcase).include?("content-type")
+      (retry_multiplier ** (retry_count - 1)) * retry_interval
     end
   end
 end

data/lib/opinionated_http/request.rb

@@ -0,0 +1,77 @@
+module OpinionatedHTTP
+  # The request object
+  class Request
+    attr_accessor :action, :verb, :format, :path, :headers, :body, :form_data, :username, :password, :parameters,
+                  :metric_prefix, :error_class, :logger
+
+    def initialize(action:, verb: nil, path: nil, format: nil, headers: {}, body: nil, form_data: nil, username: nil, password: nil, parameters: nil)
+      @action     = action
+      @path       =
+        if path.nil?
+          "/#{action}"
+        elsif path.start_with?("/")
+          path
+        else
+          "/#{path}"
+        end
+      @verb       = verb
+      @format     = format
+      @headers    = headers
+      @body       = body
+      @form_data  = form_data
+      @username   = username
+      @password   = password
+      @parameters = parameters
+    end
+
+    def http_request
+      unless headers_and_form_data_compatible?(headers, form_data)
+        raise(ArgumentError, "Setting form data will overwrite supplied content-type")
+      end
+      raise(ArgumentError, "Cannot supply both form_data and a body") if body && form_data
+
+      path_with_params = parameters ? "#{path}?#{URI.encode_www_form(parameters)}" : path
+      body             = format_body if self.body
+      request          = Net::HTTP.const_get(verb).new(path_with_params, headers)
+
+      if body && !request.request_body_permitted?
+        raise(ArgumentError, "#{request.class.name} does not support a request body")
+      end
+
+      if parameters && !request.response_body_permitted?
+        raise(ArgumentError, ":parameters cannot be supplied for #{request.class.name}")
+      end
+
+      request.body     = body if body
+      request.set_form_data form_data if form_data
+      request.basic_auth(username, password) if username && password
+      request
+    end
+
+    private
+
+    def format_body
+      return if body.nil?
+
+      case format
+      when :json
+        headers["Content-Type"] = "application/json"
+        body.to_json unless body.is_a?(String) || body.nil?
+      when nil
+        body
+      else
+        raise(ArgumentError, "Unknown format: #{format.inspect}")
+      end
+    rescue StandardError => exc
+      message = "Failed to serialize request body. #{exc.class.name}: #{exc.message}"
+      logger.error(message: message, metric: "#{metric_prefix}/exception", exception: exc)
+      raise(error_class, message)
+    end
+
+    def headers_and_form_data_compatible?(headers, form_data)
+      return true if headers.empty? || form_data.nil?
+
+      !headers.keys.map(&:downcase).include?("content-type")
+    end
+  end
+end

data/lib/opinionated_http/response.rb

@@ -0,0 +1,55 @@
+require "forwardable"
+module OpinionatedHTTP
+  # The response object
+  class Response
+    extend Forwardable
+
+    def_instance_delegators :@http_response, :code, :message
+    def_instance_delegators :@request, :verb, :action, :metric_prefix, :format, :path, :error_class, :logger
+
+    # :action used for logging the action in the error message
+    def initialize(http_response, request)
+      @http_response = http_response
+      @request       = request
+    end
+
+    def success?
+      @http_response.is_a?(Net::HTTPSuccess)
+    end
+
+    def body
+      @body ||= parse_body
+    end
+
+    # Raises an exception when the HTTP Response is not a success
+    def body!
+      return body if success?
+
+      error_message = "HTTP #{verb.upcase}: #{action} Failure: (#{code}) #{message}"
+      logger.error(message: error_message, metric: "#{metric_prefix}/exception", payload: {body: body})
+      raise(error_class, error_message)
+    end
+
+    private
+
+    attr_reader :http_response, :request
+
+    def parse_body
+      return unless http_response.class.body_permitted?
+
+      case format
+      when :json
+        JSON.parse(http_response.body)
+      when nil
+        http_response.body
+      else
+        raise(ArgumentError, "Unknown format: #{format.inspect}")
+      end
+
+    rescue StandardError => exc
+      message = "Failed to parse response body. #{exc.class.name}: #{exc.message}"
+      logger.error(message: message, metric: "#{metric_prefix}/exception", exception: exc)
+      raise(error_class, message)
+    end
+  end
+end

data/lib/opinionated_http/version.rb

@@ -1,3 +1,3 @@
 module OpinionatedHTTP
-  VERSION = "0.0.5".freeze
+  VERSION = "0.1.1".freeze
 end

data/lib/opinionated_http.rb

@@ -7,6 +7,8 @@ require "opinionated_http/version"
 module OpinionatedHTTP
   autoload :Client, "opinionated_http/client"
   autoload :Logger, "opinionated_http/logger"
+  autoload :Request, "opinionated_http/request"
+  autoload :Response, "opinionated_http/response"
 
   #
   # Create a new Opinionated HTTP instance.

data/test/client_test.rb

@@ -2,135 +2,100 @@ require "net/http"
 require "json"
 require_relative "test_helper"
 
-module OpinionatedHTTP
-  class ClientTest < Minitest::Test
-    describe OpinionatedHTTP::Client do
-      class ServiceError < StandardError
-      end
+class ClientTest < Minitest::Test
+  describe OpinionatedHTTP::Client do
+    class ServiceError < StandardError
+    end
 
-      let :http do
-        OpinionatedHTTP.new(
-          secret_config_prefix: "fake_service",
-          metric_prefix:        "FakeService",
-          logger:               SemanticLogger["FakeService"],
-          error_class:          ServiceError,
-          header:               {"Content-Type" => "application/json"}
-        )
-      end
+    let :http do
+      OpinionatedHTTP.new(
+        secret_config_prefix: "fake_service",
+        metric_prefix:        "FakeService",
+        logger:               SemanticLogger["FakeService"],
+        error_class:          ServiceError
+      )
+    end
 
-      describe "get" do
-        it "succeeds" do
-          output   = {zip: "12345", population: 54_321}
-          body     = output.to_json
-          response = stub_request(Net::HTTPSuccess, 200, "OK", body) do
-            http.get(action: "lookup", parameters: {zip: "12345"})
-          end
-          assert_equal body, response
+    describe "get" do
+      it "succeeds" do
+        output = {zip: "12345", population: 54_321}
+        body   = output.to_json
+        stub_request(Net::HTTPSuccess, 200, "OK", body) do
+          response = http.get(action: "lookup", parameters: {zip: "12345"})
+          assert_equal body, response.body!
         end
       end
 
-      describe "post" do
-        it "succeeds with body" do
-          output   = {zip: "12345", population: 54_321}
-          body     = output.to_json
-          response = stub_request(Net::HTTPSuccess, 200, "OK", body) do
-            http.post(action: "lookup", body: body)
-          end
-          assert_equal body, response
-        end
-
-        it "with form data" do
-          output   = {zip: "12345", population: 54_321}
-          body     = output.to_json
-          response = stub_request(Net::HTTPSuccess, 200, "OK", body) do
-            http.post(action: "lookup", form_data: output)
+      it "fails" do
+        message = "HTTP GET: lookup Failure: (403) Forbidden"
+        error   = assert_raises ServiceError do
+          stub_request(Net::HTTPForbidden, 403, "Forbidden", "") do
+            response = http.get(action: "lookup", parameters: {zip: "12345"})
+            response.body!
           end
-          assert_equal body, response
         end
+        assert_equal message, error.message
       end
+    end
 
-      describe "build_request" do
-        let(:path) { "/fake_action" }
-        let(:post_verb) { "Post" }
-        let(:get_verb) { "Get" }
-
-        it "creates a request corresponding to the supplied verb" do
-          req  = http.build_request(path: path, verb: post_verb)
-          req2 = http.build_request(path: path, verb: get_verb)
-
-          assert_kind_of Net::HTTP::Post, req
-          assert_kind_of Net::HTTP::Get, req2
-        end
-
-        it "returns a request with supplied headers" do
-          test_headers = {"test1" => "yes_test_1", "test2" => "yes_test_2"}
-          req          = http.build_request(path: path, verb: get_verb, headers: test_headers)
-
-          assert_equal test_headers["test1"], req["test1"]
-          assert_equal test_headers["test2"], req["test2"]
-        end
-
-        it "returns a request with supplied body" do
-          test_body = "nice bod"
-          req       = http.build_request(path: path, verb: post_verb, body: test_body)
-
-          assert_equal test_body, req.body
+    describe "post" do
+      it "succeeds with body" do
+        output = {zip: "12345", population: 54_321}
+        body   = output.to_json
+        stub_request(Net::HTTPSuccess, 200, "OK", body) do
+          response = http.post(action: "lookup", body: body)
+          assert_equal body, response.body!
         end
+      end
 
-        it "returns a request with supplied form data in x-www-form-urlencoded Content-Type" do
-          test_data       = {test1: "yes", test2: "no"}
-          expected_string = "test1=yes&test2=no"
-          req             = http.build_request(path: path, verb: post_verb, form_data: test_data)
-
-          assert_equal expected_string, req.body
-          assert_equal "application/x-www-form-urlencoded", req["Content-Type"]
+      it "with form data" do
+        output = {zip: "12345", population: 54_321}
+        body   = output.to_json
+        stub_request(Net::HTTPSuccess, 200, "OK", body) do
+          response = http.post(action: "lookup", form_data: output)
+          assert_equal body, response.body!
         end
+      end
 
-        it "add supplied authentication to the request" do
-          test_un = "admin"
-          test_pw = "hunter2"
-          req     = http.build_request(path: path, verb: get_verb, username: test_un, password: test_pw)
-          req2    = Net::HTTP::Get.new(path)
-          req2.basic_auth test_un, test_pw
-
-          assert_equal req2["authorization"], req["authorization"]
+      it "with JSON data" do
+        request = {zip: "12345", population: 54_321}
+        body   = request.to_json
+        stub_request(Net::HTTPSuccess, 200, "OK", body) do
+          response = http.post(action: "lookup", json: request)
+          assert_equal request, response.body!.transform_keys!(&:to_sym)
         end
+      end
 
-        it "raise an error if supplied content-type header would be overwritten by setting form_data" do
-          downcase_headers    = {"unimportant" => "blank", "content-type" => "application/json"}
-          capitalized_headers = {"Unimportant" => "blank", "Content-Type" => "application/json"}
-          no_conflict_headers = {"whatever" => "blank", "irrelevant" => "test"}
-          form_data           = {thing1: 1, thing2: 2}
-
-          assert_raises ArgumentError do
-            http.build_request(path: path, verb: post_verb, headers: downcase_headers, form_data: form_data)
-          end
-
-          assert_raises ArgumentError do
-            http.build_request(path: path, verb: post_verb, headers: capitalized_headers, form_data: form_data)
+      it "fails with body" do
+        message = "HTTP POST: lookup Failure: (403) Forbidden"
+        output  = {zip: "12345", population: 54_321}
+        body    = output.to_json
+        error   = assert_raises ServiceError do
+          stub_request(Net::HTTPForbidden, 403, "Forbidden", "") do
+            response = http.post(action: "lookup", body: body)
+            response.body!
           end
-
-          assert http.build_request(path: path, verb: post_verb, headers: no_conflict_headers, form_data: form_data)
         end
+        assert_equal message, error.message
+      end
 
-        it "raise an error if there is a collision between supplied body and form_data" do
-          form_data = {thing1: 1, thing2: 2}
-          body      = "not form data"
-
-          assert_raises ArgumentError do
-            http.build_request(path: path, verb: post_verb, body: body, form_data: form_data)
+      it "fails with form data" do
+        output  = {zip: "12345", population: 54_321}
+        message = "HTTP POST: lookup Failure: (403) Forbidden"
+        error   = assert_raises ServiceError do
+          stub_request(Net::HTTPForbidden, 403, "Forbidden", "") do
+            response = http.post(action: "lookup", form_data: output)
+            response.body!
           end
-
-          assert http.build_request(path: path, verb: post_verb, body: body)
-          assert http.build_request(path: path, verb: post_verb, form_data: form_data)
         end
+        assert_equal message, error.message
       end
+    end
 
-      def stub_request(klass, code, msg, body, &block)
-        response = klass.new("1.1", code, msg)
-        response.stub(:body, body) do
-          http.driver.stub(:request, response, &block)
-        end
+    def stub_request(klass, code, msg, body, &block)
+      response = klass.new("1.1", code, msg)
+      response.stub(:body, body) do
+        http.driver.stub(:request, response, &block)
       end
     end
   end

data/test/config/application.yml

@@ -1,4 +1,4 @@
 test:
-  fake_supplier:
+  fake_service:
     url: https://example.org
 

data/test/request_test.rb

@@ -0,0 +1,95 @@
+require "net/http"
+require "json"
+require_relative "test_helper"
+
+class RequestTest < Minitest::Test
+  describe OpinionatedHTTP::Request do
+    describe "http_request" do
+      let(:path) { "/fake_action" }
+      let(:post_verb) { "Post" }
+      let(:get_verb) { "Get" }
+      let(:action) { "fake_action" }
+      let :json_request do
+        {zip: "12345", population: 54_321}
+      end
+
+      it "creates a request corresponding to the supplied verb" do
+        req  = OpinionatedHTTP::Request.new(action: action, path: path, verb: post_verb).http_request
+        req2 = OpinionatedHTTP::Request.new(action: action, path: path, verb: get_verb).http_request
+
+        assert_kind_of Net::HTTP::Post, req
+        assert_kind_of Net::HTTP::Get, req2
+      end
+
+      it "creates a JSON request" do
+        req = OpinionatedHTTP::Request.new(action: action, path: path, verb: post_verb, format: :json, body: json_request).http_request
+
+        assert_equal json_request.to_json, req.body
+        assert_equal "application/json", req["Content-Type"]
+      end
+
+      it "returns a request with supplied headers" do
+        test_headers = {"test1" => "yes_test_1", "test2" => "yes_test_2"}
+        req          = OpinionatedHTTP::Request.new(action: action, path: path, verb: get_verb, headers: test_headers).http_request
+
+        assert_equal test_headers["test1"], req["test1"]
+        assert_equal test_headers["test2"], req["test2"]
+      end
+
+      it "returns a request with supplied body" do
+        test_body = "nice bod"
+        req       = OpinionatedHTTP::Request.new(action: action, path: path, verb: post_verb, body: test_body).http_request
+
+        assert_equal test_body, req.body
+      end
+
+      it "returns a request with supplied form data in x-www-form-urlencoded Content-Type" do
+        test_data       = {test1: "yes", test2: "no"}
+        expected_string = "test1=yes&test2=no"
+        req             = OpinionatedHTTP::Request.new(action: action, path: path, verb: post_verb, form_data: test_data).http_request
+
+        assert_equal expected_string, req.body
+        assert_equal "application/x-www-form-urlencoded", req["Content-Type"]
+      end
+
+      it "add supplied authentication to the request" do
+        test_un = "admin"
+        test_pw = "hunter2"
+        req     = OpinionatedHTTP::Request.new(action: action, path: path, verb: get_verb, username: test_un, password: test_pw).http_request
+        req2    = Net::HTTP::Get.new(path)
+        req2.basic_auth test_un, test_pw
+
+        assert_equal req2["authorization"], req["authorization"]
+      end
+
+      it "raise an error if supplied content-type header would be overwritten by setting form_data" do
+        downcase_headers    = {"unimportant" => "blank", "content-type" => "application/json"}
+        capitalized_headers = {"Unimportant" => "blank", "Content-Type" => "application/json"}
+        no_conflict_headers = {"whatever" => "blank", "irrelevant" => "test"}
+        form_data           = {thing1: 1, thing2: 2}
+
+        assert_raises ArgumentError do
+          OpinionatedHTTP::Request.new(action: action, path: path, verb: post_verb, headers: downcase_headers, form_data: form_data).http_request
+        end
+
+        assert_raises ArgumentError do
+          OpinionatedHTTP::Request.new(action: action, path: path, verb: post_verb, headers: capitalized_headers, form_data: form_data).http_request
+        end
+
+        assert OpinionatedHTTP::Request.new(action: action, path: path, verb: post_verb, headers: no_conflict_headers, form_data: form_data).http_request
+      end
+
+      it "raise an error if there is a collision between supplied body and form_data" do
+        form_data = {thing1: 1, thing2: 2}
+        body      = "not form data"
+
+        assert_raises ArgumentError do
+          OpinionatedHTTP::Request.new(action: action, path: path, verb: post_verb, body: body, form_data: form_data).http_request
+        end
+
+        assert OpinionatedHTTP::Request.new(action: action, path: path, verb: post_verb, body: body).http_request
+        assert OpinionatedHTTP::Request.new(action: action, path: path, verb: post_verb, form_data: form_data).http_request
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -3,7 +3,7 @@ ENV["TZ"] = "America/New_York"
 
 require "yaml"
 require "minitest/autorun"
-require "awesome_print"
+require "amazing_print"
 require "secret_config"
 require "semantic_logger"
 require "opinionated_http"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opinionated_http
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.1
 platform: ruby
 authors:
 - Reid Morrison
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-29 00:00:00.000000000 Z
+date: 2022-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: persistent_http
@@ -55,7 +55,6 @@ dependencies:
 description: HTTP Client with retries. Uses PersistentHTTP for http connection pooling,
   Semantic Logger for logging and metrics, and uses Secret Config for its configuration.
 email:
-- reidmo@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -65,14 +64,17 @@ files:
 - lib/opinionated_http.rb
 - lib/opinionated_http/client.rb
 - lib/opinionated_http/logger.rb
+- lib/opinionated_http/request.rb
+- lib/opinionated_http/response.rb
 - lib/opinionated_http/version.rb
 - test/client_test.rb
 - test/config/application.yml
+- test/request_test.rb
 - test/test_helper.rb
-homepage: 
+homepage:
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -87,11 +89,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Opinionated HTTP Client
 test_files:
 - test/client_test.rb
 - test/config/application.yml
+- test/request_test.rb
 - test/test_helper.rb