rpc4json 0.0.1.alpha → 0.0.2.alpha

data/README.md

@@ -1,5 +1,7 @@
 # JSONRPC
 
+[![Gem Version](https://badge.fury.io/rb/rpc4json.png)](http://badge.fury.io/rb/rpc4json) [![Dependency Status](https://gemnasium.com/GRoguelon/JSONRPC.png)](https://gemnasium.com/GRoguelon/JSONRPC)
+
 An Ruby implementation of the JSON-RPC 2.0 specification.
 
 ## Installation

data/lib/jsonrpc/abstract_request.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+
+require 'json'
+require 'securerandom'
+
+module JSONRPC
+  class AbstractRequest
+    attr_reader :id, :jsonrpc, :method, :params
+
+    JSONRPC_VERSION = '2.0'
+
+    class << self
+      private :new
+
+      def inherited(subclass)
+        subclass.public_class_method(:new)
+      end
+    end
+
+    def initialize(method, params = nil)
+      assert_valid_arguements(method, params)
+
+      @id      = unique_request_id
+      @jsonrpc = JSONRPC_VERSION
+      @method  = method
+      @params  = params if params
+    end
+
+    def to_hash
+      @request ||= {
+        :jsonrpc => jsonrpc,
+        :method  => method,
+        :params  => params,
+        :id      => id
+      }.delete_if { |_, value| value.nil? }
+    end
+    alias :to_h :to_hash
+
+    def to_json
+      JSON.dump(to_hash)
+    end
+
+  protected
+
+    def assert_valid_arguements(method, params)
+      if method.start_with?('rpc.')
+        raise ArgumentError, 'the method argument cannot begin by `rpc.`'
+      elsif params && !(params.is_a?(Hash) || params.is_a?(Array))
+        raise ArgumentError, 'the params argument must be an Array or a Hash.'
+      end
+    end
+
+    def unique_request_id
+      SecureRandom.uuid
+    end
+  end
+end

data/lib/jsonrpc/client/proxy.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+require 'net/http'
+require 'securerandom'
+
+module JSONRPC
+  class Client
+    class Proxy
+      def initialize(server, prefix, args = [], meth = :call, delim ='.')
+        @server = server
+        @prefix = prefix ? prefix + delim : ''
+        @args   = args
+        @meth   = meth
+      end
+
+      def method_missing(mid, *args)
+        pre = @prefix + mid.to_s
+        arg = @args + args
+        @server.send(@meth, pre, *arg)
+      end
+    end
+  end
+end

data/lib/jsonrpc/client.rb

@@ -1,10 +1,153 @@
 # encoding: utf-8
 
+require 'net/http'
+require 'securerandom'
+require 'jsonrpc/client/proxy'
+require 'jsonrpc/content_type_parser'
+require 'jsonrpc/request'
+require 'jsonrpc/response'
+
 module JSONRPC
   # This class provides a way to dial with JSON-RPC server.
   #
   # @author {mailto:geoffrey.roguelon@gmail.com Geoffrey Roguelon}
   class Client
+    include ContentTypeParser
+
+    USER_AGENT = "JSONRPC::Client (Ruby #{RUBY_VERSION})"
+
+    # Add additional HTTP headers to the request.
+    attr_accessor :http_header_extra
+
+    def initialize(host = nil, path = nil, port = nil, proxy_host = nil,
+      proxy_port = nil, user = nil, password = nil, use_ssl = nil, timeout = nil)
+      @http_header_extra  = nil
+      @http_last_response = nil
+      @cookie             = nil
+
+      @host         = host || 'localhost'
+      @path         = path || '/RPC2'
+      @proxy_host   = proxy_host
+      @proxy_port   = proxy_port
+      @proxy_host ||= 'localhost' unless @proxy_port.nil?
+      @proxy_port ||= 8080        unless @proxy_host.nil?
+      @use_ssl      = use_ssl || false
+      @timeout      = timeout || 30
+
+      @port = if use_ssl
+        require 'net/https'
+        port || 443
+      else
+        port || 80
+      end
+
+      @user, @password = user, password
+
+      set_auth
+
+      # convert ports to integers
+      @port       = @port.to_i       unless @port.nil?
+      @proxy_port = @proxy_port.to_i unless @proxy_port.nil?
+
+      # HTTP object for synchronous calls
+      @http = new_http
+    end
+
+    def request_with_array(method, *args)
+      request = Request.new(method, args).to_json
+      result  = do_rpc(request, false)
+      Response.from_json(result, request)
+    end
+
+    def notify_with_array(method, *args)
+      Request.new(method, args).tap do |request|
+        do_rpc(request.to_json, false)
+      end
+    end
+
+    def proxy(prefix = nil, *args)
+      Proxy.new(self, prefix, args, :request_with_array)
+    end
+
+  private
+
+    def do_rpc(request, async = false)
+      headers, response = headers(request, async), nil
+
+      if async
+        new_http.start {
+          response = http.post2(@path, request, headers)
+        }
+      else
+        # reuse the HTTP object for each call => connection alive is possible
+        # we must start connection explicitely first time so that http.request
+        # does not assume that we don't want keepalive
+        @http.start unless @http.started?
+
+        response = @http.post2(@path, request, headers)
+      end
+
+      @http_last_response = response
+
+      response.body.tap do |data|
+        if response.code == '401'
+          # Authorization Required
+          raise "Authorization failed.\nHTTP-Error: #{response.code} #{response.message}"
+        elsif response.code[0, 1] != "2"
+          raise "HTTP-Error: #{response.code} #{response.message}"
+        end
+
+        content_type = parse_content_type(response['Content-Type']).first
+        if content_type != 'application/json'
+          raise "Wrong content-type (received '#{content_type}' but expected 'application/json')"
+        end
+
+        expected = response['Content-Length'] || '<unknown>'
+        if data.nil? || data.bytesize == 0 || expected != '<unknown>' && expected.to_i != data.bytesize && response['Transfer-Encoding'].nil?
+          raise "Wrong size. Was #{data.bytesize}, should be #{expected}"
+        end
+
+        set_cookies = response.get_fields('Set-Cookie')
+        if set_cookies && !set_cookies.empty?
+          require 'webrick/cookie'
+          @cookie = set_cookies.collect do |set_cookie|
+            cookie = WEBrick::Cookie.parse_set_cookie(set_cookie)
+            WEBrick::Cookie.new(cookie.name, cookie.value).to_s
+          end.join('; ')
+        end
+      end
+    end
+
+    def headers(request, async)
+      headers = {
+        'User-Agent'     =>  USER_AGENT,
+        'Accept'         => 'application/json',
+        'Content-Type'   => 'application/json; charset=utf-8',
+        'Content-Length' => request.bytesize.to_s,
+        'Connection'     => (async ? 'close' : 'keep-alive')
+      }
+
+      headers['Cookie'] = @cookie        if @cookie
+      headers.merge!(@http_header_extra) if @http_header_extra
+      headers['Authorization'] = @auth   unless @auth.nil?
+      headers
+    end
+
+    def new_http
+      Net::HTTP.new(@host, @port, @proxy_host, @proxy_port).tap do |http|
+        http.set_debug_output($stdout)
+        http.use_ssl      = @use_ssl if @use_ssl
+        http.read_timeout = @timeout
+        http.open_timeout = @timeout
+      end
+    end
 
+    def set_auth
+      @auth = if !@user.nil?
+        credentials  = "#{@user}"
+        credentials << ":#{@password}" unless @password.nil?
+        @auth = 'Basic ' + [credentials].pack('m0')
+      end
+    end
   end
 end

data/lib/jsonrpc/content_type_parser.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+module JSONRPC
+  module ContentTypeParser
+    def parse_content_type(str)
+      a, *b = str.split(';')
+      return a.strip.downcase, *b
+    end
+  end
+end

data/lib/jsonrpc/notification.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+require 'jsonrpc/abstract_request'
+
+module JSONRPC
+  class Notification < AbstractRequest
+
+  protected
+
+    def unique_request_id
+      nil
+    end
+  end
+end

data/lib/jsonrpc/request.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+require 'jsonrpc/abstract_request'
+
+module JSONRPC
+  class Request < AbstractRequest; end
+end

data/lib/jsonrpc/response.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+require 'json'
+require 'jsonrpc/abstract_request'
+
+module JSONRPC
+  class Response
+    attr_reader :request, :id, :jsonrpc, :result, :error
+
+    class << self
+      def from_json(json, request = nil)
+        new(JSON.parse(json), request)
+      end
+    end
+
+    def initialize(response, request = nil)
+      @raw     = response
+      @id      = response['id']
+      @jsonrpc = response['jsonrpc']
+      @result  = response['result']
+      @error   = response['error']
+      @request = request
+    end
+
+    def body
+      success? ? result : error
+    end
+
+    def error?
+      !success?
+    end
+
+    def success?
+      @error.nil?
+    end
+  end
+end

data/lib/jsonrpc/version.rb

@@ -10,7 +10,7 @@ module JSONRPC
     # The minor number version.
     MINOR = 0
     # The tiny number version.
-    TINY  = 1
+    TINY  = 2
     # The pre realese number version.
     PRE   = :alpha
 

data/lib/jsonrpc.rb

@@ -1,6 +1,9 @@
 # encoding: utf-8
 
 require 'jsonrpc/client'
+require 'jsonrpc/notification'
+require 'jsonrpc/request'
+require 'jsonrpc/response'
 require 'jsonrpc/version'
 
 # This is the root class of the JSONRPC gem.

data/rpc4json.gemspec

@@ -22,13 +22,10 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = %w{lib}
 
-  gem.cert_chain    = %w{certs/jsonrpc.pem}
-  gem.signing_key   = File.expand_path('~/.ssh/gem-private_key.pem') if $0 =~/gem\z/
-
   gem.add_development_dependency 'bundler', '~> 1.5'
   gem.add_development_dependency 'rake'
 
   # Documentation
-  gem.add_development_dependency 'yard', '~> 0.8.7.3'
+  gem.add_development_dependency 'yard',      '~> 0.8.7.3'
   gem.add_development_dependency 'redcarpet', '~> 3.0.0'
 end

metadata

@@ -1,46 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rpc4json
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha
+  version: 0.0.2.alpha
   prerelease: 6
 platform: ruby
 authors:
 - Geoffrey Roguelon
 autorequire: 
 bindir: bin
-cert_chain:
-- !binary |-
-  LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURsakNDQW42Z0F3SUJB
-  Z0lCQVRBTkJna3Foa2lHOXcwQkFRVUZBREJJTVJvd0dBWURWUVFEREJGblpX
-  OW0KWm5KbGVTNXliMmQxWld4dmJqRVZNQk1HQ2dtU0pvbVQ4aXhrQVJrV0JX
-  ZHRZV2xzTVJNd0VRWUtDWkltaVpQeQpMR1FCR1JZRFkyOXRNQjRYRFRFek1U
-  SXpNREE1TlRrd05Gb1hEVEUwTVRJek1EQTVOVGt3TkZvd1NERWFNQmdHCkEx
-  VUVBd3dSWjJWdlptWnlaWGt1Y205bmRXVnNiMjR4RlRBVEJnb0praWFKay9J
-  c1pBRVpGZ1ZuYldGcGJERVQKTUJFR0NnbVNKb21UOGl4a0FSa1dBMk52YlRD
-  Q0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQwpnZ0VCQUsw
-  UVZoL0NNWWZ5clpZc1VWWHU2ZXhhekZRU0FiN3ZSRlZaOFVLUkNwdlB4cVMx
-  YjFCbUwrMnNpdkd3CklpZmNQT1EzT1BnVjI0VFd5Yi9jMWI2YU5KYjNZRGN5
-  M1ZKMlErbUFPL1pWTmJrdTQrUXQrV2dPa1lzWE0vcTQKZENiUWhzaTViMkRa
-  bkoyaE8xcEI1ZEt6Qi84cW1INS83QVkrbStIZU9KZkRDVmJkeVU5K3VEd0ZS
-  T1F6eXp6aAorbmtnVzMvOVZBb3R5R1VLNXFnYkFaSXRReC94bytnbjJSVzVv
-  Si9WQTlVdTZEVDJxbUhReGRlRzdEemYxZWJnCm84a09ZbGxHejY0cThOcXJa
-  N0l3c3FqTzRMTk9KYlN4Z2hXRDlrTlJ6bGpnLzRVTDRMYXU4ZmVkS0lSTXVO
-  ekgKdTgxY2xnN3JpQWxoN1ducDNBeDc0bm9FdzdjQ0F3RUFBYU9CaWpDQmh6
-  QUpCZ05WSFJNRUFqQUFNQXNHQTFVZApEd1FFQXdJRXNEQWRCZ05WSFE0RUZn
-  UVV1b0syZDFuTnAwQW9kV3hwLzVwTnE2MS9STEl3SmdZRFZSMFJCQjh3CkhZ
-  RWJaMlZ2Wm1aeVpYa3VjbTluZFdWc2IyNUFaMjFoYVd3dVkyOXRNQ1lHQTFV
-  ZEVnUWZNQjJCRzJkbGIyWm0KY21WNUxuSnZaM1ZsYkc5dVFHZHRZV2xzTG1O
-  dmJUQU5CZ2txaGtpRzl3MEJBUVVGQUFPQ0FRRUFrSGI1YkRPUgpKU1dJNlpm
-  OCtKRkFFdGFUTmN5TWJaYStNQzFvTFg1Z2hVaXRNWFdGNlpFdGVNeGZzanh6
-  VjVacUJuSEVHUlV5CkE3ZXBTS2ErUmNvdGZxU1BBc3gwdmt4bVl0NHo0Mm1o
-  KzlFUXpHKzJ5cGhEZlI1ZDdvaU00UDRjVjN5ZVNPVE8KNGlVcGpya2JjNWRV
-  VlVydVlTTUFBVFJ2WkE3YVp2Qm0zcGJEU01zYzVvTkdWdU5RTEtQU3RHeURq
-  aWQxZHVWSwpEdmFFY2s2U1FkY2FkeVZ1Vm5sTVZoek8vSTZpdkIrOTJKbXVh
-  TWl4ZG1OcTUzWlNzNS9HbithWHkvakZBcXhOCjdyRzNmK2N5VXcxeDgwSXZZ
-  cWQzRytGRWxEaFRZT0Qxd1UzMzU2TlczUm1tcGxRQ1JCNXhJSzdHdGk2Uk93
-  bG0KbTFWcDZCSFR0WnFTU3c9PQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0t
-  Cg==
-date: 2013-12-30 00:00:00.000000000 Z
+cert_chain: []
+date: 2014-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -117,9 +86,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- certs/jsonrpc.pem
 - lib/jsonrpc.rb
+- lib/jsonrpc/abstract_request.rb
 - lib/jsonrpc/client.rb
+- lib/jsonrpc/client/proxy.rb
+- lib/jsonrpc/content_type_parser.rb
+- lib/jsonrpc/notification.rb
+- lib/jsonrpc/request.rb
+- lib/jsonrpc/response.rb
 - lib/jsonrpc/version.rb
 - lib/rpc4json.rb
 - rpc4json.gemspec
@@ -144,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.23.2
 signing_key: 
 specification_version: 3
 summary: An Ruby implementation of the JSON-RPC 2.0 specification.

data/certs/jsonrpc.pem

@@ -1,22 +0,0 @@
------BEGIN CERTIFICATE-----
-MIIDljCCAn6gAwIBAgIBATANBgkqhkiG9w0BAQUFADBIMRowGAYDVQQDDBFnZW9m
-ZnJleS5yb2d1ZWxvbjEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPy
-LGQBGRYDY29tMB4XDTEzMTIzMDA5NTkwNFoXDTE0MTIzMDA5NTkwNFowSDEaMBgG
-A1UEAwwRZ2VvZmZyZXkucm9ndWVsb24xFTATBgoJkiaJk/IsZAEZFgVnbWFpbDET
-MBEGCgmSJomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC
-ggEBAK0QVh/CMYfyrZYsUVXu6exazFQSAb7vRFVZ8UKRCpvPxqS1b1BmL+2sivGw
-IifcPOQ3OPgV24TWyb/c1b6aNJb3YDcy3VJ2Q+mAO/ZVNbku4+Qt+WgOkYsXM/q4
-dCbQhsi5b2DZnJ2hO1pB5dKzB/8qmH5/7AY+m+HeOJfDCVbdyU9+uDwFROQzyzzh
-+nkgW3/9VAotyGUK5qgbAZItQx/xo+gn2RW5oJ/VA9Uu6DT2qmHQxdeG7Dzf1ebg
-o8kOYllGz64q8NqrZ7IwsqjO4LNOJbSxghWD9kNRzljg/4UL4Lau8fedKIRMuNzH
-u81clg7riAlh7Wnp3Ax74noEw7cCAwEAAaOBijCBhzAJBgNVHRMEAjAAMAsGA1Ud
-DwQEAwIEsDAdBgNVHQ4EFgQUuoK2d1nNp0AodWxp/5pNq61/RLIwJgYDVR0RBB8w
-HYEbZ2VvZmZyZXkucm9ndWVsb25AZ21haWwuY29tMCYGA1UdEgQfMB2BG2dlb2Zm
-cmV5LnJvZ3VlbG9uQGdtYWlsLmNvbTANBgkqhkiG9w0BAQUFAAOCAQEAkHb5bDOR
-JSWI6Zf8+JFAEtaTNcyMbZa+MC1oLX5ghUitMXWF6ZEteMxfsjxzV5ZqBnHEGRUy
-A7epSKa+RcotfqSPAsx0vkxmYt4z42mh+9EQzG+2yphDfR5d7oiM4P4cV3yeSOTO
-4iUpjrkbc5dUVUruYSMAATRvZA7aZvBm3pbDSMsc5oNGVuNQLKPStGyDjid1duVK
-DvaEck6SQdcadyVuVnlMVhzO/I6ivB+92JmuaMixdmNq53ZSs5/Gn+aXy/jFAqxN
-7rG3f+cyUw1x80IvYqd3G+FElDhTYOD1wU3356NW3RmmplQCRB5xIK7Gti6ROwlm
-m1Vp6BHTtZqSSw==
------END CERTIFICATE-----

metadata.gz.sig

@@ -1,3 +0,0 @@
-.��q]��b?��b����g�
-'f!�B"�p�~�K�x�|�{o��Z�uΜ;�Om�8P�j�VX9���3x?W9��!	B�x��F���L�&�bxCd=L�ն�P=˹,uz����ZD��f3����@��]
-�r�9k��k��F7�6P#�:�9�%�E�!