base on Fast web framework compatible with Rails. <p align="center"><img height="200" src="https://github.com/rage-rb/rage/assets/2270393/9d06e0a4-5c20-49c7-b51d-e16ce8f1e1b7" /></p> # Rage [](https://badge.fury.io/rb/rage-rb)   Inspired by [Deno](https://deno.com) and built on top of [Iodine](https://github.com/rage-rb/iodine), this is a Ruby web framework that is based on the following design principles: * **Rails compatible API** - Rails' API is clean, straightforward, and simply makes sense. It was one of the reasons why Rails was so successful in the past. * **High performance** - some think performance is not a major metric for a framework, but it's not true. Poor performance is a risk, and in today's world, companies refuse to use risky technologies. * **API-only** - separation of concerns is one of the most fundamental principles in software development. Backend and frontend are very different layers with different goals and paths to those goals. Separating BE code from FE code results in a much more sustainable architecture compared with classic Rails monoliths. * **Acceptance of modern Ruby** - the framework includes a fiber scheduler, which means your code never blocks while waiting on I/O. ## Installation Install the gem: ``` $ gem install rage-rb ``` Create a new app: ``` $ rage new my_app ``` Switch to your new application and install dependencies: ``` $ cd my_app $ bundle ``` Start up the server and visit http://localhost:3000. ``` $ rage s ``` Start coding! ## Getting Started This gem is designed to be a drop-in replacement for Rails in API mode. Public API is expected to fully match Rails. A Rage application can operate in two modes: * **Rails Mode**: Integrate Rage into an existing Rails application to improve throughput and better handle traffic spikes. For more information, see [Rails Integration](https://github.com/rage-rb/rage/wiki/Rails-integration). * **Standalone Mode**: Build high-performance services with minimal setup using Rage. To get started, run `rage new --help` for more details. Check out in-depth API docs for more information: - [Controller API](https://rage-rb.pages.dev/RageController/API) - [Routing API](https://rage-rb.pages.dev/Rage/Router/DSL/Handler) - [Fiber API](https://rage-rb.pages.dev/Fiber) - [Logger API](https://rage-rb.pages.dev/Rage/Logger) - [Configuration API](https://rage-rb.pages.dev/Rage/Configuration) - [CORS middleware](https://rage-rb.pages.dev/Rage/Cors) Also, see the following integration guides: - [Rails integration](https://github.com/rage-rb/rage/wiki/Rails-integration) - [RSpec integration](https://github.com/rage-rb/rage/wiki/RSpec-integration) - [WebSockets guide](https://github.com/rage-rb/rage/wiki/WebSockets-guide) If you are a first-time contributor, make sure to check the [overview doc](https://github.com/rage-rb/rage/blob/master/OVERVIEW.md) that shows how Rage's core components interact with each other. ### Example A sample controller could look like this: ```ruby require "net/http" class PagesController < RageController::API rescue_from SocketError do |_| render json: { message: "error" }, status: 500 end before_action :set_metadata def show page = Net::HTTP.get(URI("https://httpbin.org/json")) render json: { page: page, metadata: @metadata } end private def set_metadata @metadata = { format: "json", time: Time.now.to_i } end end ``` Apart from `RageController::API` as a parent class, this is mostly a regular Rails controller. However, the main difference is under the hood - Rage runs every request in a separate fiber. During the call to `Net::HTTP.get`, the fiber is automatically paused, enabling the server to process other requests. Once the HTTP request is finished, the fiber will be resumed, potentially allowing to process hundreds of requests simultaneously. To make this controller work, we would also need to update `config/routes.rb`. In this case, the file would look the following way: ```ruby Rage.routes.draw do get "page", to: "pages#show" end ``` :information_source: **Note**: Rage will automatically pause a fiber and continue to process other fibers on HTTP, PostgreSQL, and MySQL calls. Calls to `Thread.join` and `Ractor.join` will also automatically pause the current fiber. Additionally, `Fiber.await` can be used to run several requests in parallel: ```ruby require "net/http" class PagesController < RageController::API def index pages = Fiber.await([ Fiber.schedule { Net::HTTP.get(URI("https://httpbin.org/json")) }, Fiber.schedule { Net::HTTP.get(URI("https://httpbin.org/html")) }, ]) render json: { pages: pages } end end ``` :information_source: **Note**: When using `Fiber.await`, it is important to wrap every argument into a fiber using `Fiber.schedule`. ## Benchmarks #### Hello World ```ruby class BenchmarksController < ApplicationController def index render json: { hello: "world" } end end ```  #### Waiting on I/O ```ruby require "net/http" class BenchmarksController < ApplicationController def index Net::HTTP.get(URI("<endpoint-that-responds-in-one-second>")) head :ok end end ```  #### Using ActiveRecord ```ruby class BenchmarksController < ApplicationController def show render json: World.find(rand(1..10_000)) end end ```  ## Upcoming releases Status | Changes -- | ------------ :white_check_mark: | ~~Gem configuration by env.<br>Add `skip_before_action`.<br>Add `rescue_from`.<br>Router updates:<br>&emsp;• make the `root` helper work correctly with `scope`;<br>&emsp;• support the `defaults` option;~~ :white_check_mark: | ~~CLI updates:<br>&emsp;• `routes` task;<br>&emsp;• `console` task;<br>Support the `:if` and `:unless` options in `before_action`.<br>Allow to set response headers.~~ :white_check_mark: | ~~Expose the `params` object.<br>Support header authentication with `authenticate_with_http_token`.<br>Router updates:<br>&emsp;• add the `resources` route helper;<br>&emsp;• add the `namespace` route helper;~~ :white_check_mark: | ~~Add request logging.~~ :white_check_mark: | ~~Automatic code reloading in development with Zeitwerk.~~ :white_check_mark: | ~~Support conditional get with `etag` and `last_modified`.~~ :white_check_mark: | ~~Expose the `cookies` and `session` objects.~~ :white_check_mark: | ~~Implement Iodine-based equivalent of Action Cable.~~ ⏳ | Expose the `send_data` and `send_file` methods. ## Development 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. 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). ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/rage-rb/rage. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/rage-rb/rage/blob/master/CODE_OF_CONDUCT.md). ## License The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). ## Code of Conduct Everyone interacting in the Rage project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rage-rb/rage/blob/master/CODE_OF_CONDUCT.md). ", Assign "at most 3 tags" to the expected json: {"id":"2985","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"