brand.dev 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01b317f9acb3113358073f005ff31643703c16777fc8752e69bc19ec56fecb1a
-  data.tar.gz: 670ba8cf1d6e745e01337e301ade43b415d60b8260c3545652fe7131f000e880
+  metadata.gz: f50feda932f54681e729abf32d227a1d656a0361750ea41e5ea71443d70a0a93
+  data.tar.gz: 315072b49cec6b6f60f68e863c0edbcda4862a24fdbd10530f405a70c6415f56
 SHA512:
-  metadata.gz: 4d283a5947b0a3697afde17e94e0f019cb2f5001ba5c2d73bc867f8463327bc76a1e965d5669549d37264a64ffc8e0e8c5ceed24e11a5a02f50e9872bd0e3f24
-  data.tar.gz: 1b546ff6476dd2a14b69c4359e4fe45617007803986e142c772b3cb6f56c393d58d790510b6aee30a85862bd9f7d7fbcb6c9ed7c8b697d2000da8e54020a90ae
+  metadata.gz: ebf3e3c91166e69f34ab3e0fba78df2b579bebb323d3a8d5591ad871ab11a16f071d78f5af44912093d8e6a78d02d9077a5f09dd2091d53473cdd36f992322f7
+  data.tar.gz: c1d51e7e7d3dec11a1c46995b8d9277d68502b590900f16377a9f1a5e3e180db2e66e07c35971c178604f8aead837434b608661aa53b33eedf0143e8ddde5b13

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## 0.7.0 (2025-09-27)
+
+Full Changelog: [v0.6.0...v0.7.0](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.6.0...v0.7.0)
+
+### Features
+
+* **api:** api update ([1e777a7](https://github.com/brand-dot-dev/ruby-sdk/commit/1e777a71af3ff2e5f0cad6223d05bfcc183fc2fd))
+* expose response headers for both streams and errors ([569c645](https://github.com/brand-dot-dev/ruby-sdk/commit/569c645d77a1432570f2d47ac33c4b30197be2ef))
+
+
+### Bug Fixes
+
+* shorten multipart boundary sep to less than RFC specificed max length ([a2e1171](https://github.com/brand-dot-dev/ruby-sdk/commit/a2e11713038013930d3b5b44d4665326e7bafece))
+
+
+### Performance Improvements
+
+* faster code formatting ([d65a43b](https://github.com/brand-dot-dev/ruby-sdk/commit/d65a43b02c1ebe517f7119c984a540e435fc2a03))
+
+
+### Chores
+
+* allow fast-format to use bsd sed as well ([88e0856](https://github.com/brand-dot-dev/ruby-sdk/commit/88e0856c917a0bb60e062fafe6a04753c8fb8059))
+* do not install brew dependencies in ./scripts/bootstrap by default ([d067d3a](https://github.com/brand-dot-dev/ruby-sdk/commit/d067d3a622289a081516f2565b3bbd420586e8ac))
+* **internal:** codegen related update ([2629fa5](https://github.com/brand-dot-dev/ruby-sdk/commit/2629fa5004386cd943bbba2da8635b10593fcdca))
+
 ## 0.6.0 (2025-09-14)
 
 Full Changelog: [v0.5.0...v0.6.0](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.5.0...v0.6.0)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "brand.dev", "~> 0.6.0"
+gem "brand.dev", "~> 0.7.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/brand_dev/errors.rb

@@ -40,6 +40,9 @@ module BrandDev
       # @return [Integer, nil]
       attr_accessor :status
 
+      # @return [Hash{String=>String}, nil]
+      attr_accessor :headers
+
       # @return [Object, nil]
       attr_accessor :body
 
@@ -47,13 +50,15 @@ module BrandDev
       #
       # @param url [URI::Generic]
       # @param status [Integer, nil]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [Object, nil]
       # @param request [nil]
       # @param response [nil]
       # @param message [String, nil]
-      def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: nil)
+      def initialize(url:, status: nil, headers: nil, body: nil, request: nil, response: nil, message: nil)
         @url = url
         @status = status
+        @headers = headers
         @body = body
         @request = request
         @response = response
@@ -74,6 +79,7 @@ module BrandDev
       #
       # @param url [URI::Generic]
       # @param status [nil]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [nil]
       # @param request [nil]
       # @param response [nil]
@@ -81,6 +87,7 @@ module BrandDev
       def initialize(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -95,6 +102,7 @@ module BrandDev
       #
       # @param url [URI::Generic]
       # @param status [nil]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [nil]
       # @param request [nil]
       # @param response [nil]
@@ -102,6 +110,7 @@ module BrandDev
       def initialize(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -116,21 +125,24 @@ module BrandDev
       #
       # @param url [URI::Generic]
       # @param status [Integer]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [Object, nil]
       # @param request [nil]
       # @param response [nil]
       # @param message [String, nil]
       #
       # @return [self]
-      def self.for(url:, status:, body:, request:, response:, message: nil)
-        kwargs = {
-          url: url,
-          status: status,
-          body: body,
-          request: request,
-          response: response,
-          message: message
-        }
+      def self.for(url:, status:, headers:, body:, request:, response:, message: nil)
+        kwargs =
+          {
+            url: url,
+            status: status,
+            headers: headers,
+            body: body,
+            request: request,
+            response: response,
+            message: message
+          }
 
         case status
         in 400
@@ -162,15 +174,17 @@ module BrandDev
       #
       # @param url [URI::Generic]
       # @param status [Integer]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [Object, nil]
       # @param request [nil]
       # @param response [nil]
       # @param message [String, nil]
-      def initialize(url:, status:, body:, request:, response:, message: nil)
+      def initialize(url:, status:, headers:, body:, request:, response:, message: nil)
         message ||= {url: url.to_s, status: status, body: body}
         super(
           url: url,
           status: status,
+          headers: headers,
           body: body,
           request: request,
           response: response,

data/lib/brand_dev/internal/transport/base_client.rb

@@ -47,7 +47,7 @@ module BrandDev
           # @api private
           #
           # @param status [Integer]
-          # @param headers [Hash{String=>String}, Net::HTTPHeader]
+          # @param headers [Hash{String=>String}]
           #
           # @return [Boolean]
           def should_retry?(status, headers:)
@@ -85,7 +85,7 @@ module BrandDev
           #
           # @param status [Integer]
           #
-          # @param response_headers [Hash{String=>String}, Net::HTTPHeader]
+          # @param response_headers [Hash{String=>String}]
           #
           # @return [Hash{Symbol=>Object}]
           def follow_redirect(request, status:, response_headers:)
@@ -378,6 +378,7 @@ module BrandDev
           rescue BrandDev::Errors::APIConnectionError => e
             status = e
           end
+          headers = BrandDev::Internal::Util.normalized_headers(response&.each_header&.to_h)
 
           case status
           in ..299
@@ -390,7 +391,7 @@ module BrandDev
           in 300..399
             self.class.reap_connection!(status, stream: stream)
 
-            request = self.class.follow_redirect(request, status: status, response_headers: response)
+            request = self.class.follow_redirect(request, status: status, response_headers: headers)
             send_request(
               request,
               redirect_count: redirect_count + 1,
@@ -399,9 +400,9 @@ module BrandDev
             )
           in BrandDev::Errors::APIConnectionError if retry_count >= max_retries
             raise status
-          in (400..) if retry_count >= max_retries || !self.class.should_retry?(status, headers: response)
+          in (400..) if retry_count >= max_retries || !self.class.should_retry?(status, headers: headers)
             decoded = Kernel.then do
-              BrandDev::Internal::Util.decode_content(response, stream: stream, suppress_error: true)
+              BrandDev::Internal::Util.decode_content(headers, stream: stream, suppress_error: true)
             ensure
               self.class.reap_connection!(status, stream: stream)
             end
@@ -409,6 +410,7 @@ module BrandDev
             raise BrandDev::Errors::APIStatusError.for(
               url: url,
               status: status,
+              headers: headers,
               body: decoded,
               request: nil,
               response: response
@@ -485,19 +487,21 @@ module BrandDev
             send_retry_header: send_retry_header
           )
 
-          decoded = BrandDev::Internal::Util.decode_content(response, stream: stream)
+          headers = BrandDev::Internal::Util.normalized_headers(response.each_header.to_h)
+          decoded = BrandDev::Internal::Util.decode_content(headers, stream: stream)
           case req
           in {stream: Class => st}
             st.new(
               model: model,
               url: url,
               status: status,
+              headers: headers,
               response: response,
               unwrap: unwrap,
               stream: decoded
             )
           in {page: Class => page}
-            page.new(client: self, req: req, headers: response, page_data: decoded)
+            page.new(client: self, req: req, headers: headers, page_data: decoded)
           else
             unwrapped = BrandDev::Internal::Util.dig(decoded, unwrap)
             BrandDev::Internal::Type::Converter.coerce(model, unwrapped)

data/lib/brand_dev/internal/type/base_page.rb

@@ -39,7 +39,7 @@ module BrandDev
         #
         # @param client [BrandDev::Internal::Transport::BaseClient]
         # @param req [Hash{Symbol=>Object}]
-        # @param headers [Hash{String=>String}, Net::HTTPHeader]
+        # @param headers [Hash{String=>String}]
         # @param page_data [Object]
         def initialize(client:, req:, headers:, page_data:)
           @client = client

data/lib/brand_dev/internal/util.rb

@@ -566,7 +566,8 @@ module BrandDev
         #
         # @return [Array(String, Enumerable<String>)]
         private def encode_multipart_streaming(body)
-          boundary = SecureRandom.urlsafe_base64(60)
+          # RFC 1521 Section 7.2.1 says we should have 70 char maximum for boundary length
+          boundary = SecureRandom.urlsafe_base64(46)
 
           closing = []
           strio = writable_enum do |y|
@@ -647,7 +648,7 @@ module BrandDev
         #
         # Assumes each chunk in stream has `Encoding::BINARY`.
         #
-        # @param headers [Hash{String=>String}, Net::HTTPHeader]
+        # @param headers [Hash{String=>String}]
         # @param stream [Enumerable<String>]
         # @param suppress_error [Boolean]
         #

data/lib/brand_dev/models/brand_styleguide_params.rb

@@ -17,8 +17,8 @@ module BrandDev
       # @!attribute prioritize
       #   Optional parameter to prioritize screenshot capture for styleguide extraction.
       #   If 'speed', optimizes for faster capture with basic quality. If 'quality',
-      #   optimizes for higher quality with longer wait times. Defaults to 'speed' if not
-      #   provided.
+      #   optimizes for higher quality with longer wait times. Defaults to 'quality' if
+      #   not provided.
       #
       #   @return [Symbol, BrandDev::Models::BrandStyleguideParams::Prioritize, nil]
       optional :prioritize, enum: -> { BrandDev::BrandStyleguideParams::Prioritize }
@@ -45,8 +45,8 @@ module BrandDev
 
       # Optional parameter to prioritize screenshot capture for styleguide extraction.
       # If 'speed', optimizes for faster capture with basic quality. If 'quality',
-      # optimizes for higher quality with longer wait times. Defaults to 'speed' if not
-      # provided.
+      # optimizes for higher quality with longer wait times. Defaults to 'quality' if
+      # not provided.
       module Prioritize
         extend BrandDev::Internal::Type::Enum
 

data/lib/brand_dev/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BrandDev
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/rbi/brand_dev/errors.rbi

@@ -33,6 +33,9 @@ module BrandDev
       sig { returns(T.nilable(Integer)) }
       attr_accessor :status
 
+      sig { returns(T.nilable(T::Hash[String, String])) }
+      attr_accessor :headers
+
       sig { returns(T.nilable(T.anything)) }
       attr_accessor :body
 
@@ -41,6 +44,7 @@ module BrandDev
         params(
           url: URI::Generic,
           status: T.nilable(Integer),
+          headers: T.nilable(T::Hash[String, String]),
           body: T.nilable(Object),
           request: NilClass,
           response: NilClass,
@@ -50,6 +54,7 @@ module BrandDev
       def self.new(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -70,6 +75,7 @@ module BrandDev
         params(
           url: URI::Generic,
           status: NilClass,
+          headers: T.nilable(T::Hash[String, String]),
           body: NilClass,
           request: NilClass,
           response: NilClass,
@@ -79,6 +85,7 @@ module BrandDev
       def self.new(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -93,6 +100,7 @@ module BrandDev
         params(
           url: URI::Generic,
           status: NilClass,
+          headers: T.nilable(T::Hash[String, String]),
           body: NilClass,
           request: NilClass,
           response: NilClass,
@@ -102,6 +110,7 @@ module BrandDev
       def self.new(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -116,13 +125,22 @@ module BrandDev
         params(
           url: URI::Generic,
           status: Integer,
+          headers: T.nilable(T::Hash[String, String]),
           body: T.nilable(Object),
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
         ).returns(T.attached_class)
       end
-      def self.for(url:, status:, body:, request:, response:, message: nil)
+      def self.for(
+        url:,
+        status:,
+        headers:,
+        body:,
+        request:,
+        response:,
+        message: nil
+      )
       end
 
       sig { returns(Integer) }
@@ -133,13 +151,22 @@ module BrandDev
         params(
           url: URI::Generic,
           status: Integer,
+          headers: T.nilable(T::Hash[String, String]),
           body: T.nilable(Object),
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
         ).returns(T.attached_class)
       end
-      def self.new(url:, status:, body:, request:, response:, message: nil)
+      def self.new(
+        url:,
+        status:,
+        headers:,
+        body:,
+        request:,
+        response:,
+        message: nil
+      )
       end
     end
 

data/rbi/brand_dev/internal/transport/base_client.rbi

@@ -84,10 +84,9 @@ module BrandDev
 
           # @api private
           sig do
-            params(
-              status: Integer,
-              headers: T.any(T::Hash[String, String], Net::HTTPHeader)
-            ).returns(T::Boolean)
+            params(status: Integer, headers: T::Hash[String, String]).returns(
+              T::Boolean
+            )
           end
           def should_retry?(status, headers:)
           end
@@ -97,7 +96,7 @@ module BrandDev
             params(
               request: BrandDev::Internal::Transport::BaseClient::RequestInput,
               status: Integer,
-              response_headers: T.any(T::Hash[String, String], Net::HTTPHeader)
+              response_headers: T::Hash[String, String]
             ).returns(BrandDev::Internal::Transport::BaseClient::RequestInput)
           end
           def follow_redirect(request, status:, response_headers:)

data/rbi/brand_dev/internal/type/base_page.rbi

@@ -30,7 +30,7 @@ module BrandDev
           params(
             client: BrandDev::Internal::Transport::BaseClient,
             req: BrandDev::Internal::Transport::BaseClient::RequestComponents,
-            headers: T.any(T::Hash[String, String], Net::HTTPHeader),
+            headers: T::Hash[String, String],
             page_data: T.anything
           ).void
         end

data/rbi/brand_dev/internal/util.rbi

@@ -361,7 +361,7 @@ module BrandDev
         # Assumes each chunk in stream has `Encoding::BINARY`.
         sig do
           params(
-            headers: T.any(T::Hash[String, String], Net::HTTPHeader),
+            headers: T::Hash[String, String],
             stream: T::Enumerable[String],
             suppress_error: T::Boolean
           ).returns(T.anything)

data/rbi/brand_dev/models/brand_styleguide_params.rbi

@@ -18,8 +18,8 @@ module BrandDev
 
       # Optional parameter to prioritize screenshot capture for styleguide extraction.
       # If 'speed', optimizes for faster capture with basic quality. If 'quality',
-      # optimizes for higher quality with longer wait times. Defaults to 'speed' if not
-      # provided.
+      # optimizes for higher quality with longer wait times. Defaults to 'quality' if
+      # not provided.
       sig do
         returns(
           T.nilable(BrandDev::BrandStyleguideParams::Prioritize::OrSymbol)
@@ -57,8 +57,8 @@ module BrandDev
         domain:,
         # Optional parameter to prioritize screenshot capture for styleguide extraction.
         # If 'speed', optimizes for faster capture with basic quality. If 'quality',
-        # optimizes for higher quality with longer wait times. Defaults to 'speed' if not
-        # provided.
+        # optimizes for higher quality with longer wait times. Defaults to 'quality' if
+        # not provided.
         prioritize: nil,
         # Optional timeout in milliseconds for the request. If the request takes longer
         # than this value, it will be aborted with a 408 status code. Maximum allowed
@@ -83,8 +83,8 @@ module BrandDev
 
       # Optional parameter to prioritize screenshot capture for styleguide extraction.
       # If 'speed', optimizes for faster capture with basic quality. If 'quality',
-      # optimizes for higher quality with longer wait times. Defaults to 'speed' if not
-      # provided.
+      # optimizes for higher quality with longer wait times. Defaults to 'quality' if
+      # not provided.
       module Prioritize
         extend BrandDev::Internal::Type::Enum
 

data/rbi/brand_dev/resources/brand.rbi

@@ -208,8 +208,8 @@ module BrandDev
         domain:,
         # Optional parameter to prioritize screenshot capture for styleguide extraction.
         # If 'speed', optimizes for faster capture with basic quality. If 'quality',
-        # optimizes for higher quality with longer wait times. Defaults to 'speed' if not
-        # provided.
+        # optimizes for higher quality with longer wait times. Defaults to 'quality' if
+        # not provided.
         prioritize: nil,
         # Optional timeout in milliseconds for the request. If the request takes longer
         # than this value, it will be aborted with a 408 status code. Maximum allowed

data/sig/brand_dev/errors.rbs

@@ -21,11 +21,14 @@ module BrandDev
 
       attr_accessor status: Integer?
 
+      attr_accessor headers: ::Hash[String, String]?
+
       attr_accessor body: top?
 
       def initialize: (
         url: URI::Generic,
         ?status: Integer?,
+        ?headers: ::Hash[String, String]?,
         ?body: Object?,
         ?request: nil,
         ?response: nil,
@@ -37,6 +40,7 @@ module BrandDev
       def initialize: (
         url: URI::Generic,
         ?status: nil,
+        ?headers: ::Hash[String, String]?,
         ?body: nil,
         ?request: nil,
         ?response: nil,
@@ -48,6 +52,7 @@ module BrandDev
       def initialize: (
         url: URI::Generic,
         ?status: nil,
+        ?headers: ::Hash[String, String]?,
         ?body: nil,
         ?request: nil,
         ?response: nil,
@@ -59,6 +64,7 @@ module BrandDev
       def self.for: (
         url: URI::Generic,
         status: Integer,
+        headers: ::Hash[String, String]?,
         body: Object?,
         request: nil,
         response: nil,
@@ -68,6 +74,7 @@ module BrandDev
       def initialize: (
         url: URI::Generic,
         status: Integer,
+        headers: ::Hash[String, String]?,
         body: Object?,
         request: nil,
         response: nil,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brand.dev
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Brand Dev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-09-14 00:00:00.000000000 Z
+date: 2025-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool