bitbank 0.0.1

data/lib/bitbank/client.rb

@@ -0,0 +1,58 @@
+module Bitbank
+  class Client
+    def initialize(config={})
+      @config = config
+      @endpoint = "http://#{config[:username]}:#{config[:password]}" +
+                  "@#{config[:host]}:#{config[:port]}"
+    end
+
+    def accounts
+      account_data = request('listaccounts')
+      account_data.map do |account_name, account_value|
+        Account.new(self, account_name, account_value)
+      end
+    end
+
+    def balance(account_name=nil)
+      request('getbalance', account_name)
+    end
+
+    # Returns the number of blocks in the longest block chain.
+    def block_count
+      request('getblockcount')
+    end
+
+    # Returns the proof-of-work difficulty as a multiple of the minimum difficulty.
+    def difficulty
+      request('getdifficulty')
+    end
+
+    def get_work(data=nil)
+      request('getwork', data)
+    end
+
+    def info
+      request('getinfo')
+    end
+
+    def new_address(account_name=nil)
+      request('getnewaddress', account_name)
+    end
+
+    def transactions(account_name=nil, count=10)
+      transaction_data = request('listtransactions', account_name, count)
+      transaction_data.map do |txdata|
+        Transaction.new(self, txdata['txid'], txdata)
+      end
+    end
+
+    def request(method, *args)
+      body = { 'id' => 'jsonrpc', 'method' => method }
+      body['params'] = args unless args.empty? || args.first.nil?
+
+      response_json = RestClient.post(@endpoint, body.to_json)
+      response = JSON.parse(response_json)
+      response['result']
+    end
+  end
+end

data/lib/bitbank/transaction.rb

@@ -0,0 +1,43 @@
+module Bitbank
+  class Transaction
+    attr_reader :txid, :address, :category, :amount, :confirmations
+
+    def initialize(client, txid, data={})
+      @client = client
+      @txid = txid
+
+      load_details(data)
+    end
+
+    def account
+      @account ? Account.new(@client, @account) : nil
+    end
+
+    def time
+      Time.at(@time)
+    end
+
+    def confirmed?
+      confirmations && confirmations > 6
+    end
+
+    def ==(other)
+      txid == other.txid
+    end
+
+    private
+
+    def load_details(data={})
+      data = @client.request('gettransaction', txid) if data.empty?
+      data.symbolize_keys!
+
+      details = ((data.delete(:details) || []).first || {}).symbolize_keys
+      @account = data[:account] || details[:account]
+      @address = data[:address] || details[:address]
+      @category = data[:category] || details[:category]
+      @amount = data[:amount] || details[:amount]
+      @confirmations = data[:confirmations]
+      @time = data[:time]
+    end
+  end
+end

data/spec/account_spec.rb

@@ -0,0 +1,64 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Bitbank::Account" do
+  before(:each) do
+    @client = Bitbank.new(File.join(File.dirname(__FILE__), '..', 'config.yml'))
+    @account = Bitbank::Account.new(@client, 'adent', 0.02)
+  end
+
+  it 'should have a name' do
+    @account.name.should == 'adent'
+  end
+
+  describe 'address' do
+    use_vcr_cassette 'account/address'
+
+    it 'should retrieve the address for this account' do
+      @account.address.should == '1NqwGDRi9Gs4xm1BmPnGeMwgz1CowP6CeQ'
+    end
+  end
+
+  describe 'balance' do
+    use_vcr_cassette 'account/balance'
+
+    it 'should retrieve the current balance' do
+      @account.balance.should == 0.02
+    end
+  end
+
+  describe 'new_address' do
+    use_vcr_cassette 'account/new_address'
+
+    it 'should create a new address associated with this account and return it' do
+      @account.new_address.should == '15GsE7o3isyQ7ygzh8Cya58oetrGYygdoi'
+    end
+  end
+
+  describe 'pay' do
+    use_vcr_cassette 'account/pay'
+
+    it 'should return a new transaction' do
+      transaction = @account.pay('destinationaddress', 0.01)
+      transaction.amount.should == 0.01
+      transaction.account.should == @account
+    end
+  end
+
+  describe 'transactions' do
+    use_vcr_cassette 'account/transactions'
+
+    it 'should retrieve transactions for this account' do
+      transactions = @account.transactions
+      transactions.length.should == 1
+      transactions.first.is_a?(Bitbank::Transaction).should be_true
+      transactions.first.txid.should == 'txid1'
+    end
+  end
+
+  describe 'equality' do
+    it 'should compare account names' do
+      @account.should_not == Bitbank::Account.new(@client, 'prefect')
+      @account.should == Bitbank::Account.new(@client, 'adent')
+    end
+  end
+end

