ruby_lambda 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d14b2ea8a2f48a998ee212328e73e8a74a2f4512cce87e1297abd074d33d71f
-  data.tar.gz: 5a158755424e2b161fc90ff60369c3ac6922d304655ec8e34dc3753ed8dd68c0
+  metadata.gz: 7a60b683ef881c5be530f4cfffdda9281d60ada742df58f0fc84b618fb1eabef
+  data.tar.gz: 9c380e30496609a052fb97bea89976c343a73ba24d2eff3d818a5eab48885d77
 SHA512:
-  metadata.gz: 5c4ccbe29359ea91eaed3b7950cef7d83eff68fe0b7fa49a55e743e164b17eda481ca7b530c660ec5359c481dda7a6d6dd41ae02fa4f666dd1f78e0f428b1679
-  data.tar.gz: 03dce8db39c13a16fa93f7c3ac5f768a2d97c96e719fd870b06218d228b845d7b807f1412eecdd7632f90e6ac9bc7184220339da8718ba5cd6c1e4588878b9fc
+  metadata.gz: 0bb08729f54017cf404823c43162e1a085da45e74bf11193585f4523c6bee59f06d903d245b562af24c2b863efabe8383292df40ad0b76015fe07d7bc8bc5a44
+  data.tar.gz: 273dbcb92c598b90a8730165f8d70ba4c9d3ffa33f3c4c0c8d7a1524e3930578276395be0aac42a3abe24e250f0097096ee71f47a71cdb3c911b17c2e1934666

data/.travis.yml

@@ -3,5 +3,5 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.5.0
+  - 2.5.3
 before_install: gem install bundler -v 1.16.6

data/Gemfile.lock

@@ -1,8 +1,11 @@
 PATH
   remote: .
   specs:
-    ruby_lambda (0.4.0)
+    ruby_lambda (0.5.0)
       awesome_print (~> 1.8.0)
+      aws-sdk-iam (~> 1)
+      aws-sdk-lambda (~> 1)
+      dotenv (~> 2.7)
       rubyzip (~> 1.2)
       thor (~> 0.19)
 
@@ -10,9 +13,25 @@ GEM
   remote: https://rubygems.org/
   specs:
     awesome_print (1.8.0)
+    aws-eventstream (1.0.3)
+    aws-partitions (1.163.0)
+    aws-sdk-core (3.52.1)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+      aws-partitions (~> 1.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1.0)
+    aws-sdk-iam (1.22.0)
+      aws-sdk-core (~> 3, >= 3.52.1)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-lambda (1.25.0)
+      aws-sdk-core (~> 3, >= 3.52.1)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.1.0)
+      aws-eventstream (~> 1.0, >= 1.0.2)
     coderay (1.1.2)
     diff-lcs (1.3)
     docile (1.3.1)
+    dotenv (2.7.2)
     ffi (1.9.25)
     formatador (0.2.5)
     guard (2.15.0)
@@ -29,6 +48,7 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
+    jmespath (1.4.0)
     json (2.1.0)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)

data/README.md

@@ -1,4 +1,4 @@
-# RubyLambda
+# RubyLambda [![Build Status](https://travis-ci.org/cookieshq/ruby_lambda.svg?branch=develop)](https://travis-ci.org/cookieshq/ruby_lambda)
 
 RubyLambda is a toolset for developing and deploying serverless Ruby apps in AWS Lambda.
 
@@ -20,19 +20,19 @@ $ ruby-lambda deploy
 
 ### Commands
 
-#### ruby-lambda init
+### ruby-lambda init
 ```
 $ ruby-lambda init
 ```
 
 Initializes the `.gitignore`, `config.yml`, `env`, `event.json`, `lambda_function.rb`, `Gemfile`, `.ruby-version` files.
-* `event.json` is where you keep mock data that will be passed to your function when the `execute` command has ran.
+* `event.json` is where you keep mock data that will be passed to your function when the `execute` command runs.
 * `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 to AWS.
 
-#### ruby-lambda execute
+### ruby-lambda execute
 ```
 $ ruby-lambda execute
 ```
@@ -40,8 +40,8 @@ This command is used to invoke / run the function locally
 
 ```
 Options:
