jr 0.0.1

data/README

@@ -0,0 +1,14 @@
+Jr.
+---
+
+Jr. is a Ruby library for communicating with JSON RPC servers. Unfortunately,
+Jr. currently only supports HTTP JSON RPC servers.
+
+Example Usage
+-------------
+
+	# Connect to the JSON RPC at https://user:password@127.0.0.1:1234/
+	jr = Jr::Jr.new('127.0.0.1', 1234, 'user', 'password', use_ssl=true)
+
+	jr.request(:function, 'arg1', 'arg2') # 'response'
+	jr.function('arg1', 'arg2')           # 'response'

data/lib/jr.rb

@@ -0,0 +1,147 @@
+require 'json'
+require 'socket'
+require 'base64'
+require 'openssl'
+require 'net/http'
+
+JSON_RPC_VERSION = '2.0'
+
+module Jr
+	class Error < Exception
+		@@message = 'There was an error communicating with the JSON RPC server.'
+
+		# @jr is the instance of JR that raised the exception.
+		attr_reader :jr
+
+		def initialize(jr, msg=@@message)
+			@jr = jr
+
+			super(msg)
+		end
+	end
+
+	class AuthenticationError < Error
+		@@message = 'There was an error authenticating to the JSON RPC server.'
+	end
+
+	class IDMismatch < Error
+		@@message = 'The server sent us a response with an unexpected id.'
+	end
+
+	# ProtocolMismatch is raised when value of 'rpcjson' returned by the server
+	# does not match JSON_RPC_VERSION. Because of errors in JSON RPC servers, it
+	# is *NOT* raised if 'rpcjson' is omitted, even though that is required by the
+	# (draft) specification.
+	class ProtocolMismatch < Error
+		def initialize(jr, version)
+			super(jr, "We expected to receive a version '#{JSON_RPC_VERSION}' "\
+			          "response, but actually got a #{version.inspect} one.")
+		end
+	end
+
+	# ReservedMethod is raised if a method beginning with 'rpc' is called.
+	class ReservedMethod < Error
+		@@message = '%s is a reserved method'
+
+		# @method is the name of the reserved method.
+		attr_reader :method
+
+		def initialize(jr, method, msg=@@message)
+			@method = method
+			super(jr, meth % msg)
+		end
+	end
+
+	# ServerError is raised when the server requests (via the error property) that
+	# an exception be raised in client code.
+	class ServerError < Exception
+		# @code is a Fixnum specifying the type of the error.
+		attr_reader :code
+		# @message is a String providing a short description of the error.
+		attr_reader :message
+		# @data is an Object providing additional information about the error.
+		attr_reader :data
+
+		def initialize(jr, code, message, data)
+			@code, @message, @data = code, message, data
+
+			super(jr, "Error %d: %s" % [code, message])
+		end
+	end
+
+	# Jr lets you communicate with an HTTP JSON RPC server.
+	class Jr
+		attr_reader :host, :port, :user, :password, :ssl
+
+		# @connection is a Net::HTTP.
+		attr_reader :connection
+
+		def initialize(host, port, user=nil, password=nil, ssl=false)
+			%w{host user port password ssl}.each do |var|
+				instance_variable_set("@#{var}", eval(var))
+			end
+		end
+
+		# Call method on the server, and return the result.
+		def request(method, *args)
+			if method.start_with?('rpc')
+				raise ReservedMethod.new(method)
+			end
+
+			reqid = get_request_id()
+			data = JSON.dump(
+				jsonrpc: '2.0',
+				method: method.to_s,
+				params: args,
+				id: reqid
+			)
+
+			r = JSON.parse(http_request(data))
+			if r.has_key?('jsonrpc') and (r['jsonrpc'] != JSON_RPC_VERSION)
+				# Even though the JSON RPC specification requires that a 'jsonrpc' key
+				# is present, we don't require it because not all servers implement it.
+				raise ProtocolMismatch.new(self, r['jsonrpc'])
+			elsif r['id'] != reqid
+				raise ProtocolMismatch.new(IDMismatch, self)
+			elsif r['error']
+				raise ServerError.new(self, r['error']['code'], r['error']['message'],
+				                      r['error']['data'])
+			end
+
+			r['result']
+		end
+
+		def method_missing(meth, *args)
+			request(meth, *args)
+		end
+
+		private
+
+		# We return the unparsed response of the JSON RPC server to the serialized
+		# request data.
+		def http_request(data)
+			unless @connection
+				@connection = Net::HTTP.new(@host, @port)
+				@connection.use_ssl = @ssl
+			end
+
+			req = Net::HTTP::Post.new('/')
+			req.basic_auth(@user, @password)
+			req.content_type = 'multipart/form_data'
+			req.body = data
+
+			resp = @connection.request(req)
+			if Net::HTTPUnauthorized === resp
+				raise AuthenticationError.new(self)
+			end
+
+			resp.body()
+		end
+
+		# Generate a request ID. We use a random string for this.
+		def get_request_id()
+			@random_instance ||= Random.new
+			Base64.urlsafe_encode64(@random_instance.bytes(12))
+		end
+	end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: jr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- katmagic
+autorequire: 
+bindir: bin
+cert_chain:
+- ! '-----BEGIN CERTIFICATE-----
+
+  MIIDQDCCAiigAwIBAgIBADANBgkqhkiG9w0BAQUFADBGMRgwFgYDVQQDDA90aGUu
+
+  bWFnaWNhbC5rYXQxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixk
+
+  ARkWA2NvbTAeFw0xMTA4MjEyMjMyMDFaFw0xMjA4MjAyMjMyMDFaMEYxGDAWBgNV
+
+  BAMMD3RoZS5tYWdpY2FsLmthdDEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYK
+
+  CZImiZPyLGQBGRYDY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA
+
+  pBt20nwjs5W03djpRN6FAbpiio286NHMTk6HhmjV6GZKOi5ZUX5onTnKUg2Vc35z
+
+  /nK+aIPReyRfBgIcfSjhoXh1A1Dp+2laNgTtU/3eMupruatgORAPCSaG9Ns+HSyR
+
+  vySbz1QUrwvlvF0qkhhApNQ6dsLl2LMOV3QcluY+Y3CVccOWOSHdQcnAbPuzM9Hf
+
+  4ChI4OGL7+DwLA5OK2S5uewRAa2iLkJSN0WugnQlJqMT59GRaqTDOtnYQpiyKEBy
+
+  QjVPO4LNk7iDsJP22YBrveIzm8/YYRBTU4LTHMEMOyCszrYqD2S1Lwp2rtCJzQCl
+
+  BA0LtBKrZl5mwZm7qyj+TwIDAQABozkwNzAJBgNVHRMEAjAAMB0GA1UdDgQWBBSm
+
+  s5arhjp61kmGl6wsmLYkqerdqDALBgNVHQ8EBAMCBLAwDQYJKoZIhvcNAQEFBQAD
+
+  ggEBAA6cQNQMOPRy4yrj7Nh5Mb9qq8t/8ho/JQvjzVof9qRd+kfKrOoOhXfEO+Rm
+
+  sWcaOnBCVC4DnZuNDSLygVhCDtMnHjg/JsfO/GBF/QlNTJOO1jkoQiS6w0KARlBm
+
+  cpXaWg/oMtXJ2PaUga6WkNeXYf9Mad36P4yuGQScjs+WkUUy7DNZvTGReIcCWOR8
+
+  jteSvvCMobQKGr2DfFOU9Jiddh2FPpz/KOM2ijzwsVNUMUr7R58LoCnQZrZ/YaRW
+
+  ob6QnVgwqu5SUAKQxlFJ/aKlPMj735z8EogaZC1ZHgg3vkgGGyu57N/8BDDG0TzC
+
+  Zn3u2leVae/fJ03zYGArhuJKPgc=
+
+  -----END CERTIFICATE-----
+
+'
+date: 2012-02-17 00:00:00.000000000 Z
+dependencies: []
+description: Jr. lets you communicate with an HTTP JSON RPC server.
+email: the.magical.kat@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README
+- lib/jr.rb
+homepage: https://github.com/katmagic/jr
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Jr. is a JSON RPC client implementation.
+test_files: []
+has_rdoc: 

metadata.gz.sig

@@ -0,0 +1,2 @@
+ս�{�QB�~����4�ħ0�ZT2ppw$�?��kbPd�"<#���c���(]t���
߬��ę{�w�/	�`1#u�sň�R��ut�Ɣ~R^�1	��o�С�[l�|��<1�N
+R&8��G^H{A%̂��j|,��ٞ���]g