aitch 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79fcbcbeb7a0487eb6071a17cdfe2a4ffceed98d1c1358a7e5a6613d916a0256
-  data.tar.gz: a302171234f54b7b6607a5c8a8eda1c8b32c3b35658e65323ccd5a5cd6403ed3
+  metadata.gz: a3f4cd3269e5b709f85e34148b2ed6aad4a9080f9903dc625d4840d8ffc2293a
+  data.tar.gz: d97a344ec31e5f6ba528f1d359b96aa2860ab51e1cdde507d5cbc0557e9a75a4
 SHA512:
-  metadata.gz: f144ceb163b3a9cd1a91649b67bc5771fb5f73dcd021846147aa7b5583eeb4a13aa2d694cd7f468ca292b14e3226f09be8b0c9dd17292bfc74bc3792eabc2707
-  data.tar.gz: 15974c7b5905d82798affa69f3494d6ca43b32e4f7ee4b175b350994d9627a0df04af3aa626cec9424ea31ae23da626ae212f446b79c571acb6cf39afc317d81
+  metadata.gz: a11acc6e165677b372cd4c9a07b9fd33640611a056fb1c437917ffa1d89ab0520bcaf9943cd5e8f72a3f088942a8f7b9d968a59ec7207dc6a061f54364216aba
+  data.tar.gz: a0228f9d4719ee0fddd2932fece69c454062d40f4526612b41044168198f7ec91478267163e343a995ceb5f8bbcdc1d4d228d8edb73a9845b5aa0d08145581c9

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+---
+github: [fnando]
+custom: ["https://www.paypal.me/nandovieira/🍕"]

data/.github/workflows/tests.yml

@@ -0,0 +1,50 @@
+---
+name: Tests
+
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+jobs:
+  build:
+    name: Tests with Ruby ${{ matrix.ruby }}
+    runs-on: "ubuntu-latest"
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["2.7.x", "2.6.x", "2.5.x", "3.0.x", "3.1.x"]
+
+    steps:
+      - uses: actions/checkout@v1
+
+      - uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: >
+            ${{ runner.os }}-${{ matrix.ruby }}-gems-${{
+            hashFiles('aitch.gemspec') }}
+          restore-keys: >
+            ${{ runner.os }}-${{ matrix.ruby }}-gems-${{
+            hashFiles('aitch.gemspec') }}
+
+      - name: Set up Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install gem dependencies
+        env:
+          RAILS_ENV: test
+        run: |
+          gem install bundler
+          bundle config path vendor/bundle
+          bundle update --jobs 4 --retry 3
+
+      - name: Run Tests
+        env:
+          RAILS_ENV: test
+        run: |
+          bundle exec rake

data/.rubocop.yml

@@ -3,7 +3,7 @@ inherit_gem:
   rubocop-fnando: .rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.5
 
 Layout/LineLength:
   Exclude:

data/README.md

@@ -1,24 +1,24 @@
 # Aitch
 
