jsonrpc2 0.0.4 → 0.0.5

data/bin/jsonrpc2

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+require "rubygems" # ruby1.9 doesn't "require" it though
+require "thor"
+require 'jsonrpc2/client'
+require 'json'
+require 'pp'
+
+class JSONClient < Thor
+  method_option :user, :type => :string
+  method_option :pass, :type => :string
+  desc "call URI METHOD [PARAMS]", "Call "
+  def call uri, method, params=nil
+    STDOUT << "#{uri}##{method}(#{params})"
+    uri = "http://#{uri}" unless uri =~ %r'://'
+
+    client = JSONRPC2::Client.new(uri, options)
+    STDOUT << " => "
+    begin
+      pp client.call(method, JSON.parse(params))
+    rescue JSONRPC2::RemoteAuthError => e
+      puts "ERR\nFAIL: #{e.message}"
+    rescue JSONRPC2::RemoteError => e
+      puts "ERR\nFAIL: #{e.message}"
+    end
+  end
+end
+
+JSONClient.start

data/example/config.ru

@@ -4,15 +4,15 @@ require 'jsonrpc2/interface'
 class ::Object::Calculator < JSONRPC2::Interface
   title "JSON-RPC2 Calculator"
   introduction "This interface allows basic maths calculations via JSON-RPC2"
-  auth_with JSONRPC2::BasicAuth.new({'user' => 'secretword'})
+  auth_with JSONRPC2::BasicAuth.new({'user' => 'secretword', 'admin' => 'password'})
 
   section 'Simple Ops' do
       desc 'Multiply two numbers'
       param 'a', 'Number', 'a'
       param 'b', 'Number', 'b'
       result 'Number', 'a * b'
-      def mul args
-        args['a'] * args['b']
+      def mul
+        params['a'] * params['b']
       end
 
       desc 'Add numbers'
@@ -22,9 +22,12 @@ class ::Object::Calculator < JSONRPC2::Interface
       param 'b', 'Number', 'Second number'
       optional 'c', 'Number', 'Third number'
       result 'Number', 'a + b + c'
-      def sum args
-        val = args['a'] + args['b']
-        val += args['c'] if args['c']
+      def sum
+        val = params['a'] + params['b']
+        val += params['c'] if params['c']
+
+        return 42 if auth == 'admin'
+
         val
       end
   end

data/jsonrpc2.gemspec

@@ -54,4 +54,5 @@ EOD
   gem.add_dependency("httpclient")
   gem.add_dependency("json")
   gem.add_dependency("RedCloth")
+  gem.add_dependency('thor')
 end

data/lib/jsonrpc2/auth.rb

@@ -89,14 +89,15 @@ class BasicAuth < HttpAuth
 
   # Checks users hash and then the block given to the constructor to
   # verify username / password.
+  # @return [String,false] Username or nothing
   def user_valid?(user, pass)
     if @users && @users.respond_to?(:[])
       if expected = @users[user]
-        return pass == expected
+        return user if pass == expected
       end
     end
     if @lookup
-      return @lookup.call(user, pass)
+      return user if @lookup.call(user, pass)
     end
     false
   end

data/lib/jsonrpc2/client.rb

@@ -6,6 +6,10 @@ module JSONRPC2
 class RemoteError < RuntimeError
 end
 
+# JSON RPC remote auth error
+class RemoteAuthError < RemoteError
+end
+
 # Simple JSONRPC client
 class Client
   # Create client object
@@ -36,8 +40,8 @@ class Client
       headers = headers.merge(options[:headers])
     end
 
-    if options[:auth]
-      @client.set_auth(@uri, options[:auth][:username], options[:auth][:password])
+    if options[:user] && options[:pass]
+      @client.set_auth(@uri, options[:user], options[:pass])
     end
 		result = @client.post(@uri, 
 							  { 'method' => method, 'params' => args, 'jsonrpc' => '2.0', 'id' => (@id+=1) }.to_json,
@@ -49,8 +53,17 @@ class Client
 			if data.has_key?('result')
 				return data['result']
 			else
-				raise RemoteError, data['error']['message']
+        if data['error']['code'] == -32000 && data['error']['message'] =~ /^AuthFail/
+          raise RemoteAuthError, data['error']['message']
+        else
+          raise RemoteError, data['error']['message']
+        end
 			end
+    elsif result.status_code == 401
+      if result.headers['WWW-Authenticate'].to_s =~ /realm="([^"]*?)"/
+        suffix = " for #{$1}"
+      end
+      raise RemoteAuthError, "Authentication failed#{suffix}"
 		else
 			raise result.body
 		end

data/lib/jsonrpc2/interface.rb

@@ -96,23 +96,28 @@ class Interface
 	end
   # JSON error helper
 	def response_error(code, message, data)
-		{ 'jsonrpc' => '2.0', 'error' => { 'code' => code, 'message' => message, 'data' => data }, 'id' => @id }
+		{ 'jsonrpc' => '2.0', 'error' => { 'code' => code, 'message' => message, 'data' => data }, 'id' => (@jsonrpc_call && @jsonrpc_call['id'] || nil) }
 	end
