lambda_wrap 0.26.0 → 0.26.6

data/lib/lambda_wrap/lambda_manager.rb

@@ -1,196 +1,208 @@
-require 'aws-sdk'
-
-module LambdaWrap
-  ##
-  # The LambdaManager simplifies creating a package, publishing to S3, deploying a new version, & setting permissions.
-  #
-  # Note: The concept of an environment of the LambdaWrap gem matches an alias of AWS Lambda.
-  class LambdaManager
-    ##
-    # The constructor does some basic setup
-    # * Validating basic AWS configuration
-    # * Creating the underlying client to interace with the AWS SDK
-    def initialize
-      # AWS lambda client
-      @client = Aws::Lambda::Client.new
-    end
-
-    ##
-    # Packages a set of files and node modules into a deployable package.
-    #
-    # *Arguments*
-    # [directory]    A temporary directory to copy all related files before they are packages into a single zip file.
-    # [zipfile]      A path where the deployable package, a zip file, should be stored.
-    # [input_filenames]  A list of file names that contain the source code.
-    # [node_modules]  A list of node modules that need to be included in the package.
-    def package(directory, zipfile, input_filenames, node_modules)
-      FileUtils.mkdir_p directory
-      FileUtils.mkdir_p File.join(directory, 'node_modules') unless node_modules.size == 0
-
-      input_filenames.each do |filename|
-        FileUtils.copy_file(File.join(filename), File.join(directory, File.basename(filename)))
-      end
-
-      node_modules.each do |dir|
-        FileUtils.cp_r(File.join('node_modules', dir), File.join(directory, 'node_modules'))
-      end
-
-      ZipFileGenerator.new(directory, zipfile).write
-    end
-
-    ##
-    # Publishes a package to S3 so it can be deployed as a lambda function.
-    #
-    # *Arguments*
-    # [local_lambda_file]  The location of the package that needs to be deployed.
-    # [bucket]        The s3 bucket where the file needs to be uploaded to.
-    # [key]          The S3 path (key) where the package should be stored.
-    def publish_lambda_to_s3(local_lambda_file, bucket, key)
-      # get s3 object
-      s3 = Aws::S3::Resource.new
-      obj = s3.bucket(bucket).object(key)
-
-      # upload
-      version_id = nil
-      File.open(local_lambda_file, 'rb') do |file|
-        version_id = obj.put(body: file).version_id
-      end
-      raise 'Upload to S3 failed' unless version_id
-
-      puts 'Uploaded object to S3 with version ' + version_id
-      version_id
-    end
-
-    ##
-    # Deploys a package that has been uploaded to S3.
-    #
-    # *Arguments*
-    # [bucket]      The S3 bucket where the package can be retrieved from.
-    # [key]        The S3 path (key) where the package can be retrieved from.
-    # [version_id]    The version of the file on S3 to retrieve.
-    # [function_name]  The name of the lambda function.
-    # [handler]      The handler that should be executed for this lambda function.
-    # [lambda_role]    The arn of the IAM role that should be used when executing the lambda function.
-    # [lambda_description]    The description of the lambda function.
-    # [vpc_subnet_ids]  A list of subnet ids for the lambda's VPC configuration. All subnets must be on the same VPC.
-    # [vpc_security_group_ids]  A list of security group ids for the lambda's VPC configuration. All of the
-    #                           security_group_ids must be on the same VPC.
-    # [runtime] The runtime the code is written for.
-    # [timeout] The integer value of seconds until the lambda timesout. Minimum 1, Maximum 300
-    # [memory_size] The Memory/ProcessingPower allocated for the Lambda. Minimum 128. Maximum 1536. Only accepts
-    #               integers in multiples of 64.
-    def deploy_lambda(
-      bucket, key, version_id, function_name, handler, lambda_role, lambda_description = 'Deployed with LambdaWrap',
-      vpc_subnet_ids = [], vpc_security_group_ids = [], runtime = 'nodejs4.3', timeout = 5, memory_size = 128
-    )
-      # create or update function
-
-      begin
-        @client.get_function(function_name: function_name)
-        vpc_configuration = { subnet_ids: vpc_subnet_ids, security_group_ids: vpc_security_group_ids } unless (vpc_subnet_ids.empty? && vpc_security_group_ids.empty?)
-        func_config = @client.update_function_configuration(function_name: function_name, role: lambda_role, runtime: runtime,
-                                                            handler: handler, timeout: timeout, memory_size: memory_size,
-                                                            description: lambda_description,
-                                                            vpc_config: vpc_configuration).data
-        puts func_config
-
-        func_config = @client.update_function_code(function_name: function_name, s3_bucket: bucket, s3_key: key,
-                                                   s3_object_version: version_id, publish: true).data
-
-        puts func_config
-        func_version = func_config.version
-        raise 'Error while publishing existing lambda function ' + function_name unless func_version
-      rescue Aws::Lambda::Errors::ResourceNotFoundException
-        # check if vpc_subnet_ids and vpc_security_group_ids are empty or not and set the vpc_config accordingly.
-        vpc_Configuration = nil
-        vpc_Configuration = { subnet_ids: vpc_subnet_ids, security_group_ids: vpc_security_group_ids } unless (vpc_subnet_ids.empty? && vpc_security_group_ids.empty?)
-
-        # if we cannot find it, we have to create it instead of updating it
-        func_config = @client.create_function(
-          function_name: function_name, runtime: runtime, role: lambda_role,
-          handler: handler, code: { s3_bucket: bucket, s3_key: key }, timeout: timeout, memory_size: memory_size, publish: true,
-          description: lambda_description,
-          vpc_config: vpc_Configuration,
-          timeout: timeout,
-          memory_size: memory_size
-        ).data
-        puts func_config
-        func_version = func_config.version
-        raise "Error while publishing new lambda function #{function_name}" unless func_version
-      end
-
-      add_api_gateway_permissions(function_name, nil)
-
-      # return the version of the new code, not the config.
-      func_version
-    end
-
-    ##
-    # Creates an alias for a given lambda function version.
-    #
-    # *Arguments*
-    # [function_name]    The lambda function name for which the alias should be created.
-    # [func_version]    The lambda function versino to which the alias should point.
-    # [alias_name]      The name of the alias, matching the LambdaWrap environment concept.
-    def create_alias(function_name, func_version, alias_name)
-      # create or update alias
-      func_alias = @client.list_aliases(function_name: function_name).aliases.select { |a| a.name == alias_name }.first
-      if !func_alias
-        a = @client.create_alias(
-          function_name: function_name, name: alias_name, function_version: func_version,
-          description: 'created by an automated script'
-        ).data
-      else
-        a = @client.update_alias(
-          function_name: function_name, name: alias_name, function_version: func_version,
-          description: 'updated by an automated script'
-        ).data
-      end
-      puts a
-
-      add_api_gateway_permissions(function_name, alias_name)
-    end
-
-    ##
-    # Removes an alias for a function.
-    #
-    # *Arguments*
-    # [function_name]  The lambda function name for which the alias should be removed.
-    # [alias_name]    The alias to remove.
-    def remove_alias(function_name, alias_name)
-      @client.delete_alias(function_name: function_name, name: alias_name)
-    end
-
-    ##
-    # Adds permissions for API gateway to execute this function.
-    #
-    # *Arguments*
-    # [function_name]    The function name which needs to be executed from API Gateway.
-    # [env]          The environment (matching the function's alias) which needs to be executed from API Gateway.
-    # =>             If nil, the permissions are set of the $LATEST version.
-    def add_api_gateway_permissions(function_name, env)
-      # permissions to execute lambda
-      suffix = (':' + env if env) || ''
-      func = @client.get_function(function_name: function_name + suffix).data.configuration
-      statement_id = func.function_name + (('-' + env if env) || '')
-      begin
-        existing_policies = @client.get_policy(function_name: func.function_arn).data
-        existing_policy = JSON.parse(existing_policies.policy)
-        policy_exists = existing_policy['Statement'].select { |s| s['Sid'] == statement_id }.any?
-      rescue Aws::Lambda::Errors::ResourceNotFoundException
-        # policy does not exist, and that is ok
-        policy_exists = false
-      end
-
-      unless policy_exists
-        perm_add = @client.add_permission(
-          function_name: func.function_arn, statement_id: statement_id,
-          action: 'lambda:*', principal: 'apigateway.amazonaws.com'
-        )
-        puts perm_add.data
-      end
-    end
-
-    private :add_api_gateway_permissions
-  end
-end
+require 'aws-sdk'
+
+module LambdaWrap
+  ##
+  # The LambdaManager simplifies creating a package, publishing to S3, deploying a new version, & setting permissions.
+  #
+  # Note: The concept of an environment of the LambdaWrap gem matches an alias of AWS Lambda.
+  class LambdaManager
+    ##
+    # The constructor does some basic setup
+    # * Validating basic AWS configuration
+    # * Creating the underlying client to interace with the AWS SDK
+    def initialize
+      # AWS lambda client
+      @client = Aws::Lambda::Client.new
+    end
+
+    ##
+    # Packages a set of files and node modules into a deployable package.
+    #
+    # *Arguments*
+    # [directory]    A temporary directory to copy all related files before they are packages into a single zip file.
+    # [zipfile]      A path where the deployable package, a zip file, should be stored.
+    # [input_filenames]  A list of file names that contain the source code.
+    # [node_modules]  A list of node modules that need to be included in the package.
+    def package(directory, zipfile, input_filenames, node_modules)
+      FileUtils.mkdir_p directory
+      FileUtils.mkdir_p File.join(directory, 'node_modules') unless node_modules.empty?
+
+      input_filenames.each do |filename|
+        FileUtils.copy_file(File.join(filename), File.join(directory, File.basename(filename)))
+      end
+
+      node_modules.each do |dir|
+        FileUtils.cp_r(File.join('node_modules', dir), File.join(directory, 'node_modules'))
+      end
+
+      ZipFileGenerator.new(directory, zipfile).write
+    end
+
+    ##
+    # Publishes a package to S3 so it can be deployed as a lambda function.
+    #
+    # *Arguments*
+    # [local_lambda_file]  The location of the package that needs to be deployed.
+    # [bucket]        The s3 bucket where the file needs to be uploaded to.
+    # [key]          The S3 path (key) where the package should be stored.
+    def publish_lambda_to_s3(local_lambda_file, bucket, key)
+      # get s3 object
+      s3 = Aws::S3::Resource.new
+      obj = s3.bucket(bucket).object(key)
+
+      # upload
+      version_id = nil
+      File.open(local_lambda_file, 'rb') do |file|
+        version_id = obj.put(body: file).version_id
+      end
+      raise 'Upload to S3 failed' unless version_id
+
+      puts 'Uploaded object to S3 with version ' + version_id
+      version_id
+    end
+
+    ##
+    # Deploys a package that has been uploaded to S3.
+    #
+    # *Arguments*
+    # [bucket]      The S3 bucket where the package can be retrieved from.
+    # [key]        The S3 path (key) where the package can be retrieved from.
+    # [version_id]    The version of the file on S3 to retrieve.
+    # [function_name]  The name of the lambda function.
+    # [handler]      The handler that should be executed for this lambda function.
+    # [lambda_role]    The arn of the IAM role that should be used when executing the lambda function.
+    # [lambda_description]    The description of the lambda function.
+    # [vpc_subnet_ids]  A list of subnet ids for the lambda's VPC configuration. All subnets must be on the same VPC.
+    # [vpc_security_group_ids]  A list of security group ids for the lambda's VPC configuration. All of the
+    #                           security_group_ids must be on the same VPC.
+    # [runtime] The runtime the code is written for.
+    # [timeout] The integer value of seconds until the lambda timesout. Minimum 1, Maximum 300
+    # [memory_size] The Memory/ProcessingPower allocated for the Lambda. Minimum 128. Maximum 1536. Only accepts
+    #               integers in multiples of 64.
+    def deploy_lambda(
+      bucket, key, version_id, function_name, handler, lambda_role, lambda_description = 'Deployed with LambdaWrap',
+      vpc_subnet_ids = [], vpc_security_group_ids = [], runtime = 'nodejs4.3', timeout = 5, memory_size = 128
+    )
+      # create or update function
+
+      begin
+        @client.get_function(function_name: function_name)
+        unless vpc_subnet_ids.empty? && vpc_security_group_ids.empty?
+          vpc_configuration = {
+            subnet_ids: vpc_subnet_ids,
+            security_group_ids: vpc_security_group_ids
+          }
+        end
+        func_config = @client.update_function_configuration(
+          function_name: function_name, role: lambda_role, runtime: runtime,
+          handler: handler, timeout: timeout, memory_size: memory_size,
+          description: lambda_description,
+          vpc_config: vpc_configuration
+        ).data
+        puts func_config
+
+        func_config = @client.update_function_code(
+          function_name: function_name, s3_bucket: bucket, s3_key: key,
+          s3_object_version: version_id, publish: true
+        ).data
+
+        puts func_config
+        func_version = func_config.version
+        raise 'Error while publishing existing lambda function ' + function_name unless func_version
+      rescue Aws::Lambda::Errors::ResourceNotFoundException
+        # check if vpc_subnet_ids and vpc_security_group_ids are empty or not and set the vpc_config accordingly.
+        if vpc_subnet_ids.empty? && vpc_security_group_ids.empty?
+          vpc_configuration = nil
+        else
+          vpc_configuration = { subnet_ids: vpc_subnet_ids, security_group_ids: vpc_security_group_ids }
+        end
+
+        # if we cannot find it, we have to create it instead of updating it
+        func_config = @client.create_function(
+          function_name: function_name, runtime: runtime, role: lambda_role,
+          handler: handler, code: { s3_bucket: bucket, s3_key: key },
+          timeout: timeout, memory_size: memory_size, publish: true,
+          description: lambda_description,
+          vpc_config: vpc_configuration
+        ).data
+
+        puts func_config
+        func_version = func_config.version
+        raise "Error while publishing new lambda function #{function_name}" unless func_version
+      end
+
+      add_api_gateway_permissions(function_name, nil)
+
+      # return the version of the new code, not the config.
+      func_version
+    end
+
+    ##
+    # Creates an alias for a given lambda function version.
+    #
+    # *Arguments*
+    # [function_name]    The lambda function name for which the alias should be created.
+    # [func_version]    The lambda function versino to which the alias should point.
+    # [alias_name]      The name of the alias, matching the LambdaWrap environment concept.
+    def create_alias(function_name, func_version, alias_name)
+      # create or update alias
+      func_alias = @client.list_aliases(function_name: function_name).aliases.select { |a| a.name == alias_name }.first
+      a = if !func_alias
+            @client.create_alias(
+              function_name: function_name, name: alias_name, function_version: func_version,
+              description: 'created by an automated script'
+            ).data
+          else
+            @client.update_alias(
+              function_name: function_name, name: alias_name, function_version: func_version,
+              description: 'updated by an automated script'
+            ).data
+          end
+      puts a
+
+      add_api_gateway_permissions(function_name, alias_name)
+    end
+
+    ##
+    # Removes an alias for a function.
+    #
+    # *Arguments*
+    # [function_name]  The lambda function name for which the alias should be removed.
+    # [alias_name]    The alias to remove.
+    def remove_alias(function_name, alias_name)
+      @client.delete_alias(function_name: function_name, name: alias_name)
+    end
+
+    ##
+    # Adds permissions for API gateway to execute this function.
+    #
+    # *Arguments*
+    # [function_name]    The function name which needs to be executed from API Gateway.
+    # [env]          The environment (matching the function's alias) which needs to be executed from API Gateway.
+    # =>             If nil, the permissions are set of the $LATEST version.
+    def add_api_gateway_permissions(function_name, env)
+      # permissions to execute lambda
+      suffix = (':' + env if env) || ''
+      func = @client.get_function(function_name: function_name + suffix).data.configuration
+      statement_id = func.function_name + (('-' + env if env) || '')
+      begin
+        existing_policies = @client.get_policy(function_name: func.function_arn).data
+        existing_policy = JSON.parse(existing_policies.policy)
+        policy_exists = existing_policy['Statement'].select { |s| s['Sid'] == statement_id }.any?
+      rescue Aws::Lambda::Errors::ResourceNotFoundException
+        # policy does not exist, and that is ok
+        policy_exists = false
+      end
+
+      unless policy_exists
+        perm_add = @client.add_permission(
+          function_name: func.function_arn, statement_id: statement_id,
+          action: 'lambda:*', principal: 'apigateway.amazonaws.com'
+        )
+        puts perm_add.data
+      end
+    end
+
+    private :add_api_gateway_permissions
+  end
+end

