jrpc 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 02a37ef8c074646479c26dd113cf7245f5989412
+  data.tar.gz: 337a198aa49dc1e34561cd5941e5c65f63e00c97
+SHA512:
+  metadata.gz: 189d7c573b2373bcb16ca7c2fe8e06c18e1827fa7aaa4fef73d984f04230a75653ef93ee80785f464c227f8d0a360dbe2add18376f3ff03f267e5413aba66c39
+  data.tar.gz: 0355449f1477898dbf19c22ed2930b8ab239fb619948d952bdb27f48adc2ebfdeff4364bb4e60dfa61d0d8dd7621cb2abf2ecd3da9c56e6b4a84b91ebe0eb935

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.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Denis Talakevich
+
+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,33 @@
+# JRPC
+
+JSON RPC TCP client
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jrpc'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jrpc
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jrpc.
+
+
+## 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/jrpc.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jrpc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jrpc'
+  spec.version       = JRPC::VERSION
+  spec.authors       = ['Denis Talakevich']
+  spec.email         = ['senid231@gmail.com']
+
+  spec.summary       = 'JSON RPC client'
+  spec.description   = 'JSON RPC client over TCP'
+  spec.homepage      = 'https://github.com/senid231/jrpc'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'netstring'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+end

data/lib/jrpc.rb

@@ -0,0 +1,18 @@
+require 'jrpc/version'
+require 'jrpc/netstring_tcp_socket'
+require 'jrpc/base_client'
+require 'jrpc/tcp_client'
+require 'jrpc/error/error'
+require 'jrpc/error/client_error'
+require 'jrpc/error/server_error'
+require 'jrpc/error/internal_error'
+require 'jrpc/error/internal_server_error'
+require 'jrpc/error/invalid_params'
+require 'jrpc/error/invalid_request'
+require 'jrpc/error/method_not_found'
+require 'jrpc/error/parse_error'
+require 'jrpc/error/unknown_error'
+
+module JRPC
+  JSON_RPC_VERSION = '2.0'
+end

data/lib/jrpc/base_client.rb

@@ -0,0 +1,76 @@
+require 'json'
+module JRPC
+  class BaseClient
+
+    def method_missing(method, *params)
+      invoke_request(method, *params)
+    end
+
+    def invoke_request(method, *params)
+      request = create_message(method, params)
+      id = generate_id
+      request['id'] = id
+
+      response = send_request request.to_json
+      response = JSON.parse response
+
+      validate_response(response, id)
+      parse_error(response['error']) if response.has_key?('error')
+
+      response['result']
+    end
+
+    def invoke_notification(method, *params)
+      send_notification create_message(method, params).to_json
+      nil
+    end
+
+    private
+
+    def validate_response(response, id)
+      raise ClientError.new('Wrong response structure') unless response.is_a?(Hash)
+      raise ClientError.new('Wrong version') if response['jsonrpc'] != JRPC::JSON_RPC_VERSION
+      raise ClientError.new("ID response mismatch. expected #{id.inspect} got #{response['id'].inspect}") if id != response['id']
+    end
+
+    def parse_error(error)
+      case error['code']
+        when -32700
+          raise ParseError.new(error['message'])
+        when -32600
+          raise InvalidRequest.new(error['message'])
+        when -32601
+          raise MethodNotFound.new(error['message'])
+        when -32602
+          raise InvalidParams.new(error['message'])
+        when -32603
+          raise InternalError.new(error['message'])
+        when -32099..-32000
+          raise InternalServerError.new(error['message'], error['code'])
+        else
+          raise UnknownError.new(error['message'], error['code'])
+      end
+    end
+
+    def send_request(json)
+      raise NotImplementedError
+    end
+
+    def send_notification(json)
+      raise NotImplementedError
+    end
+
+    def generate_id
+      (0...10).map { ('a'..'z').to_a[rand(26)] }.join
+    end
+
+    def create_message(method, params)
+      message = {
+          'jsonrpc' => JSON_RPC_VERSION,
+          'method' => method
+      }
+      message['params'] = params unless params.empty?
+      message
+    end
+  end
+end

data/lib/jrpc/error/client_error.rb

@@ -0,0 +1,5 @@
+module JRPC
+  class ClientError < Error
+
+  end
+end

data/lib/jrpc/error/error.rb

@@ -0,0 +1,5 @@
+module JRPC
+  class Error < RuntimeError
+
+  end
+end

data/lib/jrpc/error/internal_error.rb

@@ -0,0 +1,9 @@
+module JRPC
+  class InternalError < ServerError
+
+    def initialize(message)
+      super(message, -32603)
+    end
+
+  end
+end

data/lib/jrpc/error/internal_server_error.rb

