jets 2.0.1 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 595189c68ebf3b306738227bb516e6ab44f93c9be22a67c4ae9028129384c553
-  data.tar.gz: b1ff731c9dff57744f63de0de36d62a177267b21236814eab97ce516bacac19c
+  metadata.gz: 1296b877cb1281059d7410eb87b22b2343017ce69de87689535cdabd1f1b76be
+  data.tar.gz: 0cd13123cf8fb894154cde0123631e1af4a1bae4a709a8e5c486306efedd87af
 SHA512:
-  metadata.gz: 931fce86443f6cd48e7b481572bc739ae354cb7015f26229c8b80eb3bb8fabd65d6a12b5488fc57739ccaa7bf62426c7619cd2d60c2a42cbfaba2690ca2506de
-  data.tar.gz: a75e02410737e0c5aa77a22721462c2dcb784c048873f91f5d51dc3db3b3883d2af716bd79ebe8918f31717b5b46d606f54128bacee1fa5c259686e2cf21ba5b
+  metadata.gz: 1c9f8d26180f8a82b7600c8e1bdfbe3c23e1d96ee80dc20e60e1c387d04a7c8b98896fe28a653bdd065c68847c2688ea6592c109a4b22210fa7786baaa8c2e17
+  data.tar.gz: 7b7edddbd10a35c12a434a9edef4f449db2057a116dcc6aec9f3d03ed36bba2071089a438187ee84307588b26bbea5412aab2219d843b0388d2248a09dd28cd2

data/CHANGELOG.md

@@ -3,6 +3,13 @@
 All notable changes to this project will be documented in this file.
 This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/).
 
+## [2.0.3]
+- #331 spec_helpers fixes: response.headers support, fix session, run spec controller through middleware
+
+## [2.0.2]
+- #322, #325, #326, #329 update docs
+- #330 fix remove Rails const
+
 ## [2.0.1]
 - #319 improve mega mode or afterburner, start back up rack process if it dies for any reason
 

data/README.md

