sr-jimson 0.11.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8a05ed480e1d0fd2b07c91b468b844324b045825
+  data.tar.gz: 544159b0cf98683f4e33525723e0fc5c24c3d8a0
+SHA512:
+  metadata.gz: cf2c8ad81c0bebca24ebda12b593b49cbd26e9e48dbdcb3bd92191b9baa3b36f61f5a32b3ba8fbd4a797ef77b5660133182b3f2926f1cb69d278b599afac016f
+  data.tar.gz: 4b7c7caaadcd51da3df4e92d431069d0971c45edb4579fdaaa6d5dc9e57681ad6ccc5d3e6b43321b23f37ab815022f4b38c3d009476408a30c8050eb4928e731

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+coverage
+.rvmrc
+*.swp
+Gemfile.lock
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/CHANGELOG.rdoc

@@ -0,0 +1,92 @@
+== 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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sr-jimson.gemspec
+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 @@
+# Jimson
+### JSON-RPC 2.0 Client and Server for Ruby
+![next build status](https://secure.travis-ci.org/chriskite/jimson.png?branch=next)
+
+## Client: Quick Start
+    require 'jimson'
+    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
+    require 'jimson'
+
+    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:
+    require 'json'
+

data/Rakefile

@@ -0,0 +1,21 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'rdoc/task'
+
+RSpec::Core::RakeTask.new(:rspec)
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  ENV['COVERAGE'] = 'true'
+  Rake::Task["rspec"].execute
+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
+
+task :default => :rspec

data/VERSION

@@ -0,0 +1 @@
+0.10.0

data/lib/sr/jimson.rb

@@ -0,0 +1,10 @@
+module Sr
+  module Jimson
+    VERSION = "0.11.0"
+
+    autoload :Handler, 'sr/jimson/handler'
+    autoload :Router, 'sr/jimson/router'
+    autoload :Server, 'sr/jimson/server'
+    autoload :Client, 'sr/jimson/client'
+  end
+end

data/lib/sr/jimson/blankslate.rb

@@ -0,0 +1,132 @@
+#--
+# Copyright 2004, 2006 by Jim Weirich (jim@weirichhouse.org).
+# All rights reserved.
+
+# Permission is granted for use, copying, modification, distribution,
+# and distribution of modified versions of this work as long as the
+# above copyright notice is included.
+#++
+
+class String
+  if instance_methods.first.is_a?(Symbol)
+    def _blankslate_as_name
+      to_sym
+    end
+  else
+    def _blankslate_as_name
+      self
+    end
+  end
+end
+
+class Symbol
+  if instance_methods.first.is_a?(Symbol)
+    def _blankslate_as_name
+      self
+    end
+  else
+    def _blankslate_as_name
+      to_s
+    end
+  end
+end
+
+######################################################################
+# BlankSlate provides an abstract base class with no predefined
+# methods (except for <tt>\_\_send__</tt> and <tt>\_\_id__</tt>).
+# BlankSlate is useful as a base class when writing classes that
+# depend upon <tt>method_missing</tt> (e.g. dynamic proxies).
+#
+class BlankSlate
+  class << self
+
+    # Hide the method named +name+ in the BlankSlate class.  Don't
+    # hide +instance_eval+ or any method beginning with "__".
+    def hide(name)
+      if instance_methods.include?(name._blankslate_as_name) and
+        name !~ /^(__|(instance_eval|object_id)$)/
+        @hidden_methods ||= {}
+        @hidden_methods[name.to_sym] = instance_method(name)
+        undef_method name
+      end
+    end
+
+    def find_hidden_method(name)
+      @hidden_methods ||= {}
+      @hidden_methods[name] || superclass.find_hidden_method(name)
+    end
+
+    # Redefine a previously hidden method so that it may be called on a blank
+    # slate object.
+    def reveal(name)
+      hidden_method = find_hidden_method(name)
+      fail "Don't know how to reveal method '#{name}'" unless hidden_method
+      define_method(name, hidden_method)
+    end
+  end
+
+  instance_methods.each { |m| hide(m) }
+end
+
+######################################################################
+# Since Ruby is very dynamic, methods added to the ancestors of
+# BlankSlate <em>after BlankSlate is defined</em> will show up in the
+# list of available BlankSlate methods.  We handle this by defining a
+# hook in the Object and Kernel classes that will hide any method
+# defined after BlankSlate has been loaded.
+#
+module Kernel
+  class << self
+    alias_method :blank_slate_method_added, :method_added
+
+    # Detect method additions to Kernel and remove them in the
+    # BlankSlate class.
+    def method_added(name)
+      result = blank_slate_method_added(name)
+      return result if self != Kernel
+      BlankSlate.hide(name)
+      result
+    end
+  end
+end
+
+######################################################################
+# Same as above, except in Object.
+#
+class Object
+  class << self
+    alias_method :blank_slate_method_added, :method_added
+
+    # Detect method additions to Object and remove them in the
+    # BlankSlate class.
+    def method_added(name)
+      result = blank_slate_method_added(name)
+      return result if self != Object
+      BlankSlate.hide(name)
+      result
+    end
+
+    def find_hidden_method(name)
+      nil
+    end
+  end
+end
+
+######################################################################
+# Also, modules included into Object need to be scanned and have their
+# instance methods removed from blank slate.  In theory, modules
+# included into Kernel would have to be removed as well, but a
+# "feature" of Ruby prevents late includes into modules from being
+# exposed in the first place.
+#
+class Module
+  alias blankslate_original_append_features append_features
+  def append_features(mod)
+    result = blankslate_original_append_features(mod)
+    return result if mod != Object
+    instance_methods.each do |name|
+      BlankSlate.hide(name)
+    end
+    result
+  end
+end

data/lib/sr/jimson/client.rb

@@ -0,0 +1,180 @@
+require 'multi_json'
+require 'rest-client'
+require 'sr/jimson/blankslate'
+require 'sr/jimson/request'
+require 'sr/jimson/response'
+
+module Sr::Jimson
+  class ClientHelper
+    JSON_RPC_VERSION = '2.0'
+
+    def self.make_id
+      rand(10**12)
+    end
+
+    def initialize(url, opts = {}, namespace = nil)
+      @url = url
+      URI.parse(@url) # for the sake of validating the url
+      @batch = []
+      @opts = opts
+      @namespace = namespace
+      @opts[:content_type] = 'application/json'
+    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.post(@url, post_data, @opts)
+      if resp.nil? || resp.body.nil? || resp.body.empty?
+        raise Client::Error::InvalidResponse.new
+      end
+
+      return resp.body
+    end
+
+    def send_batch_request(batch)
+      post_data = MultiJson.encode(batch)
+      resp = RestClient.post(@url, post_data, @opts)
+      if resp.nil? || resp.body.nil? || resp.body.empty?
+        raise Client::Error::InvalidResponse.new
+      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 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?(Fixnum) || !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(json)
+      end
+
+      process_batch_response(responses)
+      @batch = []
+    end
+
+  end
+
+  class BatchClient < BlankSlate
+
+    def initialize(helper)
+      @helper = helper
+    end
+
+    def method_missing(sym, *args, &block)
+      request = Sr::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)
+      @url, @opts, @namespace = url, opts, namespace
+      @helper = ClientHelper.new(url, opts, namespace)
+    end
+
+    def method_missing(sym, *args, &block)
+      @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 'sr/jimson/client/error'