twirp 0.1.0 → 0.2.0

data/test/fake_services.rb

@@ -29,7 +29,11 @@ module Example
   class Haberdasher < Twirp::Service
     package "example"
     service "Haberdasher"
-    rpc :MakeHat, Size, Hat, :handler_method => :make_hat
+    rpc :MakeHat, Size, Hat, :ruby_method => :make_hat
+  end
+
+  class HaberdasherClient < Twirp::Client
+    client_for Haberdasher
   end
 end
 
@@ -48,3 +52,19 @@ end
 # Twirp Service with no package and no rpc methods.
 class EmptyService < Twirp::Service
 end
+class EmptyClient < Twirp::Client
+end
+
+# Foo message
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "Foo" do
+    optional :foo, :string, 1
+  end
+end
+Foo = Google::Protobuf::DescriptorPool.generated_pool.lookup("Foo").msgclass
+
+# Foo Client
+class FooClient < Twirp::Client
+  service "Foo"
+  rpc :Foo, Foo, Foo, :ruby_method => :foo
+end

data/test/service_test.rb

@@ -13,14 +13,14 @@ class ServiceTest < Minitest::Test
   end
 
   # The rpc DSL should properly build the base Twirp environment for each rpc method.
-  def test_base_envs_accessor
-    assert_equal 1, Example::Haberdasher.base_envs.size
+  def test_rpcs_accessor
+    assert_equal 1, Example::Haberdasher.rpcs.size
     assert_equal({
       rpc_method: :MakeHat,
       input_class: Example::Size,
       output_class: Example::Hat,
-      handler_method: :make_hat,
-    }, Example::Haberdasher.base_envs["MakeHat"])
+      ruby_method: :make_hat,
+    }, Example::Haberdasher.rpcs["MakeHat"])
   end
 
   # DSL package and service define the proper data on the service
@@ -33,7 +33,7 @@ class ServiceTest < Minitest::Test
     assert_equal "EmptyService", EmptyService.service_name # defaults to class name
     assert_equal "EmptyService", EmptyService.service_full_name # with no package is just the service name
   end
-  
+
   def test_init_service
     svc = Example::Haberdasher.new(HaberdasherHandler.new)
     assert svc.respond_to?(:call) # so it is a Proc that can be used as Rack middleware
@@ -71,35 +71,35 @@ class ServiceTest < Minitest::Test
     assert_equal 404, status
     assert_equal 'application/json', headers['Content-Type']
     assert_equal({
-      "code" => 'bad_route', 
+      "code" => 'bad_route',
       "msg"  => 'Invalid rpc method "MakeUnicorns"',
       "meta" => {"twirp_invalid_route" => "POST /twirp/example.Haberdasher/MakeUnicorns"},
-    }, JSON.parse(body[0]))    
+    }, JSON.parse(body[0]))
   end
 
   def test_bad_route_with_wrong_http_method
-    rack_env = Rack::MockRequest.env_for "example.Haberdasher/MakeHat", 
+    rack_env = Rack::MockRequest.env_for "example.Haberdasher/MakeHat",
       method: "GET", input: '{"inches": 10}', "CONTENT_TYPE" => "application/json"
     status, headers, body = haberdasher_service.call(rack_env)
 
     assert_equal 404, status
     assert_equal 'application/json', headers['Content-Type']
     assert_equal({
-      "code" => 'bad_route', 
+      "code" => 'bad_route',
       "msg"  => 'HTTP request method must be POST',
       "meta" => {"twirp_invalid_route" => "GET /example.Haberdasher/MakeHat"},
     }, JSON.parse(body[0]))
   end
 
   def test_bad_route_with_wrong_content_type
-    rack_env = Rack::MockRequest.env_for "example.Haberdasher/MakeHat", 
+    rack_env = Rack::MockRequest.env_for "example.Haberdasher/MakeHat",
       method: "POST", input: 'free text', "CONTENT_TYPE" => "text/plain"
     status, headers, body = haberdasher_service.call(rack_env)
 
     assert_equal 404, status
     assert_equal 'application/json', headers['Content-Type']
     assert_equal({
-      "code" => 'bad_route', 
+      "code" => 'bad_route',
       "msg"  => 'unexpected Content-Type: "text/plain". Content-Type header must be one of application/json or application/protobuf',
       "meta" => {"twirp_invalid_route" => "POST /example.Haberdasher/MakeHat"},
     }, JSON.parse(body[0]))
@@ -112,7 +112,7 @@ class ServiceTest < Minitest::Test
     assert_equal 404, status
     assert_equal 'application/json', headers['Content-Type']
     assert_equal({
-      "code" => 'bad_route', 
+      "code" => 'bad_route',
       "msg"  => 'Invalid route. Expected format: POST {BaseURL}/example.Haberdasher/{Method}',
       "meta" => {"twirp_invalid_route" => "POST /wrongpath"},
     }, JSON.parse(body[0]))