data/lib/lambda_wrap/s3_bucket_manager.rb

@@ -10,7 +10,7 @@ module LambdaWrap
     # * Creating the underlying client to interact with the AWS SDK.
     # * Defining the temporary path of the api-gateway-importer jar file
     def initialize
-      @s3bucket = Aws::S3::Client.new()
+      @s3bucket = Aws::S3::Client.new
     end
 
     ##
@@ -21,15 +21,12 @@ module LambdaWrap
     # [policy]	Policy to be added to the bucket
     def setup_policy(s3_bucket_name, policy)
       # Validate the parameters
-      raise "S3 bucket is not provided" unless s3_bucket_name
-      raise "Policy json is not provided" unless policy
+      raise 'S3 bucket is not provided' unless s3_bucket_name
+      raise 'Policy json is not provided' unless policy
 
-      @s3bucket.put_bucket_policy({
-        bucket: s3_bucket_name,
-        policy: policy.to_json
-      })
+      @s3bucket.put_bucket_policy(bucket: s3_bucket_name,
+                                  policy: policy.to_json)
       puts "Created/Updated policy: #{policy} in S3 bucket #{s3_bucket_name}"
     end
-
   end
 end

data/lib/lambda_wrap/version.rb

@@ -0,0 +1,3 @@
+module LambdaWrap
+  VERSION = '0.26.6'.freeze
+end

