rpcjson 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+gem "json", ">= 0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Jonathan Jeffus
+
+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.rdoc

@@ -0,0 +1,66 @@
+= rpcjson
+
+This is my implementation of JSON-RPC as detailed in the original 2007 1.1 specification found here:
+http://json-rpc.org/wiki/specification
+
+And the newer non-standardized 2.0 specification:
+http://groups.google.com/group/json-rpc/web/json-rpc-2-0
+
+I wrote this because it didn't appear that any of the JSON-RPC implementations worked anymore for modern Ruby. There were numerous errors, missing gems and nothing worked. 
+
+== Example usage
+
+Here's an example which connects to bitcoind and asks it to getinfo.
+
+  require 'rubygems'
+  require 'rpcjson'
+
+  # 1.1 is required because bitcoind does not speak 2.0
+  bc = RPC::JSON::Client.new 'http://username:password@127.0.0.1:8332', 1.1
+  
+  # JSON-RPC error objects are raised as Ruby objects of the type
+  # RPC::JSON::Client::Error. The original object is available at
+  # e.error
+
+  begin
+
+    # First get server info
+    puts "Getting server information..."
+    info = bc.getinfo
+    info.each_key do |key|
+      puts "#{key}: #{info[key]}"
+    end
+
+    # Will raise error
+    puts "Shutting down the server..."
+    bc.st0p
+  rescue RPC::JSON::Client::Error => e
+    puts "Got an error: #{e}: #{e.error.to_json}"
+  end
+
+This software has been tested on Ruby EE 2010.02. Let me know how it works elsewhere.
+
+== Contributing to rpcjson
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Donations
+
+I wrote this mainly to provide support in Ruby for Bitcoin. If you happen to have a bitcoin account and you feel like supporting this project - please send a few coins my way.
+
+Receiving address: 14SjyYcHakwmqu8QQYh6emjy47fW8rhUKk
+
+If you haven't heard about Bitcoin, well, check out the system that makes PayPal obsolete.
+http://www.bitcoin.org
+
+== Copyright
+
+Copyright (c) 2010 Jonathan Jeffus. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "rpcjson"
+  gem.homepage = "http://github.com/jjeffus/rpcjson"
+  gem.license = "MIT"
+  gem.summary = %Q{Modern JSON-RPC 1.1 and 2.0 implementation.}
+  gem.description = %Q{This module aims to be a complete implementation of JSON-RPC 1.1 and 2.0.}
+  gem.email = "jjeffus@gmail.com"
+  gem.authors = ["Jonathan Jeffus"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  gem.add_runtime_dependency 'json', '> 0.0'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rpcjson #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/rpcjson.rb

@@ -0,0 +1,108 @@
+require 'net/http'
+require 'uri'
+require 'json'
+
+class RPC
+  class JSON
+    class Client
+      class Error < RuntimeError
+        attr_accessor :error
+        def initialize(error)
+          @error = error
+        end
+      end
+
+      def initialize(url, version = 2.0)
+        @id = 1
+        @uri = URI.parse(url)
+        @version = version
+      end
+
+      def method_missing(func, *args)
+        json = {
+          # jsonrpc
+          # A String specifying the version of the JSON-RPC protocol. MUST be exactly "2.0". 
+          'jsonrpc' => @version.to_s,
+          # method
+          # A String containing the name of the method to be invoked.
+          'method' => func,
+          # id
+          # An identifier established by the Client that MUST contain a String, Number, or NULL value if included. If it is not included it is assumed to be a notification. The value SHOULD normally not be Null [1] and Numbers SHOULD NOT contain fractional parts [2]
+          'id' => @id
+        }
+
+        # 1.0/1.1:
+        # params - An Array of objects to pass as arguments to the method. 
+        # 2.0:
+        # params
+        # A Structured value that holds the parameter values to be used during the invocation of the method. This member MAY be omitted.
+
+        # params are expected always in 1.0/1.1. Not required in 2.0.
+        if @version < 2.0 or (args != nil and args.length != 0)
+          json['params'] = args
+        end
+
+        body = JSON(json)
+        # puts "Sending: #{body}"
+
+        http = Net::HTTP.new(@uri.host, @uri.port)
+        request = Net::HTTP::Get.new(@uri.request_uri)
+        if @uri.user != nil
+          request.basic_auth(@uri.user, @uri.password)
+        end
+        request.body = body
+        response = http.request(request)
+        answer = JSON( response.body )
+
+        # p answer 
+
+        # 1.0/1.1
+        # jsonrpc: NOT INCLUDED
+        # 2.0 
+        # jsonrpc: 
+        # A String specifying the version of the JSON-RPC protocol. MUST be exactly "2.0".
+        if answer['jsonrpc'] == nil
+          if @version >= 2.0
+            STDERR.puts "Error: We're configured to use JSON-RPC #{@version}, but the server appears to be using an older implementation."
+          end
+        else
+          if answer['jsonrpc'].to_f < @version
+            STDERR.puts "Error: We're configured to use JSON-RPC #{@version}, but the server appears to be using #{answer['jsonrpc']}"
+          elsif answer['jsonrpc'].to_f > @version
+            STDERR.puts "Error: We're configured to use JSON-RPC #{@version}, but the server appears to be using #{answer['jsonrpc']}"
+          end
+        end
+
+        # 1.0/1.1
+        # error - An Error object if there was an error invoking the method. It must be null if there was no error. 
+        # 2.0
+        # error
+        # This member is REQUIRED on error.
+        # This member MUST NOT exist if there was no error triggered during invocation.
+        # The value for this member MUST be an Object as defined in section 5.1.
+
+        # It will be nil in either case if there was no error.
+        if answer['error'] != nil
+          if @version >= 2.0
+            raise Error.new(answer['error']), answer['error']['message']
+          else
+            # No standard for < 2.0 error objects.
+            # Bitcoind is 1.1 and seems to follow 2.0 standard, other clients?
+            raise Error.new(answer['error']), 'JSON-RPC Error'
+          end
+        end
+
+        @id += 1
+
+        # 1.0
+        # result - The Object that was returned by the invoked method. This must be null in case there was an error invoking the method. 
+        # 2.0
+        # result
+        # This member is REQUIRED on success.
+        # This member MUST NOT exist if there was an error invoking the method.
+        # The value of this member is determined by the method invoked on the Server. 
+        return answer['result']
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rpcjson'
+
+class Test::Unit::TestCase
+end

data/test/test_rpcjson.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestRpcjson < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    # flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification 
+name: rpcjson
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jonathan Jeffus
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-24 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+  prerelease: false
+  type: :runtime
+  name: json
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+  prerelease: false
+  type: :development
+  name: shoulda
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id003
+  prerelease: false
+  type: :development
+  name: bundler
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  requirement: *id004
+  prerelease: false
+  type: :development
+  name: jeweler
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+  prerelease: false
+  type: :development
+  name: rcov
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 0
+        version: "0.0"
+  requirement: *id006
+  prerelease: false
+  type: :runtime
+  name: json
+description: This module aims to be a complete implementation of JSON-RPC 1.1 and 2.0.
+email: jjeffus@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rpcjson.rb
+- test/helper.rb
+- test/test_rpcjson.rb
+has_rdoc: true
+homepage: http://github.com/jjeffus/rpcjson
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Modern JSON-RPC 1.1 and 2.0 implementation.
+test_files: 
+- test/helper.rb
+- test/test_rpcjson.rb