lambda_punch 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 806b9121fb13c00ae8a5e38e39a48cb2f8609aad192f5f3bc32b857032cfd0fa
-  data.tar.gz: 8426e0efa1a7c5f44d79445ea025054f8346f4264983878fc608f91efbcca387
+  metadata.gz: ad3d3b5bc8d71f3ec550dc01f998e4df18c77b839b9dd4c44d010a08b5bf25d5
+  data.tar.gz: 106ecd9404fe6a570166f5a2dfc6e7654f427aec9fc1e77df2154d4031409982
 SHA512:
-  metadata.gz: 0ec52eb4a0f53d3958080a34ed8b5d07e0f0f93e326d1e6e78dad7167ba8c87b5c60074e49d3a7219903d764ff9569b4f94ff3948f5e546e74a380b338025d94
-  data.tar.gz: a8c0b72ccc54367fd683996a0b24d586632e934be647b1f000f8c2bb83e31aac6c14f6c31b539356ae94eb14a55aa06fe9d1698d40a1123336b927fe3e40b164
+  metadata.gz: e9526b2c0ec7490eeb323df242a0b2537cc3c783aad1c6bd622bdec58354abb1f5b0230833947ded1f8242eacd1d15625cc581a34e6d822e3343adc3732124cb
+  data.tar.gz: 105223ed92a8f3782e376f9d3d472d70d0a807a984a5f94425d3332450fae150dcf20c67771898741dc2134efa67c8db262dd8efb14ddfe89dc46d6cc2214870

data/CHANGELOG.md

@@ -1,8 +1,14 @@
+## [1.1.0] - 2023-04-16
+
+### Added
+
+- New `lambda_punch` install interface.
+
 ## [1.0.3] - 2021-10-27
 
 ### Added
 
--
+- Any Timeout Gem. Tempfile Location Interface 
 
 ### Changed
 

data/README.md

@@ -4,7 +4,7 @@
 
 # 👊 LambdaPunch
 
