Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/rubyonjets/jets

Ruby on Jets
https://github.com/rubyonjets/jets

aws awslambda jets lambda ruby rubyonjets serverless

Last synced: about 1 month ago
JSON representation

Ruby on Jets

Lists

README 

        


  




Ruby and Lambda had a baby and that child's name is [Jets](http://rubyonjets.com/).



![Build Status](https://codebuild.us-west-2.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiZ08vK2hjOHczQUVoUDhSYnBNNUU4T0gxQWJuOTlLaXpwVGQ1NjJ3NnVDY1dSdFVXQ3d2VXVSQzRFcU1qd1JPMndFZlByRktIcTUrZm5GWlM5dHpjM1ZrPSIsIml2UGFyYW1ldGVyU3BlYyI6Imluc1Qrd25GanhUdHlidjUiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master)

[![Gem Version](https://badge.fury.io/rb/jets.svg)](https://badge.fury.io/rb/jets)

[![Support](https://img.shields.io/badge/Support-Help-blue.svg)](http://rubyonjets.com/support/)



[![BoltOps Badge](https://img.boltops.com/boltops/badges/boltops-badge.png)](https://www.boltops.com)



Please **watch/star** this repo to help grow and support the project.



**Upgrading**: If you are upgrading Jets, please check on the [Upgrading Notes](http://rubyonjets.com/docs/extras/upgrading/).



## What is Ruby on Jets?



Jets is a Ruby Serverless Framework. Jets allows you to create serverless applications with a beautiful language: Ruby. It includes everything required to build and deploy an application to AWS Lambda.



Understanding AWS Lambda and API Gateway is key to understanding Jets conceptually. Jets map your code to Lambda functions and other AWS Resources like API Gateway and Event Rules.



* **AWS Lambda** is functions as a service. It allows you to upload and run functions without worrying about the underlying infrastructure.

* **API Gateway** is the routing layer for Lambda. It is used to route REST URL endpoints to Lambda functions.

* **EventBridge Rules** are events as a service. You can automatically run Lambda functions triggered from AWS services. You decide what events to catch and how to react to them.



The official documentation is at [Ruby on Jets](http://rubyonjets.com).



Refer to the official docs for more info, but here's a quick intro.



### Jets Functions



Jets supports writing AWS Lambda functions with Ruby. You define them in the `app/functions` folder. A function looks like this:



app/functions/simple.rb:



```ruby

def lambda_handler(event:, context:)

  puts "hello world"

  {hello: "world"}

end

```



Here's the function in the Lambda console:



![Code Example in AWS Lambda console](https://img.boltops.com/tools/jets/readme/simple-lambda-function.png)



Though simple functions are supported by Jets, they do not add as much value as other ways to write Ruby code with Jets. Classes like [Controllers](http://rubyonjets.com/docs/controllers/) and [Jobs](http://rubyonjets.com/docs/jobs/) add many conveniences and are more powerful to use. We’ll cover them next.



### Jets Controllers



A Jets controller handles a web request and renders a response. Here's an example:



app/controllers/posts_controller.rb:



```ruby

class PostsController < ApplicationController

  def index

    # renders Lambda Proxy structure compatible with API Gateway

    render json: {hello: "world", action: "index"}

  end



  def show

    id = params[:id] # params available

    # puts goes to the lambda logs

    puts event # raw lambda event available

    render json: {action: "show", id: id}

  end

end

```



Helper methods like `params` provide the parameters from the API Gateway event. The `render` method returns a Lambda Proxy structure that API Gateway understands.



Jets creates single Lambda functions to handle your Jets Controller requests. The Lambda Function handler is a shim that routes to your controller action.



### Jets Routing



You connect Lambda functions to API Gateway URL endpoints with a routes file:



config/routes.rb:



```ruby

Jets.application.routes.draw do

  resources :posts

  any "posts/hot", to: "posts#hot" # GET, POST, PUT, etc request all work

end

```



The `routes.rb` gets translated to API Gateway resources:



![API Gateway Resources generated from routes in AWS console](https://img.boltops.com/tools/jets/readme/apigw.png)



Test your API Gateway endpoints with curl or postman. Note, replace the URL endpoint with the one that is created:



    $ curl -s "https://quabepiu80.execute-api.us-east-1.amazonaws.com/dev/posts" | jq .

    {

      "hello": "world",

      "action": "index"

    }



### Jets Jobs



A Jets job handles asynchronous background jobs outside the web request/response cycle. Here's an example:



app/jobs/hard_job.rb:



```ruby

class HardJob < ApplicationJob

  rate "10 hours" # every 10 hours

  def dig

    puts "done digging"

  end



  cron "0 */12 * * ? *" # every 12 hours

  def lift

    puts "done lifting"

  end

end

```



![Jets Jobs in AWS Lambda Console](https://img.boltops.com/tools/jets/readme/jets-jobs.png)



`HardJob#dig` runs every 10 hours, and `HardJob#lift` runs every 12 hours. The `rate` and `cron` methods created CloudWatch Event Rules. Example:



![CloudWatch Event Rules in AWS Console](https://img.boltops.com/tools/jets/readme/jets-jobs-event-rules.png)



This simple example uses Scheduled Events. There are many more possibilities, see the [Events Docs](https://docs.rubyonjets.com/docs/events/).



### Jets Deployment



You can test your application with a local server that mimics API Gateway: [Jets Local Server](http://rubyonjets.com/docs/local-server/). Once ready, deploying to AWS Lambda is a single command.



    jets deploy



After deployment, you can test the Lambda functions with the AWS Lambda console or the CLI.



### Live Demos



Here are some demos of Jets applications:



* [Quintessential CRUD Jets app](https://demo.rubyonjets.com/)

* [API Demo](https://api.demo.rubyonjets.com/)

* [Image Upload with CarrierWave](https://upload.demo.rubyonjets.com/)



Please feel free to add your examples to the [rubyonjets/examples](https://github.com/rubyonjets/examples) repo.



### More Info



For more documentation, check out the official docs: [Ruby on Jets](http://rubyonjets.com/). Here's a list of useful links:



* [Quick Start](http://rubyonjets.com/quick-start/)

* [Local Jets Server](http://rubyonjets.com/docs/local-server/)

* [REPL Console](http://rubyonjets.com/docs/repl-console/)

* [Project Structure](http://rubyonjets.com/docs/structure/)

* [App Configuration](http://rubyonjets.com/docs/config/)

* [Database Support](http://rubyonjets.com/docs/database/)

* [Polymorphic Support](http://rubyonjets.com/docs/polymorphic/)

* [Rails Support](http://rubyonjets.com/docs/rails-support/)

* [Tutorials](http://rubyonjets.com/docs/tutorials/)

* [Prewarming](http://rubyonjets.com/docs/prewarming/)

* [Custom Resources](http://rubyonjets.com/docs/custom/)

* [Shared Resources](http://rubyonjets.com/docs/custom/shared-resources/)

* [Installation](http://rubyonjets.com/docs/install/)

* [CLI Reference](http://rubyonjets.com/reference/)

* [Contributing](http://rubyonjets.com/docs/more/contributing/)

* [Support Jets](http://rubyonjets.com/donate/)

* [Example Projects](https://github.com/tongueroo/jets-examples)



## Learning Content



* [Introducing Jets: A Ruby Serverless Framework](https://blog.boltops.com/2018/08/18/introducing-jets-a-ruby-serverless-framework)

* [Official AWS Ruby Support for Jets](https://blog.boltops.com/2018/12/12/official-aws-ruby-support-for-jets-serverless-framework)

* [Build an API with Jets](https://blog.boltops.com/2019/01/13/build-an-api-service-with-jets-ruby-serverless-framework)

* [Serverless Ruby Cron Jobs Tutorial: Route53 Backup](https://blog.boltops.com/2019/01/03/serverless-ruby-cron-jobs-with-jets-route53-backup)

* [Serverless Slack Commands: Fun with AWS Image Recognition](https://blog.boltops.com/2021/02/02/serverless-slack-commands-with-ruby)

* [Jets Afterburner: Rails Support](https://blog.boltops.com/2018/12/21/jets-afterburner-serverless-rails-on-aws-lambda-in-5-minutes)

* [Jets Mega Mode: Jets and Rails](https://blog.boltops.com/2018/11/03/jets-mega-mode-run-rails-on-aws-lambda)

* [Toronto Serverless Presentation](https://blog.boltops.com/2018/09/25/toronto-serverless-presentation-jets-framework-on-aws-lambda)

* [Jets Image Uploads Tutorial with CarrierWave](https://blog.boltops.com/2018/12/13/jets-image-upload-carrierwave-tutorial-binary-support)

* [Jets Tutorial An Introductory CRUD App Part 1](https://blog.boltops.com/2018/09/07/jets-tutorial-crud-app-introduction-part-1)

* [Jets Tutorial Deploy to AWS Lambda Part 2](https://blog.boltops.com/2018/09/08/jets-tutorial-deploy-to-aws-lambda-part-2)

* [Jets Tutorial Debugging Logs Part 3](https://blog.boltops.com/2018/09/09/jets-tutorial-debugging-logs-part-3)

* [Jets Tutorial Background Jobs Part 4](https://blog.boltops.com/2018/09/10/jets-tutorial-background-jobs-part-4)

* [Jets Tutorial IAM Policies Part 5](https://blog.boltops.com/2018/09/11/jets-tutorial-iam-policies-part-5)

* [Jets Tutorial Function Properties Part 6](https://blog.boltops.com/2018/09/12/jets-tutorial-function-properties-part-6)

* [Jets Tutorial Extra Environments Part 7](https://blog.boltops.com/2018/09/13/jets-tutorial-extra-environments-part-7)

* [Jets Tutorial Different Environments Part 8](https://blog.boltops.com/2018/09/26/jets-tutorial-different-environments-part-8)

* [Jets Tutorial Polymorphic Support Part 9](https://blog.boltops.com/2018/09/27/jets-tutorial-polymorphic-support-part-9)

* [Jets Delete Tutorial](https://blog.boltops.com/2018/11/12/jets-tutorial-jets-delete)