data/lib/lambda_wrap/zip_file_generator.rb

@@ -1,67 +1,67 @@
-require 'rubygems'
-require 'zip'
-
-module LambdaWrap
-  ##
-  # Allows to easily zip a directory recursively. It's intended for gem internal use only.
-  #
-  # From the original example:
-  # This is a simple example which uses rubyzip to
-  # recursively generate a zip file from the contents of
-  # a specified directory. The directory itself is not
-  # included in the archive, rather just its contents.
-  #
-  # Usage:
-  # require /path/to/the/ZipFileGenerator/Class
-  # directoryToZip = "/tmp/input"
-  # outputFile = "/tmp/out.zip"
-  # zf = ZipFileGenerator.new(directoryToZip, outputFile)
-  # zf.write()
-  class ZipFileGenerator
-    ##
-    # Initialize with the directory to zip and the location of the output archive.
-    def initialize(input_dir, output_file)
-      @input_dir = input_dir
-      @output_file = output_file
-    end
-
-    ##
-    # Zip the input directory.
-    def write
-      entries = Dir.entries(@input_dir) - %w(. ..)
-
-      Zip::File.open(@output_file, Zip::File::CREATE) do |io|
-        write_entries entries, '', io
-      end
-    end
-
-    private
-
-    # A helper method to make the recursion work.
-    def write_entries(entries, path, io)
-      entries.each do |e|
-        zip_file_path = path == '' ? e : File.join(path, e)
-        disk_file_path = File.join(@input_dir, zip_file_path)
-        puts "Deflating #{disk_file_path}"
-
-        if File.directory? disk_file_path
-          recursively_deflate_directory(disk_file_path, io, zip_file_path)
-        else
-          put_into_archive(disk_file_path, io, zip_file_path)
-        end
-      end
-    end
-
-    def recursively_deflate_directory(disk_file_path, io, zip_file_path)
-      io.mkdir zip_file_path
-      subdir = Dir.entries(disk_file_path) - %w(. ..)
-      write_entries subdir, zip_file_path, io
-    end
-
-    def put_into_archive(disk_file_path, io, zip_file_path)
-      io.get_output_stream(zip_file_path) do |f|
-        f.puts(File.open(disk_file_path, 'rb').read)
-      end
-    end
-  end
-end
+require 'rubygems'
+require 'zip'
+
+module LambdaWrap
+  ##
+  # Allows to easily zip a directory recursively. It's intended for gem internal use only.
+  #
+  # From the original example:
+  # This is a simple example which uses rubyzip to
+  # recursively generate a zip file from the contents of
+  # a specified directory. The directory itself is not
+  # included in the archive, rather just its contents.
+  #
+  # Usage:
+  # require /path/to/the/ZipFileGenerator/Class
+  # directoryToZip = "/tmp/input"
+  # outputFile = "/tmp/out.zip"
+  # zf = ZipFileGenerator.new(directoryToZip, outputFile)
+  # zf.write()
+  class ZipFileGenerator
+    ##
+    # Initialize with the directory to zip and the location of the output archive.
+    def initialize(input_dir, output_file)
+      @input_dir = input_dir
+      @output_file = output_file
+    end
+
+    ##
+    # Zip the input directory.
+    def write
+      entries = Dir.entries(@input_dir) - %w[. ..]
+
+      Zip::File.open(@output_file, Zip::File::CREATE) do |io|
+        write_entries entries, '', io
+      end
+    end
+
+    private
+
+    # A helper method to make the recursion work.
+    def write_entries(entries, path, io)
+      entries.each do |e|
+        zip_file_path = path == '' ? e : File.join(path, e)
+        disk_file_path = File.join(@input_dir, zip_file_path)
+        puts "Deflating #{disk_file_path}"
+
+        if File.directory? disk_file_path
+          recursively_deflate_directory(disk_file_path, io, zip_file_path)
+        else
+          put_into_archive(disk_file_path, io, zip_file_path)
+        end
+      end
+    end
+
+    def recursively_deflate_directory(disk_file_path, io, zip_file_path)
+      io.mkdir zip_file_path
+      subdir = Dir.entries(disk_file_path) - %w[. ..]
+      write_entries subdir, zip_file_path, io
+    end
+
+    def put_into_archive(disk_file_path, io, zip_file_path)
+      io.get_output_stream(zip_file_path) do |f|
+        f.puts(File.open(disk_file_path, 'rb').read)
+      end
+    end
+  end
+end

