jsonrpc-client 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+coverage
+.rvmrc
+Gemfile.lock
+*.swp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+

data/LICENSE.txt

@@ -0,0 +1,17 @@
+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,29 @@
+# JSONRPC::Client
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jsonrpc-client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jsonrpc-client
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,30 @@
+require 'rake'
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:rspec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :rspec
+
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rake/rdoctask'
+end
+
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "jimson #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/jsonrpc-client.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jsonrpc/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "jsonrpc-client"
+  gem.version       = JSONRPC::VERSION
+  gem.authors       = ["Pavel Forkert"]
+  gem.email         = ["fxposter@gmail.com"]
+  gem.description   = %q{Simple JSON-RPC 2.0 client implementation}
+  gem.summary       = %q{JSON-RPC 2.0 client}
+  gem.homepage      = "https://github.com/fxposter/jsonrpc-client"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'faraday'
+  gem.add_dependency 'multi_json', '>= 1.1.0'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rake'
+end

data/lib/jsonrpc-client.rb

@@ -0,0 +1 @@
+require 'jsonrpc/client'

data/lib/jsonrpc/client.rb

@@ -0,0 +1,171 @@
+require 'multi_json'
+require 'faraday'
+require 'jsonrpc/request'
+require 'jsonrpc/response'
+require 'jsonrpc/error'
+require 'jsonrpc/version'
+
+module JSONRPC
+  class Base < BasicObject
+    JSON_RPC_VERSION = '2.0'
+
+    def self.make_id
+      rand(10**12)
+    end
+
+    def initialize(url, opts = {})
+      @url = ::URI.parse(url).to_s
+      @opts = opts
+      @opts[:content_type] ||= 'application/json'
+    end
+
+    def to_s
+      inspect
+    end
+
+    def inspect
+      "#<#{self.class.name}:0x00%08x>" % (__id__ * 2)
+    end
+
+    def class
+      (class << self; self end).superclass
+    end
+
+  private
+    def raise(*args)
+      ::Kernel.raise(*args)
+    end
+  end
+
+  class BatchClient < Base
+    attr_reader :batch
+
+    def initialize(url, opts = {})
+      super
+      @batch = []
+      @alive = true
+      yield self
+      send_batch
+      @alive = false
+    end
+
+    def method_missing(sym, *args, &block)
+      if @alive
+        request = ::JSONRPC::Request.new(sym.to_s, args)
+        push_batch_request(request)
+      else
+        super
+      end
+    end
+
+  private
+    def send_batch_request(batch)
+      post_data = ::MultiJson.encode(batch)
+      resp = ::Faraday.post(@url, post_data, @opts)
+      if resp.nil? || resp.body.nil? || resp.body.empty?
+        raise ::JSONRPC::Error::InvalidResponse.new
+      end
+
+      resp.body
+    end
+
+    def process_batch_response(responses)
+      responses.each do |resp|
+        saved_response = @batch.map { |r| r[1] }.select { |r| r.id == resp['id'] }.first
+        raise ::JSONRPC::Error::InvalidResponse.new if saved_response.nil?
+        saved_response.populate!(resp)
+      end
+    end
+
+    def push_batch_request(request)
+      request.id = ::JSONRPC::Base.make_id
+      response = ::JSONRPC::Response.new(request.id)
+      @batch << [request, response]
+      response
+    end
+
+    def send_batch
+      batch = @batch.map(&:first) # get the requests
+      response = send_batch_request(batch)
+
+      begin
+        responses = ::MultiJson.decode(response)
+      rescue
+        raise ::JSONRPC::Error::InvalidJSON.new(json)
+      end
+
+      process_batch_response(responses)
+      @batch = []
+    end
+  end
+
+  class Client < Base
+    def method_missing(method, *args, &block)
+      invoke(method, args)
+    end
+
+    def invoke(method, args)
+      resp = send_single_request(method.to_s, args)
+
+      begin
+        data = ::MultiJson.decode(resp)
+      rescue
+        raise ::JSONRPC::Error::InvalidJSON.new(resp)
+      end
+
+      process_single_response(data)
+    rescue => e
+      e.extend(::JSONRPC::Error)
+      raise
+    end
+
+    private
+    def send_single_request(method, args)
+      post_data = ::MultiJson.encode({
+        'jsonrpc' => JSON_RPC_VERSION,
+        'method'  => method,
+        'params'  => args,
+        'id'      => ::JSONRPC::Base.make_id
+      })
+      resp = ::Faraday.post(@url, post_data, @opts)
+      if resp.nil? || resp.body.nil? || resp.body.empty?
+        raise ::JSONRPC::Error::InvalidResponse.new
+      end
+
+      resp.body
+    end
+
+    def process_single_response(data)
+      raise ::JSONRPC::Error::InvalidResponse.new unless valid_response?(data)
+
+      if data['error']
+        code = data['error']['code']
+        msg = data['error']['message']
+        raise ::JSONRPC::Error::ServerError.new(code, msg)
+      end
+
+      data['result']
+    end
+
+    def valid_response?(data)
+      return false if !data.is_a?(::Hash)
+      return false if data['jsonrpc'] != JSON_RPC_VERSION
+      return false if !data.has_key?('id')
+      return false if data.has_key?('error') && data.has_key?('result')
+
+      if data.has_key?('error')
+        if !data['error'].is_a?(Hash) || !data['error'].has_key?('code') || !data['error'].has_key?('message')
+          return false
+        end
+
+        if !data['error']['code'].is_a?(Fixnum) || !data['error']['message'].is_a?(String)
+          return false
+        end
+      end
+
+      true
+    rescue
+      false
+    end
+  end
+end

