http-client-generator 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21d65c38e42bcd0404d1eaf2e444adfae16136940b1c162c41f29757cd88531b
-  data.tar.gz: 869036773a9dbcac9ea6651304a97d48c5fd8d5ee48a6d34dbc052c88bebd9eb
+  metadata.gz: edc63e0a164b0694ebe93647137b6b825061c57064cf851f4675c5e2955e6fd6
+  data.tar.gz: 68ee612dc6a37f278351736ab53fe8d2a85598314c570b65bb4e9f7daffc9463
 SHA512:
-  metadata.gz: bd8c24c756289f12cf0868a39b2954898b05c9eface230e1f2c3c34e2b63fca31fa9654e810e2d39348b31758929a3a96bcded22d3155110f0757e56804a0df5
-  data.tar.gz: aa75c5897ed9e37c3bea2a432160d0226a6d3b43ec267eac87c7dcd362983848f46f15eba413e3ef65e7adda4d43cab5b5aa5d52e2ca20e401770dab0d40b61a
+  metadata.gz: 6b15241122952c07b5560047c505e5bffb0a2f6c2ff80c5626de3a152636766fd9a61e72ff01c9734b06a235aa7aaa33796af544c621e801c5088377f22f50f6
+  data.tar.gz: a5663a4c5f8f1c8daeb0e83f3cbefff6f5d6499f5f0ff5011c8324cd9a27780ed0bffce2b9902f37386ad1e91890f532f6e825d536d0e897fbaa2838a7bd4dcc

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Pavel Egorov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,39 +1,379 @@
-# Http::Client::Generator
+# HttpClientGenerator
 
