remote_service 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4dd7830f2ff048b0348942c4da955bf2acd73188
+  data.tar.gz: ab29fdb9efff35d9bbf4bb2187329668abcabcc8
+SHA512:
+  metadata.gz: 0b7d5ce88b8d965819819136582595a6cda5ae72dc337b1a6b3b5b4844bb021bebb8d593d106d25c802445ae1ef26d222e15756f4af963aca7d5f1fbcb590a1a
+  data.tar.gz: 9fe38ebaec53b369eba922d1aa93612eea864074d4fcd5745a33e3a44db6e47e55d673c5f63576e8e291037d7129d480d516f38e0f1e586ded2b4c66881d95d5

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+.ruby-version
+*.gem

data/.travis.yml

@@ -0,0 +1,14 @@
+sudo: required
+
+language: ruby
+rvm:
+  - 2.2
+
+services:
+  - docker
+
+before_install:
+  - docker-compose up -d
+
+script:
+  - bundle exec rake test

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    remote_service (0.1.0)
+      msgpack (~> 1.0)
+      nats (~> 0.8.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    eventmachine (1.2.0.1)
+    metaclass (0.0.4)
+    minitest (5.9.0)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    msgpack (1.0.0)
+    nats (0.8.0)
+      eventmachine (~> 1.2, >= 1.2.0)
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  minitest (~> 5.0)
+  mocha (~> 1.1)
+  rake (~> 10.0)
+  remote_service!
+
+BUNDLED WITH
+   1.12.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 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,71 @@
+# RemoteService ![img](https://travis-ci.com/marekgalovic/ruby-remote-service.svg?token=tzyPCMPPikt2LiEzxR71&branch=master)
+
+Remote services made easy. This gem is basically RPC client/server implemented on top of awesome [NATS](http://nats.io/) project. Every service you want to use is exposed through class that extends `RemoteService::Proxy`. Service itself extends `RemoteService::Service` and should define all methods that you want to call from clients.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'remote_service'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install remote_service
+
+## Usage
+First you need to start NATS cluster. This can be either single broker or n-node cluster. I've made easy for you to play with this gem, so all you need to do is install `Docker` and `Docker compose` (if you haven't yet) and run following command.
+```
+docker-compose up
+```
+
+First you need to define and run your service. Minimal service can be run with a following script where return value of each method will be sent back as a response.
+```ruby
+require "remote_service"
+
+class ServiceA < RemoteService::Service
+  def all(count, keyword)
+    # exceptions raised here will raise RemoteService::Errors::RemoteCallError exception in client
+    count
+  end
+end
+
+# NATS uses autodiscovery, so third broker will be added automatically
+ServiceA.start(brokers: ['nats://127.0.0.1:4222', 'nats://127.0.0.1:5222'])
+```
+
+To call this service from remote machine, one need to define service proxy. Following script is an example of how can we execute remote call to the service defined above.
+```ruby
+require "remote_service"
+
+RemoteService.connect(brokers: ['nats://127.0.0.1:4222', 'nats://127.0.0.1:6222'])
+
+class ServiceA < RemoteService::Proxy
+  timeout 100 # optional, default value is 10ms
+end
+
+# non-blocking call
+ServiceA.all(123, keyword: 'value') do |result, error|
+  puts result
+end
+sleep(0.1) # wait for non-blocking call to execute
+
+# blocking call
+# this will raise RemoteService::Errors::RemoteCallError if an error was raised in remote service
+puts ServiceA.all(123, keyword: 'value')
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/marekgalovic/ruby-remote-service. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

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/docker-compose.yml

@@ -0,0 +1,28 @@
+version: '2'
+
+services:
+  nats_node_1:
+    image: nats:0.9.4
+    hostname: nats1
+    entrypoint: '/gnatsd -p 4222 -m 8888 -cluster nats://0.0.0.0:4248 -D'
+    ports:
+      - "4222:4222"
+      - "8888:8888"
+
+  nats_node_2:
+    image: nats:0.9.4
+    hostname: nats2
+    entrypoint: '/gnatsd -p 5222 -cluster nats://0.0.0.0:5248 -routes nats://nats1:4248 -D'
+    links:
+      - nats_node_1:nats1
+    ports:
+      - "5222:5222"
+
+  nats_node_3:
+    image: nats:0.9.4
+    hostname: nats3
+    entrypoint: '/gnatsd -p 6222 -cluster nats://0.0.0.0:6248 -routes nats://nats1:4248 -D'
+    links:
+      - nats_node_1:nats1
+    ports:
+      - "6222:6222"

data/examples/client.rb

@@ -0,0 +1,19 @@
+require 'logger'
+require 'benchmark'
+require "bundler/setup"
+require "remote_service"
+
+class ServiceA < RemoteService::Proxy
+  timeout 100
+end
+
+class ServiceB < RemoteService::Proxy
+  timeout 100
+end
+
+RemoteService.logger.level = Logger::DEBUG
+RemoteService.connect(brokers: ['nats://127.0.0.1:4222', 'nats://127.0.0.1:5222', 'nats://127.0.0.1:6222'])
+
+ServiceA.all(123, keyword: 'value')
+ServiceB.users
+

data/examples/service_a.rb

@@ -0,0 +1,10 @@
+require "bundler/setup"
+require "remote_service"
+
+class ServiceA < RemoteService::Service
+  def all(count, keyword:)
+    keyword
+  end
+end
+
+ServiceA.start(brokers: ['nats://127.0.0.1:5222'])

data/examples/service_b.rb

@@ -0,0 +1,10 @@
+require "bundler/setup"
+require 'remote_service'
+
+class ServiceB < RemoteService::Service
+  def users
+    [{id: 1, name: 'John', surname: 'Doe'}]
+  end
+end
+
+ServiceB.start(brokers: ['nats://127.0.0.1:6222'])

data/lib/remote_service/base.rb

@@ -0,0 +1,23 @@
+module RemoteService
+  class Base
+    class << self
+
+      def queue_name
+        "services.#{@queue ||= default_queue_name}"
+      end
+
+      private
+
+      def queue(name)
+        @queue = name
+      end
+
+      def default_queue_name
+        self.name.split(/::/).last.
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").downcase
+      end
+    end
+  end
+end

data/lib/remote_service/call.rb

@@ -0,0 +1,40 @@
+module RemoteService
+  class Call
+    attr_reader :queue, :action, :params, :timeout
+
+    def initialize(queue, action, params, timeout:)
+      @queue = queue
+      @action = action
+      @params = params
+      @timeout = (timeout || 10) / 1000.0
+    end
+
+    def run(&block)
+      return call_service_synchronously if !block_given?
+      call_service(&block)
+    end
+
+    private
+
+    def call_service
+      RemoteService::Queue.instance.request(queue, {action: action, params: params}) do |response|
+        yield(response['result'], response['error'])
+      end
+    end
+
+    def call_service_synchronously
+      lock = Util::Lock.new(timeout)
+      call_service do |response, error|
+        lock.unlock(response, error)
+      end
+      response, error = lock.wait
+      raise remote_error(error) if error
+      response
+    end
+
+    def remote_error(error)
+      RemoteService.logger.error("RPC_ERROR - SERVICE:[#{queue}] ACTION:[#{action}] ERROR:#{error}")
+      Errors::RemoteCallError.new(error['name'], error['message'], error['backtrace'])
+    end
+  end
+end

data/lib/remote_service/connector/nats.rb

@@ -0,0 +1,62 @@
+require 'nats/client'
+
+module RemoteService
+  module Connector
+    class Nats
+      attr_reader :brokers
+
+      def initialize(brokers:)
+        @brokers = brokers
+      end
+
+      def start(&block)
+        return connection_thread if !block_given?
+        connect(&block)
+      end
+
+      def stop
+        NATS.stop
+      end
+
+      def publish(to_queue, message)
+        NATS.publish(to_queue, message)
+      end
+
+      def request(to_queue, message, &block)
+        NATS.request(to_queue, message, &block)
+      end
+
+      def subscribe(service_queue, &block)
+        NATS.subscribe(service_queue, queue: service_queue, &block)
+      end
+
+      private
+
+      attr_reader :connection
+
+      def connect
+        NATS.start(servers: @brokers) do |connection|
+          RemoteService.logger.info "CONNECTED: #{connection.connected_server}"
+          RemoteService.logger.info "SERVERS IN POOL: #{connection.server_pool.count}"
+          connection.on_reconnect do
+            RemoteService.logger.info "RECONNECT, NEW_NODE: #{connection.connected_server}"
+          end
+          connection.on_disconnect do |reason|
+            RemoteService.logger.info "DISCONNECTED: #{reason}"
+          end
+          yield(connection)
+        end
+      end
+
+      def connection_thread
+        lock = Util::Lock.new
+        Thread.new do
+          connect do |connection|
+            lock.unlock(connection)
+          end
+        end
+        lock.wait
+      end
+    end
+  end
+end

data/lib/remote_service/errors.rb

@@ -0,0 +1,13 @@
+module RemoteService
+  module Errors
+    class RemoteCallError < StandardError
+      attr_accessor :name, :message, :backtrace
+
+      def initialize(name, message, backtrace)
+        @name = name
+        @message = message
+        @backtrace = backtrace
+      end
+    end
+  end
+end

data/lib/remote_service/proxy.rb

@@ -0,0 +1,19 @@
+module RemoteService
+  class Proxy < Base
+    class << self
+      def method_missing(method_name, *args, &block)
+        service_call(method_name, args, &block)
+      end
+
+      def timeout(time)
+        @timeout = time
+      end
+
+      private
+
+      def service_call(action, payload, &block)
+        Call.new(self.queue_name, action, payload, timeout: @timeout).run(&block)
+      end
+    end
+  end
+end

data/lib/remote_service/queue.rb

@@ -0,0 +1,74 @@
+require 'securerandom'
+require 'singleton'
+require 'msgpack'
+
+module RemoteService
+  class Queue
+    include Singleton
+
+    def connect(brokers, &block)
+      @conn = RemoteService::Connector::Nats.new(brokers)
+      @conn.start(&block)
+    end
+
+    def service(service_handler, workers=16)
+      @service_handler = service_handler
+      @workers = workers
+      start_service_subscriber
+    end
+
+    def request(queue, payload)
+      RemoteService.logger.debug "REQUEST - SERVICE:[#{queue}] PAYLOAD:[#{payload}]"
+      sent_at = Time.now.utc
+      @conn.request(queue, encode(payload)) do |response|
+        data = decode(response)
+        response_time = (Time.now.utc - sent_at)*1000
+        RemoteService.logger.debug "RESPONSE - SERVICE:[#{queue}] PAYLOAD:[#{data}] TIME:[#{response_time}ms]"
+        yield(data)
+      end
+    end
+
+    def publish(queue, payload)
+      @conn.publish(queue, encode(payload))
+    end
+
+    def stop
+      @conn.stop
+    end
+
+    private
+
+    def start_service_subscriber
+      RemoteService.logger.debug "SERVICE QUEUE: #{service_queue_name}"
+      @conn.subscribe(service_queue_name) do |request, reply_to|
+        begin
+          payload = decode(request)
+          RemoteService.logger.debug "FETCHED - REPLY_TO:[#{reply_to}] PAYLOAD:[#{payload}]"
+          @service_handler.handle(payload, reply_to)
+        rescue => e
+          RemoteService.logger.error(e)
+          Queue.instance.publish(
+            reply_to,
+            {result: nil, error: {name: e.class.name, message: e.message, backtrace: e.backtrace}},
+          )
+        end
+      end
+    end
+
+    def service?
+      @service_handler != nil
+    end
+
+    def service_queue_name
+      @service_handler.class.queue_name if @service_handler
+    end
+
+    def encode(payload)
+      MessagePack.pack(payload)
+    end
+
+    def decode(payload)
+      MessagePack.unpack(payload)
+    end
+  end
+end

data/lib/remote_service/service.rb

@@ -0,0 +1,36 @@
+require 'singleton'
+
+module RemoteService
+  class Service < Base
+    include Singleton
+
+    def handle(payload, reply_to)
+      result = method(payload['action'].to_sym).call(*prepare_params(payload['params']))
+      RemoteService.logger.debug "RESULT - ACTION:[#{payload['action']}] REPLY_TO:[#{reply_to}] PARAMS:[#{payload['params']}] RESULT:[#{result}]"
+      respond_with_result(reply_to, result)
+    end
+
+    private
+
+    def respond_with_result(reply_to, result)
+      Queue.instance.publish(reply_to, {result: result})
+    end
+
+    def prepare_params(params)
+      params.map { |param| param.is_a?(Hash) ? sym_keys(param) : param }
+    end
+
+    def sym_keys(params)
+      params.map { |k, v| [k.to_sym, v] }.to_h
+    end
+
+    class << self
+      def start(brokers, workers=16)
+        queue = Queue.instance
+        queue.connect(brokers) do
+          queue.service(self.instance, workers)
+        end
+      end
+    end
+  end
+end

data/lib/remote_service/util/lock.rb

@@ -0,0 +1,25 @@
+require 'timeout'
+
+module RemoteService
+  module Util
+    class Lock
+      def initialize(timeout=0)
+        @mutex = Mutex.new
+        @condition = ConditionVariable.new
+        @timeout = timeout
+      end
+
+      def unlock(*return_value)
+        @return_value = *return_value
+        @mutex.synchronize{ @condition.signal }
+      end
+
+      def wait
+        Timeout.timeout(@timeout) do
+          @mutex.synchronize{ @condition.wait(@mutex) }
+          @return_value
+        end
+      end
+    end
+  end
+end

data/lib/remote_service/version.rb

@@ -0,0 +1,3 @@
+module RemoteService
+  VERSION = "0.1.1"
+end

data/lib/remote_service.rb

@@ -0,0 +1,32 @@
+require "remote_service/version"
+require "remote_service/errors"
+require "remote_service/util/lock"
+require "remote_service/connector/nats"
+require "remote_service/queue"
+require "remote_service/call"
+require "remote_service/base"
+require "remote_service/service"
+require "remote_service/proxy"
+require 'logger'
+
+module RemoteService
+  extend self
+  attr_writer :logger
+
+  def connect(brokers, &block)
+    queue = Queue.instance
+    queue.connect(brokers, &block)
+  end
+
+  def disconnect
+    Queue.instance.stop
+  end
+
+  def logger
+    @logger ||= begin
+      logger = Logger.new(STDOUT)
+      logger.level = Logger::INFO
+      logger
+    end
+  end
+end

data/remote_service.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'remote_service/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "remote_service"
+  spec.version       = RemoteService::VERSION
+  spec.authors       = ["Marek Galovic"]
+  spec.email         = ["galovic.galovic@gmail.com"]
+
+  spec.summary       = %q{Dead-simple ruby RPC}
+  spec.description   = %q{NATS based client/server implementation that allows you to easily call remote services.}
+  spec.homepage      = "https://github.com/marekgalovic/ruby-remote-service"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'nats', '~> 0.8.0'
+  spec.add_runtime_dependency 'msgpack', '~> 1.0'
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency 'mocha', '~> 1.1'
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: remote_service
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Marek Galovic
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nats
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: NATS based client/server implementation that allows you to easily call
+  remote services.
+email:
+- galovic.galovic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/setup
+- docker-compose.yml
+- examples/client.rb
+- examples/service_a.rb
+- examples/service_b.rb
+- lib/remote_service.rb
+- lib/remote_service/base.rb
+- lib/remote_service/call.rb
+- lib/remote_service/connector/nats.rb
+- lib/remote_service/errors.rb
+- lib/remote_service/proxy.rb
+- lib/remote_service/queue.rb
+- lib/remote_service/service.rb
+- lib/remote_service/util/lock.rb
+- lib/remote_service/version.rb
+- remote_service.gemspec
+homepage: https://github.com/marekgalovic/ruby-remote-service
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Dead-simple ruby RPC
+test_files: []