rails_twirp 0.13.1 → 0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d04982e98774e2a130671b2729dad6141905df3544c7cfa3900137a7cd553356
-  data.tar.gz: 650187fd3c34f30ca91885c6c1fa9b1547035a816d088e0b8c583f9ea6a0608e
+  metadata.gz: 9b7e742d4821b2a3745b2463d19aae223822eac419bd773d371f379143454d71
+  data.tar.gz: 1abf4446ebeea434ecdd7064a19e5ad7375c0e3e8f936af4afaf67a938923844
 SHA512:
-  metadata.gz: 4021ee3e130f4647423177456c9ccfb5bcce728874b547f56c2ae52a78fc92a953f6e98e7dee7eb87c78adca37f4f42cd21c7761f3842f20859923a3a8b8096f
-  data.tar.gz: bcb8240668e0c0d59f63ad7148595fcf15142533bed252e6f55212f51a73df0f31a623ca97f675c1494712631ffb025b20f71956dbfaa71ba61d9d48e12f2512
+  metadata.gz: 6dfdf309ddc0f01d4da60b51205de47414fc11aff123a15f1e65fdbbd31d532c9c417fe7e73f5e5a4a9c0fb0d9f030c6a758bae1fc4a40df4f776167a64a2c84
+  data.tar.gz: 74840175fc2b2bac370dcddb5c906f89cebf072c7b5f678baca72f4c678d45c87ff15f0cfbe62c9e7d15ac3b8904eedc99ffd4d90fdb632439c18d575ad40a95

data/.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: Ruby Test
+on: push
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.0
+          bundler-cache: true
+
+      - name: Run tests
+        run: bin/test
+
+      - name: Run standardrb
+        run: bundle exec standardrb

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 0.14.0
+* Adding frozen_string_literal: true to all files.
+
+### 0.13.2
+* revert - include `test/` folder in a final gem distribution
+
 ### 0.13.1
 * Don't include `test/` folder in a final gem distribution
 * Format dummy app code with standardrb

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in rails_twirp.gemspec.

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/setup"
 require "bundler/gem_tasks"
 require "rake/testtask"

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsTwirp
   module Command
     class RoutesCommand < Rails::Command::Base

data/lib/rails_twirp/application.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rails_twirp/route_set"
 
 module RailsTwirp

data/lib/rails_twirp/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rails_twirp/application"
 require "rails_twirp/route_set"
 require "rails/railtie"

data/lib/rails_twirp/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "twirp/error"
 
 module RailsTwirp

data/lib/rails_twirp/exception_handling.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "twirp/error"
 
 module RailsTwirp

data/lib/rails_twirp/implicit_render.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "action_controller/metal/basic_implicit_render"
 
 module RailsTwirp

data/lib/rails_twirp/instrumentation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsTwirp
   module Instrumentation
     extend ActiveSupport::Concern

data/lib/rails_twirp/log_subscriber.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_support/log_subscriber"
 
 module RailsTwirp

data/lib/rails_twirp/mapper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "forwardable"
 
 module RailsTwirp

data/lib/rails_twirp/render_pb.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsTwirp
   # RenderPb makes it possible to do 'render pb: <proto object>', skipping templates
   # The way this module is written is inspired by ActionController::Renderers

data/lib/rails_twirp/rescue.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsTwirp
   module Rescue
     extend ActiveSupport::Concern

data/lib/rails_twirp/route_set.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Most of this logic is stolen from Rails ActionDispatch::Routing::RouteSet
 
 require "rails_twirp/mapper"