data/spec/bitbank_spec.rb

@@ -0,0 +1,37 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Bitbank" do
+  describe 'initialization' do
+    it 'should configure the client' do
+      client = Bitbank.new(:username => 'prefect', :password => 'hoopy')
+      client.is_a?(Bitbank::Client).should be_true
+    end
+  end
+
+  describe 'configuration' do
+    it 'should require a username and password' do
+      expect {
+        Bitbank.config = { :username => 'marvin' }
+      }.to raise_error(ArgumentError, 'Please specify a username and password for bitcoind')
+    end
+
+    it 'should parse a yaml file for credentials' do
+      Bitbank.config = File.join(File.dirname(__FILE__), '..', 'config.yml')
+      Bitbank.config[:username].should == 'testuser'
+      Bitbank.config[:password].should == 'testpass'
+    end
+
+    it 'should use default values' do
+      Bitbank.config = File.join(File.dirname(__FILE__), '..', 'config.yml')
+      Bitbank.config[:host].should == 'localhost'
+      Bitbank.config[:port].should == 8332
+    end
+  end
+
+  describe 'version' do
+    it 'should read version from file' do
+      Bitbank.version.should == File.read(
+        File.join(File.dirname(__FILE__), '..', 'VERSION')).chomp
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,134 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Bitbank::Client" do
+  before(:each) do
+    @client = Bitbank.new(File.join(File.dirname(__FILE__), '..', 'config.yml'))
+  end
+
+  describe 'request' do
+    before(:each) do
+      @json = '{"result":{"foo":"bar"}}'
+    end
+
+    it 'should post to the endpoint' do
+      RestClient.expects(:post).with(
+        @client.instance_variable_get('@endpoint'), anything).returns(@json)
+      @client.request('foo')
+    end
+
+    it 'should parse json results' do
+      RestClient.stubs(:post).returns(@json)
+      @client.request('whatever').should == { 'foo' => 'bar' }
+    end
+  end
+
+  describe 'accounts' do
+    use_vcr_cassette 'client/accounts'
+
+    it 'should retrieve all accounts' do
+      accounts = @client.accounts
+      accounts.length.should == 3
+      accounts.last.name.should == 'misc'
+    end
+  end
+
+  describe 'balance' do
+    context 'overall' do
+      use_vcr_cassette 'client/balance'
+
+      it 'should retreive the current balance' do
+        @client.balance.should == 12.34
+      end
+    end
+
+    context 'scoped to a particular account' do
+      use_vcr_cassette 'client/balance_account'
+
+      it 'should retrieve the account balance' do
+        @client.balance.should == 10.05
+      end
+    end
+  end
+
+  describe 'block_count' do
+    use_vcr_cassette 'client/block_count'
+
+    it 'should return the number of blocks in the longest block chain' do
+      @client.block_count.should == 130361
+    end
+  end
+
+  describe 'difficulty' do
+    use_vcr_cassette 'client/difficulty'
+
+    it 'should return the current difficulty' do
+      @client.difficulty.should == 567358.22457067
+    end
+  end
+
+  describe 'get_work' do
+    context 'when data is not supplied' do
+      use_vcr_cassette 'client/get_work'
+
+      it 'should return new formatted hash data to work on' do
+        work = @client.get_work
+        ['midstate', 'data', 'hash1', 'target'].each do |key|
+          work.has_key?(key).should be_true
+        end
+      end
+    end
+
+    context 'when data is supplied' do
+      it 'checks my answer'
+      it 'gives me more work'
+    end
+  end
+
+  describe 'info' do
+    use_vcr_cassette 'client/info'
+
+    it 'should return a hash containing bitcoind status information' do
+      @result = @client.info
+
+      @result['version'].should == 32100
+      @result['testnet'].should be_false
+
+      info_keys = ['version', 'balance', 'blocks', 'connections', 'proxy',
+        'generate', 'genproclimit', 'difficulty', 'hashespersec', 'testnet', 
+        'keypoololdest', 'paytxfee', 'errors']
+      info_keys.each do |key|
+        @result.keys.include?(key).should be_true
+      end
+    end
+  end
+
+  describe 'new_address' do
+    use_vcr_cassette 'client/new_address', :record => :new_episodes
+
+    it 'should create a new address and return it' do
+      @client.new_address.should == '1EzxbYD4rFvZBjUEbtnKZ9KJdrqHB7mkZE'
+    end
+  end
+
+  describe 'transactions' do
+    context 'overall' do
+      use_vcr_cassette 'client/transactions'
+
+      it 'should retrieve all transactions' do
+        transactions = @client.transactions
+        transactions.length.should == 4
+        transactions.last.txid.should == 'txid4'
+      end
+    end
+
+    context 'scoped to a particular account' do
+      use_vcr_cassette 'client/transactions_account'
+
+      it 'should retrieve transactions for the account' do
+        transactions = @client.transactions('adent')
+        transactions.length.should == 1
+        transactions.last.txid.should == 'txid1'
+      end
+    end
+  end
+end

