twirp-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9dcf037d0a667d0d0279eb44e44f83b14483921b93c087bccf212e2961d97e82
+  data.tar.gz: ebd43a7b27ee04d31a5e07daa23af429003a9c6ecce93a241e7c76e54f402a34
+SHA512:
+  metadata.gz: eece932d46ad2dd988db38915d7e89e3a559072f82799a03fda573c531d66135e4e534f486235443be1f2cf1d682cc51b5ae9da29d3bc5e051f2f850f0a1f58a
+  data.tar.gz: ad9efed9706d6ff118a98228c27cab0cdb02cfb05cd98461047e98a2ad01f2930c3ff5c1fb8770f57ca2dc3c4aa42c79ee11267f9707ad0a9217228d1983ec2c

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock
+.ruby-version

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in twirp-rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Nobuhiro Nikushi
+
+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,94 @@
+# Twirp::Rails [![Build Status](https://travis-ci.org/nikushi/twirp-rails.svg?branch=master)](https://travis-ci.org/nikushi/twirp-rails) [![Gem Version](https://badge.fury.io/rb/twirp-rails.svg)](https://badge.fury.io/rb/twirp-rails)
+
+Twirp for Rails
+
+## Features
+
+[twirp-ruby](https://github.com/twitchtv/twirp-ruby) with Ruby on Rails. It provides auto routing installation, by using the `bind` helper method to bind a handler and a service.
+
+```
+$ bin/rails routes
+
+Prefix Verb URI Pattern                           Controller#Action
+       POST /twirp/HelloService(.:format)         hello#hello,hi,greet
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'twirp-rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install twirp-rails
+
+## Configuration
+
+After insalled, put the configuration file as follows:
+
+```
+# config/initializers/twirp_rails.rb
+
+Twirp::Rails.configuration do |c|
+  # Modify the path below if you locates handlers under the different directory.
+  c.handlers_path = Rails.root.join('app', 'controllers', 'rpc')
+end
+```
+
+### Routes
+
+Add the line `use_twirp` in `config/routes.rb`.  By this, you can tell Rails app what endpoints to be served.
+
+```
+# config/routes.rb
+
+Rails.application.routes.draw do
+  use_twirp
+end
+```
+
+### Binding
+
+Next, let's link handlers(a.k.a controllers) with services. `bind` method can bind them.
+
+```
+class HelloHandler
+  include Twirp::Rails::Helpers
+
+  bind HelloService
+
+  def hello(_req, _env)
+    HelloResponse.new(message: 'hello')
+  end
+end
+```
+
+So now corresponding routes will be defined.
+
+```
+$ bin/rails routes
+
+Prefix Verb URI Pattern                           Controller#Action
+       POST /twirp/HelloService(.:format)         hello#hello,hi,greet
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/twirp-rails.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "twirp/rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/twirp/rails.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "twirp/rails/configuration"
+require "twirp/rails/helpers"
+require "twirp/rails/routes"
+require "twirp/rails/engine"
+require "twirp/rails/version"
+
+module Twirp
+  module Rails
+    class << self
+      def configuration(&block)
+        @configuration ||= Configuration.new
+        yield @configuration if block_given?
+        @configuration
+      end
+      attr_writer :configuration
+
+      # A store to register rack apps, which are the instantiated services.
+      # @return [Array<Twirp::Service>]
+      def services
+        @services ||= []
+      end
+
+      def load_handlers
+        Dir[File.join(configuration.handlers_path.to_s, '**', '*.rb')].each { |f| require f }
+      end
+    end
+  end
+end

data/lib/twirp/rails/configuration.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Twirp
+  module Rails
+    class Configuration
+      attr_reader :handlers_path
+
+      def initialize
+        @handlers_path = nil
+      end
+
+      def handlers_path=(v)
+        @handlers_path = v.to_s
+      end
+    end
+  end
+end

data/lib/twirp/rails/engine.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'rails/engine'
+
+module Twirp
+  module Rails
+    class Engine < ::Rails::Engine
+      initializer "twirp.rails.routes" do
+        Twirp::Rails.load_handlers
+        Twirp::Rails::Routes.install!
+      end
+    end
+  end
+end

data/lib/twirp/rails/helpers.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Twirp
+  module Rails
+    module Helpers
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      module ClassMethods
+        def bind(service_klass)
+          Twirp::Rails.services << service_klass.new(new)
+        end
+      end
+    end
+  end
+end

data/lib/twirp/rails/routes.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Twirp
+  module Rails
+    class Routes # :nodoc:
+      module Helper
+        def use_twirp(options = {})
+          services = Twirp::Rails.services
+          Twirp::Rails::Routes.new(self, services).generate_routes!(options)
+        end
+      end
+
+      # A module to modify the output of the controller part on `rails routes`
+      module Inspectable
+        REMOVABLE_SUFFIX_RE = /(_handler|_controller)\z/
+
+        def inspect
+          handler = instance_variable_get(:@handler).class.name.underscore.sub(REMOVABLE_SUFFIX_RE, '')
+          methods = self.class.rpcs.values.map { |h| h[:ruby_method].to_s }.sort.join(',')
+          [handler, methods].join('#')
+        end
+      end
+
+      def self.install!
+        ActionDispatch::Routing::Mapper.send :include, Twirp::Rails::Routes::Helper
+      end
+
+      attr_reader :routes
+
+      def initialize(routes, services)
+        @routes = routes
+        @services = services
+      end
+
+      def generate_routes!(options)
+        routes.scope options[:scope] || 'twirp' do
+          @services.each do |service|
+            service.extend Inspectable
+            @routes.mount service, at: service.full_name
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twirp/rails/version.rb

@@ -0,0 +1,5 @@
+module Twirp
+  module Rails
+    VERSION = "0.1.0"
+  end
+end

data/twirp-rails.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "twirp/rails/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "twirp-rails"
+  spec.version       = Twirp::Rails::VERSION
+  spec.authors       = ["Nobuhiro Nikushi"]
+  spec.email         = ["deneb.ge@gmail.com"]
+
+  spec.summary       = "Twirp for Rails"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/nikushi/twirp-rails"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_dependency "railties", ">= 4.2"
+  spec.add_dependency 'twirp'
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: twirp-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nobuhiro Nikushi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: twirp
+  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: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Twirp for Rails
+email:
+- deneb.ge@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/twirp/rails.rb
+- lib/twirp/rails/configuration.rb
+- lib/twirp/rails/engine.rb
+- lib/twirp/rails/helpers.rb
+- lib/twirp/rails/routes.rb
+- lib/twirp/rails/version.rb
+- twirp-rails.gemspec
+homepage: https://github.com/nikushi/twirp-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Twirp for Rails
+test_files: []