ruby_lambda 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f646027b7f81f705b0472a745971a06da4b80db8e45a492638fc12a0b9425356
-  data.tar.gz: d0bf726f45c71e52d965a03dca6af04db1a1fe90e12c9fe47f0db78fc4f73862
+  metadata.gz: 01a15ca221c38d90226bf1650359ac671a2596a5efc9ed60600c8c89c0054e5b
+  data.tar.gz: d6243b2995a7c207a911d27764711801f9a1d4d0062f9934a9b7ea8be2d8e768
 SHA512:
-  metadata.gz: 64ea3b68aa6e3e789bcd17bdfc337a61cfed2678025cb8c52a911af9702c3289edc6a1feeb83b41ef287464b96ae0d1be117c7f474f6764f1b87bf5e10a314f1
-  data.tar.gz: b02f4be3d106db803cb2ed5301521baddcc969285aab632be9c5009edc08cf6b9b4c51970019db49e88f86598530d5ea573540f3d5e6aa3da1d148cbf74de059
+  metadata.gz: f90537875be6ab246ecbf48fecc0488bdea4ee71f2dc2ab01293d976d6c04681123bac4020c2f4d730a461495be43f4526c62b63c1c25c3ba4422bb9f48bc9e7
+  data.tar.gz: 7415bb05652a69a515f26d9c7f6c260fe24cf76d258d08b1936877feb3bc662cf2560149d2578c71f004beb7d18ae5d90dae9c9261a9d1a951b7fa58338a6f0d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby_lambda (0.2.2)
+    ruby_lambda (0.3.0)
       awesome_print (~> 1.8.0)
       thor (~> 0.19)
 

data/README.md

