yake 0.3.0 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 498a95a56043103e5ab1315fefef95a6f55a27136fe5013df544e3fe83ed77dc
-  data.tar.gz: 92dfac92a9036c96ea622228795e268b906f156b526b1a1cb46313fa2f4af0c8
+  metadata.gz: 2d64b926e9680f75a892e5de6c68062242801d184bdbd24595a10210fbc7f22a
+  data.tar.gz: bf82c77421cec7c5b5d30020b15895ec111d8e53c0122ef6e62fa26856acb7ca
 SHA512:
-  metadata.gz: b26c78cfe69bb588cf37bafeeacc53314e40106eb38416d6b52dd652e2a954c3767fb5c4f5852ea3d132558f69a6d512cfbc48f6c11f766e3a099a5bb7c95697
-  data.tar.gz: c063851aac6c3554dd36a05db53e846d835019bf973c0b060b6cf673697350eeeba6d3ddb0585eaeed92fd165bf1767cf0f9fb0e514ef49c16de604f04783f03
+  metadata.gz: a99122212c84d638874ebd25e07d9f7305568fbdd18f95d04c8d44df1c337b75a81b37c55840d2366adf8ea05fe2cff35fbf876c082ab82dbf5f98b3511d8293
+  data.tar.gz: a76262d29fb1a173cb9293af7c5ce34e1089d181112aaf80d2d6a6b117141c89c63322b24074287d6b655d04e6d68d6499b51d46bae20555735ffd344b199761

data/README.md

@@ -9,7 +9,7 @@ Write your AWS Lambda function handlers using a Rake-like declarative syntax:
 
 ```ruby
 # ./lambda_function.rb
-require "yake"
+require 'yake'
 
 handler :lambda_handler do |event|
   # Your code here
@@ -22,11 +22,11 @@ You can even declare Sinatra-like API Gateway routes for a main entrypoint:
 
 ```ruby
 # ./lambda_function.rb
-require "yake/api"
+require 'yake/api'
 
-header "content-type" => "application/json"
+header 'content-type' => 'application/json'
 
-get "/fizz" do
+get '/fizz' do
   respond 200, { ok: true }.to_json
 end
 
@@ -44,7 +44,7 @@ end
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "yake"
+gem 'yake'
 ```
 
 And then execute:
@@ -82,10 +82,12 @@ REPORT RequestId: 149c500f-028a-4b57-8977-0ef568cf8caf	Duration: 43.97 ms	Billed
 
 Logging the request ID in this way makes gathering logs lines for a particular execution in CloudWatch much easier.
 
-This feature can be disabled by adding a declaration in your handler file:
+You can customize or disable the logger:
 
 ```ruby
-logging :off
+logging :off              # disables logging entirely
+logging pretty: false     # Logs event/result in compact JSON
+logging :on, MyLogger.new # Use a custom logger
 ```
 
 Include `Yake::Logger` on a class to access this logger:
@@ -108,35 +110,35 @@ Requiring the `yake/api` module will add the API-specific DSL into your handler.
 Define API routes using Sinatra-like syntax
 
 ```ruby
-any "/…" do |event|
+any '/…' do |event|
   # Handle 'ANY /…' route key events
 end
 
-delete "/…" do |event|
+delete '/…' do |event|
   # Handle 'DELETE /…' route key events
 end
 
-get "/…" do |event|
+get '/…' do |event|
   # Handle 'GET /…' route key events
 end
 
-head "/…" do |event|
+head '/…' do |event|
   # Handle 'HEAD /…' route key events
 end
 
-options "/…" do |event|
+options '/…' do |event|
   # Handle 'OPTIONS /…' route key events
 end
 
-patch "/…" do |event|
+patch '/…' do |event|
   # Handle 'PATCH /…' route key events
 end
 
-post "/…" do |event|
+post '/…' do |event|
   # Handle 'POST /…' route key events
 end
 
-put "/…" do |event|
+put '/…' do |event|
   # Handle 'PUT /…' route key events
 end
 ```
@@ -146,14 +148,14 @@ Helper methods are also made available to help produce a response for API Gatewa
 Set a default header for ALL responses:
 
 ```ruby