data/lib/rails_twirp/testing/integration_test.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require "twirp/encoding"
+
+module RailsTwirp
+  class IntegrationTest < ActiveSupport::TestCase
+    DEFAULT_HOST = "www.example.com"
+    Response = Struct.new(:status, :body, :headers)
+
+    attr_reader :response, :request, :controller
+    attr_writer :mount_path
+    alias_method :mount_path!, :mount_path=
+
+    def initialize(name)
+      super
+      reset!
+      @before_rpc = []
+    end
+
+    def host
+      @host || DEFAULT_HOST
+    end
+    attr_writer :host
+    alias_method :host!, :host=
+
+    def https?
+      @https
+    end
+
+    def https!(value = true)
+      @https = value
+    end
+
+    def reset!
+      @request = nil
+      @response = nil
+      @host = nil
+      @host = nil
+      @https = false
+      @mount_path = "/twirp"
+    end
+
+    def before_rpc(&block)
+      @before_rpc << block
+    end
+
+    def rpc(service, rpc, request, headers: nil)
+      @request = request
+
+      env = build_rack_env(service, rpc, request, headers)
+      @before_rpc.each do |hook|
+        hook.call(env)
+      end
+
+      status, headers, body = app.call(env)
+      @response = decode_rack_response(service, rpc, status, headers, body)
+      set_controller_from_rack_env(env)
+
+      @response
+    end
+
+    def app
+      RailsTwirp.test_app
+    end
+
+    private
+
+    def build_rack_env(service, rpc, request, headers)
+      env = {
+        "CONTENT_TYPE" => request_content_type,
+        "HTTPS" => https? ? "on" : "off",
+        "HTTP_HOST" => host,
+        "PATH_INFO" => "#{@mount_path}/#{service.service_full_name}/#{rpc}",
+        "REQUEST_METHOD" => "POST",
+        "SERVER_NAME" => host,
+        "SERVER_PORT" => https? ? "443" : "80",
+        "rack.url_scheme" => https? ? "https" : "http"
+      }
+      if headers.present?
+        http_request = ActionDispatch::Request.new(env)
+        http_request.headers.merge! headers
+      end
+
+      input_class = service.rpcs[rpc][:input_class]
+      env["rack.input"] = StringIO.new(Twirp::Encoding.encode(request, input_class, request_content_type))
+      env
+    end
+
+    def request_content_type
+      Twirp::Encoding::PROTO
+    end
+
+    def decode_rack_response(service, rpc, status, headers, body)
+      body = body.join # body is an Enumerable
+
+      if status === 200
+        output_class = service.rpcs[rpc][:output_class]
+        Twirp::Encoding.decode(body, output_class, headers["Content-Type"])
+      else
+        Twirp::Client.error_from_response(Response.new(status, body, headers))
+      end
+    end
+
+    def set_controller_from_rack_env(env)
+      @controller = ActionDispatch::Request.new(env).controller_instance
+    end
+  end
+end

data/lib/rails_twirp/url_for.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "abstract_controller/url_for"
 
 module RailsTwirp

data/lib/rails_twirp/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsTwirp
-  VERSION = "0.13.1"
+  VERSION = "0.14"
 end

data/lib/rails_twirp.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rails_twirp/version"
 
 require "rails_twirp/application"

data/rails_twirp.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "lib/rails_twirp/version"
 
 Gem::Specification.new do |spec|
@@ -9,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary = "Integrate Twirp into Rails"
   spec.license = "MIT"
 
-  spec.files = `git ls-files | grep -v -E "test/*"`.split("\n")
+  spec.files = `git ls-files`.split("\n")
 
   spec.add_dependency "rails", ">= 6.1.3"
   spec.add_dependency "twirp", ">= 1.9", "< 1.11"

data/test/dummy/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative "config/application"
+
+Rails.application.load_tasks

data/test/dummy/app/assets/config/manifest.js

@@ -0,0 +1,2 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/test/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class ApplicationController < ActionController::Base
+end

data/test/dummy/app/controllers/application_twirp_controller.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class ApplicationTwirpController < RailsTwirp::Base
+  rescue_from ActiveRecord::RecordNotFound, with: :handle_not_found
+
+  def handle_not_found
+    error :not_found, "Not found"
+  end
+end

data/test/dummy/app/controllers/dummy_controller.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class DummyController < RailsTwirp::Base
+  def rpc_name_check
+    @rpc_name = rpc_name
+  end
+end

