smithy 2.0.0.pre0 → 2.0.0.pre1

data/lib/smithy/templates/client/client_rbs.erb

@@ -0,0 +1,29 @@
+module <%= module_name %>
+  class Client < Smithy::Client::Base
+    include Smithy::Client::Stubs
+
+    def self.new: (
+<% option_types.each do |name, type| -%>
+      ?<%= name %>: <%= type %>,
+<% end -%>
+    ) -> void | (?Hash[Symbol, untyped]) -> void
+<% operations.each do |operation| -%>
+
+    interface <%= operation.response_interface %>
+      include Smithy::Client::_Response[<%= operation.output.type %>]
+<% operation.output.member_types.each do |name, type| -%>
+      def <%= name %>: () -> <%= type %>?
+<% end -%>
+    end
+<% if operation.input.members? -%>
+    def <%= operation.name %>: (
+<% operation.input.keyword_args.each do |line| -%>
+      <%= line %>
+<% end -%>
+    ) -> <%= operation.response_interface %> | (?Hash[Symbol, untyped], ?Hash[Symbol, untyped]) -> <%= operation.response_interface %>
+<% else -%>
+    def <%= operation.name %>: (?Hash[Symbol, untyped], ?Hash[Symbol, untyped]) -> <%= operation.response_interface %>
+<% end -%>
+<% end -%>
+  end
+end

data/lib/smithy/templates/client/customizations.erb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+# Any customizations can be added here.

data/lib/smithy/templates/client/endpoint_parameters.erb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+# This is generated code!
+
+module <%= module_name %>
+  # Endpoint parameters used to resolve endpoints per request.
+<% parameters.each do |param| -%>
+  # @!attribute <%= param.name %>
+<% param.docstrings.each do |docstring| -%>
+  #   <%= docstring %>
+<% end -%>
+  #
+  #   @return [<%= param.documentation_type %>]
+  #
+<% end -%>
+  EndpointParameters = Struct.new(
+<% parameters.each do |param| -%>
+    :<%= param.name %>,
+<% end -%>
+    keyword_init: true
+  ) do
+
+    def initialize(options = {})
+<% parameters.each do |param| -%>
+      self.<%= param.name %> = options.fetch(:<%= param.name %>, <%= param.default_value %>)
+<% end -%>
+<% parameters.select(&:validate_required?).each do |param| -%>
+      raise ArgumentError, "Missing required EndpointParameter: :<%= param.name %>" if <%= param.name %>.nil?
+<% end -%>
+    end
+
+    # @api private
+    def self.create(context)
+      config = context.config
+<% if operation_params.empty? -%>
+      new({
+<% parameters.select(&:create_from_config?).each do |param| -%>
+        <%= param.name %>: <%= param.value %>,
+<% end -%>
+      }.compact)
+<% else -%>
+      params = context.params
+      operation_params =
+        case context.operation_name
+<% operation_params.each do |name, params| -%>
+        when :<%= name %>
+          {
+<% params.each do |param| -%>
+            <%= param.name %>: <%= param.value %>,
+<% end -%>
+          }
+<% end -%>
+        else
+          {}
+        end
+
+      new({
+<% parameters.select(&:create_from_config?).each do |param| -%>
+        <%= param.name %>: <%= param.value %>,
+<% end -%>
+      }.merge(operation_params).compact)
+<% end -%>
+    end
+  end
+end

data/lib/smithy/templates/client/endpoint_parameters_rbs.erb

@@ -0,0 +1,13 @@
+module <%= module_name %>
+  class EndpointParameters
+    def initialize: (
+<% parameters.each do |param| -%>
+      <%= '?' unless param.validate_required? %><%= param.name %>: <%= param.rbs_type %>,
+<% end -%>
+    ) -> void | (?Hash[Symbol, untyped]) -> void
+
+<% parameters.each do |param| -%>
+    attr_accessor <%= param.name %>: <%= param.rbs_type %><%= '?' unless param.validate_required? %>
+<% end -%>
+  end
+end