@@ -8,6 +8,7 @@ Ruby and Lambda splat out a baby and that child's name is [Jets](http://rubyonje
 [![CircleCI](https://circleci.com/gh/tongueroo/jets.svg?style=svg)](https://circleci.com/gh/tongueroo/jets)
 [![Gem Version](https://badge.fury.io/rb/jets.svg)](https://badge.fury.io/rb/jets)
 [![Support](https://img.shields.io/badge/Support-Help-blue.svg)](http://rubyonjets.com/support/)
+[![Gitter Chat](https://badges.gitter.im/tongueroo/jets.png)](https://gitter.im/tongueroo/jets)
 
 **Upgrading**: If you are upgrading Jets, please check on the [Upgrading Notes](http://rubyonjets.com/docs/extras/upgrading/).
 
@@ -39,7 +40,7 @@ end
 
 Here's the function in the 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://raw.githubusercontent.com/tongueroo/jets/master/docs/img/docs/jets-simple-lambda-function-console.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.
@@ -70,7 +71,7 @@ Helper methods like `params` provide the parameters from the API Gateway event.
 
 Jets creates Lambda functions for each public method in your controller. Here they are in the Lambda console:
 
-![](https://raw.githubusercontent.com/tongueroo/jets/master/docs/img/docs/demo-lambda-functions-controller.png)
+![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 Routing
 
@@ -96,7 +97,7 @@ end
 
 The `routes.rb` gets translated to API Gateway resources:
 
-![](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://raw.githubusercontent.com/tongueroo/jets/master/docs/img/quick-start/demo-api-gateway.png)
 
 Test your API Gateway endpoints with curl or postman. Note, replace the URL endpoint with the one that is created:
 
@@ -128,7 +129,7 @@ end
 
 `HardJob#dig` runs every 10 hours and `HardJob#lift` runs every 12 hours.  The `rate` and `cron` methods created CloudWatch Event Rules. Example:
 
-![](https://raw.githubusercontent.com/tongueroo/jets/master/docs/img/docs/demo-job-cloudwatch-rule.png)
+![CloudWatch Event Rules in AWS Console](https://raw.githubusercontent.com/tongueroo/jets/master/docs/img/docs/demo-job-cloudwatch-rule.png)
 
 ### Jets Deployment
 

data/lib/jets/aws_info.rb

@@ -89,7 +89,7 @@ module Jets
     end
 
     def test?
-      ENV['TEST']
+      ENV['TEST'] || Jets.env.test?
     end
 
     private

data/lib/jets/cli.rb

@@ -80,7 +80,8 @@ class Jets::CLI
     # `jets generate` is called without additional args.  We'll take it over early and fix it here.
     autocomplete_command = Jets::Commands::Base.autocomplete(args[0])
     generate = autocomplete_command == "generate"
-    if generate && (args.size == 1 || help_flags.include?(args.last))
+
+    if generate && ((args.size == 1 || help_flags.include?(args.last)) || args.size == 2)
       puts Jets::Generator.help
       exit
     end

data/lib/jets/commands/main.rb

@@ -97,13 +97,13 @@ module Jets::Commands
     end
 
     desc "generate [type] [args]", "Generates things like scaffolds"
-    long_desc Jets::Generator.help
+    long_desc Help.text(:generate) # do use Jets::Generator.help as it'll load Rails const
     def generate(generator, *args)
       Jets::Generator.invoke(generator, *args)
     end
 
     desc "degenerate [type] [args]", "Destroys things like scaffolds"
-    long_desc Jets::Generator.help
+    long_desc Help.text(:generate) # do use Jets::Generator.help as it'll load Rails const
     def degenerate(generator, *args)
       Jets::Generator.revoke(generator, *args)
     end

data/lib/jets/controller/base.rb

@@ -23,6 +23,13 @@ class Jets::Controller
       @response = Response.new
     end
 
+    # One key difference between process! vs dispatch!
+    #
+    #    process! - takes the request through the middleware stack
+    #    dispatch! - does not
+    #
+    # Most of the time, you want process! instead of dispatch!
+    #
     def process!
       adapter = Jets::Controller::Rack::Adapter.new(event, context, meth)
       adapter.rack_vars(

data/lib/jets/generator.rb

@@ -10,8 +10,6 @@ class Jets::Generator
     end
 
     def help(args=ARGV)
-      require_generators
-
       # `jets generate -h` results in:
       #
       #     args = ["generate", "-h"]

data/lib/jets/router/method_creator/code.rb

@@ -91,8 +91,7 @@ class Jets::Router::MethodCreator
 
   private
     def singularize(s)
-      return unless s # nil
-      s.singularize
+      s&.singularize
     end
   end
 end

data/lib/jets/spec_helpers.rb

@@ -4,51 +4,12 @@ require 'base64'
 
 module Jets
   module SpecHelpers
-    attr_reader :request, :response
-    def initialize(*)
-      super
-      @request = Request.new(:get, '/', {}, Params.new)
-      @response = nil # will be set after http_call
-    end
-
-    rest_methods = %w[get post put patch delete]
-    rest_methods.each do |meth|
-      define_method(meth) do |path, **params|
-        http_call(method: meth, path: path, **params)
-      end
-      # Example:
-      # def get(path, **params)
-      #   http_call(method: :get, path: path, **params)
-      # end
-    end
-
-    def http_call(method:, path:, **params)
-      request.method = method.to_sym
-      request.path = path
-      request.headers.deep_merge!(params.delete(:headers) || {})
-
-      request.params.body_params = params.delete(:params) || params || {}
-
-      request.params.query_params = params.delete(:query)
-      request.params.query_params ||= params if request.method == :get
-      request.params.query_params ||= {}
-
-      request.params.path_params = params
-
-      @response = request.dispatch!
-    end
-
-    def fixture_path(filename)
-      "#{Jets.root}/spec/fixtures/#{filename}"
-    end
-
-    def fixture_file(filename)
-      File.new(fixture_path(filename))
-    end
+    include Fixtures
+    include Controllers
   end
 end
 
 require "rspec"
 RSpec.configure do |c|
   c.include Jets::SpecHelpers
-end
+end

data/lib/jets/spec_helpers/controllers.rb

@@ -0,0 +1,38 @@
+module Jets::SpecHelpers
+  module Controllers
+    attr_reader :request, :response
+
+    def initialize(*)
+      super
+      @request = Request.new(:get, '/', {}, Params.new)
+      @response = nil # will be set after http_call
+    end
+
+    rest_methods = %w[get post put patch delete]
+    rest_methods.each do |meth|
+      define_method(meth) do |path, **params|
+        http_call(method: meth, path: path, **params)
+      end
+      # Example:
+      # def get(path, **params)
+      #   http_call(method: :get, path: path, **params)
+      # end
+    end
+
+    def http_call(method:, path:, **params)
+      request.method = method.to_sym
+      request.path = path
+      request.headers.deep_merge!(params.delete(:headers) || {})
+
+      request.params.body_params = params.delete(:params) || params || {}
+
+      request.params.query_params = params.delete(:query)
+      request.params.query_params ||= params if request.method == :get
+      request.params.query_params ||= {}
+
+      request.params.path_params = params
+
+      @response = request.dispatch!
+    end
+  end
+end

data/lib/jets/spec_helpers/controllers/params.rb

@@ -0,0 +1,8 @@
+module Jets::SpecHelpers::Controllers
+  class Params
+    attr_accessor :path_params, :body_params, :query_params
+    def initialize(path_params={}, body_params={}, query_params={})
+      @path_params, @body_params, @query_params = path_params, body_params, query_params
+    end
+  end
+end

data/lib/jets/spec_helpers/controllers/request.rb

@@ -0,0 +1,77 @@
+module Jets::SpecHelpers::Controllers
+  class Request
+    attr_accessor :method, :path, :headers, :params
+    def initialize(method, path, headers={}, params={})
+      @method, @path, @headers, @params = method, path, headers, params
+    end
+
+    def event
+      json = {}
+      id_params = path.scan(%r{:([^/]+)}).flatten
+      expanded_path = path.dup
+      path_parameters = {}
+
+      id_params.each do |id_param|
+        raise "missing param: :#{id_param}" unless params.path_params.include? id_param.to_sym
+
+        path_param_value = params.path_params[id_param.to_sym]
+        raise "Path param :#{id_param} value cannot be blank" if path_param_value.blank?
+
+        expanded_path.gsub!(":#{id_param}", path_param_value.to_s)
+        path_parameters.deep_merge!(id_param => path_param_value.to_s)
+      end
+
+      json['resource'] = path
+      json['path'] = expanded_path
+      json['httpMethod'] = method.to_s.upcase
+      json['pathParameters'] = path_parameters
+      json['headers'] = (headers || {}).stringify_keys
+
+      if method != :get
+        json['headers']['Content-Type'] = 'application/x-www-form-urlencoded'
+        body = Rack::Multipart.build_multipart(params.body_params)
+
+        if body
+          json['headers']['Content-Length'] ||= body.length.to_s
+          json['headers']['Content-Type'] = "multipart/form-data; boundary=#{Rack::Multipart::MULTIPART_BOUNDARY}"
+        else
+          body = Rack::Utils.build_nested_query(params.body_params)
+        end
+
+        json['body'] = Base64.encode64(body)
+        json['isBase64Encoded'] = true
+      end
+
+      params.query_params.each do |key, value|
+        json['queryStringParameters'] ||= {}
+        json['queryStringParameters'][key.to_s] = value.to_s
+      end
+
+      json
+    end
+
+    def find_route!
+      path = self.path
+      path = path[0..-2] if path.end_with? '/'
+      path = path[1..-1] if path.start_with? '/'
+
+      route = Jets::Router.routes.find { |r| r.path == path && r.method == method.to_s.upcase }
+      raise "Route not found: #{method.to_s.upcase} #{path}" if route.blank?
+
+      route
+    end
+
+    def dispatch!
+      route = find_route!
+      klass = Object.const_get(route.controller_name)
+      controller = klass.new(event, {}, route.action_name)
+      response = controller.process! # response is API Gateway Hash
+
+      unless response['statusCode'] && response['body']
+        raise "Expected response to an API Gateway Hash Structure. Are you rendering correctly?"
+      end
+
+      Response.new(response) # converts APIGW hash to prettier object
+    end
+  end
+end

data/lib/jets/spec_helpers/controllers/response.rb

@@ -0,0 +1,10 @@
+module Jets::SpecHelpers::Controllers
+  class Response
+    attr_reader :status, :headers, :body
+    def initialize(response)
+      @status = response['statusCode'].to_i
+      @headers = response['headers']
+      @body = response['body']
+    end
+  end
+end

data/lib/jets/spec_helpers/fixtures.rb

@@ -0,0 +1,11 @@
+module Jets::SpecHelpers
+  module Fixtures
+    def fixture_path(filename)
+      "#{Jets.root}/spec/fixtures/#{filename}"
+    end
+
+    def fixture_file(filename)
+      File.new(fixture_path(filename))
+    end
+  end
+end

data/lib/jets/version.rb

@@ -1,3 +1,3 @@
 module Jets
-  VERSION = "2.0.1"
+  VERSION = "2.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jets
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.3
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-29 00:00:00.000000000 Z
+date: 2019-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -914,9 +914,11 @@ files:
 - lib/jets/rule/base.rb
 - lib/jets/rule/dsl.rb
 - lib/jets/spec_helpers.rb
-- lib/jets/spec_helpers/params.rb
-- lib/jets/spec_helpers/request.rb
-- lib/jets/spec_helpers/response.rb
+- lib/jets/spec_helpers/controllers.rb
+- lib/jets/spec_helpers/controllers/params.rb
+- lib/jets/spec_helpers/controllers/request.rb
+- lib/jets/spec_helpers/controllers/response.rb
+- lib/jets/spec_helpers/fixtures.rb
 - lib/jets/stack.rb
 - lib/jets/stack/builder.rb
 - lib/jets/stack/definition.rb

data/lib/jets/spec_helpers/params.rb

@@ -1,10 +0,0 @@
-module Jets
-  module SpecHelpers
-    class Params
-      attr_accessor :path_params, :body_params, :query_params
-      def initialize(path_params={}, body_params={}, query_params={})
-        @path_params, @body_params, @query_params = path_params, body_params, query_params
-      end
-    end
-  end
-end

data/lib/jets/spec_helpers/request.rb

@@ -1,78 +0,0 @@
-module Jets
-  module SpecHelpers
-    class Request
-      attr_accessor :method, :path, :headers, :params
-      def initialize(method, path, headers={}, params={})
-        @method, @path, @headers, @params = method, path, headers, params
-      end
-
-      def event
-        json = {}
-        id_params = path.scan(%r{:([^/]+)}).flatten
-        expanded_path = path.dup
-        path_parameters = {}
-
-        id_params.each do |id_param|
-          raise "missing param: :#{id_param}" unless params.path_params.include? id_param.to_sym
-
-          path_param_value = params.path_params[id_param.to_sym]
-          raise "Path param :#{id_param} value cannot be blank" if path_param_value.blank?
-
-          expanded_path.gsub!(":#{id_param}", path_param_value.to_s)
-          path_parameters.deep_merge!(id_param => path_param_value.to_s)
-        end
-
-        json['resource'] = path
-        json['path'] = expanded_path
-        json['httpMethod'] = method.to_s.upcase
-        json['pathParameters'] = path_parameters
-        json['headers'] = (headers || {}).stringify_keys
-
-        if method != :get
-          json['headers']['Content-Type'] = 'application/x-www-form-urlencoded'
-          body = Rack::Multipart.build_multipart(params.body_params)
-
-          if body
-            json['headers']['Content-Length'] ||= body.length.to_s
-            json['headers']['Content-Type'] = "multipart/form-data; boundary=#{Rack::Multipart::MULTIPART_BOUNDARY}"
-          else
-            body = Rack::Utils.build_nested_query(params.body_params)
-          end
-
-          json['body'] = Base64.encode64(body)
-          json['isBase64Encoded'] = true
-        end
-
-        params.query_params.each do |key, value|
-          json['queryStringParameters'] ||= {}
-          json['queryStringParameters'][key.to_s] = value.to_s
-        end
-
-        json
-      end
-
-      def find_route!
-        path = self.path
-        path = path[0..-2] if path.end_with? '/'
-        path = path[1..-1] if path.start_with? '/'
-
-        route = Jets::Router.routes.find { |r| r.path == path && r.method == method.to_s.upcase }
-        raise "Route not found: #{method.to_s.upcase} #{path}" if route.blank?
-
-        route
-      end
-
-      def dispatch!
-        route = find_route!
-        controller = Object.const_get(route.controller_name).new(event, {}, route.action_name)
-        response = controller.dispatch!
-
-        if !response.is_a?(Array) || response.size != 3
-          raise "Expected response to be an array of size 3. Are you rendering correctly?"
-        end
-
-        Response.new(response[0].to_i, response[2].read)
-      end
-    end
-  end
-end

data/lib/jets/spec_helpers/response.rb

@@ -1,5 +0,0 @@
-module Jets
-  module SpecHelpers
-    Response = Struct.new(:status, :body)
-  end
-end