action_controller-twirp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f6de4da76df23f5785f040d5e30c5b7c6f9a641f70c913a6bce1861cb9d8001d
+  data.tar.gz: 7ac05c58f7c1bbf94a3f24625ba04e3e7e74511124a83bd2dab8a23448356dfc
+SHA512:
+  metadata.gz: 02f89f5b0c538f22d79c457bfd1e86f9948a085236165406ecc0793fc54b697284112adb6912ee274fffc04e24355e432675c3f9923f8536611d0ec1dbe66174
+  data.tar.gz: 432b4da795794b2decd181836e9a5752bea31db4b94bb361e7a049c2fbaac40b048eb0186885900aeb5f13e514785a8dc87ddcea6f2e3dac6fc664bf69c19997

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Kosuke Arisawa
+
+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,84 @@
+# ActionController::Twirp
+
+[![build](https://github.com/arisawa/action_controller-twirp/actions/workflows/ruby.yml/badge.svg)](https://github.com/arisawa/action_controller-twirp/actions/workflows/ruby.yml)
+![License](https://img.shields.io/github/license/arisawa/action_controller-twirp)
+
+Implement twirp service with Rails controller.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "action_controller-twirp"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install action_controller-twirp
+```
+
+## Usage
+[twirp-ruby](https://github.com/twitchtv/twirp-ruby) with Ruby on Rails.
+
+It provides routing method `twirp` that maps twirp service class and Rails controller class, and a module of `ActionController::Twirp` to help execute RPC methods and rendering Twirp::Error.
+
+First, you should generate twirp service class. see: [example in twirp-ruby](https://github.com/twitchtv/twirp-ruby/wiki#usage-example)
+
+Next, add twirp action in config/routes.rb
+```ruby
+Rails.application.routes.draw do
+  scope :twirp do
+    twirp Example::V1::UserApiService, controller: 'users'
+  end
+end
+```
+
+Result of `bin/rails routes`
+```sh
+> bin/rails routes
+ Prefix  Verb  URI Pattern                                    Controller#Action
+         POST  /twirp/example.v1.UserApi/ListUsers(.:format)  users#list_users
+         POST  /twirp/example.v1.UserApi/GetUser(.:format)    users#get_user
+```
+
+Finally, implement rpc method your controller
+```ruby
+class UsersController < ApplicationController # :nodoc:
+  include ActionController::Twirp
+
+  rescue_from ActiveRecord::RecordNotFound do |e|
+    twerr = Twirp::Error.not_found('The message',
+                                   reason: e.class.name.demodulize,
+                                   id: params[:id].to_s)
+    render twirp_error: twerr
+  end
+
+  USERS = [
+    { id: 1, name: 'Anna' },
+    { id: 2, name: 'Reina' }
+  ].freeze
+
+  def list_users(_req, _env)
+    Example::V1::ListUsersResponse.new(users: USERS)
+  end
+
+  def get_user(req, _env)
+    user = USERS.find { |u| u[:id] == req.id }
+
+    raise ActiveRecord::RecordNotFound unless user
+
+    Example::V1::User.new(user)
+  end
+end
+```
+
+## 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,5 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+require 'bundler/gem_tasks'

data/lib/action_controller/twirp/railtie.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'action_controller/twirp/twirp_error_renderer'
+require 'action_dispatch/twirp/railtie'
+
+module ActionController
+  module Twirp
+    class Railtie < ::Rails::Railtie # :nodoc:
+      initializer 'action_controller.twirp' do
+        ActiveSupport.on_load(:action_controller) do
+          ActionController::Renderers.add :twirp_error do |content, options|
+            renderer = TwirpErrorRenderer.new(content, options)
+            render(**renderer.to_render_option)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/action_controller/twirp/twirp_error_renderer.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module ActionController
+  module Twirp
+    # Convert Twirp::Error to #render option
+    class TwirpErrorRenderer
+      # @param content [Twirp::Error] given as a value of :twirp_error key of render method.
+      # @param options [Hash] options of render method.
+      def initialize(content, options)
+        unless content.is_a?(::Twirp::Error)
+          raise ArgumentError, 'Only Twirp::Error instance can be specified'
+        end
+
+        @content = content
+        @options = options.dup
+      end
+
+      def to_render_option
+        {
+          json: twirp_error.to_h,
+          **@options.merge(status: status, content_type: content_type)
+        }
+      end
+
+      private
+
+      def twirp_error
+        return @twirp_error if defined? @twirp_error
+
+        code = @content.code
+
+        @twirp_error = if ::Twirp::Error.valid_code?(code)
+                         @content
+                       else
+                         ::Twirp::Error.internal("Invalid code: #{code}", invalid_code: code.to_s)
+                       end
+      end
+
+      def status
+        ::Twirp::ERROR_CODES_TO_HTTP_STATUS[twirp_error.code]
+      end
+
+      def content_type
+        ::Twirp::Encoding::JSON
+      end
+    end
+  end
+end

data/lib/action_controller/twirp/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActionController
+  module Twirp
+    VERSION = '0.1.0'
+  end
+end

data/lib/action_controller/twirp.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'action_controller/twirp/version'
+require 'action_controller/twirp/railtie'
+
+module ActionController
+  # Module to execute your implemented methods on Twirp with Rails
+  module Twirp
+    private
+
+    # Override it to call a twirp class from request path
+    def send_action(*_args)
+      twirp_service_class.raise_exceptions = true
+
+      status, header, body = twirp_service_class.new(self)&.call(request.env)
+
+      response.status = status
+      response.header.merge(header)
+      response.body = body
+    end
+
+    def twirp_service_class
+      return @twirp_service_class if defined? @twirp_service_class
+
+      class_name = request.path.split('/')[-2].underscore.gsub('.', '/').classify
+      @twirp_service_class = "#{class_name}Service".constantize
+    end
+  end
+end

data/lib/action_dispatch/routing/mapper/twirp.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ActionDispatch
+  module Routing
+    class Mapper
+      # Define mapping a generated twirp class and your controller
+      module Twirp
+        def twirp(service_class, controller:)
+          service_class.rpcs.each do |_, rpcdef|
+            path = [service_class.service_full_name, rpcdef[:rpc_method]].join('/')
+            action = [controller, rpcdef[:ruby_method]].join('#')
+            match path, to: action, via: :post
+          end
+        end
+      end
+    end
+  end
+end

data/lib/action_dispatch/twirp/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'action_dispatch/routing/mapper/twirp'
+
+module ActionDispatch
+  module Twirp
+    class Railtie < ::Rails::Railtie # :nodoc:
+      initializer 'action_dispatch.twirp' do
+        ActionDispatch::Routing::Mapper.prepend(ActionDispatch::Routing::Mapper::Twirp)
+      end
+    end
+  end
+end

data/lib/tasks/action_controller/twirp_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :action_controller_twirp do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: action_controller-twirp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kosuke Arisawa
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: twirp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.36.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.36.0
+description: You can implement twirp service with Rails controller
+email:
+- arisawa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/action_controller/twirp.rb
+- lib/action_controller/twirp/railtie.rb
+- lib/action_controller/twirp/twirp_error_renderer.rb
+- lib/action_controller/twirp/version.rb
+- lib/action_dispatch/routing/mapper/twirp.rb
+- lib/action_dispatch/twirp/railtie.rb
+- lib/tasks/action_controller/twirp_tasks.rake
+homepage: https://github.com/arisawa/action_controller-twirp
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/arisawa/action_controller-twirp
+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.32
+signing_key:
+specification_version: 4
+summary: Twirp for Rails Controller
+test_files: []