@@ -26,7 +26,7 @@ $ ruby-lambda init
 ```
 
 Initializes the `.gitignore`, `config.yml`, `env`, `event.json`, `lambda_function.rb`, `Gemfile`, `.ruby-version` files.
-* `event.json` is where you mock your event.
+* `event.json` is where you keep mock data that will be passed to your function when the `execute` command has ran.
 * `config.yml` contains some default configuration for your function.
 * `env` will be renamed to `.env` after the init command runs, it will contain `AWS_ACCESS_KEY` and `AWS_SECRET_ACCESS_KEY`. You will need these to be able to deploy your function.
 
@@ -36,6 +36,27 @@ Please have a read of the `config.yml` and update any of the default configurati
 ```
 $ ruby-lambda execute
 ```
+This command is used to invoke / run the function locally
+
+```
+Options:
+  -c, [--config=CONFIG] # Default: config.yml
+  -H, [--handler=HANDLER]
+```
+
+**Examples**
+* `$ ruby-lambda execute -c=config.yml`
+* `$ ruby-lambda execute -H=lambda_function.handler`
+
+The handler function is the function AWS Lambda will invoke / run in response to an event. AWS Lambda uses the event argument to pass in event data to the handler. If the `handler` flas is passed with execute, this will take precedence over the handler function defined within the `config.yml`
+
+```ruby
+def handler(event:, context:)
+  { statusCode: 200, body: JSON.generate('Hello from Ruby Lambda') }
+end
+```
+
+The `execute` command gets the values stored in the `event.json` file and passes them to your handler function.
 
 ## Development
 

data/bin/ruby-lambda

@@ -5,7 +5,7 @@ require 'ruby_lambda'
 
 class RubyLambdaCLI < Thor
   map '-v' => :version, '--version' => :version
-  desc '-v (--versions)', 'Outputs the version of Ruby Lambda.'
+  desc '-v (--versions)', 'Outputs the version of Ruby_Lambda.'
   def version
     puts RubyLambda::VERSION
   end
@@ -15,9 +15,19 @@ class RubyLambdaCLI < Thor
     RubyLambda::Init.new(FileUtils.pwd).run
   end
 
-  desc 'execute', 'execute'
+  desc 'execute', 'Invokes the function locally'
+  long_desc <<-LONGDESC
+    This command is used to invoke / run the function locally
+
+    With -c / --config flag to pass a custom config file to use
+
+    With -H, [--handler=HANDLER]
+  LONGDESC
+
+  option :config, default: 'config.yml', type: :string, aliases: :c
+  option :handler, type: :string, aliases: :H
   def execute
-    RubyLambda::Execute.new(FileUtils.pwd).run
+    RubyLambda::Execute.new(FileUtils.pwd, options).run
   end
 end
 

data/lib/ruby_lambda.rb

@@ -5,6 +5,7 @@ require 'awesome_print'
 require 'yaml'
 
 require 'ruby_lambda/version'
+require 'ruby_lambda/error'
 require 'ruby_lambda/init'
 require 'ruby_lambda/execute'
 

data/lib/ruby_lambda/error.rb

@@ -0,0 +1,15 @@
+module RubyLambda
+  class Error < StandardError
+    attr_reader :exception_message
+
+    def initialize(message, exception_message: nil)
+      # Call the parent's constructor to set the message
+      super(message)
+
+      # Store the exception_message in an instance variable
+      @exception_message = exception_message
+    end
+  end
+
+  class ExecuteError < Error; end
+end

data/lib/ruby_lambda/execute.rb

@@ -2,30 +2,70 @@ require 'ruby_lambda/lambda_context'
 
 module RubyLambda
   class Execute
-    def initialize(current_directory)
+    def initialize(current_directory, options = {"config"=>"config.yml"})
       @current_directory  = current_directory
       @shell = Thor::Base.shell.new
+      @options = options
     end
 
     def run(mute: false)
-      config_file = "#{@current_directory}/config.yml"
+      @mute = mute
 
-      config_data = YAML.load_file config_file
+      begin
+        if @options.has_key?('handler')
 
-      lambda_function, lambda_handler = config_data['handler'].split('.')
+          lambda_function, lambda_handler = @options['handler'].split('.')
+        elsif @options.has_key?('config')
+          lambda_function, lambda_handler = load_handler_from_file
+        end
 
-      load "#{@current_directory}/#{lambda_function}.rb"
+        check_for_handler(lambda_function, lambda_handler)
 
-      event_json_file = File.read("#{@current_directory}/event.json")
+        load "#{@current_directory}/#{lambda_function}.rb"
 
-      event = JSON.parse(event_json_file)
+        event = JSON.parse(File.read("#{@current_directory}/event.json"))
 
-      context = LambdaContext.new()
+        context = LambdaContext.new()
 
-      if mute
-        send(:"#{lambda_handler}", event: event, context: context)
-      else
-        ap send(:"#{lambda_handler}", event: event, context: context)
+        if mute
+          send(:"#{lambda_handler}", event: event, context: context)
+        else
+          ap send(:"#{lambda_handler}", event: event, context: context), options = { :indent => -2 }
+        end
+      rescue LoadError
+        @shell.say('Handler file or function, can not be found', :red) unless @mute
+
+        exit 1
+      end
+    end
+
+    def load_handler_from_file
+      begin
+        config_data = YAML.load_file "#{@current_directory}/#{@options['config']}"
+
+        raise RubyLambda::ExecuteError.new('Invalid config file') unless config_data.is_a?(Hash)
+
+        config_data['handler'].split('.')
+      rescue Errno::ENOENT
+        no_config_file_message = 'Config file missing, create a config.yml file or use the -c / --config flag to use a different config file. Alternativly you can use the -H flag to pass the name of the handler that should be executed'
+
+        @shell.say(no_config_file_message, :red) unless @mute
+
+        exit 1
+      rescue RubyLambda::ExecuteError
+        @shell.say('Invalid config file', :red) unless @mute
+
+        exit 1
+      end
+    end
+
+    def check_for_handler(lambda_function, lambda_handler)
+      if lambda_handler.nil? || lambda_handler.nil?
+        no_defined_handler_message = 'No config or handler function defined, create a config.yml file or use the -c / --config flag to use a different config file. Alternativly you can use the -H flag to pass the name of the handler that should be executed'
+
+        @shell.say(no_defined_handler_message, :red) unless @mute
+
+        exit 1
       end
     end
   end

data/lib/ruby_lambda/version.rb

@@ -1,3 +1,3 @@
 module RubyLambda
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_lambda
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - cookieshq
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-09 00:00:00.000000000 Z
+date: 2019-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -147,6 +147,7 @@ files:
 - bin/ruby-lambda
 - bin/setup
 - lib/ruby_lambda.rb
+- lib/ruby_lambda/error.rb
 - lib/ruby_lambda/execute.rb
 - lib/ruby_lambda/init.rb
 - lib/ruby_lambda/lambda_context.rb