data/spec/fixtures/vcr_cassettes/account/address.yml

@@ -0,0 +1,30 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: http://testuser:testpass@localhost:8332/
+    body: ! '{"id":"jsonrpc","method":"getaccountaddress","params":["prefect"]}'
+    headers:
+      accept:
+      - ! '*/*; q=0.5, application/xml'
+      accept-encoding:
+      - gzip, deflate
+      content-length:
+      - '61'
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      date:
+      - Sun, 12 Jun 2011 03:38:37 +0000
+      content-length:
+      - '76'
+      content-type:
+      - application/json
+      server:
+      - bitcoin-json-rpc/0.3.21-beta
+    body: ! '{"result":"1NqwGDRi9Gs4xm1BmPnGeMwgz1CowP6CeQ","error":null,"id":"jsonrpc"}
+
+'
+    http_version: '1.1'

data/spec/fixtures/vcr_cassettes/account/balance.yml

@@ -0,0 +1,30 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: http://testuser:testpass@localhost:8332/
+    body: ! '{"id":"jsonrpc","method":"getbalance","params":["adent"]}'
+    headers:
+      accept:
+      - ! '*/*; q=0.5, application/xml'
+      accept-encoding:
+      - gzip, deflate
+      content-length:
+      - '54'
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      date:
+      - Sun, 12 Jun 2011 03:36:43 +0000
+      content-length:
+      - '50'
+      content-type:
+      - application/json
+      server:
+      - bitcoin-json-rpc/0.3.21-beta
+    body: ! '{"result":0.02,"error":null,"id":"jsonrpc"}
+
+'
+    http_version: '1.1'

data/spec/fixtures/vcr_cassettes/account/new_address.yml

@@ -0,0 +1,30 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: http://testuser:testpass@localhost:8332/
+    body: ! '{"id":"jsonrpc","method":"getnewaddress","params":["adent"]}'
+    headers:
+      accept:
+      - ! '*/*; q=0.5, application/xml'
+      accept-encoding:
+      - gzip, deflate
+      content-length:
+      - '60'
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      date:
+      - Mon, 13 Jun 2011 04:40:14 +0000
+      content-length:
+      - '76'
+      content-type:
+      - application/json
+      server:
+      - bitcoin-json-rpc/0.3.21-beta
+    body: ! '{"result":"15GsE7o3isyQ7ygzh8Cya58oetrGYygdoi","error":null,"id":"jsonrpc"}
+
+'
+    http_version: '1.1'

data/spec/fixtures/vcr_cassettes/account/pay.yml

@@ -0,0 +1,60 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: http://testuser:testpass@localhost:8332/
+    body: ! '{"id":"jsonrpc","method":"sendfrom","params":["adent","destinationaddress",0.1]}'
+    headers:
+      accept:
+      - ! '*/*; q=0.5, application/xml'
+      accept-encoding:
+      - gzip, deflate
+      content-length:
+      - '107'
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      date:
+      - Sun, 12 Jun 2011 03:59:59 +0000
+      content-length:
+      - '106'
+      content-type:
+      - application/json
+      server:
+      - bitcoin-json-rpc/0.3.21-beta
+    body: ! '{"result":"newtxid","error":null,"id":"jsonrpc"}
+
+'
+    http_version: '1.1'
+
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: http://testuser:testpass@localhost:8332/
+    body: ! '{"id":"jsonrpc","method":"gettransaction","params":["newtxid"]}'
+    headers:
+      accept:
+      - ! '*/*; q=0.5, application/xml'
+      accept-encoding:
+      - gzip, deflate
+      content-length:
+      - '120'
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      date:
+      - Mon, 13 Jun 2011 04:00:01 +0000
+      content-length:
+      - '289'
+      content-type:
+      - application/json
+      server:
+      - bitcoin-json-rpc/0.3.21-beta
+    body: ! '{"result":{"amount":0.01,"confirmations":1,"txid":"newtxid","time":1307851201,"details":[{"account":"adent","address":"addr1","category":"send","amount":0.1}]},"error":null,"id":"jsonrpc"}
+
+'
+    http_version: '1.1'