Add an RBS signature for sigv4 (#3152)

Author: k-in0ue

.github/workflows/ci.yml

@@ -33,6 +33,9 @@ jobs:
           bundle config set --local with 'build rbs'
           bundle install
 
+      - name: Install rbs collection
+        run: rbs collection install
+
       - name: Build SDK
         run: bundle exec rake build
 

.gitignore

@@ -2,10 +2,12 @@
 
 /.byebug_history
 /.bundle
+/.gem_rbs_collection
 /.yardoc
 /api-docs
 /Gemfile.lock
 /coverage
+/rbs_collection.lock.yaml
 *.gem
 benchmark_report.json
 

gems/aws-sigv4/CHANGELOG.md

@@ -1,6 +1,8 @@
 Unreleased Changes
 ------------------
 
+* Feature - Add RBS signature files to support static type checking
+
 1.10.1 (2024-10-21)
 ------------------
 

gems/aws-sigv4/lib/aws-sigv4/request.rb

@@ -7,7 +7,7 @@ module Sigv4
     class Request
 
       # @option options [required, String] :http_method
-      # @option options [required, HTTP::URI, HTTPS::URI, String] :endpoint
+      # @option options [required, String, URI::HTTP, URI::HTTPS] :endpoint
       # @option options [Hash<String,String>] :headers ({})
       # @option options [String, IO] :body ('')
       def initialize(options = {})
@@ -30,12 +30,12 @@ def http_method
         @http_method
       end
 
-      # @param [String, HTTP::URI, HTTPS::URI] endpoint
+      # @param [String, URI::HTTP, URI::HTTPS] endpoint
       def endpoint=(endpoint)
         @endpoint = URI.parse(endpoint.to_s)
       end
 
-      # @return [HTTP::URI, HTTPS::URI]
+      # @return [URI::HTTP, URI::HTTPS]
       def endpoint
         @endpoint
       end

gems/aws-sigv4/lib/aws-sigv4/signer.rb

@@ -205,7 +205,7 @@ def initialize(options = {})
       # @option request [required, String] :http_method One of
       #   'GET', 'HEAD', 'PUT', 'POST', 'PATCH', or 'DELETE'
       #
-      # @option request [required, String, URI::HTTPS, URI::HTTP] :url
+      # @option request [required, String, URI::HTTP, URI::HTTPS] :url
       #   The request URI. Must be a valid HTTP or HTTPS URI.
       #
       # @option request [optional, Hash] :headers ({}) A hash of headers
@@ -383,7 +383,7 @@ def sign_event(prior_signature, payload, encoder)
       # @option options [required, String] :http_method The HTTP request method,
       #   e.g. 'GET', 'HEAD', 'PUT', 'POST', 'PATCH', or 'DELETE'.
       #
-      # @option options [required, String, HTTPS::URI, HTTP::URI] :url
+      # @option options [required, String, URI::HTTP, URI::HTTPS] :url
       #   The URI to sign.
       #
       # @option options [Hash] :headers ({}) Headers that should

gems/aws-sigv4/sig/errors.rbs

@@ -0,0 +1,13 @@
+module Aws
+  module Sigv4
+    module Errors
+      class MissingCredentialsError < ArgumentError
+        def initialize: (?String msg) -> void
+      end
+
+      class MissingRegionError < ArgumentError
+        def initialize: (*untyped) -> void
+      end
+    end
+  end
+end

gems/aws-sigv4/sig/interfaces.rbs

@@ -0,0 +1,15 @@
+module Aws
+  module Sigv4
+    interface _Credentials
+      def access_key_id: () -> String
+      def secret_access_key: () -> String
+      def session_token: () -> String?
+      def set?: () -> bool
+    end
+
+    interface _CredentialsProvider
+      def credentials: () -> _Credentials
+      def set?: () -> bool
+    end
+  end
+end

gems/aws-sigv4/sig/manifest.yaml

@@ -0,0 +1,4 @@
+dependencies:
+  - name: tempfile
+  - name: stringio
+  - name: uri

gems/aws-sigv4/sig/request.rbs

@@ -0,0 +1,25 @@
+module Aws
+  module Sigv4
+    class Request
+      def initialize: (
+          http_method: String,
+          endpoint: String | URI::HTTP | URI::HTTPS,
+          ?headers: Hash[String, String],
+          ?body: String | IO
+        ) -> void
+        | (?Hash[Symbol, untyped]) -> void
+
+      def http_method=: (String http_method) -> void
+      def http_method: () -> String
+
+      def endpoint: () -> (URI::HTTP | URI::HTTPS)
+      def endpoint=: (String | URI::HTTP | URI::HTTPS endpoint) -> void
+
+      def headers=: (Hash[String, String] headers) -> void
+      def headers: () -> Hash[String, String]
+
+      def body=: (String | IO body) -> void
+      def body: () -> (String | IO)
+    end
+  end
+end

gems/aws-sigv4/sig/signature.rbs

@@ -0,0 +1,12 @@
+module Aws
+  module Sigv4
+    class Signature
+      attr_accessor headers: Hash[String, String]
+      attr_accessor canonical_request: String
+      attr_accessor string_to_sign: String
+      attr_accessor content_sha256: String
+      attr_accessor signature: String
+      attr_accessor extra: Hash[untyped, untyped]
+    end
+  end
+end