-TODO: Delete this and the text below, and describe your gem
+`http-client-generator` is a small Ruby DSL for building API clients on top of the
+[`http`](https://github.com/httprb/http) gem.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/http/client/generator`. To experiment with that code, run `bin/console` for an interactive prompt.
+You declare resources, attach request and response plugs, provide a URL helper,
+and the gem generates class-level request methods such as `get_user`,
+`post_issue`, or `patch_repository`.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Add the gem to your application:
 
-Install the gem and add to the application's Gemfile by executing:
+```ruby
+gem 'http-client-generator'
+```
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+Then run:
 
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+```sh
+bundle install
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+Define a client module, include `HttpClientGenerator`, declare resources, and
+provide a URL helper module with methods that match each resource name.
 
-## Development
+This example sketches a small GitHub API client.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+require 'http_client_generator'
+require 'zeitwerk'
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Zeitwerk::Loader.for_gem.setup
 
-## Contributing
+module GitHub
+  include HttpClientGenerator
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/http-client-generator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/http-client-generator/blob/master/CODE_OF_CONDUCT.md).
+  Configuration = Struct.new(:base_url, :access_token, keyword_init: true)
 
-## License
+  class InvalidConfigurationError < Error
+    ACCESS_TOKEN_ERROR = 'Access token should be a non-empty String.'
+    BASE_URL_ERROR = 'Base URL should be a non-empty String.'
+  end
+
+  resources do
+    req_plug :set_request_id, :x_request_id
+    req_plug :set_header, header: :accept, value: 'application/vnd.github+json'
+    req_plug :set_header, header: :x_github_api_version, value: '2022-11-28'
+    req_plug :set_header,
+      header: :authorization,
+      value: -> { "Bearer #{GitHub.config.access_token}" }
+
+    req_plug :camelize_body
+
+    resp_plug :enforce_json_response
+    resp_plug :underscore_response
+
+    timeout connect: 2, read: 5, write: 5
+
+    get :user
+    get :repository
+    get :repository_issues, timeout: 10
+    post :issue
+    patch :issue
+  end
+
+  url_helper UrlHelper
+
+  process_config do |config|
+    validation_errors = []
+
+    unless config.access_token.is_a?(String) && !config.access_token.empty?
+      validation_errors << InvalidConfigurationError::ACCESS_TOKEN_ERROR
+    end
+
+    unless config.base_url.is_a?(String) && !config.base_url.empty?
+      validation_errors << InvalidConfigurationError::BASE_URL_ERROR
+    end
+
+    raise InvalidConfigurationError, validation_errors.join(' ') if validation_errors.any?
+  end
+end
+```
+
+```ruby
+require 'uri'
+
+module GitHub
+  module UrlHelper
+    include HttpClientGenerator::UrlBuilder
+
+    def user(_options = {})
+      "#{config.base_url}/user"
+    end
+
+    def repository(options)
+      "#{config.base_url}/repos/#{options.fetch(:owner)}/#{options.fetch(:repo)}"
+    end
+
+    def repository_issues(options)
+      build_url(
+        url: "#{config.base_url}/repos/#{options.fetch(:owner)}/#{options.fetch(:repo)}/issues",
+        query: options.slice(:state, :labels, :since, :per_page, :page),
+      )
+    end
+
+    def issue(options)
+      issue_number = options[:issue_number]
+      path = "#{config.base_url}/repos/#{options.fetch(:owner)}/#{options.fetch(:repo)}/issues"
+
+      issue_number ? "#{path}/#{issue_number}" : path
+    end
+
+    private
+
+    def config = GitHub.config
+
+    def build_url(url:, query: {})
+      uri = URI(url)
+      query_values = query.compact.transform_keys { |key| HttpClientGenerator::Inflector.camelize_lower(key) }
+
+      uri.query = URI.encode_www_form(query_values) if query_values.any?
+      uri.to_s
+    end
+  end
+end
+```
+
+Configure the client before making requests:
+
+```ruby
+GitHub.configure do |config|
+  config.base_url = 'https://api.github.com'
+  config.access_token = ENV.fetch('GITHUB_TOKEN')
+end
+```
+
+Then call generated methods. Method names are built from the HTTP verb and
+resource name:
+
+```ruby
+GitHub.get_user
+
+GitHub.get_user(timeout: 1)
+
+GitHub.get_repository(owner: 'rails', repo: 'rails')
+
+GitHub.get_repository_issues(
+  { owner: 'rails', repo: 'rails', state: 'open', per_page: 10 },
+  request_id: SecureRandom.uuid,
+)
+
+GitHub.post_issue(
+  { owner: 'octo-org', repo: 'octo-repo' },
+  body: {
+    title: 'Bug report',
+    body: 'Steps to reproduce...',
+    labels: ['bug'],
+  },
+)
+
+GitHub.patch_issue(
+  { owner: 'octo-org', repo: 'octo-repo', issue_number: 42 },
+  body: {
+    state: 'closed',
+  },
+)
+```
+
+## Resources
+
+Declare resources inside a `resources` block:
+
+```ruby
+resources do
+  get :user
+  post :issue
+  put :repository
+  patch :issue
+end
+```
+
+Each resource generates a singleton method on the client module:
+
+| Declaration | Generated method |
+| --- | --- |
+| `get :user` | `get_user` |
+| `post :issue` | `post_issue` |
+| `put :repository` | `put_repository` |
+| `patch :issue` | `patch_issue` |
+
+Generated methods accept URL options as the first positional argument, optional
+`body:` and `timeout:` keywords, and any extra keyword arguments consumed by
+plugs:
+
+```ruby
+Client.post_resource(
+  { id: 1 },
+  body: { name: 'Example' },
+  timeout: 2,
+  request_id: 'abc-123',
+)
+```
+
+JSON is the default content type. Use `content_type: :text` for plain text
+request bodies:
+
+```ruby
+resources do
+  post :webhook_test, content_type: :text
+end
+```
+
+## Timeouts
+
+Timeouts mirror the `http` gem API. Use a numeric value for a global timeout,
+per-operation values for connect/read/write limits, or `:null` to explicitly
+disable timeout handling.
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+```ruby
+resources do
+  timeout 5
 
-## Code of Conduct
+  get :user
+  get :repository_issues, timeout: { read: 10 }
+
+  namespace do
+    timeout connect: 1, read: 3, write: 3
+
+    post :issue
+  end
+
+  get :stream, timeout: :null
+end
+```
+
+Timeout precedence, from highest to lowest:
+
+1. Per-call `timeout:`
+2. Resource-level `timeout:`
+3. Current scoped `timeout`
+4. No timeout configuration
+
+```ruby
+Client.get_user(timeout: 1)
+Client.post_issue({ id: 1 }, body: { title: 'Bug' }, timeout: :null)
+```
+
+## URL Helpers
+
+Register a URL helper with `url_helper`. The helper must respond to every
+resource name and return a complete URL.
+
+```ruby
+module Client
+  module UrlHelper
+    include HttpClientGenerator::UrlBuilder
+
+    def resource(options)
+      "#{Client.config.base_url}/resources/#{options.fetch(:id)}"
+    end
+  end
+end
+
+Client.url_helper Client::UrlHelper
+```
+
+`HttpClientGenerator::UrlBuilder` extends the helper module so resource URLs can
+be called by the generated client methods.
+
+## Plugs
+
+Plugs are objects that respond to `call(request)`. Request plugs run before the
+HTTP request. Response plugs run after the response body is read.
+
+```ruby
+resources do
+  req_plug :set_request_id, :x_request_id
+  req_plug :set_bearer_token, from_arg: :access_token
+
+  resp_plug :enforce_json_response
+  resp_plug :underscore_response
+
+  get :profile
+end
+```
+
+Built-in request plugs:
+
+| Plug | Purpose |
+| --- | --- |
+| `:set_request_id` | Sets a generated or provided request id header. |
+| `:set_header` | Sets a static, dynamic, or argument-derived header. |
+| `:set_bearer_token` | Sets `Authorization: Bearer ...` from an extra method argument. |
+| `:camelize_body` | Camelizes JSON request body keys. |
+| `:validate_request` | Validates request bodies with a schema helper. |
+
+Built-in response plugs:
+
+| Plug | Purpose |
+| --- | --- |
+| `:enforce_json_response` | Parses the response as JSON and raises on invalid JSON. |
+| `:encode_json_response` | Parses JSON responses when possible and leaves invalid JSON unchanged. |
+| `:underscore_response` | Underscores parsed response keys. |
+| `:validate_response` | Validates parsed response bodies with a schema helper. |
+
+Limit plugs to specific resources with `only:` or `except:`:
+
+```ruby
+resources do
+  req_plug :camelize_body, only: %i[create_issue update_issue]
+  resp_plug :enforce_json_response, except: :download_archive
+
+  post :create_issue
+  patch :update_issue
+  get :download_archive, content_type: :text
+end
+```
+
+You can also pass a callable plug:
+
+```ruby
+resources do
+  req_plug ->(request) {
+    request.headers[:user_agent] = 'my-client/1.0'
+    request
+  }
+
+  get :user
+end
+```
+
+## Configuration
+
+The client module owns its configuration type. Define `Configuration`, then call
+`configure`:
+
+```ruby
+module Client
+  include HttpClientGenerator
+
+  Configuration = Struct.new(:base_url, :access_token, keyword_init: true)
+
+  process_config do |config|
+    raise Error, 'Missing base URL' unless config.base_url.is_a?(String)
+  end
+end
+
+Client.configure do |config|
+  config.base_url = 'https://api.example.com'
+  config.access_token = ENV.fetch('ACCESS_TOKEN')
+end
+```
+
+The final configuration object is frozen after `process_config` runs.
+
+## Development
+
+After checking out the repo, run:
+
+```sh
+bin/setup
+bundle exec rake spec
+```
+
+You can also run `bin/console` for an interactive prompt.
+
+To install this gem locally:
+
+```sh
+bundle exec rake install
+```
+
+## License
 
-Everyone interacting in the Http::Client::Generator project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/http-client-generator/blob/master/CODE_OF_CONDUCT.md).
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).

