jpc 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 44e0f3d3575d9354f06be32bea3a575703fcc549
+  data.tar.gz: 354b7950320b1d9d953b8aaa4a640da5608199ff
+SHA512:
+  metadata.gz: a475fdce6035e2ae61af9e53abaca5ddfbf73d3942abfc9e45581a9795e920f4c5c83566a5bb5effe02cc19688d41e0006d9bbc59535c4201b273de4fe3d8786
+  data.tar.gz: f65d9494aa7dd571d7f32be98cbec80b26dace79cbb57f681c00e860bba76f0a2ccd5172e5ddf3e2aa58c4cdad681e031e72fbc37c6b88e7934e90a97ad4c46a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Denis Lysenko
+
+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,77 @@
+# JPC
+
+This gem implements server-side support for JSON-RPC 2.0 via websockets over EventMachine.
+
+However it implements channels support to broadcast functions like ActionCable.
+
+## Installation
+
+Add follow line to your application's Gemfile:
+
+```ruby
+gem 'jpc', github: 'lysenkooo/jpc-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+First of all you need to create handler.
+
+```ruby
+class MainHandler < JPC::Handler
+  def test_hash_params(params)
+    "Success with #{params.inspect}"
+  end
+
+  def test_array_params(first, second, third)
+    "Success with #{first} #{second} #{third}"
+  end
+
+  def broadcast_message(message)
+    @dispatcher.cast('main_channel', message)
+  end
+
+  private
+
+  def procedures
+    %w[test_hash_params test_array_params broadcast_message]
+  end
+end
+```
+
+After that you should create invoker instance and set up forwarding JSON
+messages from your client.
+
+```ruby
+EventMachine.run do
+  dispatcher = JPC::Dispatcher.new
+
+  EM::WebSocket.run(host: '0.0.0.0', port: 8090) do |ws|
+    handler = MainHandler.new(ws, dispatcher)
+    rpc = JPC::Invoker.new(handler)
+
+    ws.onmessage do |message|
+      response = rpc.invoke(message)
+      ws.send(response)
+    end
+
+    ws.onerror do |error|
+      backtrace = error.backtrace.join("\n")
+      puts "#{error}\n#{backtrace}\n"
+    end
+  end
+end
+```
+
+Now you can use JSON-RPC 2.0 client to send messages to your websocket.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lysenkooo/jpc-ruby.
+
+## 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 "jpc"
+
+# 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

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/jpc.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jpc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jpc"
+  spec.version       = JPC::VERSION
+  spec.authors       = ["Denis Lysenko"]
+  spec.email         = ["d@lysenkooo.ru"]
+  spec.summary       = %q{JPC is JSON-RPC 2.0 Ruby Library.}
+  spec.description   = %q{This library provide possibility to handle JSON requests.}
+  spec.homepage      = "http://lysenkooo.ru"
+  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_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "oj", ">= 2.0.0"
+end

data/lib/jpc.rb

@@ -0,0 +1,10 @@
+require "jpc/version"
+require "jpc/errors"
+require "jpc/helpers"
+require "jpc/invoker"
+require "jpc/handler"
+require "jpc/dispatcher"
+
+module JPC
+  RPC_VERSION = '2.0'.freeze
+end

data/lib/jpc/dispatcher.rb

@@ -0,0 +1,37 @@
+class JPC::Dispatcher
+  include JPC::Helpers
+
+  def subscribe(ws, channel)
+    channels[channel.to_sym] ||= []
+    channels[channel.to_sym] << ws
+
+    { channel: channel, status: 'subscribed' }
+  end
+
+  def unsubscribe(ws, channel)
+    fail "Channel #{channel} not found" unless channels[channel.to_sym]
+
+    channels[channel.to_sym] -= [ws]
+
+    { channel: channel, status: 'unsubscribed' }
+  end
+
+  def cast(channel, payload)
+    message = make_message(channel: channel, payload: payload)
+
+    sent = 0
+
+    channels[channel.to_sym] && channels[channel.to_sym].each do |ws|
+      ws.send(message)
+      sent += 1
+    end
+
+    { channel: channel, sent: sent }
+  end
+
+  private
+
+  def channels
+    @channels ||= {}
+  end
+end

data/lib/jpc/errors.rb

@@ -0,0 +1,9 @@
+module JPC
+  module Errors
+    class UnauthorizedError < RuntimeError
+      def message
+        "Unauthorized Request"
+      end
+    end
+  end
+end

data/lib/jpc/handler.rb

@@ -0,0 +1,30 @@
+class JPC::Handler
+  attr_accessor :token
+
+  def initialize(ws, dispatcher)
+    @ws = ws
+    @dispatcher = dispatcher
+  end
+
+  def ping(params = {})
+    "pong #{params}"
+  end
+
+  def subscribe(channel)
+    @dispatcher.subscribe(@ws, channel)
+  end
+
+  def unsubscribe(channel)
+    @dispatcher.unsubscribe(@ws, channel)
+  end
+
+  private
+
+  def allowed_methods
+    procedures + %w(ping subscribe unsubscribe)
+  end
+
+  def procedures
+    []
+  end
+end

data/lib/jpc/helpers.rb

@@ -0,0 +1,26 @@
+module JPC
+  module Helpers
+    def make_message(data)
+      message = { jsonrpc: JPC::RPC_VERSION }.merge!(data)
+      Oj.dump(message, mode: :compat)
+    end
+
+    def make_response(id, data)
+      response = { id: id }.merge!(data)
+      make_message(response)
+    end
+
+    def make_result(id, result)
+      make_response(id, result: result)
+    end
+
+    def make_error(id, code, message)
+      error = {
+        code: code,
+        message: message
+      }
+
+      make_response(id, error: error)
+    end
+  end
+end

data/lib/jpc/invoker.rb

@@ -0,0 +1,53 @@
+class JPC::Invoker
+  include JPC::Helpers
+
+  def initialize(handler)
+    @handler = handler
+  end
+
+  def invoke(json)
+    request = Oj.load(json)
+    response = execute(request)
+  end
+
+  private
+
+  def execute(request)
+    method = request['method']
+
+    fail "Method #{method} not allowed" unless method_allowed?(method)
+
+    @handler.token = request['token'] if request['token']
+
+    if @handler.respond_to?(:authorized?)
+      fail JPC::Errors::UnauthorizedError unless @handler.authorized?(method)
+    end
+
+    if request['params'].is_a?(Array)
+      result = @handler.public_send(method, *request['params'])
+    elsif %w(Hash String Integer).include?(request['params'].class.name)
+      result = @handler.public_send(method, request['params'])
+    else
+      result = @handler.public_send(method)
+    end
+
+    make_result(request['id'], result)
+  rescue => e
+    case e.class.name
+    when 'JPC::Errors::UnauthorizedError'
+      code = 32001
+    else
+      code = 32000
+    end
+
+    make_error(
+      request['id'],
+      code,
+      "Method #{method}: #{e.message}. See #{e.backtrace[0]}"
+    )
+  end
+
+  def method_allowed?(name)
+    @handler.send(:allowed_methods).include?(name.to_s)
+  end
+end

data/lib/jpc/version.rb

@@ -0,0 +1,3 @@
+module JPC
+  VERSION = "1.1.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: jpc
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Denis Lysenko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: This library provide possibility to handle JSON requests.
+email:
+- d@lysenkooo.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jpc.gemspec
+- lib/jpc.rb
+- lib/jpc/dispatcher.rb
+- lib/jpc/errors.rb
+- lib/jpc/handler.rb
+- lib/jpc/helpers.rb
+- lib/jpc/invoker.rb
+- lib/jpc/version.rb
+homepage: http://lysenkooo.ru
+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.6
+signing_key: 
+specification_version: 4
+summary: JPC is JSON-RPC 2.0 Ruby Library.
+test_files: []