-header "content-type" => "application/json; charset=utf-8"
-header "x-custom-header" => "fizz"
+header 'content-type' => 'application/json; charset=utf-8'
+header 'x-custom-header' => 'fizz'
 ```
 
 Produce an API Gateway-style response object:
 
 ```ruby
-respond 200, { ok: true }.to_json, "x-extra-header" => "buzz"
+respond 200, { ok: true }.to_json, 'x-extra-header' => 'buzz'
 # {
 #   "statusCode" => 200,
 #   "body" => '{"ok":true}',
@@ -177,11 +179,35 @@ end
 
 Finally, `yake` does not depend on any other gems, using the Ruby stdlib only. This helps keep your Lambda packages slim & speedy.
 
-## Development
+## Datadog Integration
+
+As of `~> 0.4`, `yake` comes with a helper for writing Lambdas that integrate with Datadog's `datadog-ruby` gem.
 
-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.
+Creating a Lambda handler that wraps the Datadog tooling is easy:
+
+```ruby
+require 'aws-sdk-someservice'
+require 'yake/datadog'
+
+# Configure Datadog to use AWS tracing
+Datadog::Lambda.configure_apm { |config| config.use :aws }
+
+datadog :handler do |event|
+  # …
+end
+```
+
+## Deployment
+
+After writing your Lambda handler code you can deploy it to AWS using any number of tools. I recommend the following tools:
+
+- [Terraform](https://www.terraform.io) — my personal favorite Infrastructure-as-Code tool
+- [AWS SAM](https://aws.amazon.com/serverless/sam/) — a great alternative with less configuration than Terraform
+- [Serverless](https://www.serverless.com) — Supposedly the most popular option, though I have not used it
+
+## Development
 
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+After checking out the repo, run `bundle` to install dependencies. Then, run `rake spec` to run the tests.
 
 ## Contributing
 

data/lib/yake/api.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require "base64"
-require "json"
+require 'base64'
+require 'json'
 
-require "yake"
-require_relative "errors"
+require 'yake'
+require_relative 'errors'
 
 module Yake
   module API
@@ -13,20 +13,21 @@ module Yake
       # Proxy handler for HTTP requests from Slack
       def route(event, context = nil, &block)
         # Extract route method
-        method = event["routeKey"]
+        method = event['routeKey']
         raise Yake::Errors::UndeclaredRoute, method unless respond_to?(method)
 
         # Normalize headers
-        event["headers"]&.transform_keys!(&:downcase)
+        event['headers']&.transform_keys!(&:downcase)
 
         # Decode body if Base64-encoded
-        if event["isBase64Encoded"]
-          body = Base64.strict_decode64(event["body"])
-          event.update("body" => body, "isBase64Encoded" => false)
+        if event['isBase64Encoded']
+          body = Base64.strict_decode64(event['body'])
+          event.update('body' => body, 'isBase64Encoded' => false)
         end
 
         # Execute request
-        send(method, event, context).then { |res| block_given? ? yield(res) : res }
+        res = send(method, event, context)
+        block_given? ? yield(res) : res
       end
 
       ##
@@ -37,10 +38,10 @@ module Yake
         Yake.logger&.send(status_code.to_i >= 400 ? :error : :info, log)
 
         # Set headers
-        content_length = (body&.length || 0).to_s
+        content_length = (body&.bytesize || 0).to_s
         to_s_downcase  = -> (key) { key.to_s.downcase }
         headers = {
-          "content-length" => content_length,
+          'content-length' => content_length,
           **(@headers || {}),
           **headers,
         }.transform_keys(&to_s_downcase).compact

data/lib/yake/datadog.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+require 'logger'
+
+require 'datadog/lambda'
+require 'yake'
+
+module Yake
+  module Datadog
+    class Formatter < ::Logger::Formatter
+      Format = "[%s] %s %s %s %s\n"
+
+      def call(severity, time, progname, msg)
+        Format % [
+          severity,
+          time.utc.strftime('%Y-%m-%dT%H:%M:%S.%LZ'),
+          progname.nil? ? '-' : progname.split.last,
+          ::Datadog.tracer.active_correlation,
+          msg2str(msg).strip,
+        ]
+      end
+    end
+
+    class MockContext < Struct.new(
+      :clock_diff,
+      :deadline_ms,
+      :aws_request_id,
+      :invoked_function_arn,
+      :log_group_name,
+      :log_stream_name,
+      :function_name,
+      :memory_limit_in_mb,
+      :function_version)
+
+      def invoked_function_arn
+        @invoked_function_arn ||= begin
+          region = ENV['AWS_REGION'] || ENV['AWS_DEFAULT_REGION'] || 'us-east-1'
+          "arn:aws:lambda:#{region}:123456789012:function-name"
+        end
+      end
+    end
+
+    module DSL
+      include Yake::DSL
+
+      ##
+      # Datadog handler wrapper
+      def datadog(name, &block)
+        define_method(name) do |event:nil, context:nil|
+          context ||= MockContext.new
+          ::Datadog::Lambda.wrap(event, context) do
+            Yake.wrap(event, context, &block)
+          end
+        end
+      end
+    end
+  end
+
+  logger.formatter = Datadog::Formatter.new
+end
+
+extend Yake::Datadog::DSL

data/lib/yake/dsl.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require "json"
+require 'json'
 
-require_relative "logger"
+require_relative 'logger'
 
 module Yake
   module DSL
@@ -22,7 +22,8 @@ module Yake
 
     ##
     # Turn logging on/off
-    def logging(switch, logger = nil)
+    def logging(switch = :on, logger = nil, pretty: true)
+      Yake.pretty = pretty
       if switch == :on
         Yake.logger = logger
       elsif switch == :off

data/lib/yake/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Yake
   module Errors
     class Error < StandardError; end

data/lib/yake/logger.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require "json"
-require "logger"
+require 'json'
+require 'logger'
 
 module Yake
   module Logger
-    attr_accessor :logger
+    attr_writer :logger
 
     def logger
       @logger ||= Yake.logger
@@ -21,23 +21,30 @@ module Yake
       Format = "%s %s %s\n"
 
       def call(severity, time, progname, msg)
-        Format % [ severity, progname.nil? ? "-" : "RequestId: #{ progname }", msg2str(msg).strip ]
+        Format % [ severity, progname.nil? ? '-' : "RequestId: #{ progname }", msg2str(msg).strip ]
       end
     end
   end
 
   class << self
-    attr_accessor :logger
+    attr_writer :logger, :pretty
 
     def logger
       @logger ||= Logger.new
     end
 
+    def pretty?
+      @pretty != false
+    end
+
     def wrap(event = nil, context = nil, &block)
       original_progname = logger.progname
-      logger.progname = context&.aws_request_id
-      logger.info("EVENT #{ event.to_json }")
-      yield(event, context).tap { |res| logger.info("RETURN #{ res.to_json }") }
+      logger.progname   = context&.aws_request_id
+      jsonify           = -> (obj) { pretty? ? JSON.pretty_generate(obj) : obj.to_json }
+      logger.info("EVENT #{ jsonify === event }")
+      yield(event, context).tap do |res|
+        logger.info("RETURN #{ jsonify === res }")
+      end
     ensure
       logger.progname = original_progname
     end

data/lib/yake/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Yake
-  VERSION = "0.3.0"
+  VERSION = '0.4.3'
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: yake
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.3
 platform: ruby
 authors:
 - Alexander Mancevice
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-28 00:00:00.000000000 Z
+date: 2021-11-29 00:00:00.000000000 Z
 dependencies: []
-description: 
+description:
 email:
 - alexander.mancevice@hey.com
 executables: []
@@ -18,10 +18,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
-- LICENSE.txt
 - README.md
 - lib/yake.rb
 - lib/yake/api.rb
+- lib/yake/datadog.rb
 - lib/yake/dsl.rb
 - lib/yake/errors.rb
 - lib/yake/logger.rb
@@ -30,7 +30,7 @@ homepage: https://github.com/amancevice/yake
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -45,8 +45,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Rake-like DSL for declaring AWS Lambda function handlers
 test_files: []

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2021 Alexander Mancevice
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.