jets 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1428541d12995e263e9e59799ac44ddad7aaa4c1edbec777efe3a9ea346f605c
-  data.tar.gz: 1a31efb43f051e6edb9e02fc644b784cabccc73d9a9b52e2d95c83f6dfe7cd9c
+  metadata.gz: eebd400edfb6c76668917aa7cd01d921e4fe986b19e233aa10a688bd0ea9fe5f
+  data.tar.gz: 17d59f6694b0215e090c34ca250414570888bfef424403c51cfbe580a6487eb3
 SHA512:
-  metadata.gz: aa853515fa883f4c731cb34b52cbe4a24f2885330d4efe0c8db19cd6688c52cf19b26bb35f2eb8e7aac528aaa2fe9e5f380f99d85371113bdabe526c5dbbb521
-  data.tar.gz: 66c0ea47767db050eaf5481614cf53d2c63ab5ac44edb2eb9171d759a2d4b91a3e5052a4aa8f619e04eed0f36e5e9c56e681ad34a677e9ba979c4e2fd0d8c6be
+  metadata.gz: caa1419678318a8cfdb27e973ff0a9ee5555ccd4524b38022b29d33cc77cef0a99920ad511c71b9dd6ac72084563bea93205ea4892333ec67d1210da0a96941c
+  data.tar.gz: f7c4a9f5ad1e2cb694a83a82a95a468377dbcb97736f015e6320c4198db31ccecc966a6381412c020710da87b34759a0f8a1c5052d479c87f2fab4063d593cc9

data/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [0.8.1]
+- Upgrade all cfn resources to use the core jets resource model: request #21 from tongueroo/core-resource2
+- Rid of mimimal-stack.yml and use jets core resource model
+- Rescue encoding exception for the Jets IO flush to prevent process from crashing
+- wip: binary support, set proper isBase64Encoded for binary content, but commented out binary media types due to form post breaking
+
 ## [0.8.0]
 - Introduce core resource, pull request #20
 - Future template generation will lead to core resource. Start the move away from the older cfn template generator logic.

data/Gemfile.lock

@@ -11,7 +11,7 @@ GIT
 PATH
   remote: .
   specs:
-    jets (0.8.0)
+    jets (0.8.1)
       actionpack (>= 5.2.1)
       actionview (>= 5.2.1)
       activerecord (>= 5.2.1)
@@ -28,6 +28,7 @@ PATH
       json
       kramdown
       memoist
+      mimemagic
       pg (= 0.21)
       rack
       railties (>= 5.2.1)
@@ -111,6 +112,7 @@ GEM
       nokogiri (>= 1.5.9)
     memoist (0.16.0)
     method_source (0.9.0)
+    mimemagic (0.3.2)
     mini_portile2 (2.3.0)
     minitest (5.11.3)
     nokogiri (1.8.4)

data/jets.gemspec

@@ -44,6 +44,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "text-table"
   spec.add_dependency "rack"
   spec.add_dependency "json"
+  spec.add_dependency "mimemagic"
+
   # TODO: only load the database adapters that app's Gemfile instead of jets.gemspec
   spec.add_dependency "pg", "=0.21"
 

data/lib/jets/application.rb

@@ -94,7 +94,7 @@ class Jets::Application
       sid: "Statement1",
       action: ["logs:*"],
       effect: "Allow",
-      resource: "arn:aws:logs:#{Jets.aws.region}:#{Jets.aws.account}:log-group:#{project_namespace}-*",
+      resource: "arn:aws:logs:#{Jets.aws.region}:#{Jets.aws.account}:log-group:/aws/lambda/#{project_namespace}-*",
     }]
   end
 

data/lib/jets/cfn.rb

@@ -1,6 +1,5 @@
 class Jets::Cfn
-  autoload :TemplateMappers, "jets/cfn/template_mappers"
-  autoload :TemplateBuilders, "jets/cfn/template_builders"
+  autoload :Builders, "jets/cfn/builders"
   autoload :Ship, "jets/cfn/ship"
   autoload :Status, "jets/cfn/status"
 end

data/lib/jets/cfn/builders.rb

@@ -0,0 +1,19 @@
+require 'active_support/core_ext/hash'
+require 'yaml'
+
+class Jets::Cfn
+  class Builders
+    autoload :Interface, "jets/cfn/builders/interface"
+    autoload :ParentBuilder, "jets/cfn/builders/parent_builder"
+
+    # These build the app/controllers, app/jobs, and app/functions
+    autoload :BaseChildBuilder, "jets/cfn/builders/base_child_builder"
+    autoload :ControllerBuilder, "jets/cfn/builders/controller_builder"
+    autoload :JobBuilder, "jets/cfn/builders/job_builder"
+    autoload :FunctionBuilder, "jets/cfn/builders/function_builder"
+    autoload :RuleBuilder, "jets/cfn/builders/rule_builder"
+
+    autoload :ApiGatewayBuilder, "jets/cfn/builders/api_gateway_builder"
+    autoload :ApiDeploymentBuilder, "jets/cfn/builders/api_deployment_builder"
+  end
+end

