ruby_lambda 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa6c0abf94783204e4b49dc597fca614b23a6286764235f0841434ae30ae02dc
-  data.tar.gz: 95d98d3d9c3f176f78a2671a4b8f454af042c976879d35e5343ff59981b58738
+  metadata.gz: 3d14b2ea8a2f48a998ee212328e73e8a74a2f4512cce87e1297abd074d33d71f
+  data.tar.gz: 5a158755424e2b161fc90ff60369c3ac6922d304655ec8e34dc3753ed8dd68c0
 SHA512:
-  metadata.gz: 59a9afabde3113b52213058f3108c6a336ce892b47f4aef335b534d452c73c714ebe69062f3b6c90d61522022e5582787c240419140ccaa9854a783da3872a06
-  data.tar.gz: 2ae2922aad65e325ca29c3de58cd2098fe40e6a0584d2493585b6f90f7b7b9ede838211efdd8fc661dca0553977d8bff69c4cdde2cf976e5378f7a16ffaa1b0e
+  metadata.gz: 5c4ccbe29359ea91eaed3b7950cef7d83eff68fe0b7fa49a55e743e164b17eda481ca7b530c660ec5359c481dda7a6d6dd41ae02fa4f666dd1f78e0f428b1679
+  data.tar.gz: 03dce8db39c13a16fa93f7c3ac5f768a2d97c96e719fd870b06218d228b845d7b807f1412eecdd7632f90e6ac9bc7184220339da8718ba5cd6c1e4588878b9fc

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    ruby_lambda (0.3.2)
+    ruby_lambda (0.4.0)
       awesome_print (~> 1.8.0)
+      rubyzip (~> 1.2)
       thor (~> 0.19)
 
 GEM
@@ -60,6 +61,7 @@ GEM
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
     ruby_dep (1.5.0)
+    rubyzip (1.2.2)
     shellany (0.0.1)
     simplecov (0.16.1)
       docile (~> 1.1)

data/README.md

@@ -12,15 +12,15 @@ RubyLambda is a toolset for developing and deploying serverless Ruby apps in AWS
 The main available commands.
 
 ```
-$ ruby-lambda init
-$ ruby-lambda execute
-$ ruby-lambda build
+$ ruby-lambda init    # Within the current directory scaffold files needed for a baisc lambda function
+$ ruby-lambda execute # Invokes the function locally offline
+$ ruby-lambda build   # Build your function into a local ready to deploy zip file
 $ ruby-lambda deploy
 ```
 
 ### Commands
 
-#### ruby-lambda  init
+#### ruby-lambda init
 ```
 $ ruby-lambda init
 ```
@@ -30,9 +30,9 @@ Initializes the `.gitignore`, `config.yml`, `env`, `event.json`, `lambda_functio
 * `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.
 
-Please have a read of the `config.yml` and update any of the default configuration to better suit your function.
+Please have a read of the `config.yml` and update any of the default configuration to better suit your function to AWS.
 
-#### ruby-lambda  execute
+#### ruby-lambda execute
 ```
 $ ruby-lambda execute
 ```
@@ -48,7 +48,7 @@ Options:
 * `$ 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`
+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` flag is passed with execute, this will take precedence over the handler function defined within the `config.yml`
 
 ```ruby
 def handler(event:, context:)
@@ -58,6 +58,31 @@ end
 
 The `execute` command gets the values stored in the `event.json` file and passes them to your handler function.
 
