jets 5.0.0.beta1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4381b93c9ea3d4e8a1f44bbe065e85fc0c6da59cc1d59ef7cc3deb29411b107f
-  data.tar.gz: 6afa841f9b10dcf4526179ddfe5dd9d211ce38d9117f2442b092bb1f8d2bc424
+  metadata.gz: 54e94ceb6d67976943a212a5ccceb71bb3e7bd6c6928775c0e7b824be127e42d
+  data.tar.gz: cab6dba2a8108c047daec4706e15d226e0e7f4eb46e9b6f2617465ea186b451e
 SHA512:
-  metadata.gz: 64cc06c217190f64c0e5e446bd6aad780048c5673f64f6611bc3871ecfc295083440be55d98d222d5955d19285ba3252cb371043f679d48e74b6a676541ce3df
-  data.tar.gz: 8be226ddfa30be1b57dca669eff636b9e07a0ab8bc63e77901a1f398e2c9ab7cbc7a9f6589a6e98135f4abffc5492777e0cda9543d5c598fda1d77dbcfb0658a
+  metadata.gz: c050d7738b47e826403bc383baa0b2db251246b3d3dc359135e8e1039f8404448021477b38fbfab57f2be1cd09f7ffe8aa925cff70e313a96e61735f46f4fee2
+  data.tar.gz: 152c89e1b3e9d124f63687181f48c13ef09e3140062665a6b11baf9a99e830869cd7c8df46a2e1e8e59c58bc08bbb76d6430d235fd296ed176bcf0628890531a

data/CHANGELOG.md

@@ -3,7 +3,7 @@
 All notable changes to this project will be documented in this file.
 This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/).
 
-## [5.0.0] - Unreleased
+## [5.0.0] - 2023-12-05
 Single Lambda Function for Controllers
 * For controllers, a single Lambda function is deployed going forward.
 * APIGW serves as proxy endpoint for requests to the single Lambda function. Techniquely, there are 2 APIGW endpoints.
@@ -55,10 +55,13 @@ Breaking changes:
 * Jets.config.prewarm.concurrency option removed.
 * dynomite decoupling and integration improvements
 