data/lib/http_client_generator/inflector.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module HttpClientGenerator
+  module Inflector # :nodoc:
+    module_function
+
+    def camelize_lower(value)
+      value.to_s.split('_').then do |parts|
+        [parts.first, *parts.drop(1).map(&:capitalize)].join
+      end
+    end
+
+    def underscore(value)
+      value.to_s
+           .gsub('::', '/')
+           .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+           .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+           .tr('-', '_')
+           .downcase
+    end
+  end
+end

data/lib/http_client_generator/key_transformer.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module HttpClientGenerator
+  module KeyTransformer # :nodoc:
+    module_function
+
+    def deep_transform_keys(value, &block)
+      case value
+      when Hash
+        value.each_with_object({}) do |(key, hash_value), transformed|
+          transformed[yield(key)] = deep_transform_keys(hash_value, &block)
+        end
+      when Array
+        value.map { |item| deep_transform_keys(item, &block) }
+      else
+        value
+      end
+    end
+  end
+end

data/lib/http_client_generator/plugs/camelize_body.rb

@@ -2,13 +2,13 @@
 
 module HttpClientGenerator
   class Plugs
-    class CamelizeBody
+    class CamelizeBody # :nodoc:
       Plugs.register :camelize_body, self
 
       def call(req)
         body =
           if req.json? && req.body.is_a?(Hash)
