shark-on-lambda 0.6.10 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6436ab76f14afebb7ef7601936489cd9304db7f6591db4262f29b76f1561cfd0
-  data.tar.gz: eab44e17a31afc1933b6be70401b89f0d935c49871e65dfd6edc69c5e5334580
+  metadata.gz: 9de95366ac135aebf072c6ecdbb5cae42b25f072bffdd1e01bee446e8262f17b
+  data.tar.gz: a09d5288e281447de50cfbbd8f97a18c023d9750e5d5b5ab456f4d6187b229a6
 SHA512:
-  metadata.gz: '08b36668e651e1448a6075990c11682188819cd45c0a654d4f1798ceafca83a2f7af52be9c25e49d6104820ff55c5bbdfb5d50751c6201d44378deb63d38a0c6'
-  data.tar.gz: '08b8b93027da580a481c9f7ea91de8b0ef488dd4096a9ab7430f6939b2b4238d40987a822d005d9f7e111de36bb58c1227d0407d063d593d54b5313392d9670a'
+  metadata.gz: 9643f2cb448d20396f43ab9fd124e0aca1ae436773f1b29626ce44a644f12f6bd1477deb5c468a30b1992d824d1bf6049f8340705c11dde6a65432f1104bba38
+  data.tar.gz: '09d2eb6a2ffb09b969f3cd383a0f9a19ee6bd68fbf32b37ba1fc0acab488144dcf38d516788b421b601158d390e4eee162500c65efcb25e89f979ac4bb487c21'

data/.github/workflows/push-gem.yml

@@ -0,0 +1,67 @@
+name: Push Gem
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Set up Ruby 2.5
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.5.x
+      - name: Run RSpec
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rspec
+
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Set up Ruby 2.5
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.5.x
+      - name: Run rubocop
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rubocop
+
+  push-gem:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - name: Set up Ruby 2.5
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.5.x
+      - name: Build gem
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rake build
+      - name: Push to GitHub Package Repository
+        run: |
+          mkdir -p $HOME/.gem
+          echo ":github: Bearer $GEM_HOST_API_KEY" >> $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          bundle exec rake build
+          gem push --key github --host https://rubygems.pkg.github.com/Skudo pkg/`ls -1t pkg | head -1`
+        env:
+          GEM_HOST_API_KEY: ${{secrets.GITHUB_AUTH_TOKEN}}
+          OWNER: username
+      - name: Push to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          echo ":rubygems_api_key: $GEM_HOST_API_KEY" >> ~/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          bundle exec rake build
+          gem push pkg/`ls -1t pkg | head -1`
+        env:
+          GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/.github/workflows/tests.yml

@@ -0,0 +1,32 @@
+name: Tests
+
+on: [push]
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Set up Ruby 2.5
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.5.x
+      - name: Run RSpec
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rspec
+
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Set up Ruby 2.5
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.5.x
+      - name: Run rubocop
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rubocop

data/README.md

@@ -1,6 +1,5 @@
 # shark-on-lambda