data/lib/jsonrpc/error.rb

@@ -0,0 +1,21 @@
+module JSONRPC
+  module Error
+    class InvalidResponse < StandardError
+      def initialize()
+        super('Invalid or empty response from server.')
+      end
+    end
+
+    class InvalidJSON < StandardError
+      def initialize(json)
+        super("Couldn't parse JSON string received from server:\n#{json}")
+      end
+    end
+
+    class ServerError < StandardError
+      def initialize(code, message)
+        super("Server error #{code}: #{message}")
+      end
+    end
+  end
+end

data/lib/jsonrpc/request.rb

@@ -0,0 +1,25 @@
+module JSONRPC
+  class Request
+
+    attr_accessor :method, :params, :id
+    def initialize(method, params, id = nil)
+      @method = method
+      @params = params
+      @id = id
+    end
+
+    def to_h
+      h = {
+        'jsonrpc' => '2.0',
+        'method'  => @method
+      }
+      h.merge!('params' => @params) if !!@params && !params.empty?
+      h.merge!('id' => id)
+    end
+
+    def to_json(*a)
+      MultiJson.encode(self.to_h)
+    end
+
+  end
+end

data/lib/jsonrpc/response.rb

@@ -0,0 +1,30 @@
+module JSONRPC
+  class Response
+    attr_accessor :result, :error, :id
+
+    def initialize(id)
+      @id = id
+    end
+
+    def to_h
+      h = {'jsonrpc' => '2.0'}
+      h.merge!('result' => @result) if !!@result
+      h.merge!('error' => @error) if !!@error
+      h.merge!('id' => @id)
+    end
+
+    def is_error?
+      !!@error
+    end
+
+    def succeeded?
+      !!@result
+    end
+
+    def populate!(data)
+      @error = data['error'] if !!data['error']
+      @result = data['result'] if !!data['result']
+    end
+
+  end
+end

data/lib/jsonrpc/version.rb

@@ -0,0 +1,3 @@
+module JSONRPC
+  VERSION = '0.0.1'
+end

data/spec/client_spec.rb