-  -c, [--config=CONFIG] # Default: config.yml
-  -H, [--handler=HANDLER]
+  -c, --config=CONFIG # Default: config.yml
+  -H, --handler=HANDLER
 ```
 
 **Examples**
@@ -58,7 +58,7 @@ 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
 ```
 $ ruby-lambda build
 ```
@@ -66,17 +66,52 @@ This command will create a zipped file ready to be published on Lambda
 
 ```
 Options:
-  -n, [--native-extensions], [--no-native-extensions]
-  -q, [--quiet], [--no-quiet]
+  -n, --native-extensions
+  -q, --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.
 
+**Native Extensions**
+
+This [article](http://patshaughnessy.net/2011/10/31/dont-be-terrified-of-building-native-extensions) covers what native extensions are and a lot more information about how they work. Basically, building native extensions are nothing but compiling C code into the platform and environment specific machine language code. So, if you run bundle install — deployment on your local machine running MacOS, the C code is compiled for MacOS and stored in vendor/bundle. As AWS lambda is a Ubuntu machine, not MacOs it won’t work.
+
+To build gems with Native extensions use `-n` flag when you run this command. Doing so will run a dockerized bundle with deployment flag within a Lambda image – this will download the gems to the local directory instead of to the local systems Ruby directory, using the same OS environment as Lambda so that it installs the correct native extensions. This ensures that all our dependencies are included in the function deployment package and the correct native extensions will be called.
+
+
+### ruby-lambda deploy
+```
+$ ruby-lambda deploy
+
+```
+The deploy command will either bundle install your project and package it in a zip or accept a zip file passed to it then uploads it to AWS Lambda.
+
+```
+Options:
+    -n, --native-extensions flag to pass build gems with native extensions
+    -c, --config=CONFIG path to the config file, defalt is config.yml
+    -p, --publish if the function should be published, default is true
+    -u, --update default to true, update the function
+    -z, --zip-file=ZIP_FILE path to zip file to create or update your function
+    -q, --quiet
+```
+
+By default the `deploy` command will attepmt to create the function with your config, if the function already exists an error will be thrown. To update an existing function simply pass the `-u` flag.
+
+
+When you publish a version, AWS Lambda makes a snapshot copy of the Lambda function code (and configuration) in the $LATEST version. A published version is immutable. That is, you can't change the code or configuration information. The new version has a unique ARN that includes a version number suffix. AWS recommends that you publish a version at the same time that you create your Lambda function or update your Lambda function code. So by default all deploy will be versioned, if you do not want this, use `-p=false` flag.
+
+When you run the deploy command we will prepare the latest state of your function and zip it up, basically running the build command. If you have already built your zip, use the `-z` flag to set the path to it.
 
 ## Roadmap
-Below is the roadmap to version 1
 
-- [ ] Add a way to deploy directly to AWS lambda
+- [ ] Add an option to add APIGate way to allow functions to have an end point
+- [ ] Add the ability to deploy different ruby versions using layers
+- [ ] Add an options to choose zip uploaded to s3
+- [ ] Add option to allow deploy to use value passed through the flags
+- [ ] Add more deploy options
+- [ ] Add environment variables to be passed in deploying
+- [x] Add a way to deploy and update Lambda functions
 - [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
@@ -87,7 +122,7 @@ Below is the roadmap to version 1
 
 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.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
@@ -100,4 +135,3 @@ 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 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

@@ -47,6 +47,27 @@ class RubyLambdaCLI < Thor
   def build
     RubyLambda::Build.new(FileUtils.pwd, options).run(mute: options[:quiet])
   end
+
+  desc 'publish', 'Builds your function into a local ready to deploy zip file'
+  long_desc <<-LONGDESC
+     The deploy command will either bundle install your project and package it in a zip or accept a zip file passed to it then uploads it to AWS Lambda.
+
+    With -n, --native-extensions flag to pass build gems with native extensions
+    -c, --config=CONFIG path to the config file, defalt is config.yml
+    -p, --publish if the function should be published, default is true
+    -u, --update default to true, update the function
+    -z, --zip-file=ZIP_FILE path to zip file to create or update your function
+    -q, --quiet
+  LONGDESC
+
+  option :native_extensions, type: :boolean, default: false, aliases: :n
+  option :publish, type: :boolean, default: true, aliases: :p
+  option :update, type: :boolean, default: false, aliases: :u
+  option :config, default: 'config.yml', type: :string, aliases: :c
+  option :zip_file, type: :string, aliases: :z
+  def deploy
+    RubyLambda::Deploy.new(FileUtils.pwd, options).run(mute: options[:quiet])
+  end
 end
 
 RubyLambdaCLI.start(ARGV)

data/lib/ruby_lambda/build.rb

@@ -1,6 +1,6 @@
 module RubyLambda
   class Build
-    def initialize(current_directory, options = {"native_extensions"=>false})
+    def initialize(current_directory, options = {"native_extensions"=>false, 'file_name' => ''})
       @current_directory  = current_directory
       @shell = Thor::Base.shell.new
       @options = options
@@ -9,7 +9,7 @@ module RubyLambda
     def run(mute: false)
       @mute = mute
 
-      if @options[:native_extensions]
+      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
@@ -56,6 +56,8 @@ module RubyLambda
 
       new_file_name = ''
 
+      return @options['file_name'] if @options['file_name'] && @options['file_name'] != ''
+
       begin
         new_build_number = new_build_number  + 1
 

data/lib/ruby_lambda/deploy.rb

@@ -0,0 +1,154 @@
+module RubyLambda
+  class Deploy
+    def initialize(current_directory, options = {'native_extensions' => false, 'config' => 'config.yml'})
+      @current_directory  = current_directory
+      @shell = Thor::Base.shell.new
+      @options = options
+    end
+
+    def run(mute: false)
+      @mute = mute
+
+      @config_data  = load_data_from_config_file
+
+      Aws.config.update({
+        credentials: Aws::Credentials.new(@config_data['aws_access_key'], @config_data['aws_secret_access_key'])
+      })
+
+      @iam_client = Aws::IAM::Client.new(region: @config_data['region'])
+
+      @iam = Aws::IAM::Resource.new(client: @iam_client)
+
+      @client = Aws::Lambda::Client.new(region: @config_data['region'])
+
+      deploy_options = {}
+
+      deploy_options[:role] = get_role_arn
+      deploy_options[:function_name] = @config_data['function_name']
+      deploy_options[:handler] = @config_data['handler']
+      deploy_options[:runtime] = @config_data['runtime']
+      deploy_options[:publish] = @options['publish']
+
+      if @options['zip_file']
+        zip_file = @options['zip_file']
+      else
+        zip_file = get_temp_build_zip
+      end
+
+      deploy_options[:code] = { zip_file: File.open(zip_file, 'rb').read }
+
+      function = deploy_function(deploy_options)
+
+      clean_up
+
+      ap function
+      @shell.say('Function deployed', :green) unless @mute
+    end
+
+    def load_data_from_config_file
+      begin
+        config_data = YAML.load(ERB.new(File.read("#{@current_directory}/#{@options['config']}")).result)
+
+        raise RubyLambda::ExecuteError.new('Invalid config file') unless config_data.is_a?(Hash)
+
+        config_data
+      rescue Errno::ENOENT
+        no_config_file_message = 'Config file missing, create a config.yml file or use the -c / --config flag to pass a different config file.'
+
+        @shell.say(no_config_file_message, :red)
+
+        exit 1
+      rescue RubyLambda::ExecuteError
+        @shell.say('Invalid config file', :red)
+
+        exit 1
+      end
+    end
+
+    def get_temp_build_zip
+      @zip_file_name = "#{Time.now.strftime('%Y-%m-%d_%H-%M-%S')}_deploy_build.zip"
+
+      RubyLambda::Build.new(@current_directory, {'file_name' => @zip_file_name, 'native_extensions' => @options['native_extensions']}).run(mute: @mute)
+
+      @zip_file_name
+    end
+
+    def clean_up
+      return if @options['zip_file'] != ''
+
+      FileUtils.rm "#{@current_directory}/#{@zip_file_name}"
+    end
+
+    def deploy_function(deploy_options)
+      begin
+        if @options['update']
+          update_function(deploy_options)
+        else
+          @client.create_function(deploy_options)
+        end
+      rescue Aws::Lambda::Errors::ResourceConflictException
+        if @options['update']
+          update_function(deploy_options)
+        else
+          @shell.say('Function already exists use the --update flag to update the current function', :red)
+          clean_up
+          exit 1
+        end
+      end
+    end
+
+    def update_function(deploy_options)
+      begin
+        update_options = {}
+        update_options[:function_name] = deploy_options[:function_name]
+        update_options[:publish] = deploy_options[:publish]
+        update_options[:zip_file] = deploy_options[:code][:zip_file]
+
+        @client.update_function_code(update_options)
+      rescue Aws::Lambda::Errors::ResourceNotFoundException
+        @shell.say('Function was not found, remove the --update flag to create it', :red)
+        clean_up
+        exit 1
+      end
+    end
+
+    def get_role_arn
+      begin
+        new_role = @iam_client.get_role({
+          role_name: 'ruby_lambda_gem_basic_execution_role',
+        })
+
+        new_role.role.arn
+      rescue Aws::IAM::Errors::NoSuchEntity
+        create_role.data.arn
+      end
+    end
+
+    def create_role
+      policy_doc = {
+        Version:'2012-10-17',
+        Statement:[
+          {
+            Effect:'Allow',
+            Action:'sts:AssumeRole',
+            Principal:{
+              Service:'lambda.amazonaws.com'
+            }
+          }]
+      }
+
+      role = @iam.create_role({
+        role_name: 'ruby_lambda_gem_basic_execution_role',
+        description: 'Role created to deploy lambda functions from ruby lambda gem',
+        assume_role_policy_document: policy_doc.to_json
+      })
+
+      role.attach_policy({
+        policy_arn: 'arn:aws:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole'
+      })
+
+      sleep 5 # This will give the policy enough time to be attached to the role https://stackoverflow.com/a/37438525/7157278
+      role
+    end
+  end
+end

data/lib/ruby_lambda/version.rb

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

data/lib/ruby_lambda.rb

@@ -1,15 +1,21 @@
 require 'json'
 require 'thor'
 require 'fileutils'
-require 'awesome_print'
 require 'yaml'
+require 'erb'
+require 'tempfile'
 require 'zip'
+require 'awesome_print'
+require 'dotenv/load'
+require 'aws-sdk-lambda'
+require 'aws-sdk-iam'
 
 require 'ruby_lambda/version'
 require 'ruby_lambda/error'
 require 'ruby_lambda/init'
 require 'ruby_lambda/execute'
 require 'ruby_lambda/build'
+require 'ruby_lambda/deploy'
 
 module RubyLambda
 end

data/ruby_lambda.gemspec

@@ -31,6 +31,9 @@ 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_runtime_dependency 'dotenv', '~> 2.7'
+  spec.add_runtime_dependency 'aws-sdk-lambda', '~> 1'
+  spec.add_runtime_dependency 'aws-sdk-iam', '~> 1'
 
   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.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - cookieshq
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-14 00:00:00.000000000 Z
+date: 2019-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -53,6 +53,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-lambda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-iam
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -162,6 +204,7 @@ files:
 - bin/setup
 - lib/ruby_lambda.rb
 - lib/ruby_lambda/build.rb
+- lib/ruby_lambda/deploy.rb
 - lib/ruby_lambda/error.rb
 - lib/ruby_lambda/execute.rb
 - lib/ruby_lambda/init.rb