grpc-kit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 10cac29d383da9e2067ce2531663f0dc2dec7a7a
+  data.tar.gz: 3484d24ff86999515b2dad895bb6d9509ab22d4b
+SHA512:
+  metadata.gz: 203f47dc248133a4711030718616186e176b2f7a65969932d1585351c167fd5719d2b1c8f93c0fe8a3ee0492cae6ca04f1d48b02c15184aba639c1cd09a66c83
+  data.tar.gz: 1f3701a9ddbdb7e11a8f381a8f4494951346cf804c68242ef4c3da2579dc1684cba7505c235a655bc17bdd85c0422673da3a8c68b64fd67bc69efd58481b089a

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+  - 2.2.6
+  - 2.1.10
+before_install: gem install bundler -v 1.14.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+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,102 @@
+# GRPC::Kit
+
+GRPC toolkit for microservices
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grpc-kit'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grpc-kit
+
+## Documentation
+
+- [`GRPC::Kit::Communication::Resilient`](#grpckitcommunicationresilient)
+- [`GRPC::Kit::Logger`](#grpckitlogger)
+- [`GRPC::Kit::Queue::Publisher`](#grpckitqueuepublisher)
+- [`GRPC::Kit::Queue::Worker`](#grpckitqueueworker)
+
+### GRPC::Kit::Communication::Resilient
+
+Sometimes, GRPC and Google::Cloud raises _unavailable error_, but you can retry and all works fine. Based on [Datastore documentation](https://cloud.google.com/appengine/articles/handling_datastore_errors#timeouts-due-to-datastore-issues) we implemented a _helper_ for _resilient communication_.
+
+Example:
+
+```ruby
+pubsub = Google::Cloud::Pubsub.new
+topic  = pubsub.create_topic('topic_name')
+topic.publish('message') # receives Google::Cloud::UnavailableError
+
+# But you can uses resilient communication
+include GRPC::Kit::Communication::Resilient
+topic = resilient { topic.publish('message') }
+
+# And you can sets the limit of repetition...
+topic = resilient(limit: 5) { topic.publish('message') }
+```
+
+### GRPC::Kit::Logger
+
+By default all logs sent to `GRPC.logger` are ignored. But `GRPC::Kit::Logger` automatically configures logs to use _STDOUT_.
+
+### GRPC::Kit::Queue::Publisher
+
+To publish a message to topic (creating one if none exists) you only need to configure environment variables for `Google::Cloud::Pubsub` and use:
+
+```ruby
+GRPC::Kit::Queue::Publisher.publish('topic_name', 'message')
+```
+
+### GRPC::Kit::Queue::Worker
+
+Create a class in `lib/workers` including `GRPC::Kit::Queue::Worker`:
+
+```ruby
+# lib/workers/my_worker.rb
+class MyWorker
+  include GRPC::Kit::Queue::Worker
+
+  def initialize(msg)
+    @msg = msg
+  end
+
+  def call
+    puts @msg.data
+    @msg.ack!
+  end
+end
+```
+
+And you can use:
+
+```bash
+# to list available workers
+grpc-kit workers list
+# to run a worker
+grpc-kit workers runner MyWorker topic_name
+```
+
+## 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/b2beauty/grpc-kit.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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 'grpc/kit'
+
+# 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/exe/grpc-kit

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'grpc/kit'
+
+GRPC::Kit::Cli.start(ARGV)

data/grpc-kit.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grpc/kit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'grpc-kit'
+  spec.version       = GRPC::Kit::VERSION
+  spec.authors       = ['Leonardo Saraiva']
+  spec.email         = ['vyper@maneh.org']
+
+  spec.summary       = 'GRPC toolkit for microservices'
+  spec.description   = 'GRPC toolkit for microservices'
+  spec.homepage      = 'http://github.com/b2beauty/grpc-kit'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'google-cloud-pubsub', '~> 0.23.0'
+  spec.add_dependency 'thor',                '~> 0.19.4'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake',    '~> 12.0'
+  spec.add_development_dependency 'rspec',   '~> 3.0'
+end

data/lib/grpc/kit.rb

@@ -0,0 +1,10 @@
+require 'grpc/kit/cli'
+require 'grpc/kit/communication'
+require 'grpc/kit/logger'
+require 'grpc/kit/queue'
+require 'grpc/kit/version'
+
+module GRPC
+  module Kit
+  end
+end

data/lib/grpc/kit/cli.rb

@@ -0,0 +1,38 @@
+require 'thor'
+
+workers_dir = File.join(Dir.pwd, 'lib', 'workers')
+$LOAD_PATH.unshift(workers_dir) unless $LOAD_PATH.include?(workers_dir)
+
+module GRPC
+  module Kit
+    class Workers < Thor
+      desc 'runner <worker> <topic>', 'Run <worker> for <topic>'
+      def runner(worker, topic)
+        require worker.gsub(/(.)([A-Z])/,'\1_\2').downcase
+
+        Queue::Worker::Runner.run! topic: topic, worker: worker
+      end
+
+      desc 'list', 'List available workers'
+      def list
+        Dir.glob('lib/workers/**/*') do |file|
+          require File.basename(file, File.extname(file))
+        end
+
+        workers = GRPC::Kit::Queue::Worker.list
+        if workers.empty?
+          puts 'No available workers'
+        else
+          workers.each do |worker|
+            puts " - #{worker}"
+          end
+        end
+      end
+    end
+
+    class Cli < Thor
+      desc 'workers SUBCOMMAND ...ARGS', 'run or manage workers'
+      subcommand 'workers', Workers
+    end
+  end
+end

data/lib/grpc/kit/communication.rb

@@ -0,0 +1 @@
+require_relative 'communication/resilient'

data/lib/grpc/kit/communication/resilient.rb

@@ -0,0 +1,41 @@
+require 'grpc/errors'
+require 'google/cloud/errors'
+
+module GRPC
+  module Kit
+    module Communication
+      module Resilient
+        ERRORS = [
+          GRPC::BadStatus,
+          Google::Cloud::UnavailableError,
+          Google::Cloud::InternalError
+        ].freeze
+
+        def resilient(limit: 16)
+          tries ||= 0
+          yield
+        # From Datastore documentation:
+        # - UNAVAILABLE;
+        # - Server returned an error;
+        # - Retry using exponential backoff.
+        rescue *ERRORS => e
+          tries += 1
+          exponential_backoff(tries, limit: limit) && retry
+          raise
+        end
+
+        # See: https://en.wikipedia.org/wiki/Exponential_backoff
+        def exponential_backoff(tries, limit:)
+          # Retry few times before going exponential
+          return true if tries <= 3
+
+          # Check whether it's reached the ceiling
+          if tries < limit
+            retry_time = 0.1 * rand(1 << tries) # random number between 0 and 2**N − 1
+            sleep(retry_time)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/grpc/kit/logger.rb

@@ -0,0 +1,20 @@
+require 'logger'
+
+module GRPC
+  module Kit
+    module Logger
+      # TODO Should we use config or env var?
+      LOGGER = ::Logger.new(STDOUT)
+      # TODO Should we use config or env var?
+      LOGGER.level = ::Logger::DEBUG
+
+      def logger
+        LOGGER
+      end
+    end
+  end
+end
+
+module GRPC
+  extend Kit::Logger
+end

data/lib/grpc/kit/queue.rb

@@ -0,0 +1,2 @@
+require_relative 'queue/publisher'
+require_relative 'queue/worker'

data/lib/grpc/kit/queue/publisher.rb

@@ -0,0 +1,25 @@
+require 'google/cloud/pubsub'
+
+module GRPC
+  module Kit
+    module Queue
+      module Publisher
+        module_function
+
+        @@topics = {}
+
+        def publish(topic_name, message)
+          topic(topic_name).publish(message)
+        end
+
+        def topic(name)
+          @@topics[name] ||= pubsub.topic(name) || pubsub.create_topic(name)
+        end
+
+        def pubsub
+          @@pubsub ||= Google::Cloud::Pubsub.new
+        end
+      end
+    end
+  end
+end

data/lib/grpc/kit/queue/worker.rb

@@ -0,0 +1,24 @@
+require_relative 'worker/runner'
+
+module GRPC
+  module Kit
+    module Queue
+      module Worker
+        def self.included(klass)
+          @@workers ||= []
+          @@workers << klass
+        end
+
+        def self.list
+          @@workers
+        rescue NameError
+          []
+        end
+
+        def call
+          raise NotImplemented.new
+        end
+      end
+    end
+  end
+end

data/lib/grpc/kit/queue/worker/runner.rb

@@ -0,0 +1,50 @@
+module GRPC
+  module Kit
+    module Queue
+      module Worker
+        class Runner
+          def initialize(params)
+            @topic_name        = params[:topic]
+            @subscription_name = "#{params[:topic]}.#{params[:worker]}"
+            @worker_class      = params[:worker]
+          end
+
+          def self.run!(params)
+            new(params).run!
+          end
+
+          def run!
+            if worker.nil?
+              GRPC.logger.error("class #{@worker_class} does not exist")
+              exit
+            end
+
+            subscription.listen do |msg|
+              worker.new(msg).call
+            end
+          end
+
+          private
+
+          def worker
+            Object.const_get(@worker_class)
+          rescue NameError
+            nil
+          end
+
+          def subscription
+            @subscription ||= topic.subscription(@subscription_name) || topic.subscribe(@subscription_name)
+          end
+
+          def topic
+            @topic ||= pubsub.topic(@topic_name) || pubsub.create_topic(@topic_name)
+          end
+
+          def pubsub
+            @pubsub ||= Google::Cloud::Pubsub.new
+          end
+        end
+      end
+    end
+  end
+end

data/lib/grpc/kit/version.rb

@@ -0,0 +1,5 @@
+module GRPC
+  module Kit
+    VERSION = '0.1.0'
+  end
+end

data/lib/workers/my_other_worker.rb

@@ -0,0 +1,9 @@
+require 'grpc/kit/queue/worker'
+
+class MyOtherWorker
+  include GRPC::Kit::Queue::Worker
+
+  def call
+    puts 'ping'
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: grpc-kit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Leonardo Saraiva
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-cloud-pubsub
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.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: GRPC toolkit for microservices
+email:
+- vyper@maneh.org
+executables:
+- grpc-kit
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/grpc-kit
+- grpc-kit.gemspec
+- lib/grpc/kit.rb
+- lib/grpc/kit/cli.rb
+- lib/grpc/kit/communication.rb
+- lib/grpc/kit/communication/resilient.rb
+- lib/grpc/kit/logger.rb
+- lib/grpc/kit/queue.rb
+- lib/grpc/kit/queue/publisher.rb
+- lib/grpc/kit/queue/worker.rb
+- lib/grpc/kit/queue/worker/runner.rb
+- lib/grpc/kit/version.rb
+- lib/workers/my_other_worker.rb
+homepage: http://github.com/b2beauty/grpc-kit
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: GRPC toolkit for microservices
+test_files: []