+  # Params helper
+  def params
+    @jsonrpc_call['params']
+  end
+  # Auth info
+  def auth
+    @jsonrpc_auth
+  end
   # Check call validity and authentication & make a single method call
   #
   # @param [Hash] rpc JSON-RPC-2 call
 	def dispatch_single(rpc)
 		unless rpc.has_key?('id') && rpc.has_key?('method') && rpc['jsonrpc'].eql?('2.0')
-			@id = nil
 			return response_error(-32600, 'Invalid request', nil)
 		end
-		@id = rpc['id']
-		@method = rpc['method']
-		@rpc = rpc
-				
+    @jsonrpc_call = rpc
+
 		begin
-      if self.class.auth_with 
-        self.class.auth_with.client_check(@env, rpc) or raise AuthFail, "Invalid credentials"
+      if self.class.auth_with && ! @jsonrpc_auth
+        (@jsonrpc_auth = self.class.auth_with.client_check(@env, rpc)) or raise AuthFail, "Invalid credentials"
       end
 
 			call(rpc['method'], rpc['id'], rpc['params'])

data/lib/jsonrpc2/textile.rb

@@ -7,19 +7,23 @@ module JSONRPC2
 		def to_textile
 			return nil if @about.nil? or @about.empty?
 			str = ""
+
 			if @title
 				str << "h1. #{@title}\n"
       else
         str << "h1. #{name}\n"
 			end
+
 			if @introduction
 				str << "\nh2. Introduction\n\n#{@introduction}\n"
 			end
 
+      # Output type descriptions
+      #
 			unless @types.nil? or @types.empty?
-				str << "\nh2. Types\n"
+				str << "\n\nh2. Types\n"
 				@types.sort_by { |k,v| k }.each do |k,type|
-					str << "\nh5. #{k} type\n"
+					str << "\n\nh5. #{k} type\n"
 
 					str << "\n|_. Field |_. Type |_. Required? |_. Description |"
 					type.fields.each do |field|
@@ -29,27 +33,32 @@ module JSONRPC2
 				end
 			end
 
-			@sections.each do |section|
-				str << "\nh2. #{section[:name]}\n"
+
+      # Output method definitions
+      #
+			(@sections||[]).each do |section|
+				str << "\n\nh2. #{section[:name]}\n"
 				if section[:summary]
 					str << "\n#{section[:summary]}\n"
 				end
 				
 				str += to_textile_group(section).to_s
 			end
+
 			miscfn = to_textile_group({:name => nil})
 			if miscfn
-				str << "\nh2. Misc functions\n"
+				str << "\n\nh2. Misc functions\n" if @sections && ! @sections.empty?
 				str << miscfn
 			end
+
 			str
 		end
     # Returns method description in textile
     def method_to_textile(info)
       str = ''
-      str << "\nh3. #{info[:name]}\n"
+      str << "\n\nh3. #{info[:name]}\n"
       str << "\n#{info[:desc]}\n" if info[:desc]
-      str << "\nh5. Params\n"
+      str << "\n\nh5. Params\n"
       if info[:params].nil?
         str << "\n* _None_\n"
       elsif info[:params].is_a?(Array)
@@ -60,17 +69,17 @@ module JSONRPC2
       end
 
       if res = info[:returns]
-        str << "\nh5. Result\n"
+        str << "\n\nh5. Result\n"
         str << "\n* @#{res[:type]}@"		
         str << " - #{res[:desc]}" if res[:desc]
         str << "\n"
       else
-        str << "\nh5. Result\n"
+        str << "\n\nh5. Result\n"
         str << "\n* @null@"
       end
 
       if examples = info[:examples]
-        str << "\nh5. Sample usage\n"
+        str << "\n\nh5. Sample usage\n"
 
         nice_json = lambda do |data|
           JSON.pretty_unparse(data).gsub(/\n\n+/,"\n").gsub(/[{]\s+[}]/m, '{ }').gsub(/\[\s+\]/m, '[ ]')

data/lib/jsonrpc2/version.rb

@@ -1,5 +1,5 @@
 # JSONRPC2 namespace module
 module JSONRPC2
   # Version
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: jsonrpc2
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Geoff Youngs
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-17 00:00:00 Z
+date: 2012-07-19 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: httpclient
@@ -59,6 +59,20 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
 description: |+
   == Description
   
@@ -98,8 +112,8 @@ description: |+
   
 email: 
 - git@intersect-uk.co.uk
-executables: []
-
+executables: 
+- jsonrpc2
 extensions: []
 
 extra_rdoc_files: []
@@ -109,6 +123,7 @@ files:
 - Gemfile
 - README.markdown
 - Rakefile
+- bin/jsonrpc2
 - example/config.ru
 - jsonrpc2.gemspec
 - lib/jsonrpc2.rb