yake 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bd208d64f868cf763f2cb19ff4b766a771a3011b6edda1918cf4e3f9436b1c0
-  data.tar.gz: 439c99ae77a312ad882f8d5b58061dd9841e7f163a6e01476a54845ad38efab5
+  metadata.gz: 6688bf834975490165ca48ff259e22402ec5dc417099c8c2291b4796eb76b5b2
+  data.tar.gz: d92d5faec4b6bd8b60a65962af51493176a4184a87a52de188f84367bce4002b
 SHA512:
-  metadata.gz: 2052948f82b026240655aaf07d6a5a15dc687aa432d97fdcbec0b9c4cb88aca4c64f50d7051336f1a7b99d005b2f9d6234f50a750221897d86a6d033012200e6
-  data.tar.gz: 8800efb2e6428321aadc94c84788f8918290ab620476f51e20d1e0cfd66170bd4a3002ff86c5d4554de5c3aceaa81ecefb14fcb393fe0f5ac368d70233a83429
+  metadata.gz: 2cf319bba7cd22f2c5f58a66c401dd77dfc2d050214d39d755748d9dc78baed88c603dbfdbbe3d233385e35270c73ec19ab9d3edae394ef9e6dbc2c89c9c1a34
+  data.tar.gz: 2221a9a8108091b59c9e0eeeb7959c675faee09385847ed5fbf9a75ebbc788be6a734c13eec4a948af883ce1210d9d7fe45401c1e0f3b0cba2efceab03a88df5

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,121 @@ end
 
 Finally, `yake` does not depend on any other gems, using the Ruby stdlib only. This helps keep your Lambda packages slim & speedy.
 
-## Development
+## Support Helpers
+
+As of `v0.5`, `yake` comes with a support module for common transformations.
+
+`Hash` transformations:
+
+```ruby
+require 'yake/support'
+
+{ fizz: 'buzz' }.encode64
+# => "eyJmaXp6IjoiYnV6eiJ9\n"
+
+{ fizz: 'buzz' }.strict_encode64
+# => "eyJmaXp6IjoiYnV6eiJ9"
+
+{ 'fizz' => { 'buzz' => %w[jazz fuzz] } }.symbolize_names
+# => { :fizz => { :buzz => ["jazz", "fuzz"] } }
+
+{ fizz: 'buzz' }.to_form
+# => "fizz=buzz"
+```
+
+`Integer` transformations:
+
+```ruby
+7.days
+# => 604800
+
+7.hours
+# => 25200
+
+7.minutes
+# => 420
+
+1234567890.utc
+# => 2009-02-13 23:31:30 UTC
+```
+
+`String` transformations:
+
+```ruby
+'snake_case_string'.camel_case
+# => SnakeCaseString
+
+"Zml6eg==\n".decode64
+# => "fizz"
+
+'fizz'.encode64
+# => "Zml6eg==\n"
+
+'CamelCaseString'.snake_case
+# => 'camel_case_string'
+
+'Zml6eg=='.strict_decode64
+# => "fizz"
+
+'fizz'.strict_encode64
+# => "Zml6eg=="
+
+'{"fizz":"buzz"}'.to_h_from_json
+# => { "fizz" => "buzz" }
 
-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.
+'fizz=buzz'.to_h_from_form
+# => { "fizz" => "buzz" }
+```
+
+`Symbol` transformations
+
+```ruby
+:snake_case_symbol.camel_case
+# => :SnakeCaseSymbol
+
+:CamelCaseSymbol.snake_case
+# => 'camel_case_symbol'
+```
+
+`UTC` Time helper
+
+```ruby
+UTC.at 1234567890
+# => 2009-02-13 23:31:30 UTC
+
+UTC.now
+# => 2022-02-26 13:57:07.860539 UTC
+```
+
+## Datadog Integration
+
+As of `~> 0.4`, `yake` comes with a helper for writing Lambdas that integrate with Datadog's `datadog-ruby` gem.
+
+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/datadog.rb

@@ -1,10 +1,25 @@
 # 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,
@@ -39,6 +54,8 @@ module Yake
       end
     end
   end
+
+  logger.formatter = Datadog::Formatter.new
 end
 
 extend Yake::Datadog::DSL

data/lib/yake/dsl.rb

@@ -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/logger.rb

@@ -5,7 +5,7 @@ require 'logger'
 
 module Yake
   module Logger
-    attr_accessor :logger
+    attr_writer :logger
 
     def logger
       @logger ||= Yake.logger
@@ -27,17 +27,24 @@ module Yake
   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/support.rb

@@ -0,0 +1,39 @@
+require 'base64'
+require 'json'
+require 'time'
+
+class Hash
+  def encode64() to_json.encode64 end
+  def strict_encode64() to_json.strict_encode64 end
+  def symbolize_names() JSON.parse(to_json, symbolize_names: true) end
+  def to_form() URI.encode_www_form(self) end
+end
+
+class Integer
+  def days() hours * 24 end
+  def hours() minutes * 60 end
+  def minutes() seconds * 60 end
+  def seconds() self end
+  def utc() UTC.at(self) end
+end
+
+class String
+  def camel_case() split(/_/).map(&:capitalize).join end
+  def decode64() Base64.decode64(self) end
+  def encode64() Base64.encode64(self) end
+  def snake_case() gsub(/([a-z])([A-Z])/, '\1_\2').downcase end
+  def strict_decode64() Base64.strict_decode64(self) end
+  def strict_encode64() Base64.strict_encode64(self) end
+  def to_h_from_json(**params) JSON.parse(self, **params) end
+  def to_h_from_form() URI.decode_www_form(self).to_h end
+end
+
+class Symbol
+  def camel_case() to_s.camel_case.to_sym end
+  def snake_case() to_s.snake_case.to_sym end
+end
+
+class UTC < Time
+  def self.at(...) super.utc end
+  def self.now() super.utc end
+end

data/lib/yake/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Yake
-  VERSION = '0.4.1'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yake
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Alexander Mancevice
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-15 00:00:00.000000000 Z
+date: 2022-02-26 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -18,7 +18,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
-- LICENSE.txt
 - README.md
 - lib/yake.rb
 - lib/yake/api.rb
@@ -26,6 +25,7 @@ files:
 - lib/yake/dsl.rb
 - lib/yake/errors.rb
 - lib/yake/logger.rb
+- lib/yake/support.rb
 - lib/yake/version.rb
 homepage: https://github.com/amancevice/yake
 licenses:
@@ -39,14 +39,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.7.5
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Rake-like DSL for declaring AWS Lambda function handlers

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.