rage-rb 1.6.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39c84f49894f7ae6e8c53e78d5c84eef65885c15f3ad7d6469458a79dba6e691
-  data.tar.gz: 3a8b37eb48370a2a63c1b78f09417013f60593cdbcf0385958dd495ce35e494c
+  metadata.gz: 4adc4048bfa84558a6b86b15cbcab8e6153858878425bde66db78a975fa46f46
+  data.tar.gz: 46bef9f42fdd681bdf593f037a73ca8ae2d435acad9eed5ddf4b3740bf61b601
 SHA512:
-  metadata.gz: 8db258b1f23a58def4118ca0bdb1efcf6534ff03362ac82c45ded5276c90ab42809e007a9d7f72972dc8fd2597ac5eab2bbfaf27d6efb38a3857b1133fdbecde
-  data.tar.gz: eb7a5910f52399ff67bc0bc4078fcc970e023fcc038dc65dd16b19e17afa902a95a7c1b62cca7f61a5f5e38ba45702dc2a314ef841868fd7cf40289a65a0fe0f
+  metadata.gz: 754b954d46d065020e0c2184c04f1a13d0c0a64ddf11d1b034062df4cc669460c259032a8bf40a61c876579f1774e50e9b57181d4d3e1301c4610577e11c6734
+  data.tar.gz: 4207556922f8fd2c82d07ba8664f53847dc1e5afb6bb5d38260ac0ccd428dd011fd8c6bf34f69aa75af97044a838df23c6c36b5baae1ae7cd3d4c08455fc699b

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 ## [Unreleased]
 
