aws_lambda_ric 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf1124bbf50d67d952fa22fcd35345899f5f8051e4c3d2be9ba87f0cc701cabb
-  data.tar.gz: e32410af6693b00bb5ed60e6f7c1ff99d7dec53d4484982c18c338920ed401ce
+  metadata.gz: b33180932d42b43cbe38aaf19aca5a30c01212a209cec6eb577b62e8139f4d36
+  data.tar.gz: 64b49034a0cd70a4e974c8bb2c56c8e73cc607b36e66de08622f8daa3fba982f
 SHA512:
-  metadata.gz: '005869f4ece8cdd2a5c93e771d377c8d4107121f0916259ecdf62bd57d5e4bc695dabad4f7695d70155c22bce0d5f13ec0be9db396f7dad86c8d364595d4d81c'
-  data.tar.gz: fa08b30481f6ead00ab458515b8f4eef8ce8c4190432f879408329031383bb190cde4dcc7bd8691709d1220c98d80ff98d7561d984822b075f040ee2fb74982d
+  metadata.gz: 0dd4f76dabca24fcae696e0780be387eee6bdff75d1bf9b7f95f1d9e5a37a10823bb9f24b521bb9d64e55bf718b36a5a7f9c84625b7bb25fd4cf88eedaf89498
+  data.tar.gz: 6a95a1763b7263a87201ac82153cb27344e96927a582e3bae95003f29e3dbf1f60089d5791526624cd863d2b17983cdf03c9074a39b8cb85617f082bd796d550

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    aws_lambda_ric (1.0.0)
+    aws_lambda_ric (1.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     minitest (5.14.2)
-    rake (10.5.0)
+    rake (13.0.1)
 
 PLATFORMS
   ruby
@@ -16,7 +16,7 @@ DEPENDENCIES
   aws_lambda_ric!
   bundler (>= 2.0)
   minitest (~> 5.0)
-  rake (~> 10.0)
+  rake (~> 13.0)
 
 BUNDLED WITH
    2.2.0.rc.2

data/README.md

@@ -39,12 +39,10 @@ Or install it manually as:
 
 
 Next step would be to copy your Lambda function code into the image's working directory.
-```Docker
-# Create function directory
+```dockerfile
+# Copy function code
 RUN mkdir -p ${FUNCTION_DIR}
-
-# Copy handler function
-COPY app.rb ${FUNCTION_DIR}/app.rb
+COPY app.rb ${FUNCTION_DIR}
 
 WORKDIR ${FUNCTION_DIR}
 ```
@@ -52,7 +50,7 @@ WORKDIR ${FUNCTION_DIR}
 The next step would be to set the `ENTRYPOINT` property of the Docker image to invoke the Runtime Interface Client and then set the `CMD` argument to specify the desired handler.
 
 Example Dockerfile:
-```Docker
+```dockerfile
 FROM amazonlinux:latest
 
 # Define custom function directory
@@ -61,28 +59,28 @@ ARG FUNCTION_DIR="/function"
 # Install ruby
 RUN amazon-linux-extras install -y ruby2.6
 
+# Install bundler
+RUN gem install bundler
+
 # Install the Runtime Interface Client
 RUN gem install aws_lambda_ric
 
-# Create function directory
+# Copy function code
 RUN mkdir -p ${FUNCTION_DIR}
-
-# Copy handler function
-COPY app.rb ${FUNCTION_DIR}/app.rb
+COPY app.rb ${FUNCTION_DIR}
 
 WORKDIR ${FUNCTION_DIR}
 
-ENTRYPOINT ["aws_lambda_ric"]
+ENTRYPOINT ["/usr/local/bin/aws_lambda_ric"]
 CMD ["app.App::Handler.process"]
 ```
 
 Example Ruby handler `app.rb`:
-```rb
+```ruby
 module App
   class Handler
     def self.process(event:, context:)
-      message = "Hello World!"
-      { statusCode: 200, body: { 'message': message } }
+      "Hello World!"
     end
   end
 end
@@ -90,8 +88,58 @@ end
 
 ### Local Testing
 
-For testing locally you will need to set up a local Runtime Interface Emulator against which the Runtime Interface Client will make API calls. You will need to post data to the endpoint it creates in order to invoke your function. For more information check out the [Runtime Interface Emulator](https://github.com/aws/aws-lambda-runtime-interface-emulator).
+To make it easy to locally test Lambda functions packaged as container images we open-sourced a lightweight web-server, Lambda Runtime Interface Emulator (RIE), which allows your function packaged as a container image to accept HTTP requests. You can install the [AWS Lambda Runtime Interface Emulator](https://github.com/aws/aws-lambda-runtime-interface-emulator) on your local machine to test your function. Then when you run the image function, you set the entrypoint to be the emulator. 
+
+*To install the emulator and test your Lambda function*
+
+1) From your project directory, run the following command to download the RIE from GitHub and install it on your local machine. 
 
+```shell script
+mkdir -p ~/.aws-lambda-rie && \
+    curl -Lo ~/.aws-lambda-rie/aws-lambda-rie https://github.com/aws/aws-lambda-runtime-interface-emulator/releases/latest/download/aws-lambda-rie && \
+    chmod +x ~/.aws-lambda-rie/aws-lambda-rie
+```
+2) Run your Lambda image function using the docker run command. 
+
+```shell script
+docker run -d -v ~/.aws-lambda-rie:/aws-lambda -p 9000:8080 \
+    --entrypoint /aws-lambda/aws-lambda-rie \
+    myfunction:latest \
+        /usr/local/bin/aws_lambda_ric app.App::Handler.process
+```
+
+This runs the image as a container and starts up an endpoint locally at `http://localhost:9000/2015-03-31/functions/function/invocations`. 
+
+3) Post an event to the following endpoint using a curl command: 
+
+```shell script
+curl -XPOST "http://localhost:9000/2015-03-31/functions/function/invocations" -d '{}'.
+```
+
+This command invokes the function running in the container image and returns a response.
+
+*Alternately, you can also include RIE as a part of your base image. See the AWS documentation on how to [Build RIE into your base image](https://docs.aws.amazon.com/lambda/latest/dg/images-test.html#images-test-alternative).*
+
+## Development
+
+### Building the package
+Clone this repository and run:
+
+```shell script
+make init
+make build
+```
+
+### Running tests
+
+Make sure the project is built:
+```shell script
+make init build
+```
+Then,
+* to run unit tests: `make test`
+* to run integration tests: `make test-integ`
+* to run smoke tests: `make test-smoke`
 
 ## Security
 
@@ -99,4 +147,5 @@ If you discover a potential security issue in this project we ask that you notif
 
 ## License
 
-This project is licensed under the Apache-2.0 License.
+This project is licensed under the Apache-2.0 License.
+

data/aws_lambda_ric.gemspec

@@ -7,16 +7,19 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require './lib/aws_lambda_ric/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'aws_lambda_ric'
-  spec.version       = AwsLambdaRuntimeInterfaceClient::VERSION
-  spec.authors       = ['AWS Lambda']
+  spec.name                  = 'aws_lambda_ric'
+  spec.version               = AwsLambdaRuntimeInterfaceClient::VERSION
+  spec.authors               = ['AWS Lambda']
 
-  spec.summary       = 'AWS Lambda Runtime Interface Client for Ruby'
-  spec.description   = 'The AWS Lambda Ruby Runtime Interface Client implements the Lambda programming model for Ruby.'
-  spec.homepage      = 'https://github.com/aws/aws-lambda-ruby-runtime-interface-client'
+  spec.summary               = 'AWS Lambda Runtime Interface Client for Ruby'
+  spec.description           = 'The AWS Lambda Ruby Runtime Interface Client implements the Lambda programming model for Ruby.'
+  spec.homepage              = 'https://github.com/aws/aws-lambda-ruby-runtime-interface-client'
+
+  spec.license               = 'Apache-2.0'
+  spec.required_ruby_version = '>= 2.5'
 
   # Specify which files should be added to the gem when it is released.
-  spec.files         = %w[
+  spec.files                 = %w[
     LICENSE
     README.md
     Gemfile
@@ -26,12 +29,12 @@ Gem::Specification.new do |spec|
     bin/aws_lambda_ric
   ] + Dir['lib/**/*']
 
-  spec.bindir        = 'bin'
+  spec.bindir                = 'bin'
   # all application-style files are expected to be found in bindir
-  spec.executables   = 'aws_lambda_ric'
-  spec.require_paths = ['lib']
+  spec.executables           = 'aws_lambda_ric'
+  spec.require_paths         = ['lib']
 
   spec.add_development_dependency 'bundler', '>= 2.0'
   spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
 end

data/lib/aws_lambda_ric/version.rb

@@ -3,5 +3,5 @@
 # frozen_string_literal: true
 
 module AwsLambdaRuntimeInterfaceClient
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws_lambda_ric
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - AWS Lambda
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 description: The AWS Lambda Ruby Runtime Interface Client implements the Lambda programming
   model for Ruby.
 email: 
@@ -80,7 +80,8 @@ files:
 - lib/aws_lambda_ric/version.rb
 - lib/aws_lambda_ric/xray_cause.rb
 homepage: https://github.com/aws/aws-lambda-ruby-runtime-interface-client
-licenses: []
+licenses:
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -90,7 +91,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="