@@ -125,35 +125,35 @@ class ServiceTest < Minitest::Test
     assert_equal 404, status
     assert_equal 'application/json', headers['Content-Type'] # error responses are always JSON, even for Protobuf requests
     assert_equal({
-      "code" => 'bad_route', 
+      "code" => 'bad_route',
       "msg"  => 'Invalid route. Expected format: POST {BaseURL}/example.Haberdasher/{Method}',
       "meta" => {"twirp_invalid_route" => "POST /another/wrong.Path/MakeHat"},
     }, JSON.parse(body[0]))
   end
 
   def test_bad_route_with_wrong_json_body
-    rack_env = Rack::MockRequest.env_for "example.Haberdasher/MakeHat", 
+    rack_env = Rack::MockRequest.env_for "example.Haberdasher/MakeHat",
       method: "POST", input: 'bad json', "CONTENT_TYPE" => "application/json"
     status, headers, body = haberdasher_service.call(rack_env)
 
     assert_equal 404, status
     assert_equal 'application/json', headers['Content-Type']
     assert_equal({
-      "code" => 'bad_route', 
+      "code" => 'bad_route',
       "msg"  => 'Invalid request body for rpc method "MakeHat" with Content-Type=application/json',
       "meta" => {"twirp_invalid_route" => "POST /example.Haberdasher/MakeHat"},
     }, JSON.parse(body[0]))
   end
 
   def test_bad_route_with_wrong_protobuf_body
-    rack_env = Rack::MockRequest.env_for "example.Haberdasher/MakeHat", 
+    rack_env = Rack::MockRequest.env_for "example.Haberdasher/MakeHat",
       method: "POST", input: 'bad protobuf', "CONTENT_TYPE" => "application/protobuf"
     status, headers, body = haberdasher_service.call(rack_env)
 
     assert_equal 404, status
     assert_equal 'application/json', headers['Content-Type']
     assert_equal({
-      "code" => 'bad_route', 
+      "code" => 'bad_route',
       "msg"  => 'Invalid request body for rpc method "MakeHat" with Content-Type=application/protobuf',
       "meta" => {"twirp_invalid_route" => "POST /example.Haberdasher/MakeHat"},
     }, JSON.parse(body[0]))
@@ -230,7 +230,7 @@ class ServiceTest < Minitest::Test
     assert_equal 400, status
     assert_equal 'application/json', headers['Content-Type'] # error responses are always JSON, even for Protobuf requests
     assert_equal({
-      "code" => 'invalid_argument', 
+      "code" => 'invalid_argument',
       "msg" => "I don't like that size",
     }, JSON.parse(body[0]))
   end
@@ -243,7 +243,7 @@ class ServiceTest < Minitest::Test
 
     rack_env = proto_req "/example.Haberdasher/MakeHat", Example::Size.new
     status, headers, body = svc.call(rack_env)
-    
+
     assert_equal 200, status
     assert_equal "public, max-age=60", headers["Cache-Control"] # set by the handler
     assert_equal "application/protobuf", headers["Content-Type"] # set by Twirp::Service
@@ -397,7 +397,7 @@ class ServiceTest < Minitest::Test
     assert_equal 500, status
     refute handler_called
     assert_equal({
-      "code" => 'intenal', 
+      "code" => 'intenal',
       "msg"  => 'error from before hook',
     }, JSON.parse(body[0]))
   end
@@ -474,7 +474,7 @@ class ServiceTest < Minitest::Test
     assert_equal 500, status
     assert_equal 'application/json', headers['Content-Type']
     assert_equal({
-      "code" => 'intenal', 
+      "code" => 'intenal',
       "msg"  => 'hook1 failed',
     }, JSON.parse(body[0]))
 
@@ -517,7 +517,7 @@ class ServiceTest < Minitest::Test
     assert_equal 500, status
     refute success_called # after hook not called
     assert_equal({
-      "code" => 'intenal', 
+      "code" => 'intenal',
       "msg"  => 'error from handler',
     }, JSON.parse(body[0]))
   end
@@ -591,7 +591,7 @@ class ServiceTest < Minitest::Test
 
     assert_equal 500, status
     assert_equal({
-      "code" => 'intenal', 
+      "code" => 'intenal',
       "msg"  => 'before failed',
     }, JSON.parse(body[0]))
     assert error_called
@@ -634,7 +634,7 @@ class ServiceTest < Minitest::Test
     svc = Example::Haberdasher.new(HaberdasherHandler.new do |size, env|
       return Twirp::Error.internal "handler error"
     end)
-    
+
     error_called = false
     svc.on_error do |twerr, env|
       error_called = true
@@ -647,7 +647,7 @@ class ServiceTest < Minitest::Test
 
     assert_equal 500, status
     assert_equal({
-      "code" => 'intenal', 
+      "code" => 'intenal',
       "msg"  => 'handler error',
     }, JSON.parse(body[0]))
     assert error_called
