aitch 1.0.1 → 1.2.0

data/lib/aitch/request.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
+
 module Aitch
   class Request
-    attr_accessor :request_method
-    attr_accessor :url
-    attr_accessor :data
-    attr_accessor :headers
-    attr_accessor :options
-    attr_accessor :redirects
+    attr_accessor :request_method, :url, :data, :headers, :options, :redirects
+
+    alias params= data=
+    alias body= data=
 
     def initialize(options)
       self.headers = {}
@@ -35,7 +34,8 @@ module Aitch
     end
 
     def content_type
-      headers["Content-Type"] || options.fetch(:default_headers, {})["Content-Type"]
+      headers["Content-Type"] ||
+        options.fetch(:default_headers, {})["Content-Type"]
     end
 
     def request
@@ -57,29 +57,40 @@ module Aitch
     end
 
     def uri
-      @uri ||= URI.new(url, data, http_method_class::REQUEST_HAS_BODY)
+      @uri ||= begin
+        normalized_url = if url.start_with?("/") && options[:base_url]
+                           File.join(options[:base_url], url)
+                         else
+                           url
+                         end
+
+        URI.new(normalized_url, data, http_method_class::REQUEST_HAS_BODY)
+      end
     end
 
     def http_method_class
       Net::HTTP.const_get(request_method.to_s.capitalize)
     rescue NameError
-      raise InvalidHTTPMethodError, "unexpected HTTP verb: #{request_method.inspect}"
+      raise InvalidHTTPMethodError,
+            "unexpected HTTP verb: #{request_method.inspect}"
     end
 
-    private
-    def set_body(request)
+    private def set_body(request)
       body_data = data
       body_data = data.to_h if data.respond_to?(:to_h)
-      body_data = ResponseParser::JSONParser.engine.dump(body_data) if content_type.to_s =~ /\bjson\b/
 
-      if body_data.kind_of?(Hash)
-        request.body = Utils.build_query(body_data)
-      else
-        request.body = body_data.to_s
+      if content_type.to_s.match?(/\bjson\b/)
+        body_data = ResponseParser::JSONParser.engine.dump(body_data)
       end
+
+      request.body = if body_data.is_a?(Hash)
+                       Utils.build_query(body_data)
+                     else
+                       body_data.to_s
+                     end
     end
 
-    def set_headers(request)
+    private def set_headers(request)
       all_headers = options.fetch(:default_headers, {}).merge(headers)
 
       all_headers.each do |name, value|
@@ -88,30 +99,31 @@ module Aitch
       end
     end
 
-    def set_credentials(request)
+    private def set_credentials(request)
       return unless options[:user] || options[:password]
+
       request.basic_auth(options[:user], options[:password])
     end
 
-    def set_https(client)
+    private def set_https(client)
       client.use_ssl = uri.scheme == "https"
       client.verify_mode = OpenSSL::SSL::VERIFY_PEER
     end
 
-    def set_timeout(client)
+    private def set_timeout(client)
       client.read_timeout = options[:timeout]
     end
 
-    def set_logger(client)
+    private def set_logger(client)
       logger = options[:logger]
       client.set_debug_output(logger) if logger
     end
 
-    def set_user_agent(request)
+    private def set_user_agent(request)
       request["User-Agent"] = options[:user_agent]
     end
 
-    def set_gzip(request)
+    private def set_gzip(request)
       request["Accept-Encoding"] = "gzip,deflate"
     end
 
@@ -119,7 +131,7 @@ module Aitch
       defined?(Net::ReadTimeout) ? Net::ReadTimeout : Timeout::Error
     end
 
-    def follow_redirect(response, redirected_from = [])
+    private def follow_redirect(response)
       return response unless response.redirect?
 
       redirect = Redirect.new(options)
@@ -143,18 +155,18 @@ module Aitch
       response
     end
 
-    def validate_response!(response)
+    private def validate_response!(response)
       return unless options[:expect]
 
       expected = [options[:expect]].flatten
       return if expected.include?(response.code)
 
       descriptions = expected
-                      .map {|code| Response.description_for_code(code) }
-                      .join(", ")
+                     .map {|code| Response.description_for_code(code) }
+                     .join(", ")
 
       raise StatusCodeError,
-        "Expected(#{descriptions}) <=> Actual(#{response.description})"
+            "Expected(#{descriptions}) <=> Actual(#{response.description})"
     end
   end
 end

data/lib/aitch/response/body.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Aitch
   class Response
     class Body