-            req.body.deep_transform_keys { |key| key.to_s.camelize(:lower).to_sym }
+            KeyTransformer.deep_transform_keys(req.body) { |key| Inflector.camelize_lower(key).to_sym }
           else
             req.body
           end

data/lib/http_client_generator/plugs/underscore_response.rb

@@ -2,13 +2,14 @@
 
 module HttpClientGenerator
   class Plugs
-    class UnderscoreResponse
+    class UnderscoreResponse # :nodoc:
       Plugs.register :underscore_response, self
 
       def call(req)
         return req unless req.response_body.is_a?(Hash)
 
-        req.response_body = req.response_body.deep_transform_keys { |k| k.to_s.underscore.to_sym }
+        req.response_body =
+          KeyTransformer.deep_transform_keys(req.response_body) { |key| Inflector.underscore(key).to_sym }
 
         req
       end

data/lib/http_client_generator/request.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 module HttpClientGenerator
-  class Request
+  class Request # :nodoc:
     CONTENT_TYPES = %i[json text].freeze
 
     DEFAULT_HEADERS_BY_CONTENT_TYPE = {
       json: { accept: 'application/json', content_type: 'application/json' },
-      text: { content_type: 'text/plain' },
+      text: { content_type: 'text/plain' }
     }.freeze
 
     CONTENT_TYPES.each do |type|
@@ -15,19 +15,23 @@ module HttpClientGenerator
       end
     end
 
-    attr_accessor :verb, :name, :content_type, :url, :headers, :body, :rest_args, :response_body, :base, :extra
+    attr_accessor :verb, :name, :content_type, :timeout, :url, :headers, :body, :rest_args, :response_body,
+                  :base, :extra
 
-    def initialize(base:, name:, verb:, content_type:, url:, body:, rest_args:)
+    # rubocop:disable Metrics/ParameterLists
+    def initialize(base:, name:, verb:, content_type:, timeout:, url:, body:, rest_args:)
       @base = base
       @name = name
       @verb = verb
       @content_type = content_type
+      @timeout = timeout
       @url = url
       @rest_args = rest_args
       @body = body
       @headers = {}
       @extra = {}
     end
+    # rubocop:enable Metrics/ParameterLists
 
     def current_headers
       default_headers.merge(headers)
@@ -35,15 +39,15 @@ module HttpClientGenerator
 
     def raw_body
       if json?
-        body && body.to_json
+        body&.to_json
       else
         body
       end
     end
 
-    def raise_error(e)
-      Sentry.capture_exception(e, extra: { request_id: extra[:request_id] }) if Object.const_defined?(:Sentry)
-      raise base::RequestError, e.message, e.backtrace, cause: nil
+    def raise_error(error)
+      Sentry.capture_exception(error, extra: { request_id: extra[:request_id] }) if Object.const_defined?(:Sentry)
+      raise base::RequestError, error.message, error.backtrace, cause: nil
     end
 
     def raise_message(message)

data/lib/http_client_generator/resource.rb

@@ -3,28 +3,25 @@
 require 'http'
 
 module HttpClientGenerator
-  class Resource
-    attr_reader :verb, :content_type, :name, :req_plugs, :resp_plugs, :base
+  class Resource # :nodoc:
+    attr_reader :verb, :content_type, :name, :req_plugs, :resp_plugs, :base, :timeout
 
-    def initialize(verb:, content_type:, name:, base:, req_plugs:, resp_plugs:)
+    # rubocop:disable Metrics/ParameterLists
+    def initialize(verb:, content_type:, timeout:, name:, base:, req_plugs:, resp_plugs:)
       @verb = verb
       @base = base
       @content_type = content_type