data/lib/smithy/templates/client/endpoint_plugin.erb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# This is generated code!
+
+module <%= module_name %>
+  module Plugins
+    # @api private
+    class Endpoint < Smithy::Client::Plugin
+      option(
+        :endpoint_provider,
+        doc_type: '<%= module_name %>::EndpointProvider',
+        docstring: <<~DOCS) do |config|
+          The endpoint provider used to resolve endpoints. Any object that responds to `#resolve(parameters)`.
+        DOCS
+        EndpointProvider.new
+      end
+
+<% parameters.select(&:built_in?).each do |param| -%>
+<% param.built_in_binding[:render_config].call(plan).split("\n").each do |line| -%>
+      <%= line %>
+<% end -%>
+
+<% end -%>
+<% parameters.select(&:client_context?).each do |param| -%>
+      option(
+        :<%= param.name %>,
+        doc_type: "<%= param.documentation_type %>",
+        docstring: "<%= param.client_context_doc %>"
+      )
+
+<% end -%>
+      # @api private
+      class Handler < Smithy::Client::Handler
+        def call(context)
+          params = EndpointParameters.create(context)
+          endpoint = context.config.endpoint_provider.resolve(params)\
+
+          context.http_request.endpoint = endpoint.uri
+          apply_endpoint_headers(context, endpoint.headers)
+
+          context[:endpoint_params] = params
+          context[:endpoint_properties] = endpoint.properties
+          @handler.call(context)
+        end
+
+        private
+
+        def apply_endpoint_headers(context, headers)
+          headers.each do |key, value|
+            context.http_request.headers[key] = value
+          end
+        end
+      end
+
+      handler(Handler, priority: 75)
+    end
+  end
+end

data/lib/smithy/templates/client/endpoint_provider.erb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# This is generated code!
+
+module <%= module_name %>
+  # Resolve an endpoint from {EndpointParameters}.
+  class EndpointProvider
+    # @param [EndpointParameters] parameters
+    # @return [Smithy::Client::EndpointRules::Endpoint]
+    # @raise [ArgumentError]
+    def resolve(parameters)
+<%= endpoint_rules_code %>
+    end
+  end
+end

data/lib/smithy/templates/client/endpoint_provider_rbs.erb

@@ -0,0 +1,5 @@
+module <%= module_name %>
+  class EndpointProvider
+    def resolve: (EndpointParameters) -> Smithy::Client::EndpointRules::Endpoint
+  end
+end

data/lib/smithy/templates/client/endpoint_provider_spec.erb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+# This is generated code!
+
+require_relative '../spec_helper'
+
+module <%= module_name %>
+  describe EndpointProvider do
+    subject { EndpointProvider.new }
+<% test_cases.each do |test_case| -%>
+
+    context "<%= test_case.documentation %>" do
+      let(:expected) do
+        <%= test_case.expect %>
+      end
+
+      it 'produces the expected output from the EndpointProvider' do
+        params = EndpointParameters.new(**<%= test_case.params %>)
+<% if test_case.expect_error? -%>
+        expect do
+          subject.resolve(params)
+        end.to raise_error(ArgumentError, expected['error'])
+<% else -%>
+        endpoint = subject.resolve(params)
+        expect(endpoint.uri).to eq(expected['endpoint']['url'])
+        expect(endpoint.headers).to eq(expected['endpoint']['headers'] || {})
+        expect(endpoint.properties).to eq(expected['endpoint']['properties'] || {})
+<% end -%>
+      end
+
+<% test_case.operation_inputs.each do |operation_input| -%>
+      it 'produces the correct output from the client when calling <%= operation_input.operation_name %>' do
+        client = Client.new(
+          stub_responses: true,
+          endpoint_provider: subject,
+<% operation_input.client_params.each do |p| -%>
+          <%= p.param %>: <%= p.value %>,
+<% end -%>
+        )
+<% if test_case.expect_error? -%>
+        expect do
+          client.<%= operation_input.operation_name %>(
+<% operation_input.operation_params.each do |p| -%>
+            <%= p.param %>: <%= p.value %>,
+<% end -%>
+          )
+        end.to raise_error(ArgumentError, expected['error'])
+<% else -%>
+          response = client.<%= operation_input.operation_name %>(
+<% operation_input.operation_params.each do |p| -%>
+            <%= p.param %>: <%= p.value %>,
+<% end -%>
+          )
+        expected_uri = URI.parse(expected['endpoint']['url'])
+        expect(response.context.http_request.endpoint.to_s).to include(expected_uri.host)
+        expect(response.context.http_request.endpoint.to_s).to include(expected_uri.scheme)
+        expect(response.context.http_request.endpoint.to_s).to include(expected_uri.path)
+
+        expected['endpoint'].fetch('headers', {}).each do |k,v|
+          expect(response.context.http_request.headers[k]).to eq(v)
+        end
+
+        # TODO: expect auth
+<% end -%>
+      end
+<% end -%>
+    end
+<% end -%>
+  end
+end