data/lib/aitch/response/description.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Aitch
   class Response
     DESCRIPTION = {
@@ -56,7 +57,7 @@ module Aitch
       504 => "Gateway Time Out",
       505 => "Version Not Supported",
       507 => "Insufficient Storage",
-      511 => "Network Authentication Required",
-    }
+      511 => "Network Authentication Required"
+    }.freeze
   end
 end

data/lib/aitch/response/errors.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Aitch
   class Response
     ERRORS = {
@@ -35,6 +36,6 @@ module Aitch
       505 => VersionNotSupportedError,
       507 => InsufficientStorageError,
       511 => NetworkAuthenticationRequiredError
-    }
+    }.freeze
   end
 end

data/lib/aitch/response.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Aitch
   class Response
     extend Forwardable
@@ -17,7 +18,9 @@ module Aitch
     end
 
     ERRORS.each do |status_code, exception|
-      method_name = Utils.underscore(exception.name.split("::").last).gsub("_error", "")
+      method_name = Utils
+                    .underscore(exception.name.split("::").last)
+                    .gsub("_error", "")
 
       define_method "#{method_name}?" do
         code == status_code
@@ -35,7 +38,7 @@ module Aitch
     def success?
       code >= 200 && code <= 399
     end
-    alias_method :ok?, :success?
+    alias ok? success?
 
     def redirect?
       code >= 300 && code <= 399
@@ -75,11 +78,12 @@ module Aitch
 
     def method_missing(name, *args, &block)
       return headers[name.to_s] if headers.key?(name.to_s)
+
       super
     end
 
-    def respond_to_missing?(name, include_private = false)
-      headers.key?(name.to_s)
+    def respond_to_missing?(name, _include_private = false)
+      headers.key?(name.to_s) || super
     end
 
     def description
@@ -90,6 +94,6 @@ module Aitch
       "#<#{self.class} #{description} (#{content_type})>"
     end
 
-    alias_method :to_s, :inspect
+    alias to_s inspect
   end
 end

data/lib/aitch/response_parser/default_parser.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Aitch
   module ResponseParser
     module DefaultParser
@@ -6,7 +7,7 @@ module Aitch
         :default
       end
 
-      def self.match?(content_type)
+      def self.match?(_content_type)
         true
       end
 

data/lib/aitch/response_parser/html_parser.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Aitch
   module ResponseParser
     module HTMLParser

data/lib/aitch/response_parser/json_parser.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Aitch
   module ResponseParser
     module JSONParser
@@ -6,7 +7,7 @@ module Aitch
         attr_accessor :engine
       end
 
-      self.engine = ::JSON
+      self.engine = Engines::JSON
 
       def self.type
         :json

data/lib/aitch/response_parser/xml_parser.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Aitch
   module ResponseParser
     module XMLParser

data/lib/aitch/response_parser.rb

@@ -1,24 +1,27 @@
 # frozen_string_literal: true
+
 module Aitch
   module ResponseParser
-    PARSERS = []
+    def self.parsers
+      @parsers ||= []
+    end
 
     def self.prepend(name, parser)
       unregister(name)
-      PARSERS.unshift parser
+      parsers.unshift parser
     end
 
     def self.append(name, parser)
       unregister(name)
-      PARSERS << parser
+      parsers << parser
     end
 
     def self.unregister(name)
-      PARSERS.delete_if {|parser| parser.type == name }
+      parsers.delete_if {|parser| parser.type == name }
     end
 
     def self.find(content_type)
-      PARSERS.find {|parser| parser.match?(content_type) }
+      parsers.find {|parser| parser.match?(content_type) }
     end
 
     append :json, JSONParser

data/lib/aitch/uri.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+
 module Aitch
   class URI
     extend Forwardable
 
     def_delegators :@uri, :host, :port, :scheme
 
-    def initialize(url, data = {}, request_has_body = false)
+    def initialize(url, data = {}, request_has_body = false) # rubocop:disable Style/OptionalBooleanParameter
       @url = url
       @data = data
       @request_has_body = request_has_body
@@ -35,7 +36,9 @@ module Aitch
 
     def query
       query = [@uri.query]
-      query << ::URI.encode_www_form(@data.to_a) if !request_has_body? && @data.respond_to?(:to_a)
+      if !request_has_body? && @data.respond_to?(:to_a)
+        query << ::URI.encode_www_form(@data.to_a)
+      end
       query = query.compact.reject(&:empty?).join("&")
 
       "?#{query}" unless query == ""

data/lib/aitch/utils.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
+
 module Aitch
-  module Utils extend self
+  module Utils
+    extend self
     def underscore(string)
       string = string.gsub(/(?<=.)(URI|[A-Z])/) do |char|
         "_#{char}"