data/lib/jets/cfn/builders/api_deployment_builder.rb

@@ -0,0 +1,32 @@
+class Jets::Cfn::Builders
+  class ApiDeploymentBuilder
+    include Interface
+    include Jets::AwsServices
+
+    def initialize(options={})
+      @options = options
+      @template = ActiveSupport::HashWithIndifferentAccess.new(Resources: {})
+    end
+
+    # compose is an interface method
+    def compose
+      return if @options[:stack_type] == :minimal
+
+      puts "Building API Gateway Deployment template."
+      deployment = Jets::Resource::ApiGateway::Deployment.new
+      add_resource(deployment)
+      add_parameters(deployment.parameters)
+      add_outputs(deployment.outputs)
+    end
+
+    # template_path is an interface method
+    def template_path
+      Jets::Naming.api_deployment_template_path
+    end
+
+    # do not bother writing a template if routes are empty
+    def write
+      super unless Jets::Router.routes.empty?
+    end
+  end
+end

data/lib/jets/cfn/{template_builders → builders}/api_gateway_builder.rb

@@ -1,4 +1,4 @@
-class Jets::Cfn::TemplateBuilders
+class Jets::Cfn::Builders
   class ApiGatewayBuilder
     include Interface
     include Jets::AwsServices
@@ -29,22 +29,19 @@ class Jets::Cfn::TemplateBuilders
 
     # If the are routes in config/routes.rb add Gateway API in parent stack
     def add_gateway_rest_api
-      add_resource("RestApi", "AWS::ApiGateway::RestApi",
-        Name: Jets::Naming.gateway_api_name
-      )
+      rest_api = Jets::Resource::ApiGateway::RestApi.new
+      add_resource(rest_api)
+      add_outputs(rest_api.outputs)
 
-      stage_name = Jets::Cfn::TemplateMappers::ApiGatewayDeploymentMapper.stage_name
-      add_output("RestApi", Value: "!Ref RestApi")
-      add_output("RestApiUrl", Value: "!Sub 'https://${RestApi}.execute-api.${AWS::Region}.amazonaws.com/#{stage_name}/'")
-      add_output("Region", Value: "!Ref AWS::Region")
-      add_output("RootResourceId", Value: "!GetAtt RestApi.RootResourceId")
+      deployment = Jets::Resource::ApiGateway::Deployment.new
+      add_output("RestApiUrl", Value: deployment.outputs["RestApiUrl"])
     end
 
     # Adds route related Resources and Outputs
     def add_gateway_routes
       # The routes required a Gateway Resource to contain them.
       # TODO: Support more routes. Right now outputing all routes in 1 template will hit the 60 routes limit.
-      # Will have to either output them as a joined string or break this up to multiple tempaltes.
+      # Will have to either output them as a joined string or break this up to multiple templates.
       # http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html
       # Outputs: Maximum number of outputs that you can declare in your AWS CloudFormation template. 60 outputs
       # Output name: Maximum size of an output name. 255 characters.
@@ -55,17 +52,9 @@ class Jets::Cfn::TemplateBuilders
         homepage = path == ''
         next if homepage # handled by RootResourceId output already
 
-        map = Jets::Cfn::TemplateMappers::GatewayResourceMapper.new(path)
-
-        unless homepage # no AWS::ApiGateway::Resource for the top level route
-          add_resource(map.logical_id, "AWS::ApiGateway::Resource",
-            ParentId: map.parent_id,
-            PathPart: map.path_part,
-            RestApiId: "!Ref RestApi"
-          )
-        end
-
-        add_output(map.logical_id, Value: "!Ref #{map.logical_id}")
+        resource = Jets::Resource::ApiGateway::Resource.new(path)
+        add_resource(resource)
+        add_outputs(resource.outputs)
       end
     end
   end

data/lib/jets/cfn/builders/base_child_builder.rb

