jets 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2caf68ff06e809fb88b76bdfb381aca29ce7f8540989dd775da2b288351b7f28
-  data.tar.gz: 566b69b388a24b2d110cd522c410b4be939a4a8e38f2771a69618228ffd8009c
+  metadata.gz: a0f899e409f74150cb787d1e943bc952061eac3750eff304d6e7d657fb982b77
+  data.tar.gz: 182a1f82f57e0f4a7afd89924f6a90b60dcc1be053b4c0e3ca1cb645030c54d3
 SHA512:
-  metadata.gz: c76ed8e21738349e7052c01d27bce581afd66a8c32980532e1a2c63fcf597336bb6deabcdea64db75a880b4e055516d33271e543dcae9196b74a22e95685be9c
-  data.tar.gz: c753ef10f2c180de87e82305b68195ff591a53f1b3b497144df7ddf43aeb7bce3d779183172984d068458a070512b072920b85986ad3354a5384ee5dead40c09
+  metadata.gz: c1f6ad92079f026224861aeda73d5552834119dc59504c00ef1fbba5480c817305e3e517372eedf48684d6145fad2ed8bda610dc3223798eb4aa2c65f3a10b23
+  data.tar.gz: 31f71bf99f2499d3ba8ac00e298abba20a09b9235f8cfd20f400ae005204e07e24271a925be6abc2e728a6e0162f5ea44cbaee1248e11dd2089b397ef82661e8

data/.gitignore

@@ -17,5 +17,5 @@ tmp
 
 spec/fixtures/project/handlers
 .codebuild/definitions
-demo1*
+demo*
 /html

data/CHANGELOG.md

@@ -3,6 +3,9 @@
 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.
 
+## [1.0.6]
+- method fixes: account for inheritance and private keyword #57
+
 ## [1.0.5]
 - change config.lambdagems to config.gems
 - friendly info message when yarn is not installed

data/Gemfile

@@ -7,7 +7,7 @@ gemspec
 # TODO: Only require webpacker in Gemfile of project if possible.
 # Need both because of jets/application.rb and jets/webpacker/middleware_setup.rb
 group :development, :test do
-  gem "pg", "=0.21"
+  gem "mysql2", "~> 0.5.2"
   gem "webpacker", git: "https://github.com/tongueroo/webpacker.git", branch: "jets"
   gem "rspec_junit_formatter"
 end

data/Gemfile.lock

@@ -11,7 +11,7 @@ GIT
 PATH
   remote: .
   specs:
-    jets (1.0.5)
+    jets (1.0.6)
       actionpack (>= 5.2.1)
       actionview (>= 5.2.1)
       activerecord (>= 5.2.1)
@@ -118,9 +118,9 @@ GEM
     mimemagic (0.3.2)
     mini_portile2 (2.3.0)
     minitest (5.11.3)
+    mysql2 (0.5.2)
     nokogiri (1.8.5)
       mini_portile2 (~> 2.3.0)
-    pg (0.21.0)
     rack (2.0.5)
     rack-proxy (0.6.5)
       rack
@@ -167,7 +167,7 @@ DEPENDENCIES
   bundler
   byebug
   jets!
-  pg (= 0.21)
+  mysql2 (~> 0.5.2)
   rake
   rspec
   rspec_junit_formatter

data/README.md

@@ -19,7 +19,7 @@ It is key to understand AWS Lambda and API Gateway to understand Jets conceptual
 * **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.
 