data/lib/smithy/templates/client/errors.erb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+# This is generated code!
+
+module <%= module_name %>
+  # When this service returns an error response, the SDK constructs and raises an error.
+  # These errors all extend <%= module_name %>::Errors::ServiceError < {Smithy::Client::ServiceError}
+  #
+  # You can rescue all errors using the ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue <%= module_name %>::Errors::ServiceError
+  #       # rescues all API errors
+  #     end
+  #
+  # ## Request Context
+  #
+  # ServiceError objects have a {Smithy::Client::ServiceError#context #context} method
+  # that returns information about the request that generated the error.
+  # See {Smithy::Client::HandlerContext} for more information.
+  #
+  # ## Error Classes
+  #
+<% errors.each do |error| -%>
+  # * {<%= error.name %>}
+<% end -%>
+  #
+  # Additionally, error classes are dynamically generated for service errors based on the error code
+  # if they are not defined above.
+  module Errors
+    extend Smithy::Client::DynamicErrors
+<% errors.each do |error| -%>
+
+<% error.docstrings.each do |docstring| -%>
+    # <%= docstring %>
+<% end -%>
+    class <%= error.name %> < Smithy::Client::ServiceError
+      # @param [Smithy::Client::HandlerContext] context
+      # @param [String] message
+      # @param [<%= module_name %>::Types::<%= error.name %>] data
+      def initialize(context, message, data = Smithy::Schema::EmptyStructure.new)
+        super(context, message, data)
+      end
+<% error.members.each do |member| -%>
+
+<% member.docstrings.each do |docstring| -%>
+      # <%= docstring %>
+<% end -%>
+      def <%= member.name %>
+        <%= '@message || ' if member.message? %>@data[:<%= member.name %>]
+      end
+<% end -%>
+<% if error.retryable? -%>
+
+      def retryable?
+        true
+      end
+<% end -%>
+<% if error.throttling? -%>
+
+      def throttling?
+        true
+      end
+<% end -%>
+    end
+<% end -%>
+  end
+end

data/lib/smithy/templates/client/errors_rbs.erb

@@ -0,0 +1,17 @@
+module <%= module_name %>
+  module Errors
+<% errors.each do |error| -%>
+    class <%= error.name %> < Smithy::Client::ServiceError
+<% error.members.each do |member| -%>
+      def <%= member.name %>: () -> <%= Model::RBS.type(model, member.shape['target'], Model.shape(model, member.shape['target'])) %>?
+<% end -%>
+<% if error.retryable? -%>
+      def retryable?: () -> true
+<% end -%>
+<% if error.throttling? -%>
+      def throttling?: () -> true
+<% end -%>
+    end
+<% end -%>
+  end
+end

data/lib/smithy/templates/client/gemspec.erb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# This is generated code!
+
+Gem::Specification.new do |spec|
+  spec.name        = '<%= gem_name %>'
+  spec.version     = '<%= gem_version %>'
+  spec.summary     = 'Generated gem using Smithy'
+  spec.authors     = ['Smithy Ruby']
+  spec.files       = Dir['lib/**/*.rb', base: __dir__]
+
+<% dependencies.each do |dependency, version| -%>
+  spec.add_dependency('<%= dependency %>', '<%= version %>')
+<% end -%>
+
+  spec.required_ruby_version = '>= 3.3'
+end

