ramontayag-bitcoin-client 0.1.0

data/lib/bitcoin/dsl.rb

@@ -0,0 +1,259 @@
+module Bitcoin::DSL
+  def bitcoin
+    if self.class.respond_to?(:bitcoin)
+      @client ||= Bitcoin::Client.new(self.class.bitcoin.user, self.class.bitcoin.pass, self.class.bitcoin.options)
+    else
+      @client ||= Bitcoin::Client.new(nil, nil)
+    end
+  end
+  
+  def username=(value)
+    bitcoin.user = value
+  end
+  
+  def password=(value)
+    bitcoin.pass = value
+  end
+  
+  def host=(value)
+    bitcoin.host = value
+  end
+  
+  def port=(value)
+    bitcoin.port = value
+  end
+  
+  def ssl=(value)
+    bitcoin.ssl = value
+  end
+  
+  def username(value = nil)
+    value ? bitcoin.user = value : bitcoin.user
+  end
+  
+  def password(value = nil)
+    value ? bitcoin.pass = value : bitcoin.pass
+  end
+  
+  def host(value = nil)
+    value ? bitcoin.host = value : bitcoin.host
+  end
+  
+  def port(value = nil)
+    value ? bitcoin.port = value : bitcoin.port
+  end
+  
+  def ssl(value = nil)
+    value.nil? ? bitcoin.ssl : bitcoin.ssl = value
+  end
+  
+  def ssl?
+    bitcoin.ssl?
+  end
+  
+  
+  # Safely copies wallet.dat to destination, which can be a directory or a path with filename. 
+  def backupwallet(destination)
+    bitcoin.backupwallet destination
+  end
+  
+  # Returns the account associated with the given address. 
+  def getaccount(bitcoinaddress)
+    bitcoin.getaccount bitcoinaddress
+  end
+  
+  # Returns the current bitcoin address for receiving payments to this account. 
+  def getaccountaddress(account)
+    bitcoin.getaccountaddress account
+  end
+  
+  #	Returns the list of addresses for the given account. 
+  def getaddressesbyaccount(account)
+    bitcoin.getaddressesbyaccount account
+  end
+  
+  # If +account+ is not specified, returns the server's total available balance.
+  # If +account+ is specified, returns the balance in the account.
+  def getbalance(account = nil, minconf = 1)
+    bitcoin.getbalance account, minconf
+  end
+  
+  # Dumps the block existing at specified height.
+  # Note: this is not available in the official release
+  def getblockbycount(height)
+    bitcoin.getblockbycount height
+  end
+  
+  # Returns the number of blocks in the longest block chain.
+  def getblockcount
+    bitcoin.getblockcount
+  end
+  
+  # Returns the block number of the latest block in the longest block chain. 
+  def getblocknumber
+    bitcoin.getblocknumber
+  end
+  
+  # Returns the number of connections to other nodes.
+  def getconnectioncount
+    bitcoin.getconnectioncount
+  end
+  
+  # Returns the proof-of-work difficulty as a multiple of the minimum difficulty. 
+  def getdifficulty
+    bitcoin.getdifficulty
+  end
+  
+  # Returns true or false whether bitcoind is currently generating hashes 
+  def getgenerate
+    bitcoin.getgenerate
+  end
+  
+  # Returns a recent hashes per second performance measurement while generating. 
+  def gethashespersec
+    bitcoin.gethashespersec
+  end
+
+  # Returns an object containing various state info. 
+  def getinfo
+    bitcoin.getinfo
+  end
+    
+  # Returns a new bitcoin address for receiving payments. If +account+ is specified (recommended),
+  # it is added to the address book so payments received with the address will be credited to +account+.
+  def getnewaddress(account = nil)
+    bitcoin.getnewaddress account
+  end
+  
+  # Returns the total amount received by addresses with +account+ in transactions
+  # with at least +minconf+ confirmations. 
+  def getreceivedbyaccount(account, minconf = 1)
+    bitcoin.getreceivedbyaccount account, minconf
+  end
+  
+  # Returns the total amount received by +bitcoinaddress+ in transactions with at least +minconf+ confirmations. 
+  def getreceivedbyaddress(bitcoinaddress, minconf = 1)
+    bitcoin.getreceivedbyaddress bitcoinaddress, minconf
+  end
+  
+  # Get detailed information about +txid+ 
+  def gettransaction(txid)
+    bitcoin.gettransaction txid
+  end
+  
+  # If +data+ is not specified, returns formatted hash data to work on:
+  #
+  #  :midstate => precomputed hash state after hashing the first half of the data
+  #  :data     => block data
+  #  :hash1    => formatted hash buffer for second hash
+  #  :target   => little endian hash target 
+  #
+  # If +data+ is specified, tries to solve the block and returns true if it was successful.
+  def getwork(data = nil)
+    bitcoin.getwork data
+  end
+  
+  # List commands, or get help for a command. 
+  def help(command = nil)
+    bitcoin.help command
+  end
+  
+  # Returns Object that has account names as keys, account balances as values. 
+  def listaccounts(minconf = 1)
+    bitcoin.listaccounts minconf
+  end
+  
+  # Returns an array of objects containing:
+  # 
+  #   :account       => the account of the receiving addresses
+  #   :amount        => total amount received by addresses with this account
+  #   :confirmations => number of confirmations of the most recent transaction included
+  #
+  def listreceivedbyaccount(minconf = 1, includeempty = false)
+    bitcoin.listreceivedbyaccount minconf, includeempty
+  end
+  
+  # Returns an array of objects containing:
+  # 
+  #   :address       => receiving address
+  #   :account       => the account of the receiving address
+  #   :amount        => total amount received by the address
+  #   :confirmations => number of confirmations of the most recent transaction included 
+  # 
+  # To get a list of accounts on the system, execute bitcoind listreceivedbyaddress 0 true
+  def listreceivedbyaddress(minconf = 1, includeempty = false)
+    bitcoin.listreceivedbyaddress minconf, includeempty
+  end
+  
+  # Returns up to +count+ most recent transactions for account +account+. 
+  def listtransactions(account, count = 10)
+    bitcoin.listtransactions account, count
+  end
+  
+  # Move from one account in your wallet to another. 
+  def move(fromaccount, toaccount, amount, minconf = 1, comment = nil)
+    bitcoin.move fromaccount, toaccount, amount, minconf, comment
+  end
+  
+  # +amount+ is a real and is rounded to 8 decimal places. Returns the transaction ID if successful. 
+  def sendfrom(fromaccount, tobitcoinaddress, amount, minconf = 1, comment = nil, comment_to = nil)
+    bitcoin.sendfrom fromaccount, tobitcoinaddress, amount, minconf, comment, comment_to
+  end
+  
+  # +amount+ is a real and is rounded to 8 decimal places 
+  def sendtoaddress(bitcoinaddress, amount, comment = nil, comment_to = nil)
+    bitcoin.sendtoaddress bitcoinaddress, amount, comment, comment_to
+  end
+  
+  # Sets the account associated with the given address. 
+  def setaccount(bitcoinaddress, account)
+    bitcoin.setaccount bitcoinaddress, account
+  end
+  
+  # +generate+ is true or false to turn generation on or off.
+  # Generation is limited to +genproclimit+ processors, -1 is unlimited.
+  def setgenerate(generate, genproclimit = -1)
+    bitcoin.setgenerate generate, genproclimit
+  end
+  
+  # Stop bitcoin server. 
+  def stop
+    bitcoin.stop
+  end
+  
+  # Return information about +bitcoinaddress+. 
+  def validateaddress(bitcoinaddress)
+    bitcoin.validateaddress
+  end
+  
+  alias account getaccount
+  alias account_address getaccountaddress
+  alias addresses_by_account getaddressesbyaccount
+  alias balance getbalance
+  alias block_by_count getblockbycount
+  alias block_count getblockcount
+  alias block_number getblocknumber
+  alias connection_count getconnectioncount
+  alias difficulty getdifficulty
+  alias generate? getgenerate
+  alias hashes_per_sec gethashespersec
+  alias info getinfo
+  alias new_address getnewaddress
+  alias received_by_account getreceivedbyaccount
+  alias received_by_address getreceivedbyaddress
+  alias transaction gettransaction
+  alias work getwork
+  alias get_work getwork
+  alias accounts listaccounts
+  alias list_received_by_account listreceivedbyaccount
+  alias list_received_by_address listreceivedbyaddress
+  alias transactions listtransactions
+  alias list_transactions listtransactions
+  alias send_from sendfrom
+  alias send_to_address sendtoaddress
+  alias account= setaccount
+  alias set_account setaccount
+  alias generate= setgenerate
+  alias set_generate setgenerate
+  alias validate_address validateaddress
+end

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 = 1
+    PATCH = 0
+    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 LovleOdnu:NajOij6DriWokEjEinaw --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"}