shark-on-lambda 0.0.0 → 0.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98f01b23b24cf2ba3b39241fbd06f8c007f06bd46cac36f7bed9c2e55a94b804
-  data.tar.gz: a3311630cb31d1bffac58fe45353a19e49530558a2ccdcf8f1026d6241c35ce1
+  metadata.gz: 44a4ee1f3d1628311fba41801df9dee659ebae05ad000992310f345248c26a16
+  data.tar.gz: 5b807fc9fe412d64b23c2eee28dd8462f7375302f6a71b89c99e2b023ebbb90a
 SHA512:
-  metadata.gz: ca6c0dd4f9be066778409ca6e89e216906e1e924bd39b403fdb7fce990ba898145bd0ac1f9f9e225840657f5094aa973a9f0a79f53fabb4593eebaf018ea9ad3
-  data.tar.gz: 6216f2cf31dde529ac2b9cae27f931089a54497486f69836bb76dd600cdcf7b5b1c15bb79a0ab7a3e5a97e5e5b5c68c94d29a2df494c17b756eb1904c49a2720
+  metadata.gz: 6e0d9987dce6c080ef81c9802df11c29c7e020a23a04e60c70b8c024add57ff8facead26ff82a8e6ead6b7029b3b491162aea23ac31d8ec1cbfbbbad45c186e6
+  data.tar.gz: 2d95aee2c8d0a82a8c53adeea24a77756f1e63f731653265983b56956105b00f9096e480747778daed50dd7ef1066a276d702d7de0e9662842e9a3a609129592

data/.gitignore

@@ -9,3 +9,8 @@
 
 # rspec failure tracking
 .rspec_status
