aitch 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1608bb2a19cd498230af4c13ff13f5470c038b8c
-  data.tar.gz: 1dd7c3cde77b473060edfccb1865eed448de4cda
+SHA256:
+  metadata.gz: a3f4cd3269e5b709f85e34148b2ed6aad4a9080f9903dc625d4840d8ffc2293a
+  data.tar.gz: d97a344ec31e5f6ba528f1d359b96aa2860ab51e1cdde507d5cbc0557e9a75a4
 SHA512:
-  metadata.gz: 00029220787908d61ed6b1d64a8dcbe9e0dffdc3f450c3ce67d56b836d9967919fc12a1f18298919876478c5ef916146d529992d1008752b33eff1e36622573c
-  data.tar.gz: ff9e4b489b83f083d172e035a5440bd4db7ef36404c8f6fe728c408124a8a86927069e18183eea312038b7fb581668fe7e729d39a5e90bd4131811f46c0ee618
+  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

@@ -0,0 +1,26 @@
+---
+inherit_gem:
+  rubocop-fnando: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+
+Layout/LineLength:
+  Exclude:
+    - test/**/*.rb
+
+Naming/AccessorMethodName:
+  Exclude:
+    - lib/aitch/request.rb
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false

data/Gemfile

@@ -1,4 +1,4 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 gemspec
-
-gem "pry-meta", platforms: [:ruby_20, :ruby_21, :ruby_22]

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
 ```
 
@@ -83,6 +86,17 @@ response = Aitch.get do
 end
 ```
 
+Finally, you can use keyword arguments:
+
+```ruby
+Aitch.get(
+  url: "http://example.org",
+  params: {a: 1, b: 2},
+  headers: {Authorization: "Token token=abc"},
+  options: {follow_redirect: false}
+)
+```
+
 ### Response
 
 The response object:
@@ -104,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")
@@ -148,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
 
@@ -196,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
@@ -205,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)
@@ -215,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"
@@ -237,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
@@ -261,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/Rakefile

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "rubocop/rake_task"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -8,4 +10,6 @@ Rake::TestTask.new(:test) do |t|
   t.warning = false
 end
 
-task default: :test
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/aitch.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "./lib/aitch/version"
 
 Gem::Specification.new do |spec|
@@ -9,20 +11,23 @@ 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($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}) {|f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.0"
-
-  spec.add_dependency "nokogiri", ">= 1.6.0"
+  spec.add_dependency "nokogiri"
 
-  spec.add_development_dependency "codeclimate-test-reporter"
   spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
   spec.add_development_dependency "minitest-utils"
   spec.add_development_dependency "mocha"
+  spec.add_development_dependency "pry-meta"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-fnando"
+  spec.add_development_dependency "simplecov"
   spec.add_development_dependency "webmock"
 end

data/lib/aitch/configuration.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Aitch
   class Configuration
     # Set proxy.
@@ -22,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/dsl.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
+
 module Aitch
   class DSL
     %w[url options headers data].each do |name|
-      class_eval <<-RUBY
+      class_eval <<~RUBY, __FILE__, __LINE__ + 1
         attr_writer :#{name}
 
         def #{name}(*args)
@@ -12,8 +13,8 @@ module Aitch
       RUBY
     end
 
-    alias_method :params, :data
-    alias_method :body, :data
+    alias params data
+    alias body data
 
     def to_h
       {

data/lib/aitch/engines/json.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Aitch
+  module Engines
+    module JSON
+      def self.load(data)
+        data && ::JSON.parse(data)
+      end
+
+      def self.dump(data)
+        ::JSON.dump(data)
+      end
+    end
+  end
+end

data/lib/aitch/errors.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Aitch
   InvalidURIError        = Class.new(StandardError)
   InvalidHTTPMethodError = Class.new(StandardError)

data/lib/aitch/ext/to_query.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "cgi"
 
 class Object
@@ -36,23 +37,18 @@ 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 { |e| e.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.
   #
-  #   ['Rails', 'coding'].to_query('hobbies') # => "hobbies%5B%5D=Rails&hobbies%5B%5D=coding"
+  #   ["Rails", "coding"].to_query("hobbies")
+  #   # => "hobbies%5B%5D=Rails&hobbies%5B%5D=coding"
   def to_query(key)
     prefix = "#{key}[]"
 
     if empty?
       nil.to_query(prefix)
     else
-      collect { |value| value.to_query(prefix) }.join '&'
+      collect {|value| value.to_query(prefix) }.join "&"
     end
   end
 end
@@ -78,8 +74,8 @@ class Hash
       unless (value.is_a?(Hash) || value.is_a?(Array)) && value.empty?
         value.to_query(namespace ? "#{namespace}[#{key}]" : key)
       end
-    end.compact.sort! * '&'
+    end.compact.sort! * "&"
   end
 
-  alias_method :to_param, :to_query
+  alias to_param to_query
 end

data/lib/aitch/location.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Aitch
   class Location
     attr_reader :redirect_stack, :current_url
@@ -9,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}"]
@@ -20,8 +21,8 @@ module Aitch
 
     def find_uri_with_host
       redirect_stack.reverse
-        .map {|url| ::URI.parse(url) }
-        .find {|uri| uri.scheme }
+                    .map {|url| ::URI.parse(url) }
+                    .find(&:scheme)
     end
   end
 end

data/lib/aitch/namespace.rb

@@ -1,17 +1,31 @@
 # frozen_string_literal: true
+
 module Aitch
   class Namespace
-    def configure(&block)
+    def configure
       yield config
     end
 
     def config
       @config ||= Configuration.new
     end
-    alias_method :configuration, :config
+    alias configuration config
+
+    def execute(
+      request_method: nil,
+      url: nil,
+      params: nil,
+      data: nil,
+      body: nil,
+      headers: nil,
+      options: nil,
+      &block
+    )
+      data = data || params || body || {}
+      headers ||= {}
+      options ||= {}
 
-    def execute(request_method = nil, url = nil, data = {}, headers = {}, options = {}, &block)
-      if block_given?
+      if block
         dsl = DSL.new
         dsl.instance_eval(&block)
         args = dsl.to_h
@@ -24,17 +38,18 @@ 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
 
     def execute!(*args, &block)
-      response = execute(*args, &block)
+      options = extract_args!(args)
+      response = execute(**options, &block)
+
       raise response.error if response.error?
+
       response
     end
 
@@ -47,14 +62,23 @@ module Aitch
       options
       trace
       head
-    ].each do |method_name|
-      define_method(method_name) do |url = nil, data = {}, headers = {}, options = {}, &block|
-        execute(method_name, url, data, headers, options, &block)
+    ].each do |request_method|
+      define_method(request_method) do |*args, &block|
+        options = extract_args!(args)
+        execute(**options.merge(request_method: request_method), &block)
       end
 
-      define_method("#{method_name}!") do |url = nil, data = {}, headers = {}, options = {}, &block|
-        execute!(method_name, url, data, headers, options, &block)
+      define_method("#{request_method}!") do |*args, &block|
+        options = extract_args!(args)
+
+        execute!(**options.merge(request_method: request_method), &block)
       end
     end
+
+    private def extract_args!(args)
+      return args.first if args.size == 1 && args.first.is_a?(Hash)
+
+      %i[url data headers options].zip(args).to_h
+    end
   end
 end

data/lib/aitch/redirect.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Aitch
   class Redirect
     attr_reader :tries