+      @timeout = timeout
       @name = name
       @req_plugs = select_plugs(req_plugs)
       @resp_plugs = select_plugs(resp_plugs)
     end
+    # rubocop:enable Metrics/ParameterLists
 
-    def perform_request(url_helper, url_options, body, rest_args)
-      request = prepare_request(url_helper, url_options, body, rest_args)
+    def perform_request(url_helper, url_options, body, rest_args, timeout_override)
+      request = prepare_request(url_helper, url_options, body, rest_args, timeout_override)
 
-      request_attributes = [request.verb, request.url]
-
-      if request.body
-        request_attributes << { body: request.raw_body }
-      end
-
-      request.response_body = HTTP[request.current_headers].public_send(*request_attributes).to_s
+      request.response_body = perform_http_request(request).to_s
 
       process_response(request)
     rescue HTTP::Error => e
@@ -33,14 +30,37 @@ module HttpClientGenerator
 
     private
 
-    def prepare_request(url_helper, url_options, body, rest_args)
+    def prepare_request(url_helper, url_options, body, rest_args, timeout_override)
       url = url_helper.public_send(:"#{name}", url_options)
+      request = build_request(url, body, rest_args, timeout_override)
+
+      req_plugs.reduce(request) { |req, plug| plug.call(req) }
+    end
 
