twirbet 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8e9eb1c622bae0eec82613b9cc851082c98ec12c11cd6c06cae9d39cc14da87f
+  data.tar.gz: 80003e80a7c9e38529805adbb2b87edcb2c47e9e5244258bb72e5dd8839321a4
+SHA512:
+  metadata.gz: 74eb8e008aae34d7757b82bc4e031f172deba804a088abfa4f306d30eb319f4e730f6234b4bc33c8cc557042e05eda97e5c3fffcca842181c7876b966f40b60b
+  data.tar.gz: 5da000d1fac1baec0d690c974eaca37711176b6c511cddea000e975c7da0dfabb6a0ee079a8db29dacd0b0ff7ff36285fe7bbf984a5fab5950a5c7e7d45fb1d6

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,20 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+  - rubocop-sorbet
+
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - examples/**/*
+
+Sorbet/ValidSigil:
+  Exclude:
+    - ./**/*_pb.rb
+
+Sorbet/FalseSigil:
+  Exclude:
+    - ./**/*_pb.rb

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-12-18
+
+- Initial release

data/Gemfile

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in twirbet.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+gem "rubocop-rake", "~> 0.6.0"
+
+gem "rubocop-rspec", "~> 2.16"
+
+gem "rubocop-shopify", "~> 2.10"
+
+gem "rubocop-sorbet", "~> 0.6.11"
+
+gem "sorbet", "~> 0.5.10595"
+
+gem "spoom", "~> 1.1"
+
+gem "tapioca", "~> 0.10.3"
+
+gem "webmock", "~> 3.18"

data/Gemfile.lock