@@ -0,0 +1,129 @@
+require 'spec_helper'
+
+module JSONRPC
+  describe Client do
+    BOILERPLATE = {'jsonrpc' => '2.0', 'id' => 1}
+
+    before(:each) do
+      @resp_mock = mock('http_response')
+      Base.stub!(:make_id).and_return(1)
+    end
+
+    after(:each) do
+    end
+
+    describe "hidden methods" do
+      it "should reveal inspect" do
+        Client.new(SPEC_URL).inspect.should match /JSONRPC::Client/
+      end
+
+      it "should reveal to_s" do
+        Client.new(SPEC_URL).to_s.should match /JSONRPC::Client/
+      end
+    end
+
+    describe "#invoke" do
+      before(:each) do
+        expected = MultiJson.encode({
+         'jsonrpc' => '2.0',
+         'method'  => 'foo',
+         'params'  => [1,2,3],
+         'id'      => 1
+        })
+        response = MultiJson.encode(BOILERPLATE.merge({'result' => 42}))
+        Faraday.should_receive(:post).with(SPEC_URL, expected, {:content_type => 'application/json'}).and_return(@resp_mock)
+        @resp_mock.should_receive(:body).at_least(:once).and_return(response)
+        @client = Client.new(SPEC_URL)
+      end
+
+      context "when using an array of args" do
+        it "sends a request with the correct method and args" do
+          @client.invoke('foo', [1, 2, 3]).should == 42
+        end
+      end
+    end
+
+    describe "sending a single request" do
+      context "when using positional parameters" do
+        before(:each) do
+          @expected = MultiJson.encode({
+                       'jsonrpc' => '2.0',
+                       'method'  => 'foo',
+                       'params'  => [1,2,3],
+                       'id'      => 1
+          })
+        end
+        it "sends a valid JSON-RPC request and returns the result" do
+          response = MultiJson.encode(BOILERPLATE.merge({'result' => 42}))
+          Faraday.should_receive(:post).with(SPEC_URL, @expected, {:content_type => 'application/json'}).and_return(@resp_mock)
+          @resp_mock.should_receive(:body).at_least(:once).and_return(response)
+          client = Client.new(SPEC_URL)
+          client.foo(1,2,3).should == 42
+        end
+
+        it "sends a valid JSON-RPC request with custom options" do
+          response = MultiJson.encode(BOILERPLATE.merge({'result' => 42}))
+          Faraday.should_receive(:post).with(SPEC_URL, @expected, {:content_type => 'application/json', :timeout => 10000}).and_return(@resp_mock)
+          @resp_mock.should_receive(:body).at_least(:once).and_return(response)
+          client = Client.new(SPEC_URL, :timeout => 10000)
+          client.foo(1,2,3).should == 42
+        end
+
+        it "sends a valid JSON-RPC request with custom content_type" do
+          response = MultiJson.encode(BOILERPLATE.merge({'result' => 42}))
+          Faraday.should_receive(:post).with(SPEC_URL, @expected, {:content_type => 'application/json-rpc', :timeout => 10000}).and_return(@resp_mock)
+          @resp_mock.should_receive(:body).at_least(:once).and_return(response)
+          client = Client.new(SPEC_URL, :timeout => 10000, :content_type => 'application/json-rpc')
+          client.foo(1,2,3).should == 42
+        end
+      end
+    end
+
+    describe "sending a batch request" do
+      it "sends a valid JSON-RPC batch request and puts the results in the response objects" do
+        batch = MultiJson.encode([
+          {"jsonrpc" => "2.0", "method" => "sum", "params" => [1,2,4], "id" => "1"},
+          {"jsonrpc" => "2.0", "method" => "subtract", "params" => [42,23], "id" => "2"},
+          {"jsonrpc" => "2.0", "method" => "foo_get", "params" => [{"name" => "myself"}], "id" => "5"},
+          {"jsonrpc" => "2.0", "method" => "get_data", "id" => "9"}
+        ])
+
+        response = MultiJson.encode([
+          {"jsonrpc" => "2.0", "result" => 7, "id" => "1"},
+          {"jsonrpc" => "2.0", "result" => 19, "id" => "2"},
+          {"jsonrpc" => "2.0", "error" => {"code" => -32601, "message" => "Method not found."}, "id" => "5"},
+          {"jsonrpc" => "2.0", "result" => ["hello", 5], "id" => "9"}
+        ])
+
+        Base.stub!(:make_id).and_return('1', '2', '5', '9')
+        Faraday.should_receive(:post).with(SPEC_URL, batch, {:content_type => 'application/json'}).and_return(@resp_mock)
+        @resp_mock.should_receive(:body).at_least(:once).and_return(response)
+        client = Client.new(SPEC_URL)
+
+        sum = subtract = foo = data = nil
+        client = BatchClient.new(SPEC_URL) do |batch|
+          sum = batch.sum(1,2,4)
+          subtract = batch.subtract(42,23)
+          foo = batch.foo_get('name' => 'myself')
+          data = batch.get_data
+        end
+
+        sum.succeeded?.should be_true
+        sum.is_error?.should be_false
+        sum.result.should == 7
+
+        subtract.result.should == 19
+
+        foo.is_error?.should be_true
+        foo.succeeded?.should be_false
+        foo.error['code'].should == -32601
+
+        data.result.should == ['hello', 5]
+
+
+        expect { client.sum(1, 2) }.to raise_error(NoMethodError)
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'bundler/setup'
+require 'jsonrpc-client'
+require 'multi_json'
+
+SPEC_URL = 'http://localhost:8999'

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: jsonrpc-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Pavel Forkert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple JSON-RPC 2.0 client implementation
+email:
+- fxposter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jsonrpc-client.gemspec
+- lib/jsonrpc-client.rb
+- lib/jsonrpc/client.rb
+- lib/jsonrpc/error.rb
+- lib/jsonrpc/request.rb
+- lib/jsonrpc/response.rb
+- lib/jsonrpc/version.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/fxposter/jsonrpc-client
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1153313721096096844
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1153313721096096844
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: JSON-RPC 2.0 client
+test_files:
+- spec/client_spec.rb
+- spec/spec_helper.rb