bitcoin-client 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in bitcoind-client.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,79 @@
+= bitcoin-client
+
+Provides a Ruby library to the complete Bitcoin JSON-RPC API. Implements all methods listed
+at {https://en.bitcoin.it/wiki/Original_Bitcoin_client/API_Calls_list}[https://en.bitcoin.it/wiki/Original_Bitcoin_client/API_Calls_list].
+Also supports customizing the host and port number to connect to.
+
+
+== Usage
+
+As with most Ruby gems, you first need to require the library into your project:
+
+  require 'bitcoin'
+
+After doing this, the simplest possible usage looks like this:
+
+  Bitcoin('username', 'password').balance
+  # => 0.001
+
+Or, if you prefer a somewhat more explicit representation, the following code performs the exact
+same task:
+
+  client = Bitcoin::Client.new('username', 'password')
+  client.balance
+  # => 0.001
+  
+The third and final way to use the library is by taking advantage of a simple DSL:
+
+  include Bitcoin
+  
+  # set up credentials
+  username 'username'
+  password 'password'
+  
+  balance
+  # => 0.001
+  
+  accounts
+  # => {"account" => 0.001}
+  
+The RPC method names available to you are exactly the same as those listed on the Bitcoin wiki
+(again, that's {https://en.bitcoin.it/wiki/Original_Bitcoin_client/API_Calls_list}[https://en.bitcoin.it/wiki/Original_Bitcoin_client/API_Calls_list]). Some aliases
+have been added to make them more "ruby-ish," but none of the original names have been changed.
+
+
+== Host, Port and SSL
+
+Here are several examples of how you can change the host information:
+
+  Bitcoin('username', 'password', :host => 'example.com', :port => 38332, :ssl => true)
+  
+  client = Bitcoin::Client.new('username', 'password', :host => 'example.com')
+  client.port = 38332
+  client.ssl = true
+  client.ssl?
+  # => true
+  
+  include Bitcoin
+  host 'example.com'
+  port 38332
+  ssl?
+  # => false
+  ssl true
+  ssl?
+  # => true
+
+You should see the Bitcoin::Client class documentation if you'd like to see the other options and methods
+that are made available.
+
+
+== Donations
+
+If you found this library useful and feel inclined to compensate me for my trouble, I'm certainly not going to turn you down!
+
+Bitcoin donations can be sent to:
+
+  1HawYer58J9Vy3iju1w7jsRVci5tzaxkwn
+
+Thanks!
+

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+gem 'rdoc', '~> 3.9.2'
+require 'rdoc/task'
+
+RDoc::Task.new do |t|
+  t.main = "README.rdoc"
+  t.rdoc_files.include "README.rdoc", "lib/**/*.rb"
+end

data/bitcoind-client.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "bitcoin/version"
+
+Gem::Specification.new do |s|
+  s.name        = "bitcoin-client"
+  s.version     = Bitcoin::VERSION
+  s.authors     = ["Colin MacKenzie IV"]
+  s.email       = ["sinisterchipmunk@gmail.com"]
+  s.homepage    = "http://github.com/sinisterchipmunk/bitcoin-client"
+  s.summary     = %q{Provides a Ruby library to the complete Bitcoin JSON-RPC API.}
+  s.description = "Provides a Ruby library to the complete Bitcoin JSON-RPC API. "+
+                  "Implements all methods listed at "+
+                  "https://en.bitcoin.it/wiki/Original_Bitcoin_client/API_Calls_list and "+
+                  "lets you set options such as the host and port number, and whether to use SSL."
+
+  s.rubyforge_project = "bitcoin-client"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec",   '2.6.0'
+  s.add_development_dependency "fakeweb", '1.3.0'
+  s.add_runtime_dependency "rest-client", '1.6.3'
+end

data/lib/bitcoin-client.rb

@@ -0,0 +1 @@
+require File.expand_path("bitcoin", File.dirname(__FILE__))

data/lib/bitcoin.rb

@@ -0,0 +1,19 @@
+module Bitcoin
+  autoload :Client, 'bitcoin/client'
+  autoload :API,    'bitcoin/api'
+  autoload :Request,'bitcoin/request'
+  autoload :RPC,    'bitcoin/rpc'
+  autoload :Errors, 'bitcoin/errors'
+  autoload :Version,'bitcoin/version'
+  autoload :VERSION,'bitcoin/version'
+  autoload :DSL,    'bitcoin/dsl'
+  
+  def self.included(base)
+    base.send(:include, Bitcoin::DSL)
+    base.send(:extend,  Bitcoin::DSL)
+  end
+end
+
+def Bitcoin(user, pass, options = {})
+  ::Bitcoin::Client.new(user, pass, options)
+end

data/lib/bitcoin/api.rb

@@ -0,0 +1,33 @@
+class Bitcoin::API
+  attr_reader :options
+  attr_reader :params
+  
+  def user; options[:user]; end
+  def pass; options[:pass]; end
+  def host; options[:host]; end
+  def port; options[:port]; end
+  def ssl;  options[:ssl];  end
+  def ssl?; options[:ssl];  end
+  def user=(a); options[:user] = a; end
+  def pass=(a); options[:pass] = a; end
+  def host=(a); options[:host] = a; end
+  def port=(a); options[:port] = a; end
+  def ssl=(a);  options[:ssl]  = a; end
+
+  def initialize(options = {})
+    @options = {
+      :host => 'localhost',
+      :port => 8332,
+      :ssl  => false
+    }.merge(options)
+  end
+  
+  def to_hash
+    @options.dup
+  end
+  
+  def request(service_name, *params)
+    req = Bitcoin::Request.new(service_name, params)
+    Bitcoin::RPC.new(to_hash).dispatch(req)
+  end
+end

data/lib/bitcoin/client.rb

@@ -0,0 +1,227 @@
+class Bitcoin::Client
+  attr_reader :api
+  def user; api.user; end
+  def pass; api.pass; end
+  def host; api.host; end
+  def port; api.port; end
+  def ssl;  api.ssl;  end
+  def ssl?; api.ssl?; end
+  def user=(a); api.user = a; end
+  def pass=(a); api.pass = a; end
+  def host=(a); api.host = a; end
+  def port=(a); api.port = a; end
+  def ssl=(a);  api.ssl  = a; end
+  
+  def options
+    api.options
+  end
+  
+  def initialize(user, pass, options = {})
+    @api = Bitcoin::API.new({ :user => user, :pass => pass }.merge(options))
+  end
+  
+  # Safely copies wallet.dat to destination, which can be a directory or a path with filename. 
+  def backupwallet(destination)
+    @api.request 'backupwallet', destination
+  end
+  
+  # Returns the account associated with the given address. 
+  def getaccount(bitcoinaddress)
+    @api.request 'getaccount', bitcoinaddress
+  end
+  
+  # Returns the current bitcoin address for receiving payments to this account. 
+  def getaccountaddress(account)
+    @api.request 'getaccountaddress', account
+  end
+  
+  #	Returns the list of addresses for the given account. 
+  def getaddressesbyaccount(account)
+    @api.request '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)
+    @api.request 'getbalance', account, minconf
+  end
+  
+  # Dumps the block existing at specified height.
+  # Note: this is not available in the official release
+  def getblockbycount(height)
+    @api.request 'getblockbycount', height
+  end
+  
+  # Returns the number of blocks in the longest block chain.
+  def getblockcount
+    @api.request 'getblockcount'
+  end
+  
+  # Returns the block number of the latest block in the longest block chain. 
+  def getblocknumber
+    @api.request 'getblocknumber'
+  end
+  
+  # Returns the number of connections to other nodes.
+  def getconnectioncount
+    @api.request 'getconnectioncount'
+  end
+  
+  # Returns the proof-of-work difficulty as a multiple of the minimum difficulty. 
+  def getdifficulty
+    @api.request 'getdifficulty'
+  end
+  
+  # Returns true or false whether bitcoind is currently generating hashes 
+  def getgenerate
+    @api.request 'getgenerate'
+  end
+  
+  # Returns a recent hashes per second performance measurement while generating. 
+  def gethashespersec
+    @api.request 'gethashespersec'
+  end
+
+  # Returns an object containing various state info. 
+  def getinfo
+    @api.request '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)
+    @api.request 'getnewaddress', account
+  end
+  
+  # Returns the total amount received by addresses with +account+ in transactions
+  # with at least +minconf+ confirmations. 
+  def getreceivedbyaccount(account, minconf = 1)
+    @api.request 'getreceivedbyaccount', account, minconf
+  end
+  
+  # Returns the total amount received by +bitcoinaddress+ in transactions with at least +minconf+ confirmations. 
+  def getreceivedbyaddress(bitcoinaddress, minconf = 1)
+    @api.request 'getreceivedbyaddress', bitcoinaddress, minconf
+  end
+  
+  # Get detailed information about +txid+ 
+  def gettransaction(txid)
+    @api.request '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)
+    @api.request 'getwork', data
+  end
+  
+  # List commands, or get help for a command. 
+  def help(command = nil)
+    @api.request 'help', command
+  end
+  
+  # Returns Object that has account names as keys, account balances as values. 
+  def listaccounts(minconf = 1)
+    @api.request '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)
+    @api.request '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)
+    @api.request 'listreceivedbyaddress', minconf, includeempty
+  end
+  
+  # Returns up to +count+ most recent transactions for account +account+. 
+  def listtransactions(account, count = 10)
+    @api.request 'listtransactions', account, count
+  end
+  
+  # Move from one account in your wallet to another. 
+  def move(fromaccount, toaccount, amount, minconf = 1, comment = nil)
+    @api.request '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)
+    @api.request '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)
+    @api.request 'sendtoaddress', bitcoinaddress, amount, comment, comment_to
+  end
+  
+  # Sets the account associated with the given address. 
+  def setaccount(bitcoinaddress, account)
+    @api.request 'setaccoint', 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)
+    @api.request 'setgenerate', generate, genproclimit
+  end
+  
+  # Stop bitcoin server. 
+  def stop
+    @api.request 'stop'
+  end
+  
+  # Return information about +bitcoinaddress+. 
+  def validateaddress(bitcoinaddress)
+    @api.request 'validateaddress', bitcoinaddress
+  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/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