+## [1.8.0] - 2024-08-06
+
+### Added
+
+- Support WebSockets (#88).
+
+## [1.7.0] - 2024-07-30
+
+### Added
+
+- Support `wrap_parameters` by [@alex-rogachev](https://github.com/alex-rogachev) (#89).
+- Unknown environment error handling by [@cuneyter](https://github.com/cuneyter) (#95).
+- Allow `rescue_from` handlers to not accept arguments (#93).
+
 ## [1.6.0] - 2024-07-15
 
 ### Added

data/Gemfile

@@ -8,12 +8,15 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "rspec", "~> 3.0"
-gem "http"
 gem "yard"
+gem "rubocop", "~> 1.65", require: false
 
-gem "pg"
-gem "mysql2"
-gem "connection_pool", "~> 2.0"
-
-gem "rbnacl"
-gem "domain_name"
+group :test do
+  gem "http"
+  gem "pg"
+  gem "mysql2"
+  gem "connection_pool", "~> 2.0"
+  gem "rbnacl"
+  gem "domain_name"
+  gem "websocket-client-simple"
+end

data/OVERVIEW.md

@@ -31,7 +31,7 @@ class UsersController < RageController::API
 end
 ```
 
-Before processing requests to `UsersController#show`, Rage has to [register](https://github.com/rage-rb/rage/blob/master/lib/rage/controller/api.rb#L10) the show action. Registering means defining a new method that will look like this:
+Before processing requests to `UsersController#show`, Rage has to [register](https://github.com/rage-rb/rage/blob/master/lib/rage/controller/api.rb#L11) the show action. Registering means defining a new method that will look like this:
 
 ```ruby
 class UsersController

data/README.md

@@ -15,7 +15,7 @@ Inspired by [Deno](https://deno.com) and built on top of [Iodine](https://github
 
 * **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 IO.
+* **Acceptance of modern Ruby** - the framework includes a fiber scheduler, which means your code never blocks while waiting on I/O.
 
 ## Installation
 
@@ -44,7 +44,7 @@ Start coding!
 
 ## Getting Started
 
-This gem is designed to be a drop-in replacement for Rails in API mode. Public API is mostly expected to match Rails, however, sometimes it's a little bit more strict.
+This gem is designed to be a drop-in replacement for Rails in API mode. Public API is expected to fully match Rails.
 
 Check out in-depth API docs for more information:
 
@@ -60,6 +60,8 @@ 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)
 
+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:
@@ -116,34 +118,48 @@ class PagesController < RageController::API
 end
 ```
 
-:information_source: **Note**: When using `Fiber.await`, it is important to wrap any instance of IO into a fiber using `Fiber.schedule`.
+:information_source: **Note**: When using `Fiber.await`, it is important to wrap every argument into a fiber using `Fiber.schedule`.
 
 ## Benchmarks
 
-#### hello world
+#### Hello World
 
 ```ruby
-class ArticlesController < ApplicationController
+class BenchmarksController < ApplicationController
   def index
     render json: { hello: "world" }
   end
 end
 ```
-![Requests per second](https://github.com/rage-rb/rage/assets/2270393/6c221903-e265-4c94-80e1-041f266c8f47)
 
-#### waiting on IO
+![Requests per second](https://github.com/user-attachments/assets/a7f864ae-0dfb-4628-a420-265a10d8591d)
+
+#### Waiting on I/O
 
 ```ruby
 require "net/http"
 
-class ArticlesController < ApplicationController
+class BenchmarksController < ApplicationController
   def index
     Net::HTTP.get(URI("<endpoint-that-responds-in-one-second>"))
     head :ok
   end
 end
 ```
-![Time to complete 100 requests](https://github.com/rage-rb/rage/assets/2270393/007044e9-efe0-4675-9cab-8a4868154118)
+
+![Time to complete 100 requests](https://github.com/user-attachments/assets/4f4feda3-bd88-43d8-8999-268534c2f9de)
+
+#### Using ActiveRecord
+
+```ruby
+class BenchmarksController < ApplicationController
+  def show
+    render json: World.find(rand(10_000))
+  end
+end
+```
+
+![Requests per second](https://github.com/user-attachments/assets/04678788-0034-4db4-9582-d0bc16fd9e28)
 
 ## Upcoming releases
 

data/lib/rage/all.rb

@@ -26,6 +26,7 @@ require_relative "logger/text_formatter"
 require_relative "logger/json_formatter"
 require_relative "logger/logger"
 
+require_relative "middleware/origin_validator"
 require_relative "middleware/fiber_wrapper"
 require_relative "middleware/cors"
 require_relative "middleware/reloader"

data/lib/rage/cable/cable.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module Rage::Cable
+  # Create a new Cable application.
+  #
+  # @example
+  #   map "/cable" do
+  #     run Rage.cable.application
+  #   end
+  def self.application
+    protocol = Rage.config.cable.protocol
+    protocol.init(__router)
+
+    handler = __build_handler(protocol)
+    accept_response = [0, protocol.protocol_definition, []]
+
+    application = ->(env) do
+      if env["rack.upgrade?"] == :websocket
+        env["rack.upgrade"] = handler
+        accept_response
+      else
+        [426, { "Connection" => "Upgrade", "Upgrade" => "websocket" }, []]
+      end
+    end
+
+    Rage.with_middlewares(application, Rage.config.cable.middlewares)
+  end
+
+  # @private
+  def self.__router
+    @__router ||= Router.new
+  end
+
+  # @private
+  def self.__build_handler(protocol)
+    klass = Class.new do
+      def initialize(protocol)
+        Iodine.on_state(:on_start) do
+          unless Fiber.scheduler
+            Fiber.set_scheduler(Rage::FiberScheduler.new)
+          end
+        end
+
+        @protocol = protocol
+      end
+
+      def on_open(connection)
+        Fiber.schedule do
+          @protocol.on_open(connection)
+        rescue => e
+          log_error(e)
+        end
+      end
+
+      def on_message(connection, data)
+        Fiber.schedule do
+          @protocol.on_message(connection, data)
+        rescue => e
+          log_error(e)
+        end
+      end
+
+      if protocol.respond_to?(:on_close)
+        def on_close(connection)
+          return unless ::Iodine.running?
+
+          Fiber.schedule do
+            @protocol.on_close(connection)
+          rescue => e
+            log_error(e)
+          end
+        end
+      end
+
+      if protocol.respond_to?(:on_shutdown)
+        def on_shutdown(connection)
+          @protocol.on_shutdown(connection)
+        rescue => e
+          log_error(e)
+        end
+      end
+
+      private
+
+      def log_error(e)
+        Rage.logger.error("Unhandled exception has occured - #{e.class} (#{e.message}):\n#{e.backtrace.join("\n")}")
+      end
+    end
+
+    klass.new(protocol)
+  end
+
+  # Broadcast data directly to a named stream.
+  #
+  # @param stream [String] the name of the stream
+  # @param data [Object] the object to send to the clients. This will later be encoded according to the protocol used.
+  # @example
+  #   Rage.cable.broadcast("chat", { message: "A new member has joined!" })
+  def self.broadcast(stream, data)
+    Rage.config.cable.protocol.broadcast(stream, data)
+  end
+
+  # @!parse [ruby]
+  #   # @abstract
+  #   class WebSocketConnection
+  #     # Write data to the connection.
+  #     #
+  #     # @param data [String] the data to write
+  #     def write(data)
+  #     end
+  #
+  #     # Subscribe to a channel.
+  #     #
+  #     # @param name [String] the channel name
+  #     def subscribe(name)
+  #     end
+  #
+  #     # Close the connection.
+  #     def close
+  #     end
+  #   end
+
+  module Protocol
+  end
+end
+
+require_relative "protocol/actioncable_v1_json"
+require_relative "channel"
+require_relative "connection"
+require_relative "router"