-The official documentation is at: [Ruby on Jets](http://rubyonjets.com).
+The official documentation is at [Ruby on Jets](http://rubyonjets.com).
 
 Refer to the official docs for more info, but here's a quick intro.
 
@@ -60,7 +60,7 @@ class PostsController < ApplicationController
 end
 ```
 
-Jets creates Lambda functions each the public method in your controller.
+Jets creates Lambda functions for each public method in your controller.
 
 ### Jets Routing
 
@@ -86,15 +86,15 @@ end
 
 Test your API Gateway endpoints with curl or postman. Note, replace the URL endpoint with the one that is created:
 
-	$ curl -s "https://quabepiu80.execute-api.us-east-1.amazonaws.com/dev/posts" | jq .
-	{
-	  "hello": "world",
-	  "action": "index"
-	}
+    $ curl -s "https://quabepiu80.execute-api.us-east-1.amazonaws.com/dev/posts" | jq .
+    {
+      "hello": "world",
+      "action": "index"
+    }
 
 ### Jets Jobs
 
-A Jets job handles asynchrous background jobs performed outside of the web request/response cycle. Here's an example:
+A Jets job handles asynchronous background jobs performed outside of the web request/response cycle. Here's an example:
 
 app/jobs/hard_job.rb:
 
@@ -118,7 +118,7 @@ end
 
 You can test your application with a local server that mimics API Gateway: [Jets Local Server](http://rubyonjets.com/docs/local-server/). Once ready, deploying to AWS Lambda is a single command.
 
-	jets deploy
+    jets deploy
 
 After deployment, you can test the Lambda functions with the AWS Lambda console or the CLI.
 
@@ -132,7 +132,7 @@ Here's a [Live Demo](https://demo.rubyonjets.com/posts) of the quintessential CR
 
 ### Rails Support
 
-Jets [Mega Mode](http://rubyonjets.com/docs/megamode/) provides Rails support with little effort.  This allows you run a Rails application on AWS Lambda. Refer to the [Rails Support](http://rubyonjets.com/docs/rails-support/) docs for more info.
+Jets [Mega Mode](http://rubyonjets.com/docs/megamode/) provides Rails support with little effort.  This allows you to run a Rails application on AWS Lambda. Refer to the [Rails Support](http://rubyonjets.com/docs/rails-support/) docs for more info.
 
 ### More Info
 
@@ -141,7 +141,6 @@ For more documentation, check out the official docs: [Ruby on Jets](http://rubyo
 * [Quick Start](http://rubyonjets.com/quick-start/)
 * [Local Jets Server](http://rubyonjets.com/docs/local-server/)
 * [REPL Console](http://rubyonjets.com/docs/repl-console/)
-* [Jets Call](http://rubyonjets.com/docs/jets-call/)
 * [Project Structure](http://rubyonjets.com/project-structure/)
 * [App Configuration](http://rubyonjets.com/app-config/)
 * [Database Support](http://rubyonjets.com/docs/database-support/)

data/README/testing.md

@@ -8,6 +8,8 @@ To run unit tests:
 
 ## Integration
 
+These commands run all from the jets repo itself. The demo folder has been added to the `.gitignore`.
+
 ### Locally
 
 To run the integration tests locally, you need to create a new Jets CRUD project and start the server:
@@ -38,4 +40,9 @@ Then you can deploy the jets app and test it on real AWS Lambda.
 
 Run the remote integration script:
 
-    spec/integration/remote.sh
+    BASE_URL=xxx spec/integration/remote.sh
+
+Example:
+
+    BASE_URL=https://wb5dcjc09a.execute-api.us-west-2.amazonaws.com/dev spec/integration/remote.sh
+    

data/lib/jets/cfn/upload.rb

@@ -50,10 +50,10 @@ class Jets::Cfn
     end
 
     def upload_assets
-      puts "Uploading modified public assets to S3."
+      puts "Checking for modified public assets and uploading to S3."
       start_time = Time.now
       upload_public_assets
-      puts "Time to upload public assets to s3: #{pretty_time(Time.now-start_time).colorize(:green)}"
+      puts "Time for public assets to s3: #{pretty_time(Time.now-start_time).colorize(:green)}"
     end
 
     def upload_public_assets

data/lib/jets/commands/base.rb

@@ -79,6 +79,7 @@ class Jets::Commands::Base < Thor
     def namespaced_commands
       eager_load!
       subclasses.map do |klass|
+        # This all_tasks is part of Thor not the lambda/dsl.rb
         klass.all_tasks.keys.map do |task_name|
           klass = klass.to_s.sub('Jets::Commands::','')
           namespace = klass =~ /^Main/ ? nil : klass.underscore.gsub('/',':')

data/lib/jets/lambda/dsl.rb

@@ -13,6 +13,8 @@ module Jets::Lambda::Dsl
 
   included do
     class << self
+      extend Memoist
+
       def class_properties(options=nil)
         if options
           @class_properties ||= {}
@@ -259,12 +261,70 @@ module Jets::Lambda::Dsl
       # Returns the all tasks for this class with their method names as keys.
       #
       # ==== Returns
-      # OrderedHash:: An ordered hash with tasks names as keys and JobTask
+      # OrderedHash:: An ordered hash with tasks names as keys and Task
       #               objects as values.
       #
       def all_tasks
         @all_tasks ||= ActiveSupport::OrderedHash.new
       end
+      # Do not call all tasks outside this class, instead use: tasks or lambda functions
+      private :all_tasks
+
+      # Goes up the class inheritance chain to build the tasks.
+      #
+      # Example heirarchy:
+      #
+      #   Jets::Lambda::Functions > Jets::Controller::Base > ApplicationController ...
+      #     > PostsController > ChildPostsController
+      #
+      # Do not include tasks from the direct subclasses of Jets::Lambda::Functions
+      # because those classes are abstract.  Dont want those methods to be included.
+      def find_all_tasks(public: true)
+        klass = self
+        direct_subclasses = Jets::Lambda::Functions.subclasses
+        lookup = []
+
+        # Go up class inheritance and builds lookup structure in memory
+        until direct_subclasses.include?(klass)
+          lookup << klass.send(:all_tasks) # one place we want to call private all_tasks method
+          klass = klass.superclass
+        end
+        merged_tasks = ActiveSupport::OrderedHash.new
+        # Go back down the class inheritance chain in reverse order and merge the tasks
+        lookup.reverse.each do |tasks_hash|
+          # tasks_hash is a result of all_tasks. Example: PostsController.all_tasks
+          merged_tasks.merge!(tasks_hash)
+        end
+
+        # The cfn builders required the right final child class to build the lambda functions correctly.
+        merged_tasks.each do |meth, task|
+          # Override the class name for the cfn builders
+          task = task.clone # do not stomp over current tasks since things are usually looked by reference
+          task.instance_variable_set(:@class_name, self.name)
+          merged_tasks[meth] = task
+        end
+
+        # Methods can be made private with the :private keyword after the method has been defined.
+        # To account for this, loop back thorugh all the methods and check if the method is indeed public.
+        tasks = ActiveSupport::OrderedHash.new
+        merged_tasks.each do |meth, task|
+          if public
+            tasks[meth] = task if task.public_meth?
+          else
+            tasks[meth] = task unless task.public_meth?
+          end
+        end
+        tasks
+      end
+      memoize :find_all_tasks
+
+      def all_public_tasks
+        find_all_tasks(public: true)
+      end
+
+      def all_private_tasks
+        find_all_tasks(public: false)
+      end
 
       # Returns the tasks for this class in Array form.
       #
@@ -272,13 +332,7 @@ module Jets::Lambda::Dsl
       # Array of task objects
       #
       def tasks
-        all_tasks.values
-      end
-
-      # Used in Jets::Cfn::Builders::Interface#build
-      # Overridden in rule/dsl.rb
-      def build?
-        !tasks.empty?
+        all_public_tasks.values
       end
 
       # The public methods defined in the project app class ulimately become
@@ -287,7 +341,13 @@ module Jets::Lambda::Dsl
       # Example return value:
       #   [:index, :new, :create, :show]
       def lambda_functions
-        all_tasks.keys
+        all_public_tasks.keys
+      end
+
+      # Used in Jets::Cfn::Builders::Interface#build
+      # Overridden in rule/dsl.rb
+      def build?
+        !tasks.empty?
       end
 
       # Polymorphic support

data/lib/jets/lambda/functions.rb

@@ -18,5 +18,17 @@ module Jets::Lambda
 
     include Dsl # At the end so methods like event, context and method
       # do not trigger method_added
+
+    class << self
+      # Tracking subclasses because it helps with Lambda::Dsl#find_all_tasks
+      def subclasses
+        @subclasses ||= []
+      end
+
+      def inherited(base)
+        super
+        self.subclasses << base if base.name
+      end
+    end
   end
 end

data/lib/jets/lambda/task.rb

@@ -14,14 +14,25 @@ class Jets::Lambda::Task
     @replacements = options[:replacements] || {} # added to baseline replacements
   end
 
-  def build_function_iam?
-    !!(@iam_policy || @managed_iam_policy)
-  end
-
   def name
     @meth
   end
 
+  def public_meth?
+    # For anonymous classes (app/functions/hello.rb) the class name will be blank.
+    # These types of classes are treated specially and has only one handler method
+    # that is registered. So we know it is public.
+    return true if @class_name.nil? || @class_name == ''
+
+    klass = @class_name.constantize
+    public_methods = klass.public_instance_methods
+    public_methods.include?(meth.to_sym)
+  end
+
+  def build_function_iam?
+    !!(@iam_policy || @managed_iam_policy)
+  end
+
   @@lang_exts = {
     ruby: '.rb',
     python: '.py',

data/lib/jets/poly_fun.rb

@@ -17,6 +17,8 @@ module Jets
     end
 
     def run(event, context={})
+      check_private_method!
+
       if task.lang == :ruby
         # controller = PostsController.new(event, content)
         # resp = controller.edit
@@ -54,8 +56,20 @@ module Jets
     end
 
     def task
-      @app_class.all_tasks[@app_meth]
+      task = @app_class.all_public_tasks[@app_meth]
+      # Provider user a better error message to user than a nil failure.
+      unless task
+        raise "Unable to find #{@app_class}##{@app_meth}"
+      end
+      task
     end
     memoize :task
+
+    def check_private_method!
+      private_detected = @app_class.all_private_tasks.keys.include?(@app_meth)
+      return unless private_detected # Ok to continue
+
+      raise "The #{@app_class}##{@app_meth} is a private method.  Unable to call it unless it is public"
+    end
   end
 end

data/lib/jets/route.rb

@@ -58,7 +58,7 @@ class Jets::Route
     rescue NameError
       return false
     end
-    controller_class.all_tasks.keys.include?(action_name.to_sym)
+    controller_class.lambda_functions.include?(action_name.to_sym)
   end
 
   # Extracts the path parameters from the actual path

data/lib/jets/version.rb

@@ -1,3 +1,3 @@
 module Jets
-  VERSION = "1.0.5"
+  VERSION = "1.0.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jets
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Tung Nguyen