@@ -0,0 +1,49 @@
+class Jets::Cfn::Builders
+  class BaseChildBuilder
+    include Interface
+
+    # The app_klass is can be a controller, job or anonymous function class.
+    # IE: PostsController, HardJob
+    def initialize(app_klass)
+      @app_klass = app_klass
+      @template = ActiveSupport::HashWithIndifferentAccess.new(Resources: {})
+    end
+
+    # template_path is an interface method for Interface module
+    def template_path
+      Jets::Naming.template_path(@app_klass)
+    end
+
+    def add_common_parameters
+      add_parameter("IamRole", Description: "Iam Role that Lambda function uses.")
+      add_parameter("S3Bucket", Description: "S3 Bucket for source code.")
+    end
+
+    def add_functions
+      add_class_iam_policy
+      @app_klass.tasks.each do |task|
+        add_function(task)
+        add_function_iam_policy(task)
+      end
+    end
+
+    def add_function(task)
+      resource = Jets::Resource::Function.new(task)
+      add_resource(resource)
+    end
+
+    def add_class_iam_policy
+      return unless @app_klass.build_class_iam?
+
+      resource = Jets::Resource::Iam::ClassRole.new(@app_klass)
+      add_resource(resource)
+    end
+
+    def add_function_iam_policy(task)
+      return unless task.build_function_iam?
+
+      resource = Jets::Resource::Iam::FunctionRole.new(task)
+      add_resource(resource)
+    end
+  end
+end

data/lib/jets/cfn/{template_builders → builders}/controller_builder.rb

@@ -1,4 +1,4 @@
-class Jets::Cfn::TemplateBuilders
+class Jets::Cfn::Builders
   class ControllerBuilder < BaseChildBuilder
     # compose is an interface method for Interface module
     def compose
@@ -13,17 +13,17 @@ class Jets::Cfn::TemplateBuilders
 
       add_parameter("RestApi", Description: "RestApi")
       scoped_routes.each do |route|
-        map = Jets::Cfn::TemplateMappers::GatewayResourceMapper.new(route.path)
-        add_parameter(map.logical_id, Description: map.desc)
+        resource = Jets::Resource::ApiGateway::Resource.new(route.path)
+        add_parameter(resource.logical_id, Description: resource.desc)
       end
     end
 
     def add_routes
       scoped_routes.each_with_index do |route, i|
-        resource_route = Jets::Resource::Route.new(route)
-        add_associated_resource(resource_route.resource)
-        add_associated_resource(resource_route.resource.permission.attributes)
-        add_associated_resource(resource_route.resource.cors(route).attributes) if Jets.config.cors
+        method = Jets::Resource::ApiGateway::Method.new(route)
+        add_resource(method)
+        add_resource(method.permission)
+        add_resource(method.cors) if Jets.config.cors
       end
     end
 

data/lib/jets/cfn/{template_builders → builders}/function_builder.rb

@@ -1,4 +1,4 @@
-class Jets::Cfn::TemplateBuilders
+class Jets::Cfn::Builders
   class FunctionBuilder < BaseChildBuilder
     # compose is an interface method for Interface module
     def compose
@@ -15,6 +15,5 @@ class Jets::Cfn::TemplateBuilders
       end
       path
     end
-
   end
 end

data/lib/jets/cfn/builders/interface.rb

@@ -0,0 +1,128 @@
+# The class including this module should implement these methods:
+#
+#   * compose
+#   * template_path
+class Jets::Cfn::Builders
+  module Interface
+    extend Memoist
+
+    def build
+      # Do not bother building
+      # or writing the template unless there are functions defined
+      return if @app_klass && !@app_klass.build?
+
+      compose # must be implemented by subclass
+      write
+    end
+
+    def write
+      FileUtils.mkdir_p(File.dirname(template_path))
+      IO.write(template_path, text)
+    end
+
+    def template
+      # need the to_hash or the YAML dump has
+      #  !ruby/hash:ActiveSupport::HashWithIndifferentAccess
+      @template.to_hash
+    end
+
+    def text
+      text = YAML.dump(template)
+      post_process_template(text)
+    end
+
+    # post process the text so that
+    # "!Ref IamRole" => !Ref IamRole
+    # We strip the surrounding quotes
+    def post_process_template(text)
+      results = text.split("\n").map do |line|
+        if line.include?(': "!') # IE: IamRole: "!Ref IamRole",
+           # IamRole: "!Ref IamRole" => IamRole: !Ref IamRole
+          line.sub(/: "(.*)"/, ': \1')
+        elsif line.include?('- "!') # IE: - "!GetAtt Foo.Arn"
+           # IamRole: - "!GetAtt Foo.Arn" => - !GetAtt Foo.Arn
+          line.sub(/- "(.*)"/, '- \1')
+        else
+          line
+        end
+      end
+      results.join("\n") + "\n"
+    end
+
+    def add_parameters(attributes)
+      attributes.each do |name,value|
+        add_parameter(name.to_s.camelize, Description: value)
+      end
+    end
+
+    def add_parameter(name, options={})
+      defaults = { Type: "String" }
+      options = defaults.merge(options)
+      @template[:Parameters] ||= {}
+      @template[:Parameters][name.camelize] = options
+    end
+
+    def add_outputs(attributes)
+      attributes.each do |name,value|
+        add_output(name.to_s.camelize, Value: value)
+      end
+    end
+
+    def add_output(name, options={})
+      @template[:Outputs] ||= {}
+      @template[:Outputs][name.camelize] = options
+    end
+
+    def add_resources
+      @app_klass.tasks.each do |task|
+        task.resources.each do |definition|
+          resource = Jets::Resource.new(definition, task.replacements)
+          add_resource(resource)
+          add_resource(resource.permission)
+        end
+      end
+    end
+
+    def add_resource(resource)
+      add_template_resource(resource.logical_id, resource.type, resource.attributes)
+    end
+
+    # The add_resource method can take an options Hash with both with either
+    # top level attributes or properties.
+    #
+    # Example:
+    #
+    # Top level options:
+    #
+    #   add_template_resource("MyId", "AWS::ApiGateway::RestApi",
+    #     type: "AWS::ApiGateway::RestApi",
+    #     properties: {
+    #       name: "my-api"
+    #     },
+    #     depends_on: ["AnotherResource"]
+    #   )
+    #
+    # Simple options with properties only:
+    #
+    #   add_template_resource("MyId", "AWS::CloudFormationStack",
+    #     template_url: "template_url",
+    #     parameters: {},
+    #   )
+    #
+    def add_template_resource(logical_id, type, options)
+      options = Jets::Pascalize.pascalize(options)
+
+      attributes = if options.include?('Type')
+                     base = { 'Type' => type }
+                     base.merge(options) # options are top-level attributes
+                   else
+                     {
+                       'Type' => type,
+                       'Properties' => options # options are properties
+                     }
+                   end
+
+      @template['Resources'][logical_id] = attributes
+    end
+  end
+end