@@ -0,0 +1,127 @@
+PATH
+  remote: .
+  specs:
+    twirbet (0.1.0)
+      google-protobuf (~> 3.21)
+      rack (~> 3.0)
+      sorbet-runtime (~> 0.5.10595)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    google-protobuf (3.21.12)
+    google-protobuf (3.21.12-x86_64-linux)
+    hashdiff (1.0.1)
+    json (2.6.3)
+    netrc (0.11.0)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    public_suffix (5.0.1)
+    rack (3.0.2)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rbi (0.0.16)
+      ast
+      parser (>= 2.6.4.0)
+      sorbet-runtime (>= 0.5.9204)
+      unparser
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.40.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.16.0)
+      rubocop (~> 1.33)
+    rubocop-shopify (2.10.1)
+      rubocop (~> 1.35)
+    rubocop-sorbet (0.6.11)
+      rubocop (>= 0.90.0)
+    ruby-progressbar (1.11.0)
+    sorbet (0.5.10595)
+      sorbet-static (= 0.5.10595)
+    sorbet-runtime (0.5.10595)
+    sorbet-static (0.5.10595-universal-darwin-21)
+    sorbet-static (0.5.10595-x86_64-linux)
+    sorbet-static-and-runtime (0.5.10595)
+      sorbet (= 0.5.10595)
+      sorbet-runtime (= 0.5.10595)
+    spoom (1.1.15)
+      sorbet (>= 0.5.10187)
+      sorbet-runtime (>= 0.5.9204)
+      thor (>= 0.19.2)
+    tapioca (0.10.3)
+      bundler (>= 1.17.3)
+      netrc (>= 0.11.0)
+      parallel (>= 1.21.0)
+      rbi (~> 0.0.0, >= 0.0.16)
+      sorbet-static-and-runtime (>= 0.5.9892)
+      spoom (~> 1.1.0, >= 1.1.11)
+      thor (>= 1.2.0)
+      yard-sorbet
+    thor (1.2.1)
+    unicode-display_width (2.3.0)
+    unparser (0.6.5)
+      diff-lcs (~> 1.3)
+      parser (>= 3.1.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+    yard-sorbet (0.7.0)
+      sorbet-runtime (>= 0.5)
+      yard (>= 0.9)
+
+PLATFORMS
+  arm64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-rake (~> 0.6.0)
+  rubocop-rspec (~> 2.16)
+  rubocop-shopify (~> 2.10)
+  rubocop-sorbet (~> 0.6.11)
+  sorbet (~> 0.5.10595)
+  spoom (~> 1.1)
+  tapioca (~> 0.10.3)
+  twirbet!
+  webmock (~> 3.18)
+
+BUNDLED WITH
+   2.3.26

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Brave Hager
+
+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,144 @@
+# Twirbet
+
+Twirbet is a Sorbet-friendly Ruby library for the Twirp RPC framework.
+
+## Installation
+
+Twirbet is available as a Ruby gem. To install it via Bundler, run:
+
+```sh
+bundle install twirbet
+```
+
+## Usage
+
+### Defining a service
+
+Twirbet does not provide code generation (yet).
+
+You can use the `Twirbet::Service` and `Twirbet::Client` classes to implement
+and call Twirp services.
+
+Given a service defined in `ping.proto`:
+
+```protobuf
+syntax = "proto3";
+
+service PingService {
+  rpc Ping(PingRequest) returns (PingResponse);
+}
+
+message PingRequest {
+  string message = 1;
+}
+
+message PingResponse {
+  string message = 1;
+}
+```
+
+Here's the corresponding Ruby code:
+
+```ruby
+require "twirbet"
+require_relative "ping_pb"
+
+module PingService
+  module Handler
+    extend T::Sig
+    extend T::Helpers
+
+    interface!
+
+    sig { abstract.params(request: PingRequest).returns(PingResponse) }
+    def ping(request); end
+  end
+
+  class Service < Twirbet::Service
+    extend T::Sig
+
+    service "PingService"
+
+    rpc "Ping", PingRequest, PingResponse, ruby_method: :ping
+
+    sig { params(handler: Handler).void }
+    def initialize(handler)
+      super(handler)
+    end
+  end
+
+  class Client < Twirbet::Client
+    extend T::Sig
+    include Handler
+
+    service "PingService"
+
+    rpc "Ping", PingRequest, PingResponse, ruby_method: :ping
+
+    sig { override.params(request: PingRequest, headers: T::Hash[String, String]).returns(PingResponse) }
+    def ping(request, headers = {})
+      call("Ping", request, headers)
+    end
+  end
+end
+```
+
+### Implementing a service
+
+Once you have defined a service, you can implement it by creating a class that
+includes the `Handler` interface:
+
+```ruby
+class PingHandler
+  include PingService::Handler
+
+  sig { override.params(request: PingRequest).returns(PingResponse) }
+  def ping(request)
+    PingResponse.new(message: "Pong: #{request.message}")
+  end
+end
+```
+
+### Starting a server
+
+All services are valid Rack applications. You can use any Rack server to start a
+Twirp server.
+
+```ruby
+handler = PingHandler.new
+service = PingService::Service.new(handler)
+
+run service
+```
+
+### Calling a service
+
+You can call a service using the client:
+
+```ruby
+client = PingService::Client.new("http://localhost:8080")
+
+response = client.ping(PingRequest.new(message: "Hello, world!"))
+
+puts response.message # => "Pong: Hello, world!"
+```
+
+### Using a different HTTP client library
+
+Twirbet uses the built-in `Net::HTTP` library to make HTTP requests. You can use
+a different HTTP library by implementing the `Twirbet::Transport` interface and
+passing it to the client constructor:
+
+For example, Twirbet provides a `Twirbet::Transports::FakeTransport` class that
+can be used for testing:
+
+```ruby
+require "twirbet/transports/fake_transport"
+
+transport = Twirbet::Transports::FakeTransport.new
+client = PingService::Client.new("http://localhost:8080", transport: transport)
+
+response = client.ping(PingRequest.new(message: "Hello, world!"))
+
+puts response.message # => ""
+```

data/Rakefile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: [:spec, :rubocop]
+
+desc "Run client compatibility tests"
+task clientcompat: ["install:local"] do
+  sh "clientcompat -client=examples/clientcompat/client"
+end

data/examples/clientcompat/client

@@ -0,0 +1,28 @@
+#! /usr/bin/env ruby
+
+require_relative "clientcompat_twirbet"
+
+message = Twirp::Clientcompat::ClientCompatMessage.decode(STDIN.read)
+
+client = Twirp::Clientcompat::CompatService::Client.new(message.service_address)
+
+case message.method_name
+when :NOOP
+  request = Google::Protobuf.decode(Twirp::Clientcompat::Empty, message.request)
+  begin
+    response = client.noop_method(request)
+    $stdout.write(response.to_proto)
+  rescue Twirbet::BaseError => e
+    $stderr.write(e.code)
+  end
+when :METHOD
+  request = Google::Protobuf.decode(Twirp::Clientcompat::Req, message.request)
+  begin
+    response = client.real_method(request)
+    $stdout.write(response.to_proto)
+  rescue Twirbet::BaseError => e
+    $stderr.write(e.code)
+  end
+else
+  raise "Unknown method: #{message.method_name}"
+end

data/examples/clientcompat/clientcompat.proto

@@ -0,0 +1,29 @@
+syntax = "proto3";
+
+package twirp.clientcompat;
+option go_package = "/internal/clientcompat";
+
+service CompatService {
+  rpc Method(Req) returns (Resp);
+  rpc NoopMethod(Empty) returns (Empty);
+}
+
+message Empty {}
+
+message Req {
+  string v = 1;
+}
+
+message Resp {
+  int32 v = 1;
+}
+
+message ClientCompatMessage {
+  string service_address = 1;
+  enum CompatServiceMethod {
+    NOOP = 0;
+    METHOD = 1;
+  }
+  CompatServiceMethod method_name = 2;
+  bytes request = 3;
+}

data/examples/clientcompat/clientcompat_pb.rb

@@ -0,0 +1,36 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: clientcompat.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("clientcompat.proto", :syntax => :proto3) do
+    add_message "twirp.clientcompat.Empty" do
+    end
+    add_message "twirp.clientcompat.Req" do
+      optional :v, :string, 1
+    end
+    add_message "twirp.clientcompat.Resp" do
+      optional :v, :int32, 1
+    end
+    add_message "twirp.clientcompat.ClientCompatMessage" do
+      optional :service_address, :string, 1
+      optional :method_name, :enum, 2, "twirp.clientcompat.ClientCompatMessage.CompatServiceMethod"
+      optional :request, :bytes, 3
+    end
+    add_enum "twirp.clientcompat.ClientCompatMessage.CompatServiceMethod" do
+      value :NOOP, 0
+      value :METHOD, 1
+    end
+  end
+end
+
+module Twirp
+  module Clientcompat
+    Empty = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("twirp.clientcompat.Empty").msgclass
+    Req = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("twirp.clientcompat.Req").msgclass
+    Resp = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("twirp.clientcompat.Resp").msgclass
+    ClientCompatMessage = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("twirp.clientcompat.ClientCompatMessage").msgclass
+    ClientCompatMessage::CompatServiceMethod = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("twirp.clientcompat.ClientCompatMessage.CompatServiceMethod").enummodule
+  end
+end

data/examples/clientcompat/clientcompat_twirbet.rb

@@ -0,0 +1,57 @@
+require "twirbet"
+require_relative "clientcompat_pb"
+
+module Twirp
+  module Clientcompat
+    module CompatService
+      module Handler
+        extend T::Sig
+        extend T::Helpers
+
+        interface!
+
+        sig { abstract.params(request: Req).returns(Resp) }
+        def real_method(request); end
+
+        sig { abstract.params(request: Empty).returns(Empty) }
+        def noop_method(request); end
+      end
+
+      class Service < Twirbet::Service
+        extend T::Sig
+
+        package "twirp.clientcompat"
+        service "CompatService"
+
+        rpc "Method", Req, Resp, ruby_method: :real_method
+        rpc "NoopMethod", Empty, Empty, ruby_method: :noop_method
+
+        sig { params(handler: Handler).void }
+        def initialize(handler)
+          super(handler)
+        end
+      end
+
+      class Client < Twirbet::Client
+        extend T::Sig
+        include Handler
+
+        package "twirp.clientcompat"
+        service "CompatService"
+
+        rpc "Method", Req, Resp, ruby_method: :real_method
+        rpc "NoopMethod", Empty, Empty, ruby_method: :noop_method
+
+        sig { override.params(request: Req).returns(Resp) }
+        def real_method(request)
+          call("Method", request)
+        end
+
+        sig { override.params(request: Empty).returns(Empty) }
+        def noop_method(request)
+          call("NoopMethod", request)
+        end
+      end
+    end
+  end
+end

data/examples/ping/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "twirbet", path: "../.."
+
+gem "puma", "~> 6.0"
+
+gem "sorbet", "~> 0.5.10595"
+
+gem "tapioca", "~> 0.10.3"

data/examples/ping/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: ../..
+  specs:
+    twirbet (0.1.0)
+      google-protobuf (~> 3.21)
+      rack (~> 3.0)
+      sorbet-runtime (~> 0.5.10595)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    google-protobuf (3.21.12)
+    netrc (0.11.0)
+    nio4r (2.5.8)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    puma (6.0.0)
+      nio4r (~> 2.0)
+    rack (3.0.2)
+    rbi (0.0.16)
+      ast
+      parser (>= 2.6.4.0)
+      sorbet-runtime (>= 0.5.9204)
+      unparser
+    sorbet (0.5.10595)
+      sorbet-static (= 0.5.10595)
+    sorbet-runtime (0.5.10595)
+    sorbet-static (0.5.10595-universal-darwin-21)
+    sorbet-static-and-runtime (0.5.10595)
+      sorbet (= 0.5.10595)
+      sorbet-runtime (= 0.5.10595)
+    spoom (1.1.15)
+      sorbet (>= 0.5.10187)
+      sorbet-runtime (>= 0.5.9204)
+      thor (>= 0.19.2)
+    tapioca (0.10.3)
+      bundler (>= 1.17.3)
+      netrc (>= 0.11.0)
+      parallel (>= 1.21.0)
+      rbi (~> 0.0.0, >= 0.0.16)
+      sorbet-static-and-runtime (>= 0.5.9892)
+      spoom (~> 1.1.0, >= 1.1.11)
+      thor (>= 1.2.0)
+      yard-sorbet
+    thor (1.2.1)
+    unparser (0.6.5)
+      diff-lcs (~> 1.3)
+      parser (>= 3.1.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+    yard-sorbet (0.7.0)
+      sorbet-runtime (>= 0.5)
+      yard (>= 0.9)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  puma (~> 6.0)
+  sorbet (~> 0.5.10595)
+  tapioca (~> 0.10.3)
+  twirbet!
+
+BUNDLED WITH
+   2.3.26

data/examples/ping/bin/puma

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'puma' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("puma", "puma")

data/examples/ping/bin/pumactl

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'pumactl' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("puma", "pumactl")