data/test/dummy/app/controllers/pings_controller.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+class PingsController < ApplicationTwirpController
+  before_action :respond_error, only: :before_error
+
+  def ping
+    response = RPC::DummyAPI::PingResponse.new(double_name: request.name * 2)
+    self.response_body = response
+  end
+
+  def ping_render
+    url = rails_twirp_engine_url
+    response = RPC::DummyAPI::PingResponse.new(double_name: "#{url} #{helpers.does_this_work(request.name)}")
+    render pb: response
+  end
+
+  def ping_template
+    @double_name = request.name * 2
+  end
+
+  def error_response
+    error :unauthenticated, "You are not authenticated!!"
+  end
+
+  def raise_error
+    # This error is rescued in ApplicationTwirpController
+    raise ActiveRecord::RecordNotFound, "Not found"
+  end
+
+  def uncaught_raise
+    raise StandardError, "Uncaught"
+  end
+
+  def before_error
+    # This error won't be reached because of the before_action
+    raise NotImplementedError
+  end
+
+  def respond_error
+    error :malformed, "yOuR ReQuEsT Is mAlFoRmEd"
+  end
+end

data/test/dummy/app/controllers/testmod/nested/other_controller.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Testmod
+  module Nested
+    class OtherController < ApplicationTwirpController
+      def ping
+        response = RPC::DummyAPI::PingResponse.new(double_name: request.name * 2)
+        self.response_body = response
+      end
+    end
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+module ApplicationHelper
+end

data/test/dummy/app/helpers/random_helper.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RandomHelper
+  def does_this_work(n)
+    n * 2
+  end
+end

data/test/dummy/app/javascript/packs/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require_tree .

data/test/dummy/app/jobs/application_job.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class ApplicationJob < ActiveJob::Base
+  # Automatically retry jobs that encountered a deadlock
+  # retry_on ActiveRecord::Deadlocked
+
+  # Most jobs are safe to ignore if the underlying records are no longer available
+  # discard_on ActiveJob::DeserializationError
+end

data/test/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class ApplicationMailer < ActionMailer::Base
+  default from: "from@example.com"
+  layout "mailer"
+end

data/test/dummy/app/models/application_record.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/test/dummy/app/views/dummy/rpc_name_check.pb.pbbuilder

@@ -0,0 +1,3 @@
+pb.cache! "rpc-#{@rpc_name}", expire_in: 1.minute do
+  pb.rpc_name @rpc_name
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag 'application', media: 'all' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/test/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/test/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/test/dummy/app/views/pings/ping_template.pb.pbbuilder

@@ -0,0 +1 @@
+pb.double_name @double_name

data/test/dummy/bin/generate

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+protoc --twirp_ruby_out=proto/ --ruby_out=proto/ -I proto/ proto/api.proto

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path("../config/application", __dir__)
+require_relative "../config/boot"
+require "rails/commands"

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative "../config/boot"
+require "rake"
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+require "fileutils"
+
+# path to your application root.
+APP_ROOT = File.expand_path("..", __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to set up or update your development environment automatically.
+  # This script is idempotent, so that you can run it at any time and get an expectable outcome.
+  # Add necessary setup steps to this file.
+
+  puts "== Installing dependencies =="
+  system! "gem install bundler --conservative"
+  system("bundle check") || system!("bundle install")
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   FileUtils.cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! "bin/rails db:prepare"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! "bin/rails log:clear tmp:clear"
+
+  puts "\n== Restarting application server =="
+  system! "bin/rails restart"
+end

data/test/dummy/config/application.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "boot"
+
+require "rails/all"
+
+require "rails_twirp/engine"
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+
+module Dummy
+  class Application < Rails::Application
+    config.load_defaults Rails::VERSION::STRING.to_f
+
+    # Configuration for the application, engines, and railties goes here.
+    #
+    # These settings can be overridden in specific environments using the files
+    # in config/environments, which are processed later.
+    #
+    # config.time_zone = "Central Time (US & Canada)"
+    # config.eager_load_paths << Rails.root.join("extras")
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Set up gems listed in the Gemfile.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../../Gemfile", __dir__)
+
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+$LOAD_PATH.unshift File.expand_path("../../../lib", __dir__)

data/test/dummy/config/cable.yml

@@ -0,0 +1,10 @@
+development:
+  adapter: async
+
+test:
+  adapter: test
+
+production:
+  adapter: redis
+  url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
+  channel_prefix: dummy_production