-[![Build Status](https://travis-ci.org/fnando/aitch.png)](https://travis-ci.org/fnando/aitch)
+[![Tests](https://github.com/fnando/aitch/workflows/Tests/badge.svg)](https://github.com/fnando/aitch)
 [![Code Climate](https://codeclimate.com/github/fnando/aitch/badges/gpa.svg)](https://codeclimate.com/github/fnando/aitch)
-[![Test Coverage](https://codeclimate.com/github/fnando/aitch/badges/coverage.svg)](https://codeclimate.com/github/fnando/aitch)
-[![RubyGems](https://badge.fury.io/rb/aitch.png)](https://rubygems.org/gems/aitch)
+[![Gem Version](https://img.shields.io/gem/v/aitch.svg)](https://rubygems.org/gems/aitch)
+[![Gem Downloads](https://img.shields.io/gem/dt/aitch.svg)](https://rubygems.org/gems/aitch)
 
 A simple HTTP client.
 
 Features:
 
-* Supports Gzip|Deflate response
-* Automatically parses JSON, HTML and XML responses
-* Automatically follows redirect
+- Supports Gzip|Deflate response
+- Automatically parses JSON, HTML and XML responses
+- Automatically follows redirect
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'aitch'
+gem "aitch"
 ```
 
 And then execute:
@@ -54,6 +54,9 @@ Aitch.configure do |config|
 
   # Set the logger.
   config.logger = nil
+
+  # Set the base url.
+  config.base_url = nil
 end
 ```
 
@@ -115,7 +118,8 @@ response.data             # Parsed response body
 
 #### Parsing JSON, XML and HTML with Nokogiri
 
-If your response is a JSON, XML or a HTML content type, we'll automatically convert the response into the appropriate object.
+If your response is a JSON, XML or a HTML content type, we'll automatically
+convert the response into the appropriate object.
 
 ```ruby
 response = Aitch.get("http://simplesideias.com.br")
@@ -159,7 +163,8 @@ The request:
 Aitch.get("http://example.org")
 ```
 
-If the redirect limit is exceeded, then the `Aitch::TooManyRedirectsError` exception is raised.
+If the redirect limit is exceeded, then the `Aitch::TooManyRedirectsError`
+exception is raised.
 
 ### Basic auth
 
@@ -207,7 +212,8 @@ Request.get("http://example.org")
 
 ### Validating responses
 
-When you know the kind of response you're expecting, you can validate it by specifying the `expect` option.
+When you know the kind of response you're expecting, you can validate it by
+specifying the `expect` option.
 
 ```ruby
 Aitch.get do
@@ -216,7 +222,8 @@ Aitch.get do
 end
 ```
 
-If this request receives anything other than `200`, it will raise a `Aitch::StatusCodeError` exception.
+If this request receives anything other than `200`, it will raise a
+`Aitch::StatusCodeError` exception.
 
 ```
 Expect(200 OK) <=> Actual(404 Not Found)
@@ -226,7 +233,10 @@ You can also provide a list of accepted statuses, like `expect: [200, 201]`.
 
 ### Response Parsers
 
-You can register new response parsers by using `Aitch::ResponseParser.register(name, parser)`, where parser must implement the methods `match?(content_type)` and `load(response_body)`. This is how you could load CSV values.
+You can register new response parsers by using
+`Aitch::ResponseParser.register(name, parser)`, where parser must implement the
+methods `match?(content_type)` and `load(response_body)`. This is how you could
+load CSV values.
 
 ```ruby
 require "csv"
@@ -248,7 +258,8 @@ end
 Aitch::ResponseParser.prepend(:csv, CSVParser)
 ```
 
-The default behavior is returning the response body. You can replace it as the following:
+The default behavior is returning the response body. You can replace it as the
+following:
 
 ```ruby
 module DefaultParser
@@ -272,13 +283,31 @@ Aitch::ResponseParser.append(:default, DefaultParser)
 
 Aitch comes with response parsers for HTML, XML and JSON.
 
-By default, the JSON parser will be `JSON`. To set it to something else, use `Aitch::ResponseParser::JSONParser.engine`.
+By default, the JSON parser will be `JSON`. To set it to something else, use
+`Aitch::ResponseParser::JSONParser.engine`.
 
 ```ruby
 require "oj"
 Aitch::ResponseParser::JSONParser.engine = Oj
 ```
 
+### Setting the base url
+
+When you're creating a wrapper for an API, usually the hostname is the same for
+the whole API. In this case, you can avoid having to pass it around all the time
+by setting `Aitch::Configuration#base_url`. This option is meant to be used when
+you instantiate a new namespace.
+
+```ruby
+Client = Aitch::Namespace.new
+
+Client.configure do |config|
+  config.base_url = "https://api.example.com"
+end
+
+Client.get("/users")
+```
+
 ## Contributing
 
 1. Fork it

data/aitch.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary       = spec.description
   spec.homepage      = "http://rubygems.org/gems/aitch"
   spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) {|f| File.basename(f) }

data/lib/aitch/configuration.rb

@@ -23,12 +23,16 @@ module Aitch
     # Set the logger.
     attr_accessor :logger
 
+    # Set the base url.
+    attr_accessor :base_url
+
     def initialize
       @timeout = 10
       @redirect_limit = 5
       @follow_redirect = true
       @user_agent = "Aitch/#{Aitch::VERSION} (http://rubygems.org/gems/aitch)"
       @default_headers = {}
+      @base_url = nil
     end
 
     def to_h

data/lib/aitch/ext/to_query.rb

@@ -37,12 +37,6 @@ class FalseClass
 end
 
 class Array
-  # Calls <tt>to_param</tt> on all its elements and joins the result with
-  # slashes. This is used by <tt>url_for</tt> in Action Pack.
-  def to_param
-    collect(&:to_param).join "/"
-  end
-
   # Converts an array into a string suitable for use as a URL query string,
   # using the given +key+ as the param name.
   #

data/lib/aitch/location.rb

@@ -10,7 +10,7 @@ module Aitch
     end
 
     def location
-      return current_url unless current_url.match(%r{\A/})
+      return current_url unless current_url.match?(%r{\A/}) # rubocop:disable Performance/StartWith
 
       uri = find_uri_with_host
       url = ["#{uri.scheme}://#{uri.hostname}"]

data/lib/aitch/namespace.rb

@@ -25,7 +25,7 @@ module Aitch
       headers ||= {}
       options ||= {}
 
-      if block_given?
+      if block
         dsl = DSL.new
         dsl.instance_eval(&block)
         args = dsl.to_h
@@ -38,10 +38,8 @@ module Aitch
         }
       end
 
-      args.merge!(
-        request_method: request_method,
-        options: config.to_h.merge(Utils.symbolize_keys(args[:options]))
-      )
+      args[:request_method] = request_method
+      args[:options] = config.to_h.merge(Utils.symbolize_keys(args[:options]))
 
       Request.new(args).perform
     end

data/lib/aitch/request.rb

@@ -2,12 +2,7 @@
 
 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=
@@ -62,7 +57,15 @@ 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
@@ -76,7 +79,7 @@ module Aitch
       body_data = data
       body_data = data.to_h if data.respond_to?(:to_h)
 
-      if content_type.to_s =~ /\bjson\b/
+      if content_type.to_s.match?(/\bjson\b/)
         body_data = ResponseParser::JSONParser.engine.dump(body_data)
       end
 

data/lib/aitch/response.rb

@@ -83,7 +83,7 @@ module Aitch
     end
 
     def respond_to_missing?(name, _include_private = false)
-      headers.key?(name.to_s)
+      headers.key?(name.to_s) || super
     end
 
     def description

data/lib/aitch/uri.rb

@@ -6,15 +6,15 @@ module Aitch
 
     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
 
       begin
         @uri = ::URI.parse(url)
-      rescue ::URI::InvalidURIError => e
-        raise InvalidURIError, e
+      rescue ::URI::InvalidURIError => error
+        raise InvalidURIError, error
       end
     end
 

data/lib/aitch/version.rb

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

data/test/aitch/request_test.rb

@@ -159,4 +159,17 @@ class RequestTest < Minitest::Test
     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

@@ -6,10 +6,6 @@ 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/to_query_test.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class ToQueryTest < Minitest::Test
+  test "converts array" do
+    assert_equal "hobbies%5B%5D=Rails&hobbies%5B%5D=coding",
+                 %w[Rails coding].to_query("hobbies")
+    assert_equal "hobbies%5B%5D=",
+                 [].to_query("hobbies")
+  end
+
+  test "converts hash" do
+    assert_equal "name=David&nationality=Danish",
+                 {name: "David", nationality: "Danish"}.to_query
+
+    assert_equal "user%5Bname%5D=David&user%5Bnationality%5D=Danish",
+                 {name: "David", nationality: "Danish"}.to_query("user")
+  end
+
+  test "converts booleans" do
+    assert_equal "done=false&ready=true",
+                 {ready: true, done: false}.to_query
+
+    assert_equal "states%5B%5D=true&states%5B%5D=false",
+                 [true, false].to_query("states")
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aitch
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Nando Vieira
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-18 00:00:00.000000000 Z
+date: 2022-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -171,9 +171,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -214,6 +215,7 @@ files:
 - test/aitch/request/status_code_validation_test.rb
 - test/aitch/request_test.rb
 - test/aitch/response/custom_response_parser_test.rb
+- test/aitch/response/default_response_parser_test.rb
 - test/aitch/response/errors_test.rb
 - test/aitch/response/html_response_test.rb
 - test/aitch/response/json_response_test.rb
@@ -226,6 +228,7 @@ files:
 - test/aitch/response_parser/json_parser_test.rb
 - test/aitch/response_parser/xml_parser_test.rb
 - test/aitch/response_test.rb
+- test/aitch/to_query_test.rb
 - test/aitch/uri_test.rb
 - test/aitch/utils/symbolize_keys_test.rb
 - test/aitch/utils/underscore_test.rb
@@ -236,7 +239,7 @@ homepage: http://rubygems.org/gems/aitch
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -244,15 +247,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.17
+signing_key:
 specification_version: 4
 summary: A simple HTTP client
 test_files:
@@ -268,6 +271,7 @@ test_files:
 - test/aitch/request/status_code_validation_test.rb
 - test/aitch/request_test.rb
 - test/aitch/response/custom_response_parser_test.rb
+- test/aitch/response/default_response_parser_test.rb
 - test/aitch/response/errors_test.rb
 - test/aitch/response/html_response_test.rb
 - test/aitch/response/json_response_test.rb
@@ -280,6 +284,7 @@ test_files:
 - test/aitch/response_parser/json_parser_test.rb
 - test/aitch/response_parser/xml_parser_test.rb
 - test/aitch/response_test.rb
+- test/aitch/to_query_test.rb
 - test/aitch/uri_test.rb
 - test/aitch/utils/symbolize_keys_test.rb
 - test/aitch/utils/underscore_test.rb

data/.travis.yml

@@ -1,20 +0,0 @@
----
-language: ruby
-script: "bundle exec rake"
-before_install: gem install bundler
-cache: bundler
-sudo: false
-
-rvm:
-  - "2.7"
-
-gemfile:
-  - Gemfile
-
-notifications:
-  email: false
-
-addons:
-  code_climate:
-    repo_token:
-      secure: "j/AjAG1u7NtdldftKUXnTMKC7CPd2R/O55ejzZnJi5IlHKKKZgJla1Z0YHTsGr75JQS7Q00D0L3TOSY8fLhV6fXO3Gn+9ShKTFRV5+iUtzlV0AWKBw+uENKNJH4jn1FhCoV8Th0I6OKtq98PqZ/hLR2J+/Uv3oCBwyriyJqag2U="