rails_twirp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fe63b82d059ab115dd9fdb2ad342fa6e71264a519abac81ffb68b361ed908209
+  data.tar.gz: '049a00e7d8928a0df13e012613840d21ac722693125440070261a2ad07d7e1b0'
+SHA512:
+  metadata.gz: 919cede079ec3bf55898d5014d22dc3324379d9b793a7cfc3ef35d769a79a2458abe56f9971496ff2ec3c0d624967f51c6c50b0f501009cf0f76a5c9167fecd8
+  data.tar.gz: a7845a591ced9a9afe3dca8f0cd02babb8ed80142be3ddc7a0d1afd152a230a9dc9b1a6e8c847fb0095fa1665ea5647c89232f9810b83aa06178ab29a453b24b

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/doc/
+/log/*.log
+/pkg/
+/tmp/
+/test/dummy/db/*.sqlite3
+/test/dummy/db/*.sqlite3-*
+/test/dummy/log/*.log
+/test/dummy/storage/
+/test/dummy/tmp/
+.byebug_history
+Gemfile.lock
+*.gem

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Specify your gem's dependencies in rails_twirp.gemspec.
+gemspec
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Bouke van der Bijl
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# RailsTwirp
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_twirp'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install rails_twirp
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/bin/test

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$: << File.expand_path("../test", __dir__)
+
+require "bundler/setup"
+require "rails/plugin/test"

data/lib/commands/twirp/routes_command.rb

@@ -0,0 +1,26 @@
+module RailsTwirp
+  module Command
+    class RoutesCommand < Rails::Command::Base
+      namespace "twirp"
+
+      desc "routes", "Show Twirp routes"
+      def perform
+        require_application_and_environment!
+        lines = [["Method", "Controller#Action"]]
+
+        Rails.application.twirp.routes.services.each do |svc, route_set|
+          route_set.rpcs.each do |name, mapping|
+            lines << ["/#{svc.service_full_name}/#{name}", mapping.to_s]
+          end
+        end
+
+        first_width = lines.map { |line| line[0].length }.max
+        second_width = lines.map { |line| line[1].length }.max
+
+        lines.each do |(first, second)|
+          say "#{first.rjust(first_width)} #{second.ljust(second_width)}\n"
+        end
+      end
+    end
+  end
+end

data/lib/rails_twirp.rb

@@ -0,0 +1,11 @@
+require "rails_twirp/version"
+
+require "rails_twirp/base"
+require "rails_twirp/route_set"
+require "rails_twirp/testing/integration_test"
+
+module RailsTwirp
+  mattr_accessor :test_app
+end
+
+require "rails_twirp/engine" if defined?(Rails)

data/lib/rails_twirp/application.rb

@@ -0,0 +1,9 @@
+require "rails_twirp/route_set"
+
+module RailsTwirp
+  class Application
+    def routes
+      @routes ||= RouteSet.new
+    end
+  end
+end

data/lib/rails_twirp/base.rb

@@ -0,0 +1,50 @@
+module RailsTwirp
+  class Base < AbstractController::Base
+    abstract!
+
+    include AbstractController::Logger
+    include AbstractController::AssetPaths
+    include AbstractController::Callbacks
+    include AbstractController::Caching
+    include AbstractController::Rendering
+    include ActionView::Rendering
+
+    attr_internal :request, :env, :response_class
+    def initialize
+      @_request = nil
+      @_env = nil
+      @_response_class = nil
+      super
+    end
+
+    def http_request
+      @_http_request ||= ActionDispatch::Request.new(env[:rack_env])
+    end
+
+    def dispatch(action, request, response_class, env = {})
+      self.request = request
+      self.env = env
+      self.response_class = response_class
+
+      http_request.controller_instance = self
+
+      process(action)
+
+      # Implicit render
+      self.response_body = render unless response_body
+      response_body
+    end
+
+    def render(*args)
+      options = {formats: :pb, handlers: :pbbuilder, locals: {response_class: response_class}}
+      options.deep_merge! args.extract_options!
+      super(*args, options)
+    end
+
+    def self.dispatch(action, request, response_class, env = {})
+      new.dispatch(action, request, response_class, env)
+    end
+
+    ActiveSupport.run_load_hooks(:rails_twirp, self)
+  end
+end

data/lib/rails_twirp/engine.rb

@@ -0,0 +1,63 @@
+require "rails/railtie"
+require "rails_twirp/application"
+
+module RailsTwirp
+  # Even though this is an engine, we don't inherit from Rails::Engine because we don't want anything it provides.
+  class Engine < ::Rails::Railtie
+    # Implement Rack API
+    delegate :call, to: :routes
+
+    module TwirpValue
+      def twirp
+        @twirp ||= Application.new
+      end
+    end
+
+    initializer "rails_twirp.logger" do
+      # This hook is called whenever a RailsTwirp::Base is initialized, and it sets the logger
+      ActiveSupport.on_load(:rails_twirp) { self.logger ||= Rails.logger }
+    end
+
+    initializer :add_paths, before: :bootstrap_hook do |app|
+      app.config.paths.add "config/twirp/routes.rb"
+      app.config.paths.add "config/twirp/routes", glob: "**/*.rb"
+      app.config.paths.add "app/twirp/controllers", eager_load: true
+      app.config.paths.add "app/twirp/proto", load_path: true
+      app.config.paths.add "app/twirp/views", load_path: true
+    end
+
+    initializer :set_controller_view_path do
+      ActiveSupport.on_load(:rails_twirp) { prepend_view_path "app/twirp/views" }
+    end
+
+    initializer :add_twirp do |app|
+      # Here we add the 'twirp' method to application, which is accessible at Rails.application.twirp
+      app.extend TwirpValue
+    end
+
+    initializer :load_twirp_routes do |app|
+      # Load route files
+      route_configs = [
+        *app.config.paths["config/twirp/routes.rb"].existent,
+        *app.config.paths["config/twirp/routes"].existent
+      ]
+      load(*route_configs)
+
+      # Create a router that knows how to route all the registered services
+      services = app.twirp.routes.to_services
+      routes.draw do
+        services.each do |service|
+          mount service => service.full_name
+        end
+      end
+    end
+
+    initializer :set_test_app do |app|
+      RailsTwirp.test_app = app
+    end
+
+    def routes
+      @routes ||= ActionDispatch::Routing::RouteSet.new
+    end
+  end
+end