-      request = Request.new(
-        name: name, verb: verb, url: url, content_type: content_type, body: body, rest_args: rest_args, base: base
+    def build_request(url, body, rest_args, timeout_override)
+      Request.new(
+        name: name,
+        verb: verb,
+        url: url,
+        content_type: content_type,
+        timeout: timeout_override.nil? ? timeout : TimeoutNormalizer.call(timeout_override),
+        body: body,
+        rest_args: rest_args,
+        base: base
       )
+    end
 
-      req_plugs.reduce(request) { |req, plug| plug.call(req) }
+    def perform_http_request(request)
+      http_client = HTTP[request.current_headers]
+      http_client = http_client.timeout(request.timeout) unless request.timeout.nil?
+
+      http_client.public_send(*request_attributes(request))
+    end
+
+    def request_attributes(request)
+      attributes = [request.verb, request.url]
+      attributes << { body: request.raw_body } if request.body
+      attributes
     end
 
     def process_response(request)
@@ -51,7 +71,9 @@ module HttpClientGenerator
 
     def select_plugs(plug_entries)
       plug_entries.filter_map do |entry|
-        entry in only:, except:, plug:
+        only = entry[:only]
+        except = entry[:except]
+        plug = entry[:plug]
 
         next if only.any? && !only.include?(name)
         next if except.include?(name)

data/lib/http_client_generator/resources_definition.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module HttpClientGenerator
-  class ResourcesDefinition
+  class ResourcesDefinition # :nodoc:
     attr_reader :resources
 
     DEFAULT_OPTIONS = {
@@ -10,11 +10,12 @@ module HttpClientGenerator
 
     HTTP_VERBS = %i[get post put patch].freeze
 
-    def initialize(base, req_plugs = [], resp_plugs = [])
+    def initialize(base, req_plugs = [], resp_plugs = [], timeout = nil)
       @base = base
       @resources = []
       @req_plugs = req_plugs
       @resp_plugs = resp_plugs
+      @timeout = timeout
     end
 
     HTTP_VERBS.each do |verb|
@@ -31,8 +32,12 @@ module HttpClientGenerator
       @resp_plugs << build_plug_entry(plug, *args, only: only, except: except, **kwargs)
     end
 
-    def namespace(_name, &block)
-      namespaced_definition = ResourcesDefinition.new(@base, @req_plugs.dup, @resp_plugs.dup)
+    def timeout(value = nil, **options)
+      @timeout = TimeoutNormalizer.call(value, **options)
+    end
+
+    def namespace(_name = nil, &block)
+      namespaced_definition = ResourcesDefinition.new(@base, @req_plugs.dup, @resp_plugs.dup, @timeout)
       namespaced_definition.instance_eval(&block)
       @resources += namespaced_definition.resources
     end
@@ -58,18 +63,28 @@ module HttpClientGenerator
     end
 
     def build_resource(verb, name, options)
+      resource_options = with_defaults(options)
+
       Resource.new(
         verb: verb,
         name: name,
         base: @base,
         req_plugs: @req_plugs,
         resp_plugs: @resp_plugs,
-        **with_defaults(options)
+        **resource_options
       )
     end
 
     def with_defaults(options)
-      DEFAULT_OPTIONS.merge(options)
+      resource_options = DEFAULT_OPTIONS.merge(options)
+      resource_options[:timeout] =
+        if options.key?(:timeout)
+          TimeoutNormalizer.call(options[:timeout])
+        else
+          @timeout
+        end
+
+      resource_options
     end
   end
 end

data/lib/http_client_generator/timeout_normalizer.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module HttpClientGenerator
+  module TimeoutNormalizer # :nodoc:
+    VALID_KEYS = %i[connect read write].freeze
+
+    ERROR_MESSAGE = 'Use timeout(global), timeout(:null), or timeout(connect: x, read: y, write: z).'
+
+    def self.call(value = nil, **options)
+      timeout_value = build_timeout_value(value, options)
+      case timeout_value
+      when Numeric, :null
+        timeout_value
+      when Hash
+        normalize_hash(timeout_value)
+      else
+        raise ArgumentError, ERROR_MESSAGE
+      end
+    end
+
+    def self.build_timeout_value(value, options)
+      if options.any?
+        raise ArgumentError, ERROR_MESSAGE unless value.nil?
+
+        options
+      else
+        value
+      end
+    end
+    private_class_method :build_timeout_value
+
+    def self.normalize_hash(timeout_value)
+      invalid_keys = timeout_value.keys - VALID_KEYS
+
+      raise ArgumentError, "Unknown timeout option(s): #{invalid_keys.join(', ')}." if invalid_keys.any?
+
+      timeout_value.dup
+    end
+    private_class_method :normalize_hash
+  end
+end

data/lib/http_client_generator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HttpClientGenerator
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

data/lib/http_client_generator.rb

@@ -2,14 +2,11 @@
 
 require 'zeitwerk'
 
-require 'active_support/core_ext/string/inflections'
-require 'active_support/core_ext/hash/keys'
-
 Zeitwerk::Loader.for_gem.setup
 
-Dir["#{__dir__}/http_client_generator/plugs/*.rb"].each { |f| require f }
+Dir["#{__dir__}/http_client_generator/plugs/*.rb"].sort.each { |f| require f }
 
-module HttpClientGenerator
+module HttpClientGenerator # :nodoc:
   def self.included(base)
     super
 
@@ -30,8 +27,8 @@ module HttpClientGenerator
     resources.each do |resource|
       method_name = :"#{resource.verb}_#{resource.name}"
 
-      define_singleton_method(method_name) do |url_options = {}, body: nil, **rest_args|
-        resource.perform_request(@url_helper, url_options, body, rest_args)
+      define_singleton_method(method_name) do |url_options = {}, body: nil, timeout: nil, **rest_args|
+        resource.perform_request(@url_helper, url_options, body, rest_args, timeout)
       end
     end
   end
@@ -40,9 +37,9 @@ module HttpClientGenerator
 
   def configure(&configure)
     @config = self::Configuration.new
-      .tap(&configure)
-      .tap { |c| user_process_config(c) if respond_to?(:user_process_config) }
-      .tap(&:freeze)
+                                 .tap(&configure)
+                                 .tap { |c| user_process_config(c) if respond_to?(:user_process_config) }
+                                 .tap(&:freeze)
   end
 
   def process_config(&block)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http-client-generator
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Pavel Egorov
@@ -44,8 +44,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.txt
 - README.md
 - lib/http_client_generator.rb
+- lib/http_client_generator/inflector.rb
+- lib/http_client_generator/key_transformer.rb
 - lib/http_client_generator/plugs.rb
 - lib/http_client_generator/plugs/camelize_body.rb
 - lib/http_client_generator/plugs/encode_json_response.rb
@@ -60,6 +63,7 @@ files:
 - lib/http_client_generator/resource.rb
 - lib/http_client_generator/resources_definition.rb
 - lib/http_client_generator/schema_builder.rb
+- lib/http_client_generator/timeout_normalizer.rb
 - lib/http_client_generator/url_builder.rb
 - lib/http_client_generator/version.rb
 licenses: []