Added basic feature to auto deploy gems from Gemfile to aws layer and made it available to GEM_PATH of all functions

Author: navarasu

.gitignore

@@ -2,8 +2,7 @@
 logs
 *.log
 npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
+
 
 # Runtime data
 pids
@@ -17,45 +16,12 @@ lib-cov
 # Coverage directory used by tools like istanbul
 coverage
 
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
 # Dependency directories
 node_modules/
-jspm_packages/
-
-# TypeScript v1 declaration files
-typings/
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
 
-# Yarn Integrity file
-.yarn-integrity
+.vscode
 
-# dotenv environment variables file
-.env
+package-lock.json
 
-# next.js build output
-.next
+#OS
+.DS_Store

README.md

@@ -1,2 +1,41 @@
-# serverless-ruby-gemfile
-Serverless plugin to bundle Ruby gems
+<h1><img height="75" src="https://user-images.githubusercontent.com/20145075/86084483-aa2d4b80-baba-11ea-938d-53d6b7e37896.png" alt="iOS resume application project app icon"></h1>
+
+[![serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com)  [![npm](https://img.shields.io/npm/v/serverless-ruby-layer.svg)](https://www.npmjs.com/package/serverless-ruby-layer)
+
+A Serverless Plugin to bundle ruby gems from Gemfile and deploy it to lambda layer automatically while running `severless deploy`.
+
+It auto configures the lamda layer and RUBY_PATH to the all the functions.
+
+## Install
+
+```shell
+npm install serverless-ruby-bundler
+```
+
+## Simple Usage
+
+*Include plugin in the `serverless.yml`*
+
+```YML
+service: basic
+
+plugins:
+  - serverless-ruby-layer
+
+provider:
+  name: aws
+  runtime: ruby2.5
+
+functions:
+  hello:
+    handler: handler.hello
+  ```
+
+*Gemfile*
+
+```ruby
+  source 'https://rubygems.org'
+  gem 'httparty'
+```
+
+Running `servleress deploy` automatically deploys the required gems as in Gemfile to AWS lambda layer and make the gems available to the `RUBY_PATH` of the functions `hello.handler`

examples/basic/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gem 'httparty'

examples/basic/handler.rb

@@ -0,0 +1,7 @@
+require 'httparty'
+
+def hello(event:, context:)
+  body = HTTParty.get("https://github.com").body
+
+  { statusCode: 200, body: body }
+end

examples/basic/serverless.yml

@@ -0,0 +1,12 @@
+service: basic 
+
+plugins:
+  - serverless-ruby-layer
+
+provider:
+  name: aws
+  runtime: ruby2.5
+
+functions:
+  hello:
+    handler: handler.hello

index.js

@@ -0,0 +1,40 @@
+'use strict';
+const Promise = require('bluebird');
+const { bundleGems } = require('./lib/bundle');
+
+class ServerlessRubyBundler {
+  get options() {
+    const options = Object.assign(
+      {},
+      (this.serverless.service.custom &&
+        this.serverless.service.custom.rubyLayer) ||
+        {}
+    );
+    return options;
+  }
+  constructor(serverless) {
+    this.serverless = serverless;
+    this.servicePath = this.serverless.config.servicePath;
+    this.warningLogged = false;
+
+    this.commands = {
+      rubylayer: {
+        lifecycleEvents: ['pack',],
+        },
+    };
+
+    const packRubyLayer  = () =>  {
+      return Promise.bind(this)
+                     .then(bundleGems);
+    } 
+
+    this.hooks = {
+      'after:package:createDeploymentArtifacts': packRubyLayer,
+      'rubylayer:pack': packRubyLayer,
+    };
+
+  }
+
+}
+
+module.exports = ServerlessRubyBundler;

lib/bundle.js

@@ -0,0 +1,118 @@
+const { spawnSync } = require('child_process');
+const path = require('path');
+const fs = require('fs-extra');
+const Promise = require('bluebird');
+var JSZip = require('jszip');
+
+function runCommand(cmd,args,options) {
+  const ps = spawnSync(cmd, args,options);
+  if (ps.error) {
+    console.log(ps.error.code)
+    throw new Error(ps.error);
+  } else if (ps.status !== 0) {
+    throw new Error(ps.stderr);
+  }
+  return ps;
+}
+
+function cleanBuild(){
+  this.build_path = path.join(this.servicePath,'.serverless','build','ruby_layer')
+  if (fs.pathExistsSync(this.build_path)){
+    fs.rmdirSync(this.build_path,  { recursive: true }) 
+  }
+}
+
+function bundleInstall(){
+  this.serverless.cli.log(this.build_path)
+  const gem_path = path.join(this.build_path,'Gemfile')
+  fs.copySync(path.join(this.servicePath,'Gemfile'), gem_path )
+  const bundle_args = ['bundle', 'install', '--path=.','--without', 'test', 'development']
+  const options={cwd : this.build_path, encoding : 'utf8'}
+  ps = runCommand("bundle",['-v'])
+  if (ps.error && ps.error.code === 'ENOENT') {
+     throw new Error('bundle command not found in local');
+  }
+  this.serverless.cli.log(bundle_args.slice(1,bundle_args.length))
+  ps=runCommand(bundle_args[0],bundle_args.slice(1,bundle_args.length),options)
+  this.serverless.cli.log(ps.stdout)
+}
+
+function zipDir(folder_path,targetPath,zipOptions){  
+  zip = new JSZip()
+  return addDirtoZip(zip, folder_path)
+          .then(() => {
+            return new Promise(resolve =>
+                        zip.generateNodeStream(zipOptions)
+                           .pipe(fs.createWriteStream(targetPath))
+                           .on('finish', resolve))
+                           .then(() => null)});
+}
+
+function addDirtoZip(zip, dir_path){
+  const dir_path_norm = path.normalize(dir_path)
+  return fs.readdirAsync(dir_path_norm)
+           .map(file_name => {
+              return addFiletoZip(zip, dir_path_norm, file_name)
+            });
+}
+
+function addFiletoZip(zip, dir_path, file_name){
+  const filePath = path.join(dir_path, file_name)
+  return fs.statAsync(filePath)
+          .then(stat => {
+            if (stat.isDirectory()){
+                return addDirtoZip(zip.folder(file_name), filePath);
+            } else {
+                const file_option = { date: stat.mtime, unixPermissions: stat.mode };
+                return fs.readFileAsync(filePath)
+                  .then(data => zip.file(file_name, data, file_option));
+              }
+          });
+}
+
+function zipBundleFolder() {
+  this.gem_folder= fs.readdirSync(path.join(this.build_path,'ruby'))[0]
+  fs.rmdirSync(path.join(this.build_path,'ruby',this.gem_folder,'cache'),{ recursive: true })
+  const platform = process.platform == 'win32' ? 'DOS' : 'UNIX'
+  return zipDir(path.join(this.build_path,'ruby'),
+                path.join(this.build_path, 'gemLayer.zip'), 
+                { platform: platform, compression: 'DEFLATE',
+                compressionOptions: { level: 9 }});
+}
+
+function configureLayer() {
+  if (!this.serverless.service.layers) {
+    this.serverless.service.layers = {};
+  }
+
+  this.serverless.service.layers['gemLayer'] = Object.assign(
+    {
+      artifact: path.join(this.build_path, 'gemLayer.zip'),
+      name: `${
+        this.serverless.service.service
+      }-${this.serverless.providers.aws.getStage()}-ruby-bundle`,
+      description:
+        'Ruby gem generated by serverless-ruby-bundler',
+      compatibleRuntimes: [this.serverless.service.provider.runtime]
+    },
+    this.options.layer
+  );
+
+  Object.keys(this.serverless.service.functions).forEach(funcName => {
+    const function_ = this.serverless.service.getFunction(funcName)
+    function_.environment={}
+    function_.environment["GEM_PATH"]="/opt/"+this.gem_folder
+    function_.layers = [{"Ref":"GemLayerLambdaLayer"}]
+  })
+  return Promise.resolve();
+}
+
+function bundleGems()  {
+  return Promise.bind(this)
+          .then(cleanBuild)
+          .then(bundleInstall)
+          .then(zipBundleFolder)
+          .then(configureLayer)
+} 
+
+module.exports = { bundleGems};

package.json

@@ -0,0 +1,29 @@
+{
+  "name": "serverless-ruby-layer",
+  "version": "1.0.0",
+  "description": "Serverless Plugin to bundle gemfile as lamda layer",
+  "main": "index.js",
+  "scripts": {
+    "test": "node test.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/navarasu/serverless-ruby-layer.git"
+  },
+  "keywords": [
+    "serverless",
+    "layer",
+    "ruby"
+  ],
+  "author": "Navarasu <nova@navarasu.coms>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/navarasu/serverless-ruby-layer/issues"
+  },
+  "homepage": "https://github.com/navarasu/serverless-ruby-layer#readme",
+  "dependencies": {
+    "bluebird": "^3.5.5",
+    "fs-extra": "^8.1.0",
+    "jszip": "^3.1.0"
+  }
+}