jimson-reloaded 0.12.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 398634f92c8530750c7a6fe8966e2dbb6dec17a3999d5ea97c83b3481f610c0b
+  data.tar.gz: dda0d5e556736f80f2e8702510aa5302717dd0708fed75388b15179dd62fea21
+SHA512:
+  metadata.gz: ac184436f5551653a2709a3a18826e6e85ee62d26ef842faf45afde95823c5c68fc4b44035124e9273c1317e6e75c394cb8c578b074d3c6c795b9ac0cffb3a11
+  data.tar.gz: db750df41bff5e0bc2e0e41160ed358c2f4cf77ea27c5386cba0a21838149a6111ad4ed4cb567e276d146736069f8176736dd3704ed89eea42384f1d87b82ed3

data/CHANGELOG.md

@@ -0,0 +1,109 @@
+# 0.12.0 / 
+
+* Unified Bignum and Fixnum to Integer
+* Add ability to specify custom content type
+* Add data returned to invalid response exception
+* Add support for named parameters
+* Add Router :ns_sep option for custom namespace
+* Fix json variable name on invalid json response
+* made it possible to overwrite advanced RestClient values, like ssl_ca_file
+
+# 0.11.0 / 2016-03-13
+
+* Minor enhancements
+
+  * Update dependency versions for Ruby 2.*
+  * Remove Gemfile.lock
+
+# 0.10.0 / 2013-06-28
+
+* Minor enhancements
+
+  * Update dependency versions
+
+# 0.9.1 / 2012-09-18
+
+* Bug fixes
+
+  * Allow opts to be passed to Server.with_routes
+
+# 0.9.0 / 2012-08-22
+
+* Minor enhancements
+
+  * Add show_errors option to server, which will cause application errors to include the error name and the first line of the backtrace
+
+# 0.8.0 / 2012-08-17
+
+* Major enhancements
+
+  * Add namespaced method calls to client (e.g. 'client[:foo].sum(1,2,3) # calls foo.sum')
+  * Add Server.with_routes to quickly created a routed server
+
+# 0.7.1 / 2012-08-16
+
+* Bug fixes
+
+  * Fix handling of array params in client, which were erroneously being flattened
+
+# 0.7.0 / 2012-04-13
+
+* Major enhancements
+
+  * Add namespaced routing
+
+* Bug fixes
+
+  * Fix deprecation warning about RDoc task in Rakefile
+
+# 0.6.0 / 2012-03-14
+
+* Minor enhancements
+
+  * Add ability to pass options to Rack and RestClient
+
+# 0.5.0 / 2012-03-06
+
+* Major enhancements
+
+  * Switch to MultiJson from json gem
+
+* Bug fixes
+
+  * Allow BigNum in 'id' field of request and response
+
+# 0.3.1 / 2011-08-11
+
+* Minor enhancements
+
+  * Refactor the way the server is intantiated/started to work better with config.ru
+
+# 0.3.0 / 2011-08-11
+
+* Major enhancements
+
+  * Replace eventmachine-httpserver with rack for more cross-platform goodness
+
+# 0.2.3 / 2011-08-01
+
+* Bug fixes
+
+  * Fix argument error in client error handling
+
+# 0.2.2 / 2011-07-28
+
+* Bug fixes
+
+  * Fix invalid local variable error in client error handling
+
+# 0.2.1 / 2011-07-27
+
+* Bug fixes
+
+  * Fix error in client handling some errors caused by errant 'new' keyword
+
+# 0.2.0 / 2011-07-20
+
+* Major enhancements
+
+  * Replace patron with rest-client for JRuby compatibility in the client

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,43 @@
+# Jimson-Reloaded
+
+This is a fork of [chriskite/jimson](https://github.com/chriskite/jimson). I merged all open PRs of the original unmaintaned gem and will maintain it as `jimson-reloaded`. PRs are welcome 🤗.
+
+### JSON-RPC 2.0 Client and Server for Ruby
+
+[![Build Status](https://github.com/railslove/jimson/actions/workflows/ruby.yml/badge.svg?branch=main)](https://github.com/railslove/jimson/actions/workflows/ruby.yml)
+
+## Client: Quick Start
+
+```ruby
+require 'jimson-reloaded'
+client = Jimson::Client.new("http://www.example.com:8999") # the URL for the JSON-RPC 2.0 server to connect to
+result = client.sum(1,2) # call the 'sum' method on the RPC server and save the result '3'
+```
+
+## Server: Quick Start
+
+```ruby
+require 'jimson-reloaded'
+
+class MyHandler
+  extend Jimson::Handler
+
+  def sum(a,b)
+    a + b
+  end
+end
+
+server = Jimson::Server.new(MyHandler.new)
+server.start # serve with webrick on http://0.0.0.0:8999/
+```
+
+## JSON Engine
+
+Jimson uses multi\_json, so you can load the JSON library of your choice in your application and Jimson will use it automatically.
+
+For example, require the 'json' gem in your application:
+
+```ruby
+require 'json'
+```
+

data/Rakefile

@@ -0,0 +1,26 @@
+$:.unshift(File.dirname(__FILE__) + '/lib/')
+require 'jimson/version'
+require 'rubygems'
+require 'rake'
+require 'rspec/core/rake_task'
+
+gem 'rubygems-tasks', '~> 0.2'
+require 'rubygems/tasks'
+
+Gem::Tasks.new
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:rspec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :rspec
+
+require 'rdoc/task'
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "jimson #{Jimson::VERSION}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/jimson-reloaded.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'jimson/handler'
+require 'jimson/router'
+require 'jimson/server'
+require 'jimson/client'
+
+module Jimson
+end

data/lib/jimson/client.rb

@@ -0,0 +1,182 @@
+require 'blankslate'
+require 'multi_json'
+require 'rest-client'
+require 'jimson/request'
+require 'jimson/response'
+
+module Jimson
+  class ClientHelper
+    JSON_RPC_VERSION = '2.0'
+
+    def self.make_id
+      rand(10**12)
+    end
+
+    def initialize(url, opts = {}, namespace = nil, client_opts = {})
+      @url = url
+      URI.parse(@url) # for the sake of validating the url
+      @batch = []
+      @opts = opts
+      @namespace = namespace
+      @opts[:content_type] ||= 'application/json'
+      @client_opts = client_opts
+    end
+
+    def process_call(sym, args)
+      resp = send_single_request(sym.to_s, args)
+
+      begin
+        data = MultiJson.decode(resp)
+      rescue
+        raise Client::Error::InvalidJSON.new(resp)
+      end
+
+      return process_single_response(data)
+
+      rescue Exception, StandardError => e
+        e.extend(Client::Error) unless e.is_a?(Client::Error)
+        raise e
+    end
+
+    def send_single_request(method, args)
+      namespaced_method = @namespace.nil? ? method : "#@namespace#{method}"
+      post_data = MultiJson.encode({
+        'jsonrpc' => JSON_RPC_VERSION,
+        'method'  => namespaced_method,
+        'params'  => args,
+        'id'      => self.class.make_id
+      })
+      resp = RestClient::Request.execute(@client_opts.merge(:method => :post, :url => @url, :payload => post_data, :headers => @opts))
+      if resp.nil? || resp.body.nil? || resp.body.empty?
+        raise Client::Error::InvalidResponse.new(resp)
+      end
+
+      return resp.body
+    end
+
+    def send_batch_request(batch)
+      post_data = MultiJson.encode(batch)
+      resp = RestClient::Request.execute(@client_opts.merge(:method => :post, :url => @url, :payload => post_data, :headers => @opts))
+      if resp.nil? || resp.body.nil? || resp.body.empty?
+        raise Client::Error::InvalidResponse.new(resp)
+      end
+
+      return 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 Client::Error::InvalidResponse.new if saved_response.nil?
+        saved_response.populate!(resp)
+      end
+    end
+
+    def process_single_response(data)
+      raise Client::Error::InvalidResponse.new(data) if !valid_response?(data)
+
+      if !!data['error']
+        code = data['error']['code']
+        msg = data['error']['message']
+        raise Client::Error::ServerError.new(code, msg)
+      end
+
+      return 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?(Integer) || !data['error']['message'].is_a?(String)
+          return false
+        end
+      end
+
+      return true
+
+      rescue
+        return false
+    end
+
+    def push_batch_request(request)
+      request.id = self.class.make_id
+      response = Response.new(request.id)
+      @batch << [request, response]
+      return response
+    end
+
+    def send_batch
+      batch = @batch.map(&:first) # get the requests
+      response = send_batch_request(batch)
+
+      begin
+        responses = MultiJson.decode(response)
+      rescue
+        raise Client::Error::InvalidJSON.new(response)
+      end
+
+      process_batch_response(responses)
+      @batch = []
+    end
+
+  end
+
+  class BatchClient < BlankSlate
+
+    def initialize(helper)
+      @helper = helper
+    end
+
+    def method_missing(sym, *args, &block)
+      request = Jimson::Request.new(sym.to_s, args)
+      @helper.push_batch_request(request)
+    end
+
+  end
+
+  class Client < BlankSlate
+    reveal :instance_variable_get
+    reveal :inspect
+    reveal :to_s
+
+    def self.batch(client)
+      helper = client.instance_variable_get(:@helper)
+      batch_client = BatchClient.new(helper)
+      yield batch_client
+      helper.send_batch
+    end
+
+    def initialize(url, opts = {}, namespace = nil, client_opts = {})
+      @url, @opts, @namespace, @client_opts = url, opts, namespace, client_opts
+      @helper = ClientHelper.new(url, opts, namespace, client_opts)
+    end
+
+    def method_missing(sym, *args, &block)
+      args = args.first if args.size == 1 && args.first.is_a?(Hash)
+      @helper.process_call(sym, args) 
+    end
+
+    def [](method, *args)
+      if method.is_a?(Symbol)
+        # namespace requested
+        new_ns = @namespace.nil? ? "#{method}." : "#@namespace#{method}."
+        return Client.new(@url, @opts, new_ns)
+      end
+      @helper.process_call(method, args) 
+    end
+
+  end
+end
+
+require 'jimson/client/error'

data/lib/jimson/client/error.rb

@@ -0,0 +1,23 @@
+module Jimson
+  class Client
+    module Error
+      class InvalidResponse < StandardError
+        def initialize(response = nil)
+          super("Invalid or empty response from server:\n#{response.inspect}")
+        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
+end

data/lib/jimson/handler.rb

@@ -0,0 +1,25 @@
+module Jimson
+  module Handler
+    
+    def jimson_default_methods
+      self.instance_methods.map(&:to_s) - Object.methods.map(&:to_s)
+    end
+
+    def jimson_expose(*methods)
+      @jimson_exposed_methods ||= []
+      @jimson_exposed_methods += methods.map(&:to_s)
+    end
+
+    def jimson_exclude(*methods)
+      @jimson_excluded_methods ||= []
+      @jimson_excluded_methods += methods.map(&:to_s)
+    end
+
+    def jimson_exposed_methods
+      @jimson_exposed_methods ||= []
+      @jimson_excluded_methods ||= []
+      (jimson_default_methods - @jimson_excluded_methods + @jimson_exposed_methods).sort
+    end
+
+  end
+end