rack-shelf 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b938a108e6359907bc7bec04a69ddae9e81207a8c5c7aded0d189359ef9a29ec
+  data.tar.gz: 454922f5c0b22591dafccf73850b29aaef98909e46b4ad749298f7481d26e437
+SHA512:
+  metadata.gz: 63d4c509ea364e4ae94923f939eb051f107abee03145714d0a3cfad11512d18321d7b465763df0c27926f17db2480f1291574edd54a9f53c0faedb15334e1f49
+  data.tar.gz: 8e5aa94d9a2f057e25547b1652d4aba7043fa4684b3d034aa66cde63ca324c991a9ca19425943b176eb5b7ef882eb95128dfba9fb6caa07afa0c4943196595ca

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    rack-shelf (0.0.1)
+      rack
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    jaro_winkler (1.5.4)
+    parallel (1.19.1)
+    parser (2.7.0.4)
+      ast (~> 2.4.0)
+    rack (2.1.1)
+    rainbow (3.0.0)
+    rexml (3.2.4)
+    rubocop (0.80.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack-shelf!
+  rubocop (~> 0.80.1)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT LICENSE
+
+Copyright (c) 2020 Michael Miller <icy.arctic.fox@gmail.com>
+
+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.

data/README.md

@@ -0,0 +1,51 @@
+Rack Shelf
+==========
+
+Easily integrate a Rack application into AWS Lambda.
+
+Provides adapters to convert AWS Lambda events to Rack environment requests
+and Rack responses to AWS Lambda proxy integrations.
+
+Shelf currently works with API Gateway.
+
+Installation
+------------
+
+Add to your Gemfile:
+
+```ruby
+gem 'rack-shelf'
+```
+
+or gemspec:
+
+```ruby
+s.add_dependency 'rack-shelf'
+```
+
+Usage
+-----
+
+In your AWS Lambda handler file:
+
+```ruby
+require 'rack/shelf'
+
+class App
+  def call
+    [200, {}, 'Hello world!']
+  end
+end
+
+def handler(event:, context:)
+  Rack::Shelf.api_gateway(App.new, event, context)
+end
+```
+
+### Detailed Explanation
+
+The `#api_gateway` method indicates the Lambda is expected to be invoked by API Gateway.
+The method accepts three arguments: the Rack application, the Lambda event, and the Lambda context.
+Shelf will translate the Lambda information to a Rack environment instance and invoke `#call` on the application.
+It then takes the return value of `#call` (the three-element array) and translates it to a hash.
+That hash contains the expected keys and values for an AWS Lambda proxy integration.

data/lib/rack/shelf.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative 'shelf/api_gateway'
+require_relative 'shelf/base64_response_adapter'
+require_relative 'shelf/environment_builder'
+require_relative 'shelf/response_adapter'
+require_relative 'shelf/version'
+
+module Rack
+  # Adapts AWS Lambda event sources to Rack environments.
+  module Shelf
+    extend self
+
+    # Runs a Rack application, translating the request and response.
+    # This method assumes the Lambda event came from API Gateway.
+    # @param app [#call] Rack application to call.
+    # @param event [Hash] Lambda event hash.
+    # @param context [Object] Lambda context object.
+    # @return [Hash] AWS Lambda response.
+    def api_gateway(app, event, context)
+      run(APIGateway, ResponseAdapter, app, event, context)
+    end
+
+    # Runs a Rack application, translating the request and response.
+    # This method assumes the Lambda event came from API Gateway.
+    # The response body is encoded as base-64.
+    # @param app [#call] Rack application to call.
+    # @param event [Hash] Lambda event hash.
+    # @param context [Object] Lambda context object.
+    # @return [Hash] AWS Lambda response.
+    def api_gateway_base64(app, event, context)
+      run(APIGateway, Base64ResponseAdapter, app, event, context)
+    end
+
+    private
+
+    # Runs the app and translates the request and response.
+    # @param request_adapter [#env] Translates the Lambda event.
+    # @param response_adapter [#convert, #error] Translates the Rack response.
+    # @param app [#call] Rack application to call.
+    # @param event [Hash] Lambda event hash.
+    # @param context [Object] Lambda context object.
+    # @return [Hash] AWS Lambda response.
+    def run(request_adapter, response_adapter, app, event, context)
+      env      = request_adapter.env(event, context)
+      response = app.call(env)
+      response_adapter.convert(response)
+    rescue StandardError => e
+      response_adapter.error(e)
+    end
+  end
+end

data/lib/rack/shelf/api_gateway.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require_relative 'environment_builder'
+
+module Rack
+  module Shelf
+    # Converts AWS API Gateway events given to Lambda
+    # to Rack environment instances.
+    class APIGateway
+      # Produces a Rack compatible environment instance
+      # from a Lambda event and context.
+      # @param event [Hash] Event from the Lambda handler.
+      # @param context [Object] Context from the Lambda handler.
+      # @return [Hash] Rack environment.
+      def self.env(event, context)
+        new(event, context).build
+      end
+
+      # Creates an instance dedicated to building a Rack environment
+      # for a single event and context.
+      # @param event [Hash] Event from the Lambda handler.
+      # @param context [Object] Context from the Lambda handler.
+      def initialize(event, context)
+        @event   = event
+        @context = context
+        @builder = EnvironmentBuilder.new
+      end
+
+      # Builds the rack environment.
+      # @return [Hash] Rack environment.
+      def build
+        build_common
+        build_headers
+        build_body
+
+        builder.build
+      end
+
+      private
+
+      # Rack environment builder instance.
+      # @return [EnvironmentBuilder]
+      attr_reader :builder
+
+      # Event from the Lambda handler.
+      # @return [Hash]
+      attr_reader :event
+
+      # Context from the Lambda handler.
+      # @return [Object]
+      attr_reader :context
+
+      # Retrieves the HTTP headers from the Lambda event.
+      # @return [Hash] HTTP headers.
+      def headers
+        event['headers'] || {}
+      end
+
+      # Retrieves the HTTP request method from the Lambda event.
+      # @return [String] HTTP request method.
+      def request_method
+        event.fetch('httpMethod')
+      end
+
+      # Retrieves the path information, or a default value.
+      # @return [String]
+      def path_info
+        event['path'] || '/'
+      end
+
+      # Retrieves the query parameters from the Lambda event.
+      # @return [Hash]
+      def query_params
+        event['queryStringParameters'] || {}
+      end
+
+      # Retrieves the server hostname, or a default value.
+      # @return [String]
+      def server_name
+        event['Host'] || 'localhost'
+      end
+
+      # Retrieves the server port, or a default value.
+      # @return [Integer]
+      def server_port
+        event['X-Forwarded-Port'] || 80
+      end
+
+      # Retrieves the URL scheme, or a default value.
+      # @return [String]
+      def url_scheme
+        headers.fetch('CloudFront-Forwarded-Proto') do
+          headers.fetch('X-Forwarded-Proto', 'http')
+        end
+      end
+
+      # Configures common Rack environment attributes.
+      # @return [void]
+      def build_common # rubocop:disable Metrics/AbcSize
+        builder.request_method(request_method)
+        builder.path_info(path_info)
+        builder.query_params(query_params)
+        builder.server_name(server_name)
+        builder.server_port(server_port)
+        builder.url_scheme(url_scheme)
+      end
+
+      # Configures the HTTP request headers.
+      # @return [void]
+      def build_headers
+        headers.each do |key, value|
+          builder.header(key, value)
+        end
+      end
+
+      # Configures the client request body portion.
+      # @return [void]
+      def build_body
+        return unless (body = event['body'])
+
+        if event['isBase64Encoded']
+          builder.base64_body(body)
+        else
+          builder.body(body)
+        end
+      end
+    end
+  end
+end

data/lib/rack/shelf/base64_response_adapter.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'base64'
+require_relative 'response_adapter'
+
+module Rack
+  module Shelf
+    # Transforms a standard Rack response array
+    # to a return value required by AWS Lambda.
+    # Encodes the response body as base-64.
+    # This is typically used for sending binary data (not text).
+    class Base64ResponseAdapter < ResponseAdapter
+      # Constructs the AWS Lambda response.
+      # @return [Hash]
+      def build
+        super.merge('isBase64Encoded' => true)
+      end
+
+      private
+
+      # Constructs the response body encoded in base-64.
+      # @return [String]
+      def body
+        Base64.encode64(super)
+      end
+    end
+  end
+end

data/lib/rack/shelf/environment_builder.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+require 'base64'
+require 'rack'
+require 'stringio'
+
+module Rack
+  module Shelf
+    # Builds up a Rack env hash.
+    class EnvironmentBuilder
+      # Default values for the Rack environment.
+      DEFAULTS = {
+        'REQUEST_METHOD' => 'GET',
+        'SCRIPT_NAME' => '',
+        'PATH_INFO' => '/',
+        'QUERY_STRING' => '',
+        'SERVER_NAME' => 'localhost',
+        'SERVER_PORT' => '80',
+        'rack.version' => Rack::VERSION,
+        'rack.url_scheme' => 'http',
+        'rack.input' => StringIO.new,
+        'rack.errors' => $stderr,
+        'rack.multithread' => false,
+        'rack.multiprocess' => false,
+        'rack.run_once' => false,
+        'rack.hijack?' => false
+      }.freeze
+
+      # Creates the builder with reasonable defaults.
+      def initialize
+        @env = DEFAULTS.clone(freeze: false)
+      end
+
+      # Specifies the request method.
+      # @param method [String] Must be one of:
+      #   +GET+, +POST+, +PUT+, +HEAD+, +DELETE+, +PATCH+, or +OPTIONS+.
+      # @return [void]
+      def request_method(method)
+        @env['REQUEST_METHOD'] = method
+      end
+
+      # Specifies the name (or mounting point) of the application.
+      # @param name [String] Script name.
+      # @return [void]
+      def script_name(name)
+        @env['SCRIPT_NAME'] = name
+      end
+
+      # Specifies the path info (path after the mounting point).
+      # @param path [String] Path info.
+      # @return [void]
+      def path_info(path)
+        @env['PATH_INFO'] = path
+      end
+
+      # Specifies the entire query string.
+      # @param string [String] Pre-encoded query string.
+      # @return [void]
+      def query_string(string)
+        @env['QUERY_STRING'] = string
+      end
+
+      # Specifies the query parameters as a hash.
+      # @param params [Hash] Query parameters.
+      # @return [void]
+      def query_params(params)
+        string = Rack::Utils.build_query(params)
+        query_string(string)
+      end
+
+      # Specifies the hostname of the server.
+      # @param name [String] Server name.
+      # @return [void]
+      def server_name(name)
+        @env['SERVER_NAME'] = name
+      end
+
+      # Specifies the port the server is listening on.
+      # @param port [#to_s] Port number.
+      # @return [void]
+      def server_port(port)
+        @env['SERVER_PORT'] = port.to_s
+      end
+
+      # Specifies the URL scheme for the request.
+      # @param scheme [String] Must be: +http+ or +https+.
+      # @return [void]
+      def url_scheme(scheme)
+        @env['rack.url_scheme'] = scheme
+      end
+
+      # Specifies the stream used for input (request body).
+      # @param io [IO] Input stream.
+      # @return [void]
+      def input_stream(io)
+        @env['rack.input'] = io
+      end
+
+      # Specifies the client request body.
+      # @param content [String] Request body.
+      # @return [void]
+      def body(content)
+        io = StringIO.new(content)
+        input_stream(io)
+      end
+
+      # Specifies the client request body encoded in base-64.
+      # @param content [String] Base-64 encoded request body.
+      # @return [void]
+      def base64_body(content)
+        decoded = Base64.decode64(content)
+        body(decoded)
+      end
+
+      # Specifies the stream used to display errors.
+      # @param io [IO] Error stream.
+      # @return [void]
+      def error_stream(io)
+        @env['rack.errors'] = io
+      end
+
+      # Defines an HTTP header in the request.
+      # @param header [String] HTTP header name.
+      # @param value [String] Value of the HTTP header.
+      # @return [void]
+      def header(header, value)
+        name = header.upcase.gsub('-', '_')
+        key  = case name
+               when 'CONTENT_TYPE', 'CONTENT_LENGTH'
+                 name
+               else
+                 'HTTP_' + name
+               end
+
+        @env[key] = value
+      end
+
+      # Defines a custom application value.
+      # @param prefix [String] Prefix of the key.
+      # @param name [String] Name of the application key.
+      # @param value [Object] Value of the key.
+      # @return [void]
+      # @raise [ArgumentError] The prefix can't be +rack+.
+      def application(prefix, name, value)
+        raise ArgumentError, "Prefix can't be 'rack'" if prefix == 'rack'
+
+        key = [prefix, name].join('.')
+        @env[key] = value
+      end
+
+      # Creates the Rack env hash.
+      # @return [Hash]
+      def build
+        @env.clone
+      end
+    end
+  end
+end

data/lib/rack/shelf/response_adapter.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Rack
+  module Shelf
+    # Transforms a standard Rack response array
+    # to a return value required by AWS Lambda.
+    # @see https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html#api-gateway-simple-proxy-for-lambda-output-format
+    class ResponseAdapter
+      # Converts a Rack response to one supported by AWS Lambda.
+      # @param response [Array] Three-element array.
+      #   This is the standard response from a Rack application.
+      #   Must have the elements: status code, headers, and body.
+      # @return [Hash] AWS Lambda response.
+      # @see https://www.rubydoc.info/github/rack/rack/file/SPEC#label-The+Response
+      def self.convert(response)
+        new(*response).build
+      end
+
+      # Generates a Lambda response for an error.
+      # @param exception [Exception, #to_s] Caught exception.
+      # @param status_code [Integer] HTTP response code.
+      # @return [Hash] AWS Lambda response.
+      def self.error(exception, status_code = 500)
+        new(status_code, {}, exception.to_s).build
+      end
+
+      # Creates an adapter dedicated to processing one response.
+      # @param status_code [#to_i] HTTP status code.
+      # @param headers [#each] HTTP headers.
+      # @param body [#each] Response body.
+      def initialize(status_code, headers, body)
+        @status_code = status_code
+        @headers     = headers
+        @body        = body
+      end
+
+      # Constructs the AWS Lambda response.
+      # @return [Hash]
+      def build
+        {
+          'status_code' => status_code,
+          'headers' => headers,
+          'body' => body,
+          'isBase64Encoded' => false
+        }
+      end
+
+      private
+
+      # The integer HTTP status code.
+      # @return [Integer]
+      def status_code
+        @status_code.to_i
+      end
+
+      # Constructs the HTTP headers.
+      # @return [Hash]
+      def headers
+        # Typically, the headers are already a hash.
+        # But, the Rack Spec only requires the object to expose `#each`.
+        {}.tap do |hash|
+          @headers.each do |key, value|
+            hash[key] = value
+          end
+        end
+      end
+
+      # Constructs the response body.
+      # @return [String]
+      def body
+        StringIO.new.tap do |io|
+          @body.each do |part|
+            io.write(part)
+          end
+          @body.close if @body.respond_to?(:close)
+        end.string
+      end
+    end
+  end
+end

data/lib/rack/shelf/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rack
+  module Shelf
+    VERSION = '0.0.1'
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: rack-shelf
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Miller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.1
+description: Provides a translation for AWS Lambda events to Rack environments.
+email:
+- icy.arctic.fox@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- lib/rack/shelf.rb
+- lib/rack/shelf/api_gateway.rb
+- lib/rack/shelf/base64_response_adapter.rb
+- lib/rack/shelf/environment_builder.rb
+- lib/rack/shelf/response_adapter.rb
+- lib/rack/shelf/version.rb
+homepage: https://gitlab.com/arctic-fox/rack-shelf
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Adapts AWS Lambda event sources to Rack environments.
+test_files: []