data/lib/smithy/templates/client/module.erb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# This is generated code!
+
+<% requires.each do |require| -%>
+require '<%= require %>'
+<% end %>
+
+<% ["Object"].concat(module_names).each_cons(2) do |parent, child| -%>
+<%= parent %>.const_set('<%= child %>', Module.new) unless <%= parent %>.const_defined?('<%= child %>')
+<% end -%>
+
+<% docstrings.each do |docstring| -%>
+# <%= docstring %>
+<% end -%>
+module <%= module_name %>
+  VERSION = '<%= gem_version %>'
+end
+
+<% relative_requires.each do |require| -%>
+require_relative '<%= gem_name %>/<%= require %>'
+<% end -%>

data/lib/smithy/templates/client/module_rbs.erb

@@ -0,0 +1,7 @@
+<% module_names.each_with_index do |module_name, i| -%>
+  <%= '  ' * i %>module <%= module_name %>
+<% end -%>
+<%= '  ' * (module_names.size) %>  VERSION: String
+<% (0...module_names.size).reverse_each do |i| -%>
+  <%= '  ' * i %>end
+<% end -%>

data/lib/smithy/templates/client/paginators.erb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# This is generated code!
+
+module <%= module_name %>
+  # @api private
+  module Paginators
+
+<% paginators.each do |paginator| -%>
+    # @api private
+    class <%= paginator.name %>
+      def next_tokens(data)
+<% paginator.next_tokens_code.each do |line| -%>
+        <%= line %>
+<% end -%>
+      end
+
+      def prev_tokens(params)
+<% paginator.prev_tokens_code.each do |line| -%>
+        <%= line %>
+<% end -%>
+      end
+
+      def items(data)
+<% paginator.items_code.each do |line| -%>
+        <%= line %>
+<% end -%>
+      end
+    end
+
+<% end -%>
+  end
+end

data/lib/smithy/templates/client/protocol_spec.erb