+#### ruby-lambda build
+```
+$ ruby-lambda build
+```
+This command will create a zipped file ready to be published on Lambda
+
+```
+Options:
+  -n, [--native-extensions], [--no-native-extensions]
+  -q, [--quiet], [--no-quiet]
+```
+
+All output zipped will in the builds folder within the project root - the build folder will be created if one does not already exists.
+
+
+## Roadmap
+Below is the roadmap to version 1
+
+- [ ] Add a way to deploy directly to AWS lambda
+- [x] Add ablility to execute the function offline
+- [x] Add json file or options to be passed to execute function
+- [x] Add a way to build files in to zips ready to be deployed to lambda
+- [x] Add the building and zipping of native extentions ready for the lambda environment using docker
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -74,4 +99,5 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the RubyLambda project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/cookieshq/ruby_lambda/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the RubyLambda project’s codebases and issue trackers is expected to follow the [code of conduct](https://github.com/cookieshq/ruby_lambda/blob/master/CODE_OF_CONDUCT.md).
+

data/bin/ruby-lambda

@@ -3,18 +3,23 @@
 require "#{::File.dirname(__FILE__)}/../lib/ruby_lambda"
 
 class RubyLambdaCLI < Thor
+  class_option :quiet, type: :boolean, default: false, aliases: :q
+
   map '-v' => :version, '--version' => :version
   desc '-v (--versions)', 'Outputs the version of Ruby_Lambda.'
   def version
     puts RubyLambda::VERSION
   end
 
-  desc 'init', 'Uses the current directory as a lambda ruby project (creates `main.rb`, `.ruby-version`, and `Gemfile`).'
+  desc 'init', 'Within the current directory scaffold files needed for a baisc lambda function'
+  long_desc <<-LONGDESC
+    Uses the current directory as a lambda ruby project (creates `main.rb`, `.ruby-version`, and `Gemfile`).
+  LONGDESC
   def init
-    RubyLambda::Init.new(FileUtils.pwd).run
+    RubyLambda::Init.new(FileUtils.pwd).run(mute: options[:quiet])
   end
 
-  desc 'execute', 'Invokes the function locally'
+  desc 'execute', 'Invokes the function locally offline'
   long_desc <<-LONGDESC
     This command is used to invoke / run the function locally
 
@@ -28,6 +33,20 @@ class RubyLambdaCLI < Thor
   def execute
     RubyLambda::Execute.new(FileUtils.pwd, options).run
   end
+
+  desc 'build', 'Builds your function into a local ready to deploy zip file'
+  long_desc <<-LONGDESC
+    This command will create a zipped file ready to be published on Lambda
+
+    All output zips will be in the folder builds
+
+    With -n / --native-extensions flag to pass build gems with native extensions
+  LONGDESC
+
+  option :native_extensions, type: :boolean, default: false, aliases: :n
+  def build
+    RubyLambda::Build.new(FileUtils.pwd, options).run(mute: options[:quiet])
+  end
 end
 
 RubyLambdaCLI.start(ARGV)

data/lib/ruby_lambda.rb

@@ -3,11 +3,13 @@ require 'thor'
 require 'fileutils'
 require 'awesome_print'
 require 'yaml'
+require 'zip'
 
 require 'ruby_lambda/version'
 require 'ruby_lambda/error'
 require 'ruby_lambda/init'
 require 'ruby_lambda/execute'
+require 'ruby_lambda/build'
 
 module RubyLambda
 end

data/lib/ruby_lambda/build.rb

@@ -0,0 +1,120 @@
+module RubyLambda
+  class Build
+    def initialize(current_directory, options = {"native_extensions"=>false})
+      @current_directory  = current_directory
+      @shell = Thor::Base.shell.new
+      @options = options
+    end
+
+    def run(mute: false)
+      @mute = mute
+
+      if @options[:native_extensions]
+        unless which('docker')
+          @shell.say 'Can not find docker, you need to install docker if you want to build with native extensions', :red
+          return
+        end
+
+        setup_gems_with_native_extensions
+      else
+        setup_gems
+      end
+
+      @shell.say('Setting up files to build', :yellow) unless @mute
+      FileUtils.mkdir_p "#{@current_directory}/builds"
+
+      @output_file = "#{@current_directory}/#{generate_build_name}"
+
+      @shell.say('Adding files to zip', :yellow) unless @mute
+      write
+    end
+
+    private
+
+    def setup_gems
+      Dir.chdir(@current_directory) do
+        Bundler.with_clean_env do
+          @shell.say('Installing gems for deployment', :yellow) unless @mute
+          `bundle install`
+          `bundle install --deployment`
+        end
+      end
+    end
+
+    def setup_gems_with_native_extensions
+
+      Dir.chdir(@current_directory) do
+        Bundler.with_clean_env do
+          @shell.say('Installing gems for deployment', :yellow) unless @mute
+          `docker run -v #{@current_directory}:#{@current_directory} -w #{@current_directory} -i -t lambci/lambda:build-ruby2.5 bundle install --deployment`
+        end
+      end
+    end
+
+    def generate_build_name
+      new_build_number = Dir["#@current_directory/builds"].length - 1
+
+      new_file_name = ''
+
+      begin
+        new_build_number = new_build_number  + 1
+
+        new_file_name = "builds/build_#{new_build_number}.zip"
+      end while File.exist?("#@current_directory/#{new_file_name}")
+
+      new_file_name
+    end
+
+    def write
+      git_ignore_path = "#@current_directory/.gitignore"
+
+      files_to_ignore = %w(. .. .bundle builds tmp .gitignore .ruby-version)
+
+      if File.exist?(git_ignore_path)
+        files_to_ignore << File.readlines(git_ignore_path).map { |a| a.strip }
+      end
+
+      entries = Dir.entries(@current_directory) - files_to_ignore.flatten
+
+      ::Zip::File.open(@output_file, ::Zip::File::CREATE) do |zipfile|
+        write_entries entries, '', zipfile
+      end
+    end
+
+    def write_entries(entries, path, zipfile)
+      entries.each do |e|
+        zipfile_path = path == '' ? e : File.join(path, e)
+        disk_file_path = File.join(@current_directory, zipfile_path)
+
+        if File.directory? disk_file_path
+          recursively_deflate_directory(disk_file_path, zipfile, zipfile_path)
+        else
+          put_into_archive(disk_file_path, zipfile, zipfile_path)
+        end
+      end
+    end
+
+    def recursively_deflate_directory(disk_file_path, zipfile, zipfile_path)
+      zipfile.mkdir zipfile_path
+      subdir = Dir.entries(disk_file_path) - %w(. ..)
+      write_entries subdir, zipfile_path, zipfile
+    end
+
+    def put_into_archive(disk_file_path, zipfile, zipfile_path)
+      zipfile.get_output_stream(zipfile_path) do |f|
+        f.write(File.open(disk_file_path, 'rb').read)
+      end
+    end
+
+    def which(cmd)
+      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        exts.each { |ext|
+          exe = File.join(path, "#{cmd}#{ext}")
+          return exe if File.executable?(exe) && !File.directory?(exe)
+        }
+      end
+      return nil
+    end
+  end
+end

data/lib/ruby_lambda/execute.rb

@@ -8,9 +8,7 @@ module RubyLambda
       @options = options
     end
 
-    def run(mute: false)
-      @mute = mute
-
+    def run
       begin
         if @options.has_key?('handler')
 
@@ -27,13 +25,9 @@ module RubyLambda
 
         context = LambdaContext.new()
 
-        if mute
-          send(:"#{lambda_handler}", event: event, context: context)
-        else
-          ap send(:"#{lambda_handler}", event: event, context: context), options = { :indent => -2 }
-        end
+        ap send(:"#{lambda_handler}", event: event, context: context), options = { :indent => -2 }
       rescue LoadError
-        @shell.say('Handler file or function, can not be found', :red) unless @mute
+        @shell.say('Handler file or function, can not be found', :red)
 
         exit 1
       end
@@ -49,11 +43,11 @@ module RubyLambda
       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
+        @shell.say(no_config_file_message, :red)
 
         exit 1
       rescue RubyLambda::ExecuteError
-        @shell.say('Invalid config file', :red) unless @mute
+        @shell.say('Invalid config file', :red)
 
         exit 1
       end
@@ -63,7 +57,7 @@ module RubyLambda
       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
+        @shell.say(no_defined_handler_message, :red)
 
         exit 1
       end

data/lib/ruby_lambda/init.rb

@@ -9,7 +9,6 @@ module RubyLambda
     end
 
     def run(mute: false)
-
       @mute = mute
 
       unless File.writable?(@current_directory)

data/lib/ruby_lambda/templates/.gitignore

@@ -1,4 +1,4 @@
 /tmp/
 .env
-build/
+builds/
 /.bundle/

data/lib/ruby_lambda/version.rb

@@ -1,3 +1,3 @@
 module RubyLambda
-  VERSION = '0.3.2'
+  VERSION = '0.4.0'
 end

data/ruby_lambda.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'thor', '~> 0.19'
   spec.add_runtime_dependency 'awesome_print', '~> 1.8.0'
+  spec.add_runtime_dependency 'rubyzip', '~> 1.2'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_lambda
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - cookieshq
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-26 00:00:00.000000000 Z
+date: 2019-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -39,6 +39,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -147,6 +161,7 @@ files:
 - bin/ruby-lambda
 - bin/setup
 - lib/ruby_lambda.rb
+- lib/ruby_lambda/build.rb
 - lib/ruby_lambda/error.rb
 - lib/ruby_lambda/execute.rb
 - lib/ruby_lambda/init.rb