-<a href="https://lamby.custominktech.com"><img src="https://user-images.githubusercontent.com/2381/59363668-89edeb80-8d03-11e9-9985-2ce14361b7e3.png" alt="Lamby: Simple Rails & AWS Lambda Integration using Rack." align="right" width="300" /></a>Asynchronous background job processing for AWS Lambda with Ruby using [Lambda Extensions](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-extensions-api.html). Inspired by the [SuckerPunch](https://github.com/brandonhilkert/sucker_punch) gem but specifically tooled to work with Lambda's invoke model.
+<a href="https://lamby.custominktech.com"><img src="https://raw.githubusercontent.com/customink/lamby/master/images/social2.png" alt="Lamby: Simple Rails & AWS Lambda Integration using Rack." align="right" width="450" style="margin-left:1rem;margin-bottom:1rem;" /></a>Asynchronous background job processing for AWS Lambda with Ruby using [Lambda Extensions](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-extensions-api.html). Inspired by the [SuckerPunch](https://github.com/brandonhilkert/sucker_punch) gem but specifically tooled to work with Lambda's invoke model.
 
 **For a more robust background job solution, please consider using AWS SQS with the [Lambdakiq](https://github.com/customink/lambdakiq) gem. A drop-in replacement for [Sidekiq](https://github.com/mperham/sidekiq) when running Rails in AWS Lambda using the [Lamby](https://lamby.custominktech.com/) gem.**
 
@@ -18,35 +18,36 @@ The LambdaPunch extension process is very small and lean. It only requires a few
 
 ## 🎁 Installation
 
-Add this line to your project's `Gemfile` and then make sure to `bundle install` afterward.
+Add this line to your project's `Gemfile` and then make sure to `bundle install` afterward. It is only needed in the `production` group.
 
 ```ruby
 gem 'lambda_punch'
 ```
 
-Now, within your application's handler file, make sure to start the LambdaPunch DRb server outside of your handler method. Within the handler method, add an `ensure` section that lets the extension process know the request is done.
+Within your project or [Rails application's](https://lamby.custominktech.com/docs/anatomy) `Dockerfile`, add the following. Make sure you do this before you `COPY` your code. The idea is to implicitly use the default `USER root` since it needs permissions to create an `/opt/extensions` directory.
 
-```ruby
-LambdaPunch.start_server!
-
-def handler(event:, context:)
-  # ...
-ensure
-  LambdaPunch.handled!(context)
-end
+```dockerfile
+RUN gem install lambda_punch && lambda_punch install
 ```
 
-Within your project or [Rails application's](https://lamby.custominktech.com/docs/anatomy) `Dockerfile`, after you copy your code, add this `RUN` command to install the extension within your container's `/opt/extensions` directory.
+Installation with AWS Lambda via the [Lamby](https://lamby.custominktech.com/) v4 (or higher) gem can be done using Lamby's `handled_proc` config. For example, appends these to your `config/environments/production.rb` file. Here we are ensuring that the LambdaPunch DRb server is running and that after each Lamby request we notify LambdaPunch.
 
-```dockerfile
-RUN bundle exec rake lambda_punch:install
+```ruby
+config.to_prepare { LambdaPunch.start_server! }
+config.lamby.handled_proc = Proc.new do |_event, context|
+  LambdaPunch.handled!(context)
+end
 ```
 
-If you are using `LambdaPunch` with a non-Rails project, add this to your Rake file
+If you are using an older version of Lamby or a simple Ruby project with your own handler method, the installation would look something like this:
 
 ```ruby
-spec = Gem::Specification.find_by_name 'lambda_punch'
-load "#{spec.gem_dir}/lib/lambda_punch/tasks/install.rake"
+LambdaPunch.start_server!
+def handler(event:, context:)
+  # ...
+ensure
+  LambdaPunch.handled!(context)
+end
 ```
 
 ## 🧰 Usage
@@ -59,12 +60,11 @@ LambdaPunch.push do
 end
 ```
 
-For example, if you are using Rails with AWS Lambda via the [Lamby](https://lamby.custominktech.com/) gem along with [New Relic APM](https://dev.to/aws-heroes/using-new-relic-apm-with-rails-on-aws-lambda-51gi) here is how your handler function might appear to ensure their metrics are flushed after each request.
+A common use case would be to ensure the [New Relic APM](https://dev.to/aws-heroes/using-new-relic-apm-with-rails-on-aws-lambda-51gi) flushes its data after each request. Using Lamby in your `config/environments/production.rb`  file would look like this:
 
 ```ruby
-def handler(event:, context:)
-  Lamby.handler $app, event, context
-ensure
+config.to_prepare { LambdaPunch.start_server! }
+config.lamby.handled_proc = Proc.new do |_event, context|
   LambdaPunch.push { NewRelic::Agent.agent.flush_pipe_data }
   LambdaPunch.handled!(context)
 end

data/exe/lambda_punch

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'rake'
+
+load "#{spec.gem_dir}/lib/lambda_punch/tasks/install.rake"
+
+command = ARGV[0] || 'install'
+
+Rake::Task["lambda_punch:#{command}"].invoke

data/lib/lambda_punch/version.rb

@@ -1,3 +1,3 @@
 module LambdaPunch
-  VERSION = "1.0.3"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lambda_punch
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Ken Collins
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-28 00:00:00.000000000 Z
+date: 2023-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -111,7 +111,8 @@ dependencies:
 description: 'LambdaPunch: Async Processing using Lambda Extensions'
 email:
 - ken@metaskills.net
-executables: []
+executables:
+- lambda_punch
 extensions: []
 extra_rdoc_files: []
 files:
@@ -133,6 +134,7 @@ files:
 - bin/setup
 - bin/test
 - docker-compose.yml
+- exe/lambda_punch
 - lambda_punch.gemspec
 - lib/lambda_punch.rb
 - lib/lambda_punch/api.rb
@@ -154,7 +156,7 @@ metadata:
   homepage_uri: https://github.com/customink/lambda_punch
   source_code_uri: https://github.com/customink/lambda_punch
   changelog_uri: https://github.com/customink/lambda_punch/blob/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -169,8 +171,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.4.7
+signing_key:
 specification_version: 4
 summary: 'LambdaPunch: Async Processing using Lambda Extensions'
 test_files: []