http-client-generator 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 547094492a3531c3719f9d0aa0909b98d6f41f429da5670ec764cd73a507581d
-  data.tar.gz: 64cb0d19b54b4f8d6b0acb4fc79d780810dc6abf42f94faa5541af5f586525b8
+  metadata.gz: dc140c4ff46aa9f676473ce9e79cd3391f52ba15fcc4e216c97ea60f19e87e16
+  data.tar.gz: f954c42beb245f685b796837484adab448f8ae980715b5f3dfea8160c5815277
 SHA512:
-  metadata.gz: 9d0f5a805bc01653ad6d932d2e3df5988fdc7d2cad413ff9e4e35c0caf0c822fa9ffe94d5b7df15e4fe2d8d897a1d2304697160647e1905e459a36321bce2d3a
-  data.tar.gz: 5105a5eb18be5e0cd16802ad99ded20b34951e76ac6b1d8dd71cfc8b5b9cfe40685a56e187d1e761899d7f728ddf17593561735bee5b7c9e09f87e973008536b
+  metadata.gz: d10565515b1a5123c7bf00a69322ff439a8a9091c916f41a8b1b2033912573130bffb9b6ff6485e1bfdc89a1c5f4b679a8da0583382a40c119fd5a205949802a
+  data.tar.gz: 816a1e79aa512d1772efd88c43a86167bf282c4be3c9e45b12ad507a5374aa9bc51bc2be7c6783ce1f6ce90b931cf9376ab8d7396ee37a621a1402fb21be9f52

data/README.md

@@ -273,13 +273,19 @@ 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.
+HTTP request. Response-head plugs run after the status is received but before
+the body is read. 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_head_plug ->(request) {
+    request.raise_message('Profile is unavailable') if request.response_status == 404
+    request
+  }
+
   resp_plug :enforce_json_response
   resp_plug :underscore_response
 
@@ -306,6 +312,30 @@ Built-in response plugs:
 | `:underscore_response` | Underscores parsed response keys. |
 | `:validate_response` | Validates parsed response bodies with a schema helper. |
 
+`request.response_status` is the integer HTTP status code. It is available to
+response-head plugs and ordinary response plugs.
+
+### Streaming responses
+
+Declare `stream: true` to return the `HTTP::Response::Body` without eagerly
+reading it. Consume the returned body with `each` or `readpartial`:
+
+```ruby
+resources do
+  resp_head_plug ->(request) {
+    request.raise_message('Download failed') unless request.response_status == 200
+    request
+  }
+
+  get :download_archive, stream: true
+end
+
+Client.get_download_archive.each { |chunk| write_chunk(chunk) }
+```
+
+Streaming resources cannot use ordinary `resp_plug`s because those plugs require
+a materialized body. Use `resp_head_plug` for streaming-specific handling.
+
 Limit plugs to specific resources with `only:` or `except:`:
 
 ```ruby

data/lib/http_client_generator/request.rb

@@ -16,7 +16,7 @@ module HttpClientGenerator
     end
 
     attr_accessor :verb, :name, :content_type, :timeout, :url, :headers, :body, :rest_args, :response_body,
-                  :base, :extra
+                  :response_status, :base, :extra
 
     # rubocop:disable Metrics/ParameterLists
     def initialize(base:, name:, verb:, content_type:, timeout:, url:, body:, rest_args:)

data/lib/http_client_generator/resource.rb

@@ -4,24 +4,34 @@ require 'http'
 
 module HttpClientGenerator
   class Resource # :nodoc:
-    attr_reader :verb, :content_type, :name, :req_plugs, :resp_plugs, :base, :timeout
+    attr_reader :verb, :content_type, :name, :req_plugs, :resp_head_plugs, :resp_plugs, :base, :timeout, :stream
 
     # rubocop:disable Metrics/ParameterLists
-    def initialize(verb:, content_type:, timeout:, name:, base:, req_plugs:, resp_plugs:)
+    def initialize(verb:, content_type:, timeout:, name:, base:, req_plugs:, resp_head_plugs:, resp_plugs:,
+                   stream: false)
       @verb = verb
       @base = base
       @content_type = content_type
       @timeout = timeout
       @name = name
+      @stream = stream
       @req_plugs = select_plugs(req_plugs)
+      @resp_head_plugs = select_plugs(resp_head_plugs)
       @resp_plugs = select_plugs(resp_plugs)
+      validate_streaming_plugs!
     end
     # rubocop:enable Metrics/ParameterLists
 
     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.response_body = perform_http_request(request).to_s
+      response = perform_http_request(request)
+      request.response_status = response.status.code
+      request = process_response_head(request)
+
+      return response.body if stream
+
+      request.response_body = response.to_s
 
       process_response(request)
     rescue HTTP::Error => e
@@ -69,6 +79,16 @@ module HttpClientGenerator
       request.response_body
     end
 
+    def process_response_head(request)
+      resp_head_plugs.reduce(request) { |req, plug| plug.call(req) }
+    end
+
+    def validate_streaming_plugs!
+      return unless stream && resp_plugs.any?
+
+      raise ArgumentError, "Streaming resource #{name.inspect} cannot use response body plugs"
+    end
+
     def select_plugs(plug_entries)
       plug_entries.filter_map do |entry|
         only = entry[:only]

data/lib/http_client_generator/resources_definition.rb

@@ -10,11 +10,12 @@ module HttpClientGenerator
 
     HTTP_VERBS = %i[get post put patch].freeze
 
-    def initialize(base, req_plugs = [], resp_plugs = [], timeout = nil)
+    def initialize(base, req_plugs = [], response_plugs = {}, timeout = nil)
       @base = base
       @resources = []
       @req_plugs = req_plugs
-      @resp_plugs = resp_plugs
+      @resp_head_plugs = response_plugs.fetch(:head, [])
+      @resp_plugs = response_plugs.fetch(:body, [])
       @timeout = timeout
     end
 
@@ -32,12 +33,18 @@ module HttpClientGenerator
       @resp_plugs << build_plug_entry(plug, *args, only: only, except: except, **kwargs)
     end
 
+    def resp_head_plug(plug, *args, only: nil, except: nil, **kwargs)
+      @resp_head_plugs << build_plug_entry(plug, *args, only: only, except: except, **kwargs)
+    end
+
     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 = ResourcesDefinition.new(
+        @base, @req_plugs.dup, { head: @resp_head_plugs.dup, body: @resp_plugs.dup }, @timeout
+      )
       namespaced_definition.instance_eval(&block)
       @resources += namespaced_definition.resources
     end
@@ -70,6 +77,7 @@ module HttpClientGenerator
         name: name,
         base: @base,
         req_plugs: @req_plugs,
+        resp_head_plugs: @resp_head_plugs,
         resp_plugs: @resp_plugs,
         **resource_options
       )

data/lib/http_client_generator/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http-client-generator
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Pavel Egorov