data/lib/rails_twirp/route_set.rb

@@ -0,0 +1,113 @@
+# Most of this logic is stolen from Rails ActionDispatch::Routing::RouteSet
+
+module RailsTwirp
+  class RouteSet
+    attr_reader :services
+
+    def initialize
+      # Make services a hash with a default_proc, so the same class gets reused if the service
+      # method is used multiple times with the same key.
+      # This makes it possible to split up the routes into multiple files.
+      @services = Hash.new { |hash, key| hash[key] = ServiceRouteSet.new(key) }
+    end
+
+    def draw(&block)
+      mapper = Mapper.new(self)
+      mapper.instance_exec(&block)
+    end
+
+    def to_services
+      services.each_value.map(&:to_service)
+    end
+
+    class ServiceRouteSet
+      attr_reader :rpcs
+
+      def initialize(service_class)
+        @service_class = service_class
+        @rpcs = {}
+      end
+
+      def add_route(name, mapping)
+        if @rpcs[name]
+          raise ArgumentError, "Invalid RPC, route already defined: #{name}"
+        end
+
+        @rpcs[name] = mapping
+      end
+
+      def to_service
+        # Synthesize a handler that will process the requests
+        #
+        handler = Class.new
+        @rpcs.each do |name, mapping|
+          rpc_info = @service_class.rpcs[name]
+          method_name = rpc_info[:ruby_method]
+
+          # Stolen from Rails in ActionDispatch::Request#controller_class_for
+          controller_name = mapping.controller.underscore
+          const_name = controller_name.camelize << "Controller"
+          action_name = mapping.action
+          response_class = rpc_info[:output_class]
+
+          handler.define_method(method_name) do |req, env|
+            controller_class = ::ActiveSupport::Dependencies.constantize(const_name)
+            controller_class.dispatch(action_name, req, response_class, env)
+          end
+        end
+
+        service = @service_class.new(handler.new)
+        service.before do |rack_env, env|
+          env[:rack_env] = rack_env
+        end
+        service
+      end
+    end
+
+    class Mapping
+      attr_reader :controller, :action
+
+      def initialize(to:)
+        @controller, @action = split_to(to)
+      end
+
+      def to_s
+        "#{controller}##{action}"
+      end
+
+      private
+
+      # copied from Rails
+      def split_to(to)
+        if /#/.match?(to)
+          to.split("#").map!(&:-@)
+        else
+          []
+        end
+      end
+    end
+
+    class ServiceMapper
+      def initialize(service_route_set)
+        @service_route_set = service_route_set
+      end
+
+      def rpc(name, to:)
+        mapping = Mapping.new(to: to)
+        @service_route_set.add_route(name, mapping)
+      end
+    end
+
+    class Mapper
+      def initialize(route_set)
+        @route_set = route_set
+      end
+
+      def service(service_definition, &block)
+        service_route_set = @route_set.services[service_definition]
+        service_mapper = ServiceMapper.new(service_route_set)
+        service_mapper.instance_exec(&block)
+      end
+    end
+  end
+end