data/lib/lambda_wrap.rb

@@ -1,5 +1,5 @@
-# :nodoc:
-Dir["#{File.expand_path(File.dirname(__FILE__))}/**/*.rb"].each { |f| require f }
-
-STDOUT.sync = true
-STDERR.sync = true
+# :nodoc:
+Dir["#{File.expand_path(File.dirname(__FILE__))}/**/*.rb"].each { |f| require f }
+
+STDOUT.sync = true
+STDERR.sync = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lambda_wrap
 version: !ruby/object:Gem::Version
-  version: 0.26.0
+  version: 0.26.6
 platform: ruby
 authors:
 - Markus Thurner
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-27 00:00:00.000000000 Z
+date: 2017-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -40,9 +40,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-description: This gem wraps the AWS SDK to simplify deployment of AWSLambda functions
-  backed by API Gateway and DynamoDB.
-email: 
+description: |-
+  This gem wraps the AWS SDK to simplify deployment of AWS \
+                        Lambda functions backed by API Gateway and DynamoDB.
+email:
+- theodorecarmstrong@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -52,6 +54,7 @@ files:
 - lib/lambda_wrap/dynamo_db_manager.rb
 - lib/lambda_wrap/lambda_manager.rb
 - lib/lambda_wrap/s3_bucket_manager.rb
+- lib/lambda_wrap/version.rb
 - lib/lambda_wrap/zip_file_generator.rb
 homepage: https://github.com/Cimpress-MCP/LambdaWrap
 licenses:
@@ -73,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Easy deployment of AWS Lambda functions and dependencies.