+## [4.0.10] - 2023-12-04
+- [#678](https://github.com/boltops-tools/jets/pull/678) handle option method or http_method from route state
 
 ## [4.0.9] - 2023-12-03
 - [#674](https://github.com/boltops-tools/jets/pull/674) Fix broken --mode jobs new project generation
 - [#675](https://github.com/boltops-tools/jets/pull/675) Add resource tags to CloudFormation stack
+
 ## [4.0.8] - 2023-12-03
 - [#677](https://github.com/boltops-tools/jets/pull/677) pin dynomite 1.2.7
 

data/README.md

@@ -16,12 +16,13 @@ Please **watch/star** this repo to help grow and support the project.
 
 ## What is Ruby on Jets?
 
-Jets is a Ruby Serverless Framework.  Jets allows you to create serverless applications with a beautiful language: Ruby.  It includes everything required to build an application and deploy it to AWS Lambda.
+Jets is a Ruby Serverless Framework. Jets allows you to create serverless applications with a beautiful language: Ruby. It includes everything required to build and deploy an application to AWS Lambda.
 
-It is key to understand AWS Lambda and API Gateway to understand Jets conceptually.  Jets maps your code to Lambda functions and API Gateway resources.
+Understanding AWS Lambda and API Gateway is key to understanding Jets conceptually. Jets map your code to Lambda functions and other AWS Resources like API Gateway and Event Rules.
 
-* **AWS Lambda** is Functions as a Service. It allows you to upload and run functions without worrying about the underlying infrastructure.
+* **AWS Lambda** is functions as a service. It allows you to upload and run functions without worrying about the underlying infrastructure.
 * **API Gateway** is the routing layer for Lambda. It is used to route REST URL endpoints to Lambda functions.
+* **EventBridge Rules** are events as a service. You can automatically run Lambda functions triggered from AWS services. You decide what events to catch and how to react to them.
 
 The official documentation is at [Ruby on Jets](http://rubyonjets.com).
 
@@ -42,14 +43,14 @@ end
 
 Here's the function in the Lambda console:
 
-![Code Example in AWS Lambda console](https://raw.githubusercontent.com/tongueroo/jets/master/docs/img/docs/jets-simple-lambda-function-console.png)
+![Code Example in AWS Lambda console](https://img.boltops.com/tools/jets/readme/simple-lambda-function.png)
 
 
-Though simple functions are supported by Jets, they do not add much value as other ways to write Ruby code with Jets. Classes like [Controllers](http://rubyonjets.com/docs/controllers/) and [Jobs](http://rubyonjets.com/docs/jobs/) add many conveniences and are more powerful to use. We’ll cover them next.
+Though simple functions are supported by Jets, they do not add as much value as other ways to write Ruby code with Jets. Classes like [Controllers](http://rubyonjets.com/docs/controllers/) and [Jobs](http://rubyonjets.com/docs/jobs/) add many conveniences and are more powerful to use. We’ll cover them next.
 
 ### Jets Controllers
 
-A Jets controller handles a web request and renders a response.  Here's an example:
+A Jets controller handles a web request and renders a response. Here's an example:
 
 app/controllers/posts_controller.rb:
 
@@ -69,11 +70,9 @@ class PostsController < ApplicationController
 end
 ```
 
-Helper methods like `params` provide the parameters from the API Gateway event. The `render` method renders a Lambda Proxy structure back that API Gateway understands.
+Helper methods like `params` provide the parameters from the API Gateway event. The `render` method returns a Lambda Proxy structure that API Gateway understands.
 
-Jets creates Lambda functions for each public method in your controller. Here they are in the Lambda console:
-
-![Lambda Functions for each public method in AWS Console](https://raw.githubusercontent.com/tongueroo/jets/master/docs/img/docs/demo-lambda-functions-controller.png)
+Jets creates single Lambda functions to handle your Jets Controller requests. The Lambda Function handler is a shim that routes to your controller action.
 
 ### Jets Routing
 
@@ -83,23 +82,14 @@ config/routes.rb:
 
 ```ruby
 Jets.application.routes.draw do
-  get  "posts", to: "posts#index"
-  get  "posts/new", to: "posts#new"
-  get  "posts/:id", to: "posts#show"
-  post "posts", to: "posts#create"
-  get  "posts/:id/edit", to: "posts#edit"
-  put  "posts", to: "posts#update"
-  delete  "posts", to: "posts#delete"
-
-  resources :comments # expands to the RESTful routes above
-
+  resources :posts
   any "posts/hot", to: "posts#hot" # GET, POST, PUT, etc request all work
 end
 ```
 
 The `routes.rb` gets translated to API Gateway resources:
 
-![API Gateway Resources generated from routes in AWS console](https://raw.githubusercontent.com/tongueroo/jets/master/docs/img/quick-start/demo-api-gateway.png)
+![API Gateway Resources generated from routes in AWS console](https://img.boltops.com/tools/jets/readme/apigw.png)
 
 Test your API Gateway endpoints with curl or postman. Note, replace the URL endpoint with the one that is created:
 
@@ -111,7 +101,7 @@ Test your API Gateway endpoints with curl or postman. Note, replace the URL endp
 
 ### Jets Jobs
 
-A Jets job handles asynchronous background jobs performed outside of the web request/response cycle. Here's an example:
+A Jets job handles asynchronous background jobs outside the web request/response cycle. Here's an example:
 
 app/jobs/hard_job.rb:
 
@@ -129,9 +119,13 @@ class HardJob < ApplicationJob
 end
 ```
 
-`HardJob#dig` runs every 10 hours and `HardJob#lift` runs every 12 hours.  The `rate` and `cron` methods created CloudWatch Event Rules. Example:
+![Jets Jobs in AWS Lambda Console](https://img.boltops.com/tools/jets/readme/jets-jobs.png)
+
+`HardJob#dig` runs every 10 hours, and `HardJob#lift` runs every 12 hours. The `rate` and `cron` methods created CloudWatch Event Rules. Example:
+
+![CloudWatch Event Rules in AWS Console](https://img.boltops.com/tools/jets/readme/jets-jobs-event-rules.png)
 
-![CloudWatch Event Rules in AWS Console](https://raw.githubusercontent.com/tongueroo/jets/master/docs/img/docs/demo-job-cloudwatch-rule.png)
+This simple example uses Scheduled Events. There are many more possibilities, see the [Events Docs](https://docs.rubyonjets.com/docs/events/).
 
 ### Jets Deployment
 
@@ -141,29 +135,19 @@ You can test your application with a local server that mimics API Gateway: [Jets
 
 After deployment, you can test the Lambda functions with the AWS Lambda console or the CLI.
 
-### AWS Lambda Console
-
-![Lambda Console](https://s3.amazonaws.com/boltops-demo/images/screenshots/lambda-console-posts-controller-index.png)
-
 ### Live Demos
 
 Here are some demos of Jets applications:
 
 * [Quintessential CRUD Jets app](https://demo.rubyonjets.com/)
 * [API Demo](https://api.demo.rubyonjets.com/)
-* [Jets Afterburner: Easy Rails Support](https://afterburner.demo.rubyonjets.com/)
-* [Mega Mode: Jets and Rails Combined](https://mega.demo.rubyonjets.com/)
 * [Image Upload with CarrierWave](https://upload.demo.rubyonjets.com/)
 
-Please feel free to add your own example to the [jets-examples](https://github.com/tongueroo/jets-examples) repo.
-
-### Rails Support
-
-[Jets Afterburner Mode](http://rubyonjets.com/docs/rails-support/) provides Rails support with little effort.  This allows you to run a Rails application on AWS Lambda. Also here's a Tutorial Blog Post: [Jets Afterburner: Rails Support](https://blog.boltops.com/2018/12/21/jets-afterburner-serverless-rails-on-aws-lambda-in-5-minutes).
+Please feel free to add your examples to the [rubyonjets/examples](https://github.com/rubyonjets/examples) repo.
 
 ### More Info
 
-For more documentation, check out the official docs: [Ruby on Jets](http://rubyonjets.com/).  Here's a list of useful links:
+For more documentation, check out the official docs: [Ruby on Jets](http://rubyonjets.com/). Here's a list of useful links:
 
 * [Quick Start](http://rubyonjets.com/quick-start/)
 * [Local Jets Server](http://rubyonjets.com/docs/local-server/)

data/lib/jets/builders/code_builder.rb

@@ -233,7 +233,7 @@ module Jets::Builders
       # Checking this way because when using jets standalone for Afterburner mode we don't want to run into
       # bundler gem collisions.  TODO: figure out the a better way to handle the collisions.
       lines = IO.readlines("#{Jets.root}/Gemfile")
-      lines.detect { |l| l =~ /#{name}/ }
+      lines.detect { |l| l =~ /#{name}/ && l !~ /\s.*#/ }
     end
 
     # Cleans out non-cached files like code-*.zip in Jets.build_root

data/lib/jets/builders/templates/handlers/one_lambda_for_all_controllers.rb

@@ -8,7 +8,7 @@ def lambda_handler(event:, context:)
     return
   end
 
-  <% if @vars.process_type == "controller" -%>
+<% if @vars.process_type == "controller" -%>
   route = Jets::Router.find_route_by_event(event)
   controller = route.controller_name
   action = route.action_name

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

@@ -14,8 +14,9 @@ class Jets::Cfn::Resource::ApiGateway::RestApi::Routes::Change
       return [] if data.nil?
 
       data.map do |item|
+        http_method = item.dig('options','method') || item.dig('options','http_method')
         Jets::Router::Route.new(
-          http_method: item['http_method'],
+          http_method: http_method,
           path: item['path'],
           to: item['to'],
           engine: item['engine'],

data/lib/jets/cfn/resource/api_gateway/rest_api/routes/change.rb

@@ -5,13 +5,19 @@ class Jets::Cfn::Resource::ApiGateway::RestApi::Routes
 
     def changed?
       return false unless parent_stack_exists?
-      return false if Jets.config.cfn.build.routes == "one_apigw_method_for_all_routes"
+      return true if reset?
+
       # Note: Variable.changed? will likely always true in one_apigw_method_for_all_routes mode
-      # since parent variables are allowed to vary.
+      # since parent variables are allowed to vary in Jets v5.
+      if Jets.config.cfn.build.routes == "one_apigw_method_for_all_routes"
+        MediaTypes.changed? || To.changed?
+      else
+        MediaTypes.changed? || To.changed? || Variable.changed? || Page.changed?
+      end
+    end
 
-      # JETS_REPLACE_API is legacy.  JETS_API_REPLACE is the new var
-      MediaTypes.changed? || To.changed? || Variable.changed? || Page.changed? ||
-        ENV['JETS_RESET'] || ENV['JETS_API_REPLACE'] || ENV['JETS_REPLACE_API']
+    def reset?
+      ENV['JETS_RESET'] || ENV['JETS_API_REPLACE'] || ENV['JETS_REPLACE_API']
     end
 
     def parent_stack_exists?

data/lib/jets/commands/releases/releases_command.rb

@@ -1,6 +1,6 @@
 module Jets::Command
   class ReleasesCommand < Base # :nodoc:
-    desc "history", "List deploy history"
+    desc "history", "List releases"
     long_desc Help.text(:history)
     paging_options(order: 'desc').call
     def perform

data/lib/jets/core.rb

@@ -88,7 +88,13 @@ module Jets::Core
   def parsed_project_name
     lines = IO.readlines("#{Jets.root}/config/application.rb")
     project_name_line = lines.find { |l| l =~ /config\.project_name.*=/ && l !~ /^\s+#/ }
-    project_name_line.gsub(/.*=/,'').strip.gsub(/["']/,'') if project_name_line
+    if project_name_line
+      parsed = project_name_line.gsub(/.*=/,'').strip
+      # The +? makes it non-greedy
+      # See: https://ruby-doc.org/core-2.5.1/Regexp.html#class-Regexp-label-Repetition
+      md = parsed.match(/['"](.+?)['"]/)
+      md ? md[1] : raise("Unable to parse project name from config/application.rb: #{project_name_line}")
+    end
   end
   memoize :parsed_project_name
 

data/lib/jets/dotenv/ssm.rb

@@ -45,6 +45,9 @@ class Jets::Dotenv
     rescue Aws::SSM::Errors::ParameterNotFound
       @missing << [key, value, name]
       ''
+    rescue Aws::SSM::Errors::ValidationException
+      puts "ERROR: Invalid SSM parameter name: #{name.inspect}".color(:red)
+      raise
     end
 
     def ssm_name(key, value)

data/lib/jets/generators/overrides/app/helpers.rb

@@ -56,7 +56,6 @@ module Jets::Generators::Overrides::App
     end
 
     def copy_project
-      # directory ".", project_folder, copy_options
       directory ".", ".", copy_options
     end
 
@@ -69,9 +68,6 @@ module Jets::Generators::Overrides::App
       excludes.uniq!
 
       unless @database
-        # Do not even generate the config/database.yml because
-        # Jets webpacker:install bombs and tries to load the db since it sees a
-        # config/database.yml but there's no database pg gem configured.
         excludes += %w[
           database.yml
           db

data/lib/jets/generators/overrides/app/templates/.env

@@ -0,0 +1,10 @@
+# Variables in here are available and shared across all environments: development, production, etc
+# Docs: https://docs.rubyonjets.com/docs/env-files/
+
+# Examples:
+# DATABASE_URL="mysql2://user:pass@host.com/db_name?pool=5" # raw value as-is
+# SSM can be use to reference a parameter store value
+# DATABASE_URL=SSM                       # conventionally references /PROJECT_NAME/JETS_ENV/DATABASE_URL
+# DATABASE_URL=SSM                       # /demo/development/DATABASE_URL
+# DATABASE_URL=SSM:database-url          # /demo/development/database-url
+# DATABASE_URL=SSM:/path/to/database-url # /path/to/database-url

data/lib/jets/router/matcher.rb

@@ -32,7 +32,7 @@ module Jets::Router
       # Checking the request_method_from_hidden_method_field so that handler can find the right route
       # super early in the process. Otherwise lambda routes to the wrong controller action.
       @request_method = request_method || @request.request_method_from_hidden_method_field || @request.request_method.to_s.upcase
-      @request_path = @request.path
+      @request_path = strip_format(@request.path)
       route = find_route
       match_constraints(route) if route
     end
@@ -43,7 +43,7 @@ module Jets::Router
     def find_by_env(env)
       @env = env
       @request_method = env["REQUEST_METHOD"] || "GET"
-      @request_path = env["PATH_INFO"]
+      @request_path = strip_format(env["PATH_INFO"])
       find_route
     end
 
@@ -87,12 +87,16 @@ module Jets::Router
     end
     memoize :mount
 
+    def strip_format(path)
+      path.sub(/\..+$/, '') # Remove format from the end of the path
+    end
+
     def match?(route)
       # Immediately stop checking when the request http_method: GET, POST, ANY, etc
       # doesnt match.
       return false if request_method != route.http_method && route.http_method != "ANY"
 
-      route_path = route.path
+      route_path = strip_format(route.path)
       route_path = "#{mount.at}#{route_path}" if mount
 
       if request_path == route_path

data/lib/jets/version.rb

@@ -1,3 +1,3 @@
 module Jets
-  VERSION = "5.0.0.beta1"
+  VERSION = "5.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jets
 version: !ruby/object:Gem::Version
-  version: 5.0.0.beta1
+  version: 5.0.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-03 00:00:00.000000000 Z
+date: 2023-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -962,7 +962,8 @@ files:
 - lib/jets/generators/overrides/app/USAGE
 - lib/jets/generators/overrides/app/app_generator.rb
 - lib/jets/generators/overrides/app/helpers.rb
-- lib/jets/generators/overrides/app/templates/.gitignore
+- lib/jets/generators/overrides/app/templates/.env
+- lib/jets/generators/overrides/app/templates/.gitignore.tt
 - lib/jets/generators/overrides/app/templates/.rspec
 - lib/jets/generators/overrides/app/templates/Gemfile.tt
 - lib/jets/generators/overrides/app/templates/README.md
@@ -1187,9 +1188,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.4.20
 signing_key: