jets 4.0.17 → 5.0.0.beta1

data/lib/jets/cfn/params/api/resources.rb

@@ -0,0 +1,28 @@
+module Jets::Cfn::Params::Api
+  class Resources < Base
+    # interface method
+    def build
+      # For the nested ApiResources template defined in the parent template, we need
+      # grab the parameters from the other paged ApiResources templates if not in
+      # the current template.
+      @template[:Parameters].keys.each do |key|
+        key = key.to_sym
+        case key.to_s
+        when "RestApi"
+          @params.merge!(key => "!GetAtt ApiGateway.Outputs.RestApi")
+        when "RootResourceId"
+          @params.merge!(key => "!GetAtt ApiGateway.Outputs.RootResourceId")
+        else
+          @params.merge!(key => "!GetAtt #{self.class.stack_logical_id(key)}.Outputs.#{key}")
+        end
+      end
+    end
+
+    class << self
+      # IE: path: #{Jets.build_root}/templates/api-resources-1.yml"
+      def stack_logical_id(parameter)
+        Jets::Cfn::Template.lookup_logical_id("api-resources", parameter)
+      end
+    end
+  end
+end

data/lib/jets/{resource/child_stack/common_parameters.rb → cfn/params/common.rb}

@@ -1,6 +1,6 @@
-module Jets::Resource::ChildStack
-  module CommonParameters
-    def common_parameters
+module Jets::Cfn::Params
+  module Common
+    def parameters
       parameters = {
         IamRole: "!GetAtt IamRole.Arn",
         S3Bucket: "!Ref S3Bucket",

data/lib/jets/{resource → cfn/resource}/api_gateway/authorizer.rb

@@ -1,5 +1,5 @@
-module Jets::Resource::ApiGateway
-  class Authorizer < Jets::Resource::Base
+module Jets::Cfn::Resource::ApiGateway
+  class Authorizer < Jets::Cfn::Base
     def initialize(props={})
       @props = props # associated_properties from dsl.rb
     end
@@ -7,27 +7,27 @@ module Jets::Resource::ApiGateway
     def definition
       {
         authorizer_logical_id => {
-          type: "AWS::ApiGateway::Authorizer",
-          properties: props,
+          Type: "AWS::ApiGateway::Authorizer",
+          Properties: props,
         }
       }
     end
 
     def props
       default = {
-        # authorizer_credentials: '',
-        # authorizer_result_ttl_in_seconds: '',
-        # auth_type: '',
-        # identity_source: '', # required
-        # identity_validation_expression: '',
-        # name: '',
-        # provider_arns: [],
-        rest_api_id: '!Ref RestApi', # Required: Yes
-        type: '', # Required: Yes
+        # AuthorizerCredentials: '',
+        # AuthorizerResultTtlInSeconds: '',
+        # AuthType: '',
+        # IdentitySource: '', # required
+        # IdentityValidationExpression: '',
+        # Name: '',
+        # ProviderARNs: [],
+        RestApiId: '!Ref RestApi', # Required: Yes
+        Type: '', # Required: Yes
       }
 
-      unless @props[:type].to_s.upcase == 'COGNITO_USER_POOLS'
-        @props[:authorizer_uri] = { # Required: Conditional
+      unless @props[:Type].to_s.upcase == 'COGNITO_USER_POOLS'
+        @props[:AuthorizerUri] = { # Required: Conditional
           "Fn::Join" => ['', [
             'arn:aws:apigateway:',
             "!Ref 'AWS::Region'",
@@ -37,7 +37,7 @@ module Jets::Resource::ApiGateway
           ]]
         }
       end
-      @props[:authorizer_result_ttl_in_seconds] = @props.delete(:ttl) if @props[:ttl]
+      @props[:AuthorizerResultTtlInSeconds] = @props.delete(:ttl) if @props[:ttl] # shorthand
 
       normalize_type!(@props)
       normalize_identity_source!(@props)
@@ -45,7 +45,7 @@ module Jets::Resource::ApiGateway
     end
 
     def authorizer_logical_id
-      "{namespace}_authorizer" # IE: protect_authorizer
+      "{namespace}Authorizer" # IE: protect_authorizer
     end
 
     def outputs
@@ -58,13 +58,13 @@ module Jets::Resource::ApiGateway
   private
     # Also sets a default if it's not provided
     def normalize_type!(props)
-      type = props[:type] || :request
-      @props[:type] = type.to_s.upcase
+      type = props[:Type] || :request
+      @props[:Type] = type.to_s.upcase
     end
 
     # Also sets a default if it's not provided
     def normalize_identity_source!(props)
-      identity_source = props[:identity_source] || Jets.config.api.authorizers.default_token_source
+      identity_source = props[:IdentitySource] || Jets.config.api.authorizers.default_token_source
       # request authorizer type can have multiple identity sources.
       # token authorizer type has only one identity source.
       # We handle both cases.
@@ -76,7 +76,7 @@ module Jets::Resource::ApiGateway
           "method.request.header.#{source}" # convention
         end
       end
-      @props[:identity_source] = identity_sources.join(',')
+      @props[:IdentitySource] = identity_sources.join(',')
     end
   end
 end

data/lib/jets/cfn/resource/api_gateway/base_path/function.rb

@@ -0,0 +1,57 @@
+module Jets::Cfn::Resource::ApiGateway::BasePath
+  class Function < Jets::Cfn::Base
+    include Jets::Cfn::Resource::Lambda::Function::Environment
+
+    def definition
+      {
+        BasePathFunction: {
+          Type: "AWS::Lambda::Function",
+          Properties: {
+            FunctionName: function_name,
+            Description: "Jets#base_path",
+            Code: {
+              S3Bucket: "!Ref S3Bucket",
+              S3Key: code_s3_key,
+            },
+            Role: "!GetAtt BasePathRole.Arn",
+            Handler: handler,
+            Runtime: get_runtime,
+            Timeout: 60,
+            MemorySize: 1536,
+            Environment: env_properties[:Environment],
+            Layers: layers,
+          }
+        }
+      }
+    end
+
+    def get_runtime
+      props = camelize(Jets.application.config.function.to_h)
+      props[:Runtime] || Jets.ruby_runtime
+    end
+
+    def layers
+      return Jets.config.lambda.layers if Jets.config.pro.disable
+      ["!Ref GemLayer"] + Jets.config.lambda.layers
+    end
+
+    # JETS_RESET is respected here because CloudFormation Custom Resources
+    # do not allow updates to the ServiceToken property.
+    # Changing the base-path Lambda Function name results in a CloudFormation error:
+    #
+    #     Modifying service token is not allowed
+    #
+    def function_name
+      "#{Jets.project_namespace}-jets-base-path"
+    end
+
+    def handler
+      "handlers/functions/jets/base_path.lambda_handler"
+    end
+
+    def code_s3_key
+      checksum = Jets::Builders::Md5.checksums["stage/code"]
+      "jets/code/code-#{checksum}.zip" # s3_key
+    end
+  end
+end

data/lib/jets/{resource → cfn/resource}/api_gateway/base_path/mapping.rb

@@ -16,28 +16,29 @@
 #   * Also tried to change the domain name of to something like demo-dev-[random].mydomain.com
 #   That does not work because the domain name has to match the route53 record exactly.
 #
-module Jets::Resource::ApiGateway::BasePath
-  class Mapping < Jets::Resource::Base
+module Jets::Cfn::Resource::ApiGateway::BasePath
+  class Mapping < Jets::Cfn::Base
     def definition
       function_logical_id = "BasePathFunction" # lambda function that supports custom resource
       {
-        base_path_mapping: {
-          type: "Custom::BasePathMapping",
-          properties: {
-            service_token: "!GetAtt #{function_logical_id}.Arn",
-            # base_path: '', # empty path represents root
-            # domain_name: "!Ref DomainName",
-            # rest_api_id: "!Ref RestApi", # since this is in the Deployment template
-            # stage: Deployment.stage_name,
+        BasePathMapping: {
+          Type: "Custom::BasePathMapping",
+          Properties: {
+            ServiceToken: "!GetAtt #{function_logical_id}.Arn",
+            # A change to any of these properties updates the CloudFormation Custom Resource
+            # IE: It runs the Lambda function that implements the custom resource
+            BasePath: Jets.config.domain.base_path, # '' empty path represents root
+            DomainName: "!Ref DomainName",
+            RestApiId: "!Ref RestApi",
+            Stage: Jets::Cfn::Resource::ApiGateway::Deployment.stage_name,
           },
-          depends_on: Jets::Resource::ApiGateway::Deployment.logical_id,
         }
       }
     end
 
     def outputs
       {
-        "BasePathMapping" => "!Ref BasePathMapping",
+        BasePathMapping: "!Ref BasePathMapping",
       }
     end
   end

data/lib/jets/cfn/resource/api_gateway/base_path/role.rb

@@ -0,0 +1,70 @@
+module Jets::Cfn::Resource::ApiGateway::BasePath
+  class Role < Jets::Cfn::Base
+    extend Memoist
+    include Jets::AwsServices
+
+    def definition
+      {
+        BasePathRole: {
+          Type: "AWS::IAM::Role",
+          Properties: {
+            # RoleName: role_name,
+            Path: "/",
+            AssumeRolePolicyDocument: {
+              Version: "2012-10-17",
+              Statement: [{
+                Effect: "Allow",
+                Principal: {Service: ["lambda.amazonaws.com"]},
+                Action: ["sts:AssumeRole"]}
+              ]
+            },
+            Policies: [
+              PolicyName: "base-path-mapping-policy", # cannot be empty
+              PolicyDocument: policy_document,
+            ]
+          },
+        }
+      }
+    end
+
+    def policy_document
+      project_namespace = Jets.project_namespace
+      default_policy_statements = Jets.application.config.default_iam_policy # Array of Hashes
+      apigateway = [{
+        Action: [ "apigateway:*" ],
+        Effect: "Allow",
+        Resource: "arn:aws:apigateway:#{Jets.aws.region}::/restapis/*", # scoped to all restapis because this changes
+      },{
+        Action: [ "apigateway:*" ],
+        Effect: "Allow",
+        Resource: "arn:aws:apigateway:#{Jets.aws.region}::/domainnames/*", # scoped to all restapis because this changes
+      }]
+      cloudformation = [{
+        Action: ["cloudformation:DescribeStacks"],
+        Effect: "Allow",
+        Resource: "arn:aws:cloudformation:#{Jets.aws.region}:#{Jets.aws.account}:stack/#{project_namespace}*",
+      }]
+
+      # Combine the statements
+      {
+        Version: '2012-10-17',
+        Statement: default_policy_statements + apigateway + cloudformation
+      }
+    end
+
+    # Duplicated in rest_api/change_detection.rb, base_path/role.rb, rest_api/routes.rb
+    def rest_api_id
+      stack_name = Jets::Names.parent_stack_name
+      return "RestApi" unless stack_exists?(stack_name)
+
+      stack = cfn.describe_stacks(stack_name: stack_name).stacks.first
+
+      api_gateway_stack_arn = lookup(stack[:outputs], "ApiGateway")
+
+      # resources = cfn.describe_stack_resources(stack_name: api_gateway_stack_arn).stack_resources
+      stack = cfn.describe_stacks(stack_name: api_gateway_stack_arn).stacks.first
+      rest_api_id = lookup(stack[:outputs], "RestApi")
+    end
+    memoize :rest_api_id
+  end
+end

data/lib/jets/{resource → cfn/resource}/api_gateway/deployment.rb

@@ -1,45 +1,38 @@
-module Jets::Resource::ApiGateway
-  class Deployment < Jets::Resource::Base
+module Jets::Cfn::Resource::ApiGateway
+  class Deployment < Jets::Cfn::Base
     def definition
       {
         deployment_logical_id => {
-          type: "AWS::ApiGateway::Deployment",
-          properties: {
-            description: "Version #{timestamp} deployed by jets",
-            rest_api_id: "!Ref #{RestApi.logical_id}",
-            stage_name: stage_name,
+          Type: "AWS::ApiGateway::Deployment",
+          Properties: {
+            Description: "Version #{timestamp} deployed by jets",
+            RestApiId: "!Ref #{RestApi.logical_id}",
+            StageName: stage_name,
           }
         }
       }
     end
 
     def parameters
-      p = {
-        "GemLayer" => "GemLayer",
-        "IamRole" => "IamRole",
-        "RestApi" => "RestApi",
-        "S3Bucket" => "S3Bucket",
+      {
+        RestApi: "RestApi",
       }
-      p[:DomainName] = "DomainName" if Jets.custom_domain?
-      p[:BasePath] = "BasePath" unless Jets.config.domain.base_path.nil?
-      p
     end
 
     def outputs(internal=false)
       rest_api = internal ? RestApi.internal_logical_id : "RestApi"
       {
-        "RestApiUrl" => "!Sub 'https://${#{rest_api}}.execute-api.${AWS::Region}.amazonaws.com/#{stage_name}/'",
+        RestApiUrl: "!Sub 'https://${#{rest_api}}.execute-api.${AWS::Region}.amazonaws.com/#{stage_name}/'",
       }
     end
 
     def depends_on
-      expression = "#{Jets::Names.template_path_prefix}-*_controller*"
+      expression = "#{Jets::Names.templates_folder}/*_controller*"
       controller_logical_ids = []
       Dir.glob(expression).each do |path|
         next unless File.file?(path)
 
-        regexp = Regexp.new(".*#{Jets.config.project_namespace}-")
-        controller_name = path.sub(regexp, '').sub('.yml', '')
+        controller_name = path.sub("#{Jets::Names.templates_folder}/", '').sub('.yml', '')
         # map the path to a camelized logical_id. Example:
         #   /tmp/jets/demo/templates/demo-dev-2-posts_controller.yml to
         #   PostsController
@@ -57,7 +50,7 @@ module Jets::Resource::ApiGateway
 
     def self.stage_name
       # Stage name only allows a-zA-Z0-9_
-      [Jets.config.short_env, Jets.config.extra].compact.join('_').gsub('-','_')
+      [Jets.short_env, Jets.extra].compact.join('_').gsub('-','_')
     end
 
     def timestamp

data/lib/jets/{resource → cfn/resource}/api_gateway/domain_name.rb

@@ -8,34 +8,34 @@
 #       DomainName: api.mydomain.com
 #       CertificateArn: arn:aws:acm:us-east-1:111122223333:certificate/fb1b9770-a305-495d-aefb-27e5e101ff3
 #
-module Jets::Resource::ApiGateway
-  class DomainName < Jets::Resource::Base
+module Jets::Cfn::Resource::ApiGateway
+  class DomainName < Jets::Cfn::Base
     def definition
       properties = {
-        domain_name: domain_name,
-        endpoint_configuration: {
-          types: endpoint_types
+        DomainName: domain_name,
+        EndpointConfiguration: {
+          Types: endpoint_types
         }
       }
       # Can really only be REGIONAL or EDGE
       if endpoint_types.include?("REGIONAL")
-        properties[:regional_certificate_arn] = cert_arn
+        properties[:RegionalCertificateArn] = cert_arn
       end
       if endpoint_types.include?("EDGE")
-        properties[:certificate_arn] = cert_arn
+        properties[:CertificateArn] = cert_arn
       end
 
       {
-        domain_name: {
-          type: "AWS::ApiGateway::DomainName",
-          properties: properties
+        DomainName: {
+          Type: "AWS::ApiGateway::DomainName",
+          Properties: properties
         }
       }
     end
 
     def outputs
       {
-        "DomainName" => "!Ref DomainName",
+        DomainName: "!Ref DomainName",
       }
     end
 

data/lib/jets/{resource → cfn/resource}/api_gateway/method/authorization.rb

@@ -1,4 +1,4 @@
-class Jets::Resource::ApiGateway::Method
+class Jets::Cfn::Resource::ApiGateway::Method
   module Authorization
   private
     def authorizer_id

data/lib/jets/cfn/resource/api_gateway/method.rb

@@ -0,0 +1,92 @@
+# Converts a Jets::Route to a CloudFormation Jets::Cfn::Resource::ApiGateway::Method resource
+module Jets::Cfn::Resource::ApiGateway
+  class Method < Jets::Cfn::Base
+    include Authorization
+
+    # route - Jets::Route
+    def initialize(route)
+      @route = route
+    end
+
+    def definition
+      {
+        method_logical_id => {
+          Type: "AWS::ApiGateway::Method",
+          Properties: props
+        }
+      }
+    end
+
+    # Note: The {namespace} in
+    #   functions/${{namespace}LambdaFunction.Arn}/invocations
+    # is replaced by Jets::Cfn::Resource::Replacer
+    #
+    #   Jets::Cfn::Resource::ApiGateway::Method
+    #     Jets::Cfn::Resource (attributes delegate to resource)
+    #     Jets::Cfn::Resource => replacer
+    #
+    def props
+      function_logical_id = Jets.one_lambda_for_all_controllers? ?
+          "JetsControllerLambdaFunction" :
+          "{namespace}LambdaFunction"
+
+      resource_id = ResourceId.new(@route.path).resource_id
+      props = {
+        ResourceId: "!Ref #{resource_id}",
+        RestApiId: "!Ref #{RestApi.logical_id}",
+        HttpMethod: @route.http_method,
+        RequestParameters: {},
+        AuthorizationType: authorization_type,
+        ApiKeyRequired: api_key_required?,
+        Integration: {
+          IntegrationHttpMethod: "POST",
+          Type: "AWS_PROXY",
+          Uri: "!Sub arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${#{function_logical_id}}/invocations"
+        },
+        MethodResponses: []
+      }
+      props[:AuthorizerId] = authorizer_id if authorizer_id
+      props[:AuthorizationScopes] = authorization_scopes if authorization_scopes
+
+      props
+    end
+
+    def method_logical_id
+      # https://stackoverflow.com/questions/6104240/how-do-i-strip-non-alphanumeric-characters-from-a-string-and-keep-spaces
+      # Add path to the logical id to allow 2 different paths to be connected to the same controller action.
+      # Example:
+      #
+      #   root "jets/public#show"
+      #   any "*catchall", to: "jets/public#show"
+      #
+      # Without the path in the logical id, the logical id would be ShowApiMethod for both routes and only the
+      # last one would be created in the CloudFormation template.
+      path = @route.path.gsub('*','')
+              .gsub(/[^0-9a-z]/i, ' ')
+              .gsub(/\s+/, '_')
+      path = nil if path == ''
+      http_verb = @route.http_method.downcase
+      [http_verb, path, "api_method"].compact.join('_')
+    end
+
+    def replacements
+      # Mimic task to grab replacements
+      # Use functions/${namespace} in Uri
+      resources = [definition]
+      action_name = Jets.one_lambda_per_controller? ? "lambda_handler" : @route.action_name
+      task = Jets::Lambda::Definition.new(@route.controller_name, action_name,
+               resources: resources)
+      task.replacements
+    end
+
+  private
+
+    def controller_klass
+      @controller_klass ||= "#{controller_name}_controller".camelize.constantize
+    end
+
+    def controller_name
+      @controller_name ||= @route.to.split('#').first
+    end
+  end
+end

data/lib/jets/{resource → cfn/resource}/api_gateway/resource.rb

@@ -1,18 +1,20 @@
-module Jets::Resource::ApiGateway
-  class Resource < Jets::Resource::Base
+module Jets::Cfn::Resource::ApiGateway
+  class Resource < Jets::Cfn::Base
     def initialize(path, internal: false)
-      @path = path # Examples: "posts/:id/edit" or "posts"
+      # The original implementation uses path without the leading slash.
+      # Remove it here so the path_part is calculated correctly.
+      @path = path.delete_prefix('/') # Examples: "posts/:id/edit" or "posts"
       @internal = internal
     end
 
     def definition
       {
         resource_logical_id => {
-          type: "AWS::ApiGateway::Resource",
-          properties: {
-            parent_id: parent_id,
-            path_part: path_part,
-            rest_api_id: "!Ref #{RestApi.logical_id(@internal)}",
+          Type: "AWS::ApiGateway::Resource",
+          Properties: {
+            ParentId: parent_id,
+            PathPart: path_part,
+            RestApiId: "!Ref #{RestApi.logical_id(@internal)}",
           }
         }
       }
@@ -26,9 +28,11 @@ module Jets::Resource::ApiGateway
 
     def resource_logical_id
       if @path == ''
+        # Not including ApiResource in the logical id so it doesn't collide with a
+        # user-defined ApiResource that happens to be named RootResourceId.
         "RootResourceId"
       else
-        Jets::Resource.truncate_id path_logical_id(@path), "ApiResource"
+        Jets::Cfn::Resource.truncate_id(path_logical_id(@path), "ApiResource")
       end
     end
 
@@ -41,7 +45,7 @@ module Jets::Resource::ApiGateway
       if @path.include?('/') # posts/:id or posts/:id/edit
         parent_path = @path.split('/')[0..-2].join('/')
         parent_logical_id = path_logical_id(parent_path)
-        Jets::Resource.truncate_id(parent_logical_id, "ApiResource")
+        Jets::Cfn::Resource.truncate_id(parent_logical_id, "ApiResource")
       else
         "RootResourceId"
       end

data/lib/jets/cfn/resource/api_gateway/resource_id.rb

@@ -0,0 +1,25 @@
+module Jets::Cfn::Resource::ApiGateway
+  class ResourceId
+    def initialize(path)
+      @path = path
+    end
+
+    # Used by Method and Cors
+    def resource_id
+      @path == '/' ?
+        "RootResourceId" :
+        resource_logical_id.camelize + "ApiResource"
+    end
+
+    # Example: Posts
+    def resource_logical_id
+      camelized_path.underscore
+    end
+
+    def camelized_path
+      path = @path
+      path = "homepage" if path == '/'
+      path.gsub('/','_').gsub(':','').gsub('*','').gsub('.','').camelize
+    end
+  end
+end

data/lib/jets/{resource → cfn/resource}/api_gateway/rest_api/change_detection.rb

@@ -1,4 +1,4 @@
-class Jets::Resource::ApiGateway::RestApi
+class Jets::Cfn::Resource::ApiGateway::RestApi
   class ChangeDetection
     extend Memoist
     include Jets::AwsServices

data/lib/jets/{resource → cfn/resource}/api_gateway/rest_api/logical_id/message.rb

@@ -1,4 +1,4 @@
-class Jets::Resource::ApiGateway::RestApi::LogicalId
+class Jets::Cfn::Resource::ApiGateway::RestApi::LogicalId
   class Message
     def routes_changed
       <<~EOL

data/lib/jets/{resource → cfn/resource}/api_gateway/rest_api/logical_id.rb

@@ -1,4 +1,4 @@
-class Jets::Resource::ApiGateway::RestApi
+class Jets::Cfn::Resource::ApiGateway::RestApi
   class LogicalId
     extend Memoist
     include Jets::AwsServices

data/lib/jets/{resource → cfn/resource}/api_gateway/rest_api/routes/change/base.rb

@@ -1,4 +1,4 @@
-class Jets::Resource::ApiGateway::RestApi::Routes::Change
+class Jets::Cfn::Resource::ApiGateway::RestApi::Routes::Change
   class Base
     extend Memoist
     include Jets::AwsServices
@@ -14,11 +14,12 @@ class Jets::Resource::ApiGateway::RestApi::Routes::Change
       return [] if data.nil?
 
       data.map do |item|
-        method = item.dig('options','method') || item.dig('options','http_method')
         Jets::Router::Route.new(
+          http_method: item['http_method'],
           path: item['path'],
-          method: method,
           to: item['to'],
+          engine: item['engine'],
+          internal: item['internal'],
         )
       end
     end

data/lib/jets/{resource → cfn/resource}/api_gateway/rest_api/routes/change/media_types.rb

@@ -1,11 +1,11 @@
-class Jets::Resource::ApiGateway::RestApi::Routes::Change
+class Jets::Cfn::Resource::ApiGateway::RestApi::Routes::Change
   class MediaTypes < Base
     def changed?
       current_binary_media_types != new_binary_media_types
     end
 
     def new_binary_media_types
-      rest_api = Jets::Resource::ApiGateway::RestApi.new
+      rest_api = Jets::Cfn::Resource::ApiGateway::RestApi.new
       rest_api.binary_media_types
     end
     memoize :new_binary_media_types