data/lib/aitch/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Aitch
-  VERSION = "1.0.1"
+  VERSION = "1.2.0"
 end

data/lib/aitch.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "net/https"
 require "forwardable"
 require "json"
@@ -19,6 +20,7 @@ require "aitch/namespace"
 require "aitch/location"
 require "aitch/configuration"
 require "aitch/errors"
+require "aitch/engines/json"
 require "aitch/request"
 require "aitch/redirect"
 require "aitch/response/errors"
@@ -37,21 +39,19 @@ module Aitch
     extend Forwardable
 
     def_delegators :namespace,
-      :configuration, :config,
-      :get, :get!,
-      :post, :post!,
-      :put, :put!,
-      :patch, :patch!,
-      :options, :options!,
-      :trace, :trace!,
-      :head, :head!,
-      :delete, :delete!,
-      :execute, :execute!,
-      :configure
+                   :configuration, :config,
+                   :get, :get!,
+                   :post, :post!,
+                   :put, :put!,
+                   :patch, :patch!,
+                   :options, :options!,
+                   :trace, :trace!,
+                   :head, :head!,
+                   :delete, :delete!,
+                   :execute, :execute!,
+                   :configure
   end
 
-  private
-
   def self.namespace
     @namespace ||= Namespace.new
   end

data/test/aitch/aitch_test.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "test_helper"
 
 class AitchTest < Minitest::Test

data/test/aitch/configuration_test.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "test_helper"
 
 class ConfigurationTest < Minitest::Test
@@ -16,7 +17,7 @@ class ConfigurationTest < Minitest::Test
   end
 
   test "sets default headers" do
-    assert_equal Hash.new, Aitch::Configuration.new.default_headers
+    assert_equal({}, Aitch::Configuration.new.default_headers)
   end
 
   test "configures aitch" do

data/test/aitch/dsl_test.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "test_helper"
 
 class DslTest < Minitest::Test

data/test/aitch/execute_test.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "test_helper"
 
 class ExecuteTest < Minitest::Test

data/test/aitch/namespace_test.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "test_helper"
 
 class NamespaceTest < Minitest::Test
@@ -7,6 +8,6 @@ class NamespaceTest < Minitest::Test
     ns.config.user_agent = "MyLib/1.0.0"
 
     assert_equal "MyLib/1.0.0", ns.config.user_agent
-    assert_match %r[^Aitch], Aitch.config.user_agent
+    assert_match(/^Aitch/, Aitch.config.user_agent)
   end
 end

data/test/aitch/request/client_https_test.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "test_helper"
 
 class ClientHttpsTest < Minitest::Test

data/test/aitch/request/follow_redirect_test.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "test_helper"
 
 class FollowRedirectTest < Minitest::Test
@@ -25,9 +26,9 @@ class FollowRedirectTest < Minitest::Test
     register_uri(:get, "http://example.org/", location: "http://example.com/", status: 301)
     register_uri(:get, "http://example.com/", location: "https://example.com/", status: 301)
 
-    assert_raises(Aitch::TooManyRedirectsError) {
+    assert_raises(Aitch::TooManyRedirectsError) do
       Aitch.get("http://example.org/")
-    }
+    end
   end
 
   test "returns only redirection urls" do
@@ -50,7 +51,7 @@ class FollowRedirectTest < Minitest::Test
     register_uri(:post, "http://example.org/hi", status: 307, location: "/hello")
     register_uri(:post, "http://example.org/hello", status: 200)
 
-    response = Aitch.post("http://example.org/", {a: 1}, {Range: "1..100"})
+    response = Aitch.post("http://example.org/", {a: 1}, Range: "1..100")
 
     assert_equal "http://example.org/hello", response.url
     assert_equal 200, response.code

data/test/aitch/request/json_request_test.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "test_helper"
 
 class JsonRequestTest < Minitest::Test

data/test/aitch/request/request_class_test.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+
 require "test_helper"
 
 class RequestClassTest < Minitest::Test
   test "raises with invalid method" do
-    error = assert_raises(Aitch::InvalidHTTPMethodError) {
+    error = assert_raises(Aitch::InvalidHTTPMethodError) do
       build_request(request_method: "invalid").request
-    }
+    end
 
     assert_equal %[unexpected HTTP verb: "invalid"], error.message
   end

data/test/aitch/request/status_code_validation_test.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
+
 require "test_helper"
 
 class StatusCodeValidationTest < Minitest::Test
   test "raises exception when status code isn't valid" do
     register_uri(:get, "http://example.org/", status: 404)
 