-
-[![Travis CI Build Status](https://travis-ci.org/Skudo/shark-on-lambda.svg?branch=develop)](https://travis-ci.org/Skudo/shark-on-lambda)
+[![GitHub Actions Test Status](https://github.com/Skudo/shark-on-lambda/workflows/Tests/badge.svg?branch=develop)](https://github.com/Skudo/shark-on-lambda/actions)
 [![CodeClimate Maintainability Score](https://api.codeclimate.com/v1/badges/fb0c16b3c6212f97b753/maintainability)](https://codeclimate.com/github/Skudo/shark-on-lambda/maintainability)
 
 `shark-on-lambda` provides a lightweight framework to write Ruby on AWS Lambda
@@ -24,8 +23,7 @@ maintaining a smaller memory footprint.
 
 ## Changelog
 
-### Pre-1.0
-* Supports events from the API Gateway.
+Have a look at the [actual changelog](changelog.md).
 
 ## Installation
 
@@ -50,11 +48,11 @@ are triggered by HTTP requests on the API Gateway. They also are responsible for
 responding with a well-formed response to the caller.
 
 ```ruby
-class MyHandler < SharkOnLambda::ApiGateway::BaseHandler
+class MyHandler < SharkOnLambda::BaseHandler
 end
 ```
 
-By inheriting from `SharkOnLambda::ApiGateway::BaseHandler`, your own handler
+By inheriting from `SharkOnLambda::BaseHandler`, your own handler
 class is indirectly tied to your controller class by convention: It assumes 
 the controller name is `MyController` and it will dispatch events to that
 controller.
@@ -63,7 +61,7 @@ If you however bring your own class with a different name, you can configure
 your handler to use that controller instead:
 
 ```ruby
-class MyHandler < SharkOnLambda::ApiGateway::BaseHandler
+class MyHandler < SharkOnLambda::BaseHandler
   self.controller_class = AnotherController
 end
 ```
@@ -72,7 +70,7 @@ All controller methods are going to be automagically mapped to class methods
 on the handler class. 
 
 ```ruby
-class MyController < SharkOnLambda::ApiGateway::BaseController
+class MyController < SharkOnLambda::BaseController
   def index
   end
   
@@ -80,7 +78,7 @@ class MyController < SharkOnLambda::ApiGateway::BaseController
   end
 end
 
-class MyHandler < SharkOnLambda::ApiGateway::BaseHandler
+class MyHandler < SharkOnLambda::BaseHandler
 end
 ```
 
@@ -103,7 +101,7 @@ functions you may know from Rails and `render` does not really support multiple
 renderers (yet).
 
 ```ruby
-class MyController < SharkOnLambda::ApiGateway::BaseController
+class MyController < SharkOnLambda::BaseController
   def index
     # Make the API Gateway respond with a 201 response saying "Hello, World!"
     # in the response body.
@@ -124,7 +122,7 @@ end
 ### _JSON API_-compliant controllers
 
 If you inherit your controller from 
-`SharkOnLambda::ApiGateway::JsonapiController`, `render` and `redirect_to` will
+`SharkOnLambda::JsonapiController`, `render` and `redirect_to` will
 create _JSON API_-compliant responses.
 
 You however __must__ have a serialiser for the objects you want to render.
@@ -141,7 +139,7 @@ _JSON API_ compatibility. Therefore, we expect the serialisers to be inherited
 from `::JSONAPI::Serializable::Resource` (or `::JSONAPI::Serializable::Error`).
 
 ```ruby
-class SomethingSerializer < ::JSONAPI::Serializable::Resource
+class SomethingSerializer < JSONAPI::Serializable::Resource
   type :somethings
   
   attributes :foo, :bar, :baz

data/changelog.md

@@ -1,5 +1,16 @@
 ## Changelog
 
+#### Unreleaesed
+
+- [Break] HTTP redirection now uses the status code `302`.
+- [Break] Remove the `ApiGateway` namespace, move all items from that namespace up by one level.
+- [Break] Remove build rake tasks.
+- Added support for Rack-compatible middleware. 
+- `SharkOnLambda::BaseController` now acts more like `ActionController::BaseController`.
+- Support `ActiveModel::Errors` nested validation errors.
+- Added `SharkOnLambda::RSpec::Helpers` and `SharkOnLambda::RSpec::JsonapiHelpers`.
+- Moved to GitHub.
+
 #### 0.6.10
 
 - Upgrade `rack` for good measure.

data/gems.locked

@@ -1,14 +1,29 @@
 PATH
   remote: .
   specs:
-    shark-on-lambda (0.6.10)
+    shark-on-lambda (1.0.0.rc1)
+      actionpack
       activesupport
       jsonapi-rb
-      rack (>= 2.0.8)
+      rack (>= 2.0.8, < 3)
+      zeitwerk (~> 2.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actionpack (6.0.0)
+      actionview (= 6.0.0)
+      activesupport (= 6.0.0)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.0.0)
+      activesupport (= 6.0.0)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
     activemodel (6.0.0)
       activesupport (= 6.0.0)
     activesupport (6.0.0)
@@ -18,14 +33,23 @@ GEM
       tzinfo (~> 1.1)
       zeitwerk (~> 2.1, >= 2.1.8)
     ast (2.4.0)
+    builder (3.2.4)
+    byebug (11.0.1)
+    coderay (1.1.2)
+    colorize (0.8.1)
     concurrent-ruby (1.1.5)
+    crass (1.0.6)
     diff-lcs (1.3)
     docile (1.3.2)
-    factory_bot (5.1.0)
+    erubi (1.9.0)
+    factory_bot (5.1.1)
       activesupport (>= 4.2.0)
-    i18n (1.6.0)
+    fasterer (0.8.2)
+      colorize (~> 0.7)
+      ruby_parser (>= 3.14.1)
+    i18n (1.7.0)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.3)
+    jaro_winkler (1.5.4)
     json (2.2.0)
     jsonapi-deserializable (0.2.0)
     jsonapi-rb (0.5.0)
@@ -34,27 +58,47 @@ GEM
     jsonapi-renderer (0.2.2)
     jsonapi-serializable (0.3.1)
       jsonapi-renderer (~> 0.2.0)
-    minitest (5.12.0)
-    parallel (1.17.0)
-    parser (2.6.4.1)
+    loofah (2.4.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    minitest (5.13.0)
+    nokogiri (1.10.8)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.18.0)
+    parser (2.6.5.0)
       ast (~> 2.4.0)
-    rack (2.0.8)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rack (2.2.2)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
     rainbow (3.0.0)
     rake (13.0.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    rubocop (0.74.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.76.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.6)
@@ -62,6 +106,9 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.1)
+    ruby_parser (3.14.2)
+      sexp_processor (~> 4.9)
+    sexp_processor (4.14.1)
     simplecov (0.17.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
@@ -72,7 +119,7 @@ GEM
       thread_safe (~> 0.1)
     unicode-display_width (1.6.0)
     yard (0.9.20)
-    zeitwerk (2.1.10)
+    zeitwerk (2.2.1)
 
 PLATFORMS
   ruby
@@ -81,6 +128,9 @@ DEPENDENCIES
   activemodel
   bundler
   factory_bot
+  fasterer
+  pry
+  pry-byebug
   rake
   rspec
   rubocop
@@ -89,4 +139,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.1.2
+   2.1.4

data/lib/shark_on_lambda/api_gateway_handler.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module SharkOnLambda
+  class ApiGatewayHandler
+    class << self
+      attr_writer :controller_class_name
+
+      def controller_action?(action)
+        controller_actions.include?(action.to_sym)
+      end
+
+      def controller_class_name
+        return @controller_class_name if defined?(@controller_class_name)
+
+        name_inferrer = Inferrers::NameInferrer.from_handler_name(name)
+        @controller_class_name = name_inferrer.controller
+      end
+
+      private
+
+      def controller_actions
+        return [] if controller_class.nil?
+
+        controller_class.public_instance_methods(false)
+      end
+
+      def controller_class
+        controller_class_name.safe_constantize
+      end
+
+      def method_missing(action, *args, &_block)
+        return super unless respond_to_missing?(action)
+
+        new.call(action, *args)
+      end
+
+      def respond_to_missing?(name, _include_all = false)
+        controller_action?(name)
+      end
+    end
+
+    attr_reader :application, :env
+    delegate :context, :event, to: :adapter
+
+    def initialize
+      @application = Application.new
+    end
+
+    def call(action, event:, context:)
+      raise NoMethodError unless self.class.controller_action?(action)
+
+      adapter = RackAdapters::ApiGateway.new(context: context, event: event)
+      env = adapter.env
+      env['shark.controller'] = self.class.controller_class_name
+      env['shark.action'] = action.to_s
+
+      status, headers, body = @application.call(env)
+      adapter.build_response(status, headers, body)
+    end
+  end
+end

data/lib/shark_on_lambda/application.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SharkOnLambda
+  class Application
+    def call(env)
+      dup.send('_call', env)
+    end
+
+    private
+
+    def _call(env)
+      dispatcher = SharkOnLambda.config.dispatcher
+      middleware_stack = SharkOnLambda.config.middleware.build(dispatcher)
+      middleware_stack.call(env)
+    end
+  end
+end

data/lib/shark_on_lambda/base_controller.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module SharkOnLambda
+  class BaseController < ActionController::Metal
+    EXCLUDED_MODULES = [
+      AbstractController::Translation,
+      AbstractController::AssetPaths,
+
+      ActionController::UrlFor,
+      ActionController::ConditionalGet,
+      ActionController::EtagWithTemplateDigest,
+      ActionController::EtagWithFlash,
+      ActionController::Caching,
+      ActionController::MimeResponds,
+      ActionController::ImplicitRender,
+      ActionController::Cookies,
+      ActionController::Flash,
+      ActionController::FormBuilder,
+      ActionController::RequestForgeryProtection,
+      ActionController::ContentSecurityPolicy,
+      ActionController::ForceSSL,
+      ActionController::HttpAuthentication::Basic::ControllerMethods,
+      ActionController::HttpAuthentication::Digest::ControllerMethods,
+      ActionController::HttpAuthentication::Token::ControllerMethods,
+      ActionView::Layouts
+    ].freeze
+    ActionController::Base.without_modules(EXCLUDED_MODULES).each do |mod|
+      include mod
+    end
+
+    def self.dispatch(*)
+      super
+    rescue AbstractController::ActionNotFound,
+           AbstractController::DoubleRenderError,
+           ActionController::ActionControllerError => e
+      raise Errors[500], e.message
+    end
+
+    def redirect_to(*)
+      super
+      self.response_body = '' if no_body?
+    end
+
+    private
+
+    def no_body?
+      response.status.in?(Response::NO_CONTENT_CODES)
+    end
+  end
+end

data/lib/shark_on_lambda/configuration.rb

@@ -4,7 +4,7 @@ module SharkOnLambda
   class Configuration < OpenStruct
     include Concerns::ResettableSingleton
 
-    attr_writer :stage
+    attr_writer :dispatcher, :stage
 
     class << self
       include Concerns::YamlConfigLoader
@@ -56,6 +56,14 @@ module SharkOnLambda
       end
     end
 
+    def dispatcher
+      @dispatcher ||= Dispatcher.new
+    end
+
+    def middleware
+      @middleware ||= ActionDispatch::MiddlewareStack.new
+    end
+
     def root
       @root ||= Pathname.new('.')
     end

data/lib/shark_on_lambda/dispatcher.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module SharkOnLambda
+  class Dispatcher
+    def call(env)
+      request = Request.new(env)
+      response = Response.new
+
+      controller = controller_class(env)
+      action = controller_action(env)
+      controller.dispatch(action, request, response)
+
+      response.prepare!
+    end
+
+    private
+
+    def controller_action(env)
+      env['shark.action']
+    end
+
+    def controller_class(env)
+      env['shark.controller'].camelize.constantize
+    end
+  end
+end

data/lib/shark_on_lambda/errors/base.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module SharkOnLambda
+  module Errors
+    class Base < StandardError
+      attr_accessor :id, :code, :meta, :pointer, :parameter
+      attr_writer :detail
+
+      def self.status(status_code)
+        define_method :status do
+          status_code
+        end
+      end
+
+      def detail
+        return @detail if @detail.present?
+        return nil if message == self.class.name
+
+        message
+      end
+
+      def title
+        Rack::Utils::HTTP_STATUS_CODES[status]
+      end
+    end
+
+    def self.[](status_code)
+      @errors[status_code]
+    end
+
+    @errors = Rack::Utils::HTTP_STATUS_CODES.map do |status_code, message|
+      next unless (400..599).cover?(status_code) && message.present?
+
+      error_class = Class.new(Base) do
+        status status_code
+      end
+      class_name_parts = message.to_s.split(/\s+/)
+      class_name_parts.map! { |word| word.gsub(/[^a-z]/i, '').capitalize }
+      class_name = class_name_parts.join('')
+      const_set(class_name, error_class)
+
+      [status_code, error_class]
+    end
+    @errors.compact!
+    @errors = @errors.to_h
+  end
+end

data/lib/shark_on_lambda/errors/base_serializer.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SharkOnLambda
+  module Errors
+    class BaseSerializer < JSONAPI::Serializable::Error
+      id { @object.id }
+      status { @object.status }
+      code { @object.code }
+      title { @object.title }
+      detail { @object.detail }
+      meta { @object.meta }
+      source do
+        pointer @object.pointer if @object.pointer.present?
+        parameter @object.parameter if @object.parameter.present?
+      end
+    end
+  end
+end

data/lib/shark_on_lambda/jsonapi_controller.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module SharkOnLambda
+  class JsonapiController < BaseController
+    ActionController::Renderers.add :jsonapi do |object, options|
+      response.set_header('content-type', 'application/vnd.api+json')
+      return { data: {} }.to_json if object.nil?
+
+      jsonapi_params = JsonapiParameters.new(params)
+      jsonapi_renderer = JsonapiRenderer.new
+      render_options = jsonapi_params.to_h.deep_merge(options)
+
+      jsonapi_renderer.render(object, render_options)
+    end
+
+    def redirect_to(options = {}, response_status = {})
+      super
+      return if response_status[:status] == 304
+
+      self.response_body = { data: {} }.to_json
+    end
+
+    def render(object, options = {})
+      options.merge!(jsonapi: object, content_type: 'application/vnd.api+json')
+
+      super(options)
+    end
+  end
+end