@@ -0,0 +1,144 @@
+# This is generated code!
+
+require_relative '../spec_helper'
+
+<% additional_requires.each do |require| -%>
+require '<%= require %>'
+<% end -%>
+
+module <%= module_name %>
+  describe Client do
+    let(:client_options) { { stub_responses: true } }
+    let(:client) { Client.new(client_options) }
+
+<% all_operation_tests.each do |operation_tests| -%>
+    describe '#<%= operation_tests.name %>' do
+<% unless operation_tests.request_tests.empty? -%>
+      describe 'requests' do
+<% operation_tests.request_tests.each do |test| -%>
+<% test.comments.each do |line| -%>
+        # <%= line %>
+<% end -%>
+<% if test.skip? -%>
+        it '<%= test.id %>', skip: '<%= test.skip_reason %>' do
+<% else -%>
+        it '<%= test.id %>' do
+<% end -%>
+<% if test['host'] -%>
+          client = Client.new(client_options.merge(endpoint: '<%= test.endpoint %>'))
+<% end -%>
+<% if test.idempotency_token_trait? -%>
+          allow(SecureRandom).to receive(:uuid).and_return('00000000-0000-4000-8000-000000000000')
+<% end -%>
+          response = client.<%= operation_tests.name %>(<%= test.params %>)
+          request = response.context.http_request
+          expect(request.http_method).to eq('<%= test['method'] %>')
+          expect(request.endpoint.path).to eq('<%= test['uri'] %>')
+<% if test['resolvedHost'] -%>
+          expect(request.endpoint.host).to eq('<%= test['resolvedHost'] %>')
+<% end -%>
+<% if test.query_expect? -%>
+          actual_query = CGI.parse(request.endpoint.query || '')
+<% if test['queryParams'] -%>
+          expected_query = CGI.parse("<%= test['queryParams'].join('&') %>")
+          expected_query.each do |k, v|
+            actual = actual_query[k].map { |s| s.force_encoding('utf-8') }
+            expect(actual).to eq(v)
+          end
+<% end -%>
+<% if test['forbidQueryParams'] -%>
+          <%= test['forbidQueryParams']%>.each do |query|
+            expect(actual_query.key?(query)).to be false
+          end
+<% end -%>
+<% if test['requireQueryParams'] -%>
+          <%= test['requireQueryParams']%>.each do |query|
+            expect(actual_query.key?(query)).to be true
+          end
+<% end -%>
+<% end -%>
+<% test['headers']&.each do |k,v| -%>
+          expect(request.headers['<%= k %>']).to eq('<%= v %>')
+<% end -%>
+<% test['forbidHeaders']&.each do |k| -%>
+          expect(request.headers.key?('<%= k %>')).to be(false)
+<% end -%>
+<% test['requireHeaders']&.each do |k| -%>
+          expect(request.headers.key?('<%= k %>')).to be(true)
+<% end -%>
+<% if test['body'] -%>
+          <%= test.body_expect %>
+<% end -%>
+        end
+<% end -%>
+      end
+<% end -%>
+<% unless operation_tests.response_tests.empty? -%>
+      describe 'responses' do
+<% operation_tests.response_tests.each do |test| -%>
+<% test.comments.each do |line| -%>
+        # <%= line %>
+<% end -%>
+<% if test.skip? -%>
+        it '<%= test.id %>', skip: '<%= test.skip_reason %>' do
+<% else -%>
+        it '<%= test.id %>' do
+<% end -%>
+          response = { status_code: <%= test['code'] %> }
+<% if test['headers'] -%>
+          response[:headers] = <%= test['headers'] %>
+<% else -%>
+          response[:headers] = {}
+<% end -%>
+<% if test['body'] -%>
+          response[:body] = <%= test.stub_body %>
+<% else -%>
+          response[:body] = nil
+<% end -%>
+          client.stub_responses(:<%= operation_tests.name %>, response)
+          response = client.<%= operation_tests.name %>(<%= test.params %>)
+<% if (member_name, _shape = test.streaming_member) -%>
+          response.data.<%= member_name.underscore %>.rewind
+          response.data.<%= member_name.underscore %> = response.data.<%= member_name.underscore %>.read
+          response.data.<%= member_name.underscore %> = nil if response.data.<%= member_name.underscore %>.empty?
+<% end -%>
+          <%= test.data_expect %>
+        end
+<% end -%>
+      end
+<% end -%>
+<% unless operation_tests.error_tests.empty? -%>
+      describe 'response errors' do
+<% operation_tests.error_tests.each do |test| -%>
+<% test.comments.each do |line| -%>
+        # <%= line %>
+<% end -%>
+<% if test.skip? -%>
+        it '<%= test.id %>:  <%= test.error_name %>', skip: '<%= test.skip_reason %>' do
+<% else -%>
+        it '<%= test.id %>:  <%= test.error_name %>' do
+<% end -%>
+          response = { status_code: <%= test['code'] %> }
+<% if test['headers'] -%>
+          response[:headers] = <%= test['headers'] %>
+<% else -%>
+          response[:headers] = {}
+<% end -%>
+<% if test['body'] -%>
+          response[:body] = <%= test.stub_body %>
+<% else -%>
+          response[:body] = nil
+<% end -%>
+          client.stub_responses(:<%= operation_tests.name %>, response)
+          expect { client.<%= operation_tests.name %> }.to raise_error do |e|
+            expect(e).to be_a(Errors::<%= test.error_name %>)
+            <%= test.data_expect %>
+          end
+        end
+<% end -%>
+      end
+<% end -%>
+    end
+<% end -%>
+  end
+end

data/lib/smithy/templates/client/rubocop_yml.erb

@@ -0,0 +1,33 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.3
+  SuggestExtensions: false
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Lint/StructNewOverride:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - 'lib/<%= gem_name %>.rb'
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*.rb'