-    error = assert_raises(Aitch::StatusCodeError) {
+    error = assert_raises(Aitch::StatusCodeError) do
       Aitch.get("http://example.org/", {}, {}, expect: [200])
-    }
+    end
 
     assert_equal "Expected(200 OK) <=> Actual(404 Not Found)", error.message
   end

data/test/aitch/request_test.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
+
 require "test_helper"
 
 class RequestTest < Minitest::Test
   test "sets content type" do
-    request = build_request(content_type: 'application/json')
-    assert_equal 'application/json', request.content_type
+    request = build_request(content_type: "application/json")
+    assert_equal "application/json", request.content_type
   end
 
   test "raises with invalid uri" do
@@ -25,9 +26,11 @@ class RequestTest < Minitest::Test
   end
 
   test "sets user agent" do
-    requester = build_request
+    requester = build_request(headers: {"User-Agent" => "CUSTOM"})
     request = requester.request
-    assert_equal requester.options[:user_agent], request["User-Agent"]
+
+    assert_equal "CUSTOM", requester.headers["User-Agent"]
+    assert_equal "CUSTOM", request["User-Agent"]
   end
 
   test "requests gzip encoding" do
@@ -50,6 +53,11 @@ class RequestTest < Minitest::Test
     assert_equal "some body", request.body
   end
 
+  test "sets request body from params key" do
+    request = build_request(request_method: "post", params: "some body").request
+    assert_equal "some body", request.body
+  end
+
   test "sets json body from object" do
     request = build_request(
       request_method: "post",
@@ -66,7 +74,7 @@ class RequestTest < Minitest::Test
     request = build_request(
       request_method: "post",
       data: {a: 1},
-      options: {json_parser: JSON, default_headers: {'Content-Type' => 'application/json'}}
+      options: {json_parser: JSON, default_headers: {"Content-Type" => "application/json"}}
     ).request
 
     expected = {a: 1}.to_json
@@ -121,7 +129,7 @@ class RequestTest < Minitest::Test
   test "performs request when using dsl" do
     register_uri(:post, /.+/)
 
-    response = Aitch.post do
+    Aitch.post do
       url "http://example.org/some/path"
       params a: 1, b: 2
       headers Rendering: "0.1"
@@ -132,7 +140,36 @@ class RequestTest < Minitest::Test
     assert_equal :post, last_request.method
     assert_equal "a=1&b=2", last_request.body
     assert_equal "0.1", last_request.headers["Rendering"]
-    assert_equal "user", last_request.uri.user
-    assert_equal "pass", last_request.uri.password
+    assert_equal "user:pass", Base64.decode64(last_request.headers["Authorization"].split(" ").last)
+  end
+
+  test "performs request when using kwargs" do
+    register_uri(:post, /.+/)
+
+    Aitch.post(
+      url: "http://example.org/some/path",
+      data: {a: 1, b: 2},
+      headers: {Rendering: "0.1"},
+      options: {user: "user", password: "pass"}
+    )
+
+    assert_equal "/some/path", last_request.uri.request_uri
+    assert_equal :post, last_request.method
+    assert_equal "a=1&b=2", last_request.body
+    assert_equal "0.1", last_request.headers["Rendering"]
+    assert_equal "user:pass", Base64.decode64(last_request.headers["Authorization"].split(" ").last)
+  end
+
+  test "uses base url" do
+    register_uri(:get, /.+/)
+
+    client = Aitch::Namespace.new
+    client.configure {|c| c.base_url = "https://example.com" }
+
+    client.get("/some/path")
+
+    assert_equal "/some/path", last_request.uri.request_uri
+    assert_equal "example.com", last_request.uri.host
+    assert_equal "https", last_request.uri.scheme
   end
 end

data/test/aitch/response/custom_response_parser_test.rb

@@ -1,14 +1,11 @@
 # frozen_string_literal: true
+
 require "test_helper"
 require "csv"
 
 class CustomResponseParserTest < Minitest::Test
   setup do
     parser = Class.new do
-      def self.type
-        :csv
-      end
-
       def self.match?(content_type)
         content_type =~ /csv/
       end

data/test/aitch/response/default_response_parser_test.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require "csv"
+
+class DefaultResponseParserTest < Minitest::Test
+  test "returns application/custom" do
+    register_uri(:get, "http://example.org/file.custom", body: "1,2,3", content_type: "application/custom")
+    response = Aitch.get("http://example.org/file.custom")
+
+    assert_instance_of String, response.data
+    assert_equal %[1,2,3], response.data
+  end
+end

data/test/aitch/response/errors_test.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "test_helper"
 
 class ErrorsTest < Minitest::Test

data/test/aitch/response/html_response_test.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "test_helper"
 
 class HtmlResponseTest < Minitest::Test