data/lib/jets/cfn/{template_builders → builders}/job_builder.rb

@@ -1,9 +1,9 @@
-class Jets::Cfn::TemplateBuilders
+class Jets::Cfn::Builders
   class JobBuilder < BaseChildBuilder
     def compose
       add_common_parameters
       add_functions
-      add_associated_resources
+      add_resources
     end
   end
 end

data/lib/jets/cfn/builders/parent_builder.rb

@@ -0,0 +1,84 @@
+require 'erb'
+
+class Jets::Cfn::Builders
+  class ParentBuilder
+    include Interface
+    include Jets::AwsServices
+
+    def initialize(options={})
+      @options = options
+      @template = ActiveSupport::HashWithIndifferentAccess.new(Resources: {})
+    end
+
+    # compose is an interface method
+    def compose
+      puts "Building parent template."
+
+      build_minimal_resources
+      build_child_resources unless @options[:stack_type] == :minimal
+    end
+
+    # template_path is an interface method
+    def template_path
+      Jets::Naming.parent_template_path
+    end
+
+    def build_minimal_resources
+      # Initial s3 bucket, used to store code zipfile and templates Jets generates
+      resource = Jets::Resource::S3.new
+      add_resource(resource)
+      add_outputs(resource.outputs)
+
+      # Add application-wide IAM policy from Jets.config.iam_role
+      resource = Jets::Resource::Iam::ApplicationRole.new
+      add_resource(resource)
+      add_outputs(resource.outputs)
+    end
+
+    def build_child_resources
+      expression = "#{Jets::Naming.template_path_prefix}-*"
+      # IE: path: #{Jets.build_root}/templates/demo-dev-2-comments_controller.yml
+      Dir.glob(expression).each do |path|
+        next unless File.file?(path)
+        next if api_gateway_paths.include?(path) # specially treated
+
+        add_app_class_stack(path)
+      end
+
+      if @options[:stack_type] == :full and !Jets::Router.routes.empty?
+        add_api_gateway
+        add_api_deployment
+      end
+    end
+
+    def add_app_class_stack(path)
+      resource = Jets::Resource::ChildStack::AppClass.new(path, @options[:s3_bucket])
+      add_child_resources(resource)
+    end
+
+    def add_api_gateway
+      resource = Jets::Resource::ChildStack::ApiGateway.new(@options[:s3_bucket])
+      add_child_resources(resource)
+    end
+
+    def add_api_deployment
+      resource = Jets::Resource::ChildStack::ApiDeployment.new(@options[:s3_bucket])
+      add_child_resources(resource)
+    end
+
+    def add_child_resources(resource)
+      add_resource(resource)
+      add_outputs(resource.outputs)
+    end
+
+    def api_gateway_paths
+      files = %w[
+        api-deployment.yml
+        api-gateway.yml
+      ]
+      files.map do |name|
+        "#{Jets::Naming.template_path_prefix}-#{name}"
+      end
+    end
+  end
+end