@@ -0,0 +1,5 @@
+module JRPC
+  class InternalServerError < ServerError
+
+  end
+end

data/lib/jrpc/error/invalid_params.rb

@@ -0,0 +1,9 @@
+module JRPC
+  class InvalidParams < ServerError
+
+    def initialize(message)
+      super(message, -32602)
+    end
+
+  end
+end

data/lib/jrpc/error/invalid_request.rb

@@ -0,0 +1,9 @@
+module JRPC
+  class InvalidRequest < ServerError
+
+    def initialize(message)
+      super(message, -32600)
+    end
+
+  end
+end

data/lib/jrpc/error/method_not_found.rb

@@ -0,0 +1,9 @@
+module JRPC
+  class MethodNotFound < ServerError
+
+    def initialize(message)
+      super(message, -32601)
+    end
+
+  end
+end

data/lib/jrpc/error/parse_error.rb

@@ -0,0 +1,9 @@
+module JRPC
+  class ParseError < ServerError
+
+    def initialize(message)
+      super(message, -32700)
+    end
+
+  end
+end

data/lib/jrpc/error/server_error.rb

@@ -0,0 +1,11 @@
+module JRPC
+  class ServerError < Error
+    attr_reader :code
+
+    def initialize(message, code)
+      @code = code
+      super(message)
+    end
+
+  end
+end

data/lib/jrpc/error/unknown_error.rb

@@ -0,0 +1,5 @@
+module JRPC
+  class UnknownError < ServerError
+
+  end
+end

data/lib/jrpc/netstring_tcp_socket.rb

@@ -0,0 +1,36 @@
+require 'socket'
+require 'netstring'
+module JRPC
+  class NetstringTcpSocket < ::TCPSocket
+    def send_string(request)
+      send Netstring.dump(request.to_s), 0
+    end
+
+    def receive_string
+      length = get_msg_length
+      response = recv(length)
+      raise ClientError.new('invalid response. missed comma as terminator') if response[-1] != ','
+      response.chomp(',')
+    end
+
+    def set_timeout(timeout)
+      seconds = Integer(timeout)
+      microseconds = Integer((timeout-seconds)*1_000_000)
+      packed_structure = [seconds, microseconds].pack('l_2') # structure with the number of seconds and microseconds
+      setsockopt(Socket::SOL_SOCKET, Socket::SO_RCVTIMEO, packed_structure)
+    end
+
+    private
+
+    def get_msg_length
+      length = ''
+      while true do
+        character = recv(1)
+        break if character == ':'
+        length += character
+      end
+
+      Integer(length)+1
+    end
+  end
+end

data/lib/jrpc/tcp_client.rb

@@ -0,0 +1,35 @@
+module JRPC
+  class TcpClient < BaseClient
+    attr_reader :hostname, :port, :namespace, :options
+
+    def initialize(options = {})
+      @hostname = options.delete(:hostname)
+      @port = options.delete(:port)
+      @namespace = options.delete(:namespace).to_s
+      @options = options
+      @socket = NetstringTcpSocket.new(@hostname, @port)
+      @socket.set_timeout @options.fetch(:timeout, 5)
+    end
+
+    def close
+      @socket.close
+    end
+
+
+    private
+
+    def create_message(method, params)
+      super("#{namespace}#{method}", params)
+    end
+
+    def send_request(request)
+      @socket.send_string(request)
+      @socket.receive_string
+    end
+
+    def send_notification(request)
+      @socket.send_string(request)
+    end
+
+  end
+end

data/lib/jrpc/version.rb

@@ -0,0 +1,3 @@
+module JRPC
+  VERSION = '0.2.0'
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: jrpc
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Denis Talakevich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: netstring
+  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.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: JSON RPC client over TCP
+email:
+- senid231@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jrpc.gemspec
+- lib/jrpc.rb
+- lib/jrpc/base_client.rb
+- lib/jrpc/error/client_error.rb
+- lib/jrpc/error/error.rb
+- lib/jrpc/error/internal_error.rb
+- lib/jrpc/error/internal_server_error.rb
+- lib/jrpc/error/invalid_params.rb
+- lib/jrpc/error/invalid_request.rb
+- lib/jrpc/error/method_not_found.rb
+- lib/jrpc/error/parse_error.rb
+- lib/jrpc/error/server_error.rb
+- lib/jrpc/error/unknown_error.rb
+- lib/jrpc/netstring_tcp_socket.rb
+- lib/jrpc/tcp_client.rb
+- lib/jrpc/version.rb
+homepage: https://github.com/senid231/jrpc
+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.4.8
+signing_key: 
+specification_version: 4
+summary: JSON RPC client
+test_files: []