data/lib/rails_twirp/testing/integration_test.rb

@@ -0,0 +1,43 @@
+module RailsTwirp
+  class IntegrationTest < ActiveSupport::TestCase
+    attr_reader :response, :request, :controller
+
+    def initialize(name)
+      super
+      reset!
+      @before_rpc = []
+    end
+
+    def reset!
+      @request = nil
+      @response = nil
+    end
+
+    def before_rpc(&block)
+      @before_rpc << block
+    end
+
+    def rpc(service, rpc, request, headers: nil)
+      @request = request
+      service = app.twirp.routes.services[service].to_service
+
+      rack_env = {}
+      http_request = ActionDispatch::Request.new(rack_env)
+      http_request.headers.merge! headers if headers.present?
+      env = {rack_env: rack_env}
+
+      @before_rpc.each do |hook|
+        hook.call(env)
+      end
+
+      response = service.call_rpc rpc, request, env
+      @response = response
+      @controller = http_request.controller_instance
+      response
+    end
+
+    def app
+      RailsTwirp.test_app
+    end
+  end
+end

data/lib/rails_twirp/version.rb

@@ -0,0 +1,3 @@
+module RailsTwirp
+  VERSION = "0.1.0"
+end

data/rails_twirp.gemspec

@@ -0,0 +1,17 @@
+require_relative "lib/rails_twirp/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rails_twirp"
+  spec.version = RailsTwirp::VERSION
+  spec.authors = ["Bouke van der Bijl"]
+  spec.email = ["bouke@cheddar.me"]
+  spec.homepage = "https://github.com/cheddar-me/rails-twirp"
+  spec.summary = "Integrate Twirp into Rails"
+  spec.license = "MIT"
+
+  spec.files = `git ls-files`.split("\n")
+  spec.test_files = `git ls-files -- test/*`.split("\n")
+
+  spec.add_dependency "rails", "~> 6.1.3"
+  spec.add_dependency "twirp", "~> 1.7.2"
+end

data/test/rails_twirp_test.rb

@@ -0,0 +1,7 @@
+require "test_helper"
+
+class RailsTwirpTest < ActiveSupport::TestCase
+  test "it has a version number" do
+    assert RailsTwirp::VERSION
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require "rails"
+require "rails/test_help"
+require "rails/test_unit/reporter"
+Rails::TestUnitReporter.executable = "bin/test"

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: rails_twirp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bouke van der Bijl
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.3
+- !ruby/object:Gem::Dependency
+  name: twirp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+description:
+email:
+- bouke@cheddar.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/test
+- lib/commands/twirp/routes_command.rb
+- lib/rails_twirp.rb
+- lib/rails_twirp/application.rb
+- lib/rails_twirp/base.rb
+- lib/rails_twirp/engine.rb
+- lib/rails_twirp/route_set.rb
+- lib/rails_twirp/testing/integration_test.rb
+- lib/rails_twirp/version.rb
+- rails_twirp.gemspec
+- test/rails_twirp_test.rb
+- test/test_helper.rb
+homepage: https://github.com/cheddar-me/rails-twirp
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Integrate Twirp into Rails
+test_files:
+- test/rails_twirp_test.rb
+- test/test_helper.rb