+
+# Add gems to `vendor/cache`
+vendor/cache/*
+!vendor/cache/bima*.gem
+!vendor/cache/shark*.gem

data/.gitlab-ci.yml

@@ -0,0 +1,13 @@
+rspec:
+  image: ruby:2.5
+  script:
+    - gem install bundler
+    - bundle install
+    - bundle exec rake spec
+
+rubocop:
+  image: ruby:2.5
+  script:
+    - gem install bundler
+    - bundle install
+    - bundle exec rubocop

data/.rubocop.yml

@@ -1,3 +1,16 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+    - 'spec/factories/*.rb'
+
 Naming/FileName:
   Exclude:
     - lib/shark-on-lambda.rb
+    - spec/shark-on-lambda_spec.rb
+
+# TODO: Add documentation and remove the Style/Documentation exception.
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -3,5 +3,12 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.6.0
-before_install: gem install bundler -v 1.17.2
+  - 2.5.3
+
+install:
+  - gem install bundler
+  - bundle install
+
+script:
+  - bundle exec rake spec
+  - bundle exec rubocop

data/README.md

@@ -1,43 +1,209 @@
-# Shark::On::Lambda
+# shark-on-lambda
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/shark/on/lambda`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Travis CI Build Status](https://travis-ci.org/Skudo/shark-on-lambda.svg?branch=develop)](https://travis-ci.org/Skudo/shark-on-lambda)
+[![CodeClimate Maintainability Score](https://api.codeclimate.com/v1/badges/fb0c16b3c6212f97b753/maintainability)](https://codeclimate.com/github/Skudo/shark-on-lambda/maintainability)
 
-TODO: Delete this and the text above, and describe your gem
+`shark-on-lambda` provides a lightweight framework to write Ruby on AWS Lambda
+whilst using a familiar approach to web services known from e. g. Ruby on Rails.
+
+## History
+
+For a long time, "going serverless" on AWS Lambda was a world Ruby developers 
+only could explore using methods such as packing their own Ruby binaries,
+going the JRuby way, running on the Java VM, or using Ruby On Jets.
+
+When AWS went public with the Ruby 2.5 runtime for AWS Lambda at the end of 
+2018, that changed for Ruby developers and suddenly, a whole new world opened.
+
+Since it is possible to run any Rack-based application on AWS Lambda, you can
+even run your own Rails application there, if you want to.
+
+However, if you prefer a more lightweight solution, `shark-on-lambda` may be
+of interest to you, as it offers you a similar approach to things whilst
+maintaining a smaller memory footprint.
+
+## Changelog
+
+### Pre-1.0
+* Supports events from the API Gateway.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's `gems.rb`:
 
 ```ruby
-gem 'shark-on-lambda'
+gem 'shark_on_lambda'
 ```
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Or install it yourself:
 
-    $ gem install shark-on-lambda
+    $ gem install shark_on_lambda
 
-## Usage
+## Handlers
 
-TODO: Write usage instructions here
+Handlers are the entry points for Lambda function invocation, e. g. when they
+are triggered by HTTP requests on the API Gateway. They also are responsible for
+responding with a well-formed response to the caller.
 
-## Development
+```ruby
+class MyHandler < SharkOnLambda::ApiGateway::BaseHandler
+end
+```
 
-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.
+By inheriting from `SharkOnLambda::ApiGateway::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.
 
-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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+If you however bring your own class with a different name, you can configure
+your handler to use that controller instead:
 
-## Contributing
+```ruby
+class MyHandler < SharkOnLambda::ApiGateway::BaseHandler
+  self.controller_class = AnotherController
+end
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/shark-on-lambda. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+All controller methods are going to be automagically mapped to class methods
+on the handler class. 
+
+```ruby
+class MyController < SharkOnLambda::ApiGateway::BaseController
+  def index
+  end
+  
+  def show
+  end
+end
+
+class MyHandler < SharkOnLambda::ApiGateway::BaseHandler
+end
+```
+
+`MyHandler` will respond to `.index` and `.show` class methods that accept the
+`event` and `context` objects from the API Gateway. Those are passed to 
+`MyController` and eventually, the controller method that corresponds to the
+handler class method is called.
+
+## Controllers
+
+Controllers are similar to Rails controllers: In addition to having access to 
+the AWS Lambda `event` and `context` objects, you also have access to `params`, 
+`request`, and `response` objects that are derived from the `event` object.
+
+### "Basic" controllers
+
+You also have access to the `render` and `redirect_to` methods __that are not as
+powerful as the Rails equivalent by far__. There are none of the `render_*`
+functions you may know from Rails and `render` does not really support multiple
+renderers (yet).
+
+```ruby
+class MyController < SharkOnLambda::ApiGateway::BaseController
+  def index
+    # Make the API Gateway respond with a 201 response saying "Hello, World!"
+    # in the response body.
+    #
+    # The default status code for `render` is 200.    
+    render 'Hello, World!', status: 201
+  end
+  
+  def show
+    # Does what you think it does.
+    #
+    # The default status code for `redirect_to` is 307.    
+    redirect_to 'https://github.com', status: 302
+  end
+end
+```
 
-## License
+### _JSON API_-compliant controllers
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+If you inherit your controller from 
+`SharkOnLambda::ApiGateway::JsonapiController`, `render` and `redirect_to` will
+create _JSON API_-compliant responses.
+
+You however __must__ have a serialiser for the objects you want to render.
+Otherwise, rendering will fail and you will receive an _Internal Server Error_
+instead.
+
+_JSON API_ `fields` and `include` query string parameters are automagically
+being parsed and used for rendering automagically by the _JSON API_ renderer.
+
+## _JSON API_ serialisers
+
+We use `jsonapi-serializable` (and `jsonapi-rb` in general) for our
+_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
+  type :somethings
+  
+  attributes :foo, :bar, :baz
+end
+```
+
+### Serialiser lookup
+
+Each object that is to be serialised requires a serialiser class that knows
+how to serialise it. We also implemented a convention over configuration
+approach here to determine which serialiser class to use:
+
+1) If the object is an instance of `YourClass` and `YourClassSerializer` is
+   defined, `YourClassSerializer` is used as the serialiser class.
+   
+2) If the object is an instance of `YourClass` and `YourClassSerializer` is
+   __not__ defined, check whether 1) applies for any of the ancestors of
+   `YourClass`.   
+
+#### Example
+ 
+If `YourClass` has `YourBaseClass`, `Object`, and `BasicObject` as ancestor 
+classes, the first existing one of `YourClassSerializer`, 
+`YourBaseClassSerializer`, `ObjectSerializer`, and `BasicObjectSerializer` 
+(in that order) is used. If none of those exist, serialisation will fail with
+an _Internal Server Error_.
+
+## Configuration
+
+You can "initialise" `SharkOnLambda` using its `.initialize!` class method.
+
+`SharkOnLambda.initialize!` yields to a block with the `config` and `secrets`
+objects where you can access and add to those two objects.
+
+```ruby
+SharkOnLambda.initialize! do |config, secrets|
+  # Do things here.
+end
+```
+
+Calling `SharkOnLambda.initialize!` does these things (in order):
+
+1. Process the block passed to `.initialize!`.
+2. Load `config/settings.yml` and `config/settings.local.yml` into the
+   `config` object.
+3. Load `config/database.yml` and `config/database.local.yml` into
+   `config.database`.
+4. Load `config/secrets.yml` and `secrets/secrets.local.yml` into the
+   `secrets` object.
+5. Load all `config/initializers/*.rb` files.
+
+If `SharkOnLambda.config.stage` was set inside the block passed to
+`.initialize!`, configurations and secrets for that stage will be merged into
+the default set (the `default` node in the YAML files) of configuration and 
+secrets, overwriting values where applicable.
+
+## Development
 
-## Code of Conduct
+Clone this repository and change away. Then, once you are done, please submit
+a pull request at https://github.com/Skudo/shark-on-lambda/pulls.
 
-Everyone interacting in the Shark::On::Lambda project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/shark-on-lambda/blob/master/CODE_OF_CONDUCT.md).
+However, please make sure the tests (`bundle exec rake spec`) and `rubocop`
+(`bundle exec rubocop`) pass before submitting a pull request. Pull requests
+that do not pass both on the CI system will not be merged. On the same note,
+untested code will not be merged, either.

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/bin/console

@@ -1,14 +1,9 @@
 #!/usr/bin/env ruby
+#
+# frozen_string_literal: true
 
 require 'bundler/setup'
-require 'shark-on-lambda'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
 require 'irb'
+require 'shark_on_lambda'
+
 IRB.start(__FILE__)

data/changelog.md

@@ -0,0 +1,17 @@
+## Changelog
+
+#### 0.6.7
+
+- [Fix] Build 0.6.6 using the wrong branch.
+
+#### 0.6.6
+
+- [Fix] Handle the quirkiness of API Gateway query strings properly.
+
+#### 0.6.5
+
+- [Fix] Parse nested query string parameters correctly.
+
+#### 0.6.4
+
+- Initial public release.

data/gems.locked

@@ -0,0 +1,92 @@
+PATH
+  remote: .
+  specs:
+    shark-on-lambda (0.6.7)
+      activesupport
+      jsonapi-rb
+      rack
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.0)
+      activesupport (= 6.0.0)
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    ast (2.4.0)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    factory_bot (5.1.0)
+      activesupport (>= 4.2.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.3)
+    json (2.2.0)
+    jsonapi-deserializable (0.2.0)
+    jsonapi-rb (0.5.0)
+      jsonapi-deserializable (~> 0.2.0)
+      jsonapi-serializable (~> 0.3.0)
+    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)
+      ast (~> 2.4.0)
+    rack (2.0.7)
+    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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rubocop (0.74.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.0)
+    yard (0.9.20)
+    zeitwerk (2.1.10)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activemodel
+  bundler
+  factory_bot
+  rake
+  rspec
+  rubocop
+  shark-on-lambda!
+  simplecov
+  yard
+
+BUNDLED WITH
+   2.0.2

data/{Gemfile → gems.rb}

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-# Specify your gem's dependencies in shark-on-lambda.gemspec
 gemspec

data/lib/shark-on-lambda.rb

@@ -1,7 +1,3 @@
 # frozen_string_literal: true
 
-require 'shark-on-lambda/version'
-
-# Top-level module for this gem.
-module SharkOnLambda
-end
+require 'shark_on_lambda'