@@ -771,18 +771,17 @@ class ServiceTest < Minitest::Test
 
 
 
-
   # Test Helpers
   # ------------
 
   def json_req(path, attrs)
-    Rack::MockRequest.env_for path, method: "POST", 
+    Rack::MockRequest.env_for path, method: "POST",
       input: JSON.generate(attrs),
       "CONTENT_TYPE" => "application/json"
   end
 
   def proto_req(path, proto_message)
-    Rack::MockRequest.env_for path, method: "POST", 
+    Rack::MockRequest.env_for path, method: "POST",
       input: proto_message.class.encode(proto_message),
       "CONTENT_TYPE" => "application/protobuf"
   end

data/twirp.gemspec

@@ -10,16 +10,16 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Cyrus A. Forbes", "Mario Izquierdo"]
   spec.email         = ["forbescyrus@gmail.com", "tothemario@gmail.com"]
   spec.summary       = %q{Twirp services in Ruby.}
-  spec.description   = %q{Twirp is a simple RPC framework with protobuf service definitions. The Twirp gem provides support for Ruby.}
+  spec.description   = %q{Twirp is a simple RPC framework with protobuf service definitions. The Twirp gem provides native support for Ruby.}
   spec.homepage      = "https://github.com/cyrusaf/ruby-twirp"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.files         = Dir['lib/**/*'] + %w(Gemfile LICENSE README.md twirp.gemspec)
+  spec.test_files    = Dir['test/**/*']
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'google-protobuf', '>= 3.0.0'
+  spec.add_runtime_dependency 'google-protobuf', '~> 3.0', '>= 3.0.0'
+  spec.add_runtime_dependency 'faraday', '~> 0'
 
-  spec.add_development_dependency 'bundler', '>= 1'
+  spec.add_development_dependency 'bundler', '~> 1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twirp
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Cyrus A. Forbes
@@ -9,12 +9,15 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-12 00:00:00.000000000 Z
+date: 2018-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -22,25 +25,42 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
 description: Twirp is a simple RPC framework with protobuf service definitions. The
-  Twirp gem provides support for Ruby.
+  Twirp gem provides native support for Ruby.
 email:
 - forbescyrus@gmail.com
 - tothemario@gmail.com
@@ -48,22 +68,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
-- example/Gemfile
-- example/Gemfile.lock
-- example/gen/haberdasher_pb.rb
-- example/gen/haberdasher_twirp.rb
-- example/haberdasher.proto
-- example/main.rb
 - lib/twirp.rb
+- lib/twirp/client.rb
 - lib/twirp/error.rb
 - lib/twirp/service.rb
+- lib/twirp/service_dsl.rb
 - lib/twirp/version.rb
-- protoc-gen-twirp_ruby/main.go
+- test/client_test.rb
 - test/error_test.rb
 - test/fake_services.rb
 - test/service_test.rb
@@ -88,11 +102,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Twirp services in Ruby.
 test_files:
+- test/client_test.rb
 - test/error_test.rb
 - test/fake_services.rb
 - test/service_test.rb

data/.gitignore

@@ -1 +0,0 @@
-*.gem

data/Gemfile.lock

@@ -1,20 +0,0 @@
-PATH
-  remote: .
-  specs:
-    twirp (0.0.1)
-      google-protobuf (>= 3.0.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    google-protobuf (3.5.1.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (>= 1)
-  twirp!
-
-BUNDLED WITH
-   1.14.6

data/example/Gemfile

@@ -1,7 +0,0 @@
-
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-gem "twirp"
-gem "rack"

data/example/Gemfile.lock

@@ -1,17 +0,0 @@
-GEM
-  remote: https://rubygems.org/
-  specs:
-    google-protobuf (3.5.1.2)
-    rack (2.0.1)
-    twirp (0.0.1)
-      google-protobuf (>= 3.0.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  rack
-  twirp
-
-BUNDLED WITH
-   1.16.1

data/example/gen/haberdasher_pb.rb

@@ -1,18 +0,0 @@
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: haberdasher.proto
-
-require 'google/protobuf'
-
-Google::Protobuf::DescriptorPool.generated_pool.build do
-  add_message "example.HelloWorldRequest" do
-    optional :name, :string, 1
-  end
-  add_message "example.HelloWorldResponse" do
-    optional :message, :string, 1
-  end
-end
-
-module Example
-  HelloWorldRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("example.HelloWorldRequest").msgclass
-  HelloWorldResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("example.HelloWorldResponse").msgclass
-end

data/example/gen/haberdasher_twirp.rb

@@ -1,10 +0,0 @@
-# Code generated by protoc-gen-twirp_ruby, DO NOT EDIT.
-require 'twirp'
-
-module Example
-  class HaberdasherService < Twirp::Service
-    package "example"
-    service "Haberdasher"
-    rpc :HelloWorld, HelloWorldRequest, HelloWorldResponse, :handler_method => :hello_world
-  end
-end