bitcoin-client 0.0.1

data/lib/bitcoin/errors.rb

@@ -0,0 +1,4 @@
+module Bitcoin::Errors
+  class RPCError < StandardError
+  end
+end

data/lib/bitcoin/request.rb

@@ -0,0 +1,35 @@
+require 'json'
+
+class Bitcoin::Request
+  attr_reader :service_name, :params
+  
+  def initialize(service_name, params = [])
+    @service_name = service_name
+    @params = params.dup
+    
+    # bitcoin rejects null values even for optional params. Since
+    # even params following those may have default non-nil values,
+    # we'll assume the first non-nil value marks a set of optional
+    # params, and drop it and everything following it.
+    #
+    # ex:
+    #   [nil]          => []
+    #   [1,nil,nil]    => [1]
+    #   [1,nil,nil,1]  => [1]
+    if index = @params.index(nil)
+      @params = @params[0...index]
+    end
+  end
+  
+  def to_hash
+    {
+      :method => service_name,
+      :params => params,
+      :id => "jsonrpc"
+    }
+  end
+  
+  def to_post_data
+    to_hash.to_json
+  end
+end

data/lib/bitcoin/rpc.rb

@@ -0,0 +1,50 @@
+require 'rest_client'
+
+class Bitcoin::RPC
+  def initialize(options)
+    @user, @pass = options[:user], options[:pass]
+    @host, @port = options[:host], options[:port]
+    @ssl = options[:ssl]
+  end
+  
+  def credentials
+    if @user
+      "#{@user}:#{@pass}"
+    else
+      nil
+    end
+  end
+  
+  def service_url
+    url = @ssl ? "https://" : "http://"
+    url.concat "#{credentials}@" if c = credentials
+    url.concat "#{@host}:#{@port}"
+    url
+  end
+  
+  def dispatch(request)
+    respdata = RestClient.post service_url, request.to_post_data
+    response = JSON.parse(respdata)
+    raise Bitcoin::Errors::RPCError, response['error'] if response['error']
+    response['result']
+  end
+  
+  private
+  def symbolize_keys(hash)
+    case hash
+    when Hash
+      hash.inject({}) do |result, (key, value)|
+        key = key.to_sym if key.kind_of?(String)
+        value = symbolize_keys(value)
+        result[key] = value
+        result
+      end
+    when Array
+      hash.collect do |ele|
+        symbolize_keys(ele)
+      end
+    else
+      hash
+    end
+  end
+end

data/lib/bitcoin/version.rb

@@ -0,0 +1,12 @@
+module Bitcoin
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 1
+    REL = nil
+    
+    STRING = REL ? [MAJOR, MINOR, PATCH, REL].join('.') : [MAJOR, MINOR, PATCH].join('.')
+  end
+  
+  VERSION = Version::STRING
+end

data/spec/fixtures/backupwallet_without_params.json

@@ -0,0 +1,8 @@
+HTTP/1.1 500 Internal Server Error
+Date: Sun, 21 Aug 2011 22:53:05 +0000
+Connection: close
+Content-Length: 183
+Content-Type: application/json
+Server: bitcoin-json-rpc/0.3.24-beta
+
+{"result":null,"error":{"code":-1,"message":"backupwallet <destination>\nSafely copies wallet.dat to destination, which can be a directory or a path with filename."},"id":"curltest"}

data/spec/fixtures/build_fixture.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require 'yaml'
+require 'json'
+
+service_name = ARGV[0]
+file_name = (ARGV[1] || service_name).dup
+params = ARGV[2..-1].collect { |y| y == '_nil' ? nil : YAML::load(y) }
+
+file_name << ".json" unless file_name =~ /\.json$/
+
+data = { 'jsonrpc' => '1.0', 'id' => 'curltest', 'method' => service_name, 'params' => params }
+command = "curl --user cm4:H2na-92D --data-binary '#{data.to_json}' -H 'content-type: text/plain;' http://127.0.0.1:8332/ -i"
+
+puts command, nil
+result = %x[#{command}]
+puts result, nil
+File.open(file_name, "w") { |f| f.print result }
+

data/spec/fixtures/getbalance.json

@@ -0,0 +1,8 @@
+HTTP/1.1 200 OK
+Date: Mon, 22 Aug 2011 00:22:27 +0000
+Connection: close
+Content-Length: 51
+Content-Type: application/json
+Server: bitcoin-json-rpc/0.3.24-beta
+
+{"result":0.00100000,"error":null,"id":"curltest"}

data/spec/fixtures/getblockcount.json

@@ -0,0 +1,8 @@
+HTTP/1.1 200 OK
+Date: Sun, 21 Aug 2011 22:01:17 +0000
+Connection: close
+Content-Length: 47
+Content-Type: application/json
+Server: bitcoin-json-rpc/0.3.24-beta
+
+{"result":141972,"error":null,"id":"curltest"}

data/spec/fixtures/getblocknumber.json

@@ -0,0 +1,8 @@
+HTTP/1.1 200 OK
+Date: Sun, 21 Aug 2011 22:02:32 +0000
+Connection: close
+Content-Length: 47
+Content-Type: application/json
+Server: bitcoin-json-rpc/0.3.24-beta
+
+{"result":141972,"error":null,"id":"curltest"}

data/spec/fixtures/getconnectioncount.json

@@ -0,0 +1,8 @@
+HTTP/1.1 200 OK
+Date: Sun, 21 Aug 2011 22:21:22 +0000
+Connection: close
+Content-Length: 42
+Content-Type: application/json
+Server: bitcoin-json-rpc/0.3.24-beta
+
+{"result":8,"error":null,"id":"curltest"}

data/spec/fixtures/getdifficulty.json

@@ -0,0 +1,8 @@
+HTTP/1.1 200 OK
+Date: Sun, 21 Aug 2011 22:23:42 +0000
+Connection: close
+Content-Length: 57
+Content-Type: application/json
+Server: bitcoin-json-rpc/0.3.24-beta
+
+{"result":1805700.83619367,"error":null,"id":"curltest"}

data/spec/fixtures/getgenerate.json

@@ -0,0 +1,8 @@
+HTTP/1.1 200 OK
+Date: Sun, 21 Aug 2011 22:24:10 +0000
+Connection: close
+Content-Length: 46
+Content-Type: application/json
+Server: bitcoin-json-rpc/0.3.24-beta
+
+{"result":false,"error":null,"id":"curltest"}

data/spec/fixtures/gethashespersec.json

@@ -0,0 +1,8 @@
+HTTP/1.1 200 OK
+Date: Sun, 21 Aug 2011 22:25:42 +0000
+Connection: close
+Content-Length: 42
+Content-Type: application/json
+Server: bitcoin-json-rpc/0.3.24-beta
+
+{"result":0,"error":null,"id":"curltest"}

data/spec/fixtures/getinfo.json

@@ -0,0 +1,8 @@
+HTTP/1.1 200 OK
+Date: Sun, 21 Aug 2011 20:24:03 +0000
+Connection: close
+Content-Length: 281
+Content-Type: application/json
+Server: bitcoin-json-rpc/0.3.24-beta
+
+{"result":{"version":32400,"balance":0.00100000,"blocks":141957,"connections":8,"proxy":"","generate":false,"genproclimit":-1,"difficulty":1805700.83619367,"hashespersec":0,"testnet":false,"keypoololdest":1313766189,"paytxfee":0.00000000,"errors":""},"error":null,"id":"curltest"}

data/spec/fixtures/help.json

@@ -0,0 +1,8 @@
+HTTP/1.1 200 OK
+Date: Sun, 21 Aug 2011 23:20:10 +0000
+Connection: close
+Content-Length: 1078
+Content-Type: application/json
+Server: bitcoin-json-rpc/0.3.24-beta
+
+{"result":"backupwallet <destination>\ngetaccount <bitcoinaddress>\ngetaccountaddress <account>\ngetaddressesbyaccount <account>\ngetbalance [account] [minconf=1]\ngetblockcount\ngetblocknumber\ngetconnectioncount\ngetdifficulty\ngetgenerate\ngethashespersec\ngetinfo\ngetnewaddress [account]\ngetreceivedbyaccount <account> [minconf=1]\ngetreceivedbyaddress <bitcoinaddress> [minconf=1]\ngettransaction <txid>\ngetwork [data]\nhelp [command]\nlistaccounts [minconf=1]\nlistreceivedbyaccount [minconf=1] [includeempty=false]\nlistreceivedbyaddress [minconf=1] [includeempty=false]\nlisttransactions [account] [count=10] [from=0]\nmove <fromaccount> <toaccount> <amount> [minconf=1] [comment]\nsendfrom <fromaccount> <tobitcoinaddress> <amount> [minconf=1] [comment] [comment-to]\nsendmany <fromaccount> {address:amount,...} [minconf=1] [comment]\nsendtoaddress <bitcoinaddress> <amount> [comment] [comment-to]\nsetaccount <bitcoinaddress> <account>\nsetgenerate <generate> [genproclimit]\nsettxfee <amount>\nstop\nvalidateaddress <bitcoinaddress>","error":null,"id":"curltest"}

data/spec/fixtures/listreceivedbyaddress_with_minconf_0.json

@@ -0,0 +1,8 @@
+HTTP/1.1 200 OK
+Date: Sun, 21 Aug 2011 23:04:42 +0000
+Connection: close
+Content-Length: 155
+Content-Type: application/json
+Server: bitcoin-json-rpc/0.3.24-beta
+
+{"result":[{"address":"1234","account":"","label":"","amount":0.00100000,"confirmations":180}],"error":null,"id":"curltest"}

data/spec/fixtures/listreceivedbyaddress_with_minconf_0_and_includeempty_true.json

@@ -0,0 +1,7 @@
+HTTP/1.1 200 OK
+Date: Sun, 21 Aug 2011 23:15:11 +0000
+Connection: close
+Content-Type: application/json
+Server: bitcoin-json-rpc/0.3.24-beta
+
+{"result":[{"address":"1234","account":"","label":"","amount":0.00100000,"confirmations":180}],"error":null,"id":"curltest"}

data/spec/fixtures/listreceivedbyaddress_without_params.json

@@ -0,0 +1,7 @@
+HTTP/1.1 200 OK
+Date: Sun, 21 Aug 2011 22:54:36 +0000
+Connection: close
+Content-Type: application/json
+Server: bitcoin-json-rpc/0.3.24-beta
+
+{"result":[{"address":"1234","account":"","label":"","amount":0.00100000,"confirmations":180}],"error":null,"id":"curltest"}

data/spec/lib/bitcoin/api_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Bitcoin::API do
+  subject { Bitcoin::API.new(:user => $user, :pass => $pass) }
+  
+  it "should have default host, port, ssl" do
+    subject.host.should == 'localhost'
+    subject.port.should == 8332
+    subject.ssl?.should be_false
+  end
+  
+  it "should accept host, port, ssl options" do
+    req = Bitcoin::API.new(:user => $user, :pass => $pass, :host => 'example.com', :port => 1234, :ssl => true)
+    req.host.should == 'example.com'
+    req.port.should == 1234
+    req.ssl?.should be_true
+  end
+  
+  it "should build an options hash" do
+    subject.to_hash.should == {
+      :user => $user,
+      :pass => $pass,
+      :host => 'localhost',
+      :port => 8332,
+      :ssl => false,
+    }
+  end
+end

data/spec/lib/bitcoin/client_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+describe Bitcoin::Client do
+  subject { Bitcoin::Client.new($user, $pass) }
+  
+  it "defaults" do
+    subject.user.should == $user
+    subject.pass.should == $pass
+    subject.host.should == 'localhost'
+    subject.port.should == 8332
+    subject.ssl?.should_not be_true
+  end
+  
+  context "RPC" do
+    extend RPCServiceHelper
+    
+    service 'getinfo' do
+      it "should produce the expected result" do
+        result.should == {
+          'version' => 32400,
+          'balance' => 0.001,
+          'blocks' => 141957,
+          'connections' => 8,
+          'proxy' => "",
+          'generate' => false,
+          'genproclimit' => -1,
+          'difficulty' => 1805700.83619367,
+          'hashespersec' => 0,
+          'testnet' => false,
+          'keypoololdest' => 1313766189,
+          'paytxfee' => 0.0,
+          'errors' => ""
+        }
+      end
+    end
+    
+    service 'getblockcount' do
+      it "should produce the expected result" do
+        result.should == 141972
+      end
+    end
+
+    service 'getblocknumber' do
+      it "should produce the expected result" do
+        result.should == 141972
+      end
+    end
+    
+    service 'getconnectioncount' do
+      it "should produce the expected result" do
+        result.should == 8
+      end
+    end
+    
+    service 'getdifficulty' do
+      it "should produce the expected result" do
+        result.should == 1805700.83619367
+      end
+    end
+    
+    service 'getgenerate' do
+      it "should produce the expected result" do
+        result.should be_false
+      end
+    end
+    
+    service 'gethashespersec' do
+      it "should produce the expected result" do
+        result.should == 0
+      end
+    end
+    
+    service 'listreceivedbyaddress' do
+      context 'without params' do
+        it "should produce the expected result" do
+          result.should == [{
+            'address' => "1234",
+            'account' => "", 
+            'label' => "",
+            'amount' => 0.001, 
+            'confirmations' => 180}]
+        end
+      end
+      
+      context 'with minconf 0' do
+        it "should produce the expected result" do
+          result(0).should == [{
+            'address' => "1234",
+            'account' => "", 
+            'label' => "",
+            'amount' => 0.001, 
+            'confirmations' => 180}]
+        end
+      end
+
+      context 'with minconf 0 and includeempty true' do
+        it "should produce the expected result" do
+          result(0, true).should == [{
+            'address' => "1234",
+            'account' => "", 
+            'label' => "",
+            'amount' => 0.001, 
+            'confirmations' => 180}]
+        end
+      end
+    end
+  end
+end

data/spec/lib/bitcoin/request_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Bitcoin::Request do
+  it "should omit null arguments and everything after them" do
+    # bitcoin rejects null values even for optional params. Since
+    # even params following those may have default non-nil values,
+    # we'll assume the first non-nil value marks a set of optional
+    # params, and drop it and everything following it.
+
+    req = Bitcoin::Request.new('svc', [1, nil, nil, nil])
+    req.params.should == [1]
+    
+    req = Bitcoin::Request.new('svc', [nil])
+    req.params.should == []
+    
+    req = Bitcoin::Request.new('svc', [1, nil, nil, 1, nil])
+    req.params.should == [1]
+  end
+end

data/spec/lib/bitcoin_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Bitcoin do
+  before :each do
+    FakeWeb.register_uri(:post, "http://user:pass@localhost:8332", :response => fixture('getbalance'))
+  end
+  
+  it "as a function" do
+    cli = Bitcoin($user, $pass)
+    cli.balance.should == 0.001
+  end
+  
+  it "DSL, included" do
+    class << self
+      include Bitcoin
+    end
+    
+    username $user
+    password $pass
+    
+    balance.should == 0.001
+  end
+  
+  it "DSL, extended" do
+    class << self
+      include Bitcoin
+      
+      username $user
+      password $pass
+      
+      balance.should == 0.001
+    end
+  end
+end