bitcoind 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.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'test' do
+  watch(%r{lib/bitcoind/(.*)\.rb})      { |m| "test/#{m[1]}_test.rb" }
+  watch(%r{test/.*_test\.rb})
+  watch('lib/bitcoind.rb') { 'test' }
+  watch('test/test_helper.rb') { "test" }
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Bryce Kerley
+
+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.md

@@ -0,0 +1,63 @@
+# Bitcoind
+
+Automate your [Bitcoin](http://bitcoin.org/) transactions with this Ruby interface to the `bitcoind` JSON-RPC API.
+
+## Connecting
+
+Before connecting, you will need to configure a username and password for `bitcoind`, and start
+`bitcoind`. Once that's done:
+
+    client = Bitcoind.new 'username', 'password'
+      # => #<Bitcoind::Client "http://username:password@localhost:8332" >
+
+## Account Balances
+
+You can get the balance of all addresses controlled by the client:
+
+    client.balance
+      # => 12.34
+
+You can also get a hash of all accounts the client controls:
+
+    client.accounts
+      # => {"Your Address"=>#<Bitcoind::Account "Your Address" >, "eve-online ransoms"=>#<Bitcoind::Account "eve-online ransoms" >}
+
+And of course each account has its own balance too:
+
+    ransom = client.accounts['eve-online ransoms']
+      # => #<Bitcoind::Account "eve-online ransoms" >
+    ransom.balance
+      # => 2.19
+
+## Transactions
+
+You can get all the transactions in an account:
+
+    ransom.transactions
+      # => [#<Bitcoind::Transaction abadbabe123deadbeef 2.19 to eve-online ransoms at 2011-02-19 16:21:09 -0500>]
+
+You can send money from an account too:
+
+    ransom.send_to 'destinationaddress', 2
+      # => #<Bitcoind::Account deadbeef888abadbeef UNCONFIRMED>
+
+## Making Accounts
+
+Creating an account with an associated address is done through the accounts interface:
+
+    tiny_wings = client.accounts.new 'tiny wings ransoms'
+      # => #<Bitcoind::Account "tiny wings ransoms" >
+    tiny_wings.address
+      # => "1KV5khnHbbHF2nNQkk7Pe5nPndEj43U27r"
+
+# Contributing
+
+* [Fork the project on GitHub](https://github.com/bkerley/bitcoind)
+* Write tests for your changes locally
+* Make the tests pass by implementing the changes
+* Push your changes to GitHub.
+* Send a pull request.
+
+# Copyright
+
+Copyright (c) 2011 Bryce Kerley. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/bitcoind.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "bitcoind/version"
+
+Gem::Specification.new do |s|
+  s.name        = "bitcoind"
+  s.version     = Bitcoind::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Bryce Kerley"]
+  s.email       = ["bkerley@brycekerley.net"]
+  s.homepage    = ""
+  s.summary     = %q{Control the bitcoin nework client over JSON-RPC.}
+  s.description = %q{Automate your Bitcoin transactions with this Ruby interface to the bitcoind JSON-RPC API.}
+
+  s.rubyforge_project = "bitcoind"
+
+  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"]
+
+  s.add_dependency 'rest-client', ['~> 1.6.1']
+  s.add_dependency 'activesupport', ['~> 3.0.6']
+
+  s.add_development_dependency 'guard-test', ['~> 0.1.6']
+  s.add_development_dependency 'shoulda', ['~> 2.11.3']
+  s.add_development_dependency 'mocha', ['~> 0.9.12']
+  s.add_development_dependency 'bundler', ['~> 1.0.12']
+end

data/lib/bitcoind.rb

@@ -0,0 +1,13 @@
+require 'json'
+require 'rest_client'
+require 'active_support/memoizable'
+
+%w{ client account account_hash transaction }.each do |f|
+  require File.join(File.dirname(__FILE__), 'bitcoind', f)
+end
+
+module Bitcoind
+  def self.new(user, pass)
+    return Client.new user, pass
+  end
+end

data/lib/bitcoind/account.rb

@@ -0,0 +1,38 @@
+module Bitcoind
+  class Account
+    extend ActiveSupport::Memoizable
+    attr_accessor :name, :balance
+
+    def initialize(client, name)
+      @client = client
+      self.name = name
+    end
+
+    def inspect
+      "#<Bitcoind::Account #{self.name.inspect} >"
+    end
+
+    def send_to(destination, amount)
+      txn_id = @client.request 'sendfrom', self.name, destination, amount
+      Transaction.new @clientm, self, txn_id
+    end
+
+    def balance
+      @client.request 'getbalance', self.name
+    end
+    memoize :balance
+
+    def address
+      @client.request 'getaccountaddress', self.name
+    end
+    memoize :address
+
+    def transactions
+      txn_array = @client.request 'listtransactions', self.name
+
+      txn_array.map do |h|
+        Transaction.new @client, self, h['txid']
+      end
+    end
+  end
+end

data/lib/bitcoind/account_hash.rb

@@ -0,0 +1,18 @@
+module Bitcoind
+  class AccountHash < Hash
+    def initialize(client, balance_hash)
+      @client = client
+      balance_hash.each do |name,b|
+        self[name] = Account.new client, name
+      end
+    end
+
+    def new(name)
+      addr = @client.request 'getnewaddress', name
+
+      self[name] = Account.new @client, name
+
+      self[name]
+    end
+  end
+end

data/lib/bitcoind/client.rb

@@ -0,0 +1,28 @@
+module Bitcoind
+  class Client
+    def initialize(user, pass)
+      @endpoint = "http://#{user}:#{pass}@localhost:8332"
+    end
+
+    def balance
+      request 'getbalance'
+    end
+
+    def accounts
+      balance_hash = request 'listaccounts'
+      AccountHash.new self, balance_hash
+    end
+
+    def request(method, *args)
+      body = { 'id'=>'jsonrpc', 'method'=>method}
+      body['params'] = args unless args.empty?
+      response_json = RestClient.post @endpoint, body.to_json
+      response = JSON.parse response_json
+      return response['result']
+    end
+
+    def inspect
+      "#<Bitcoind::Client #{@endpoint.inspect} >"
+    end
+  end
+end

data/lib/bitcoind/transaction.rb

@@ -0,0 +1,39 @@
+module Bitcoind
+  class Transaction
+    extend ActiveSupport::Memoizable
+    attr_accessor :id, :account
+    def initialize(client, account, id)
+      @client = client
+      self.account = account
+      self.id = id
+    end
+
+    def detail_hash
+      @client.request 'gettransaction', self.id
+    end
+    memoize :detail_hash
+
+    def inspect
+      "#<Bitcoind::Transaction #{id} #{amount} to #{account.name} at #{time}>"
+    rescue RestClient::InternalServerError
+      "#<Bitcoind::Transaction #{id} UNCONFIRMED>"
+    end
+
+    def amount
+      detail_hash['amount']
+    end
+
+    def confirmations
+      detail_hash['confirmations'] rescue 0
+    end
+
+    def time
+      Time.at detail_hash['time']
+    end
+    memoize :time
+
+    def confirmed?
+      confirmations > 6
+    end
+  end
+end

data/lib/bitcoind/version.rb

@@ -0,0 +1,3 @@
+module Bitcoind
+  VERSION = "0.0.1"
+end

data/test/account_hash_test.rb

@@ -0,0 +1,27 @@
+require 'helper'
+
+class AccountHashTest < Test::Unit::TestCase
+  context 'an AccountHash' do
+    setup do
+      @client = stub
+      @ach = Bitcoind::AccountHash.new @client, ""=>0.0, "pi"=>3.14, "benjamin"=>100.0
+    end
+
+    should 'access accounts like a normal hash' do
+      assert_equal 'pi', @ach['pi'].name
+      assert_equal 'benjamin', @ach['benjamin'].name
+    end
+
+    context 'new method' do
+      should 'make a new account with a given name' do
+        @client.expects(:request).
+          once.
+          with('getnewaddress', 'new test account').
+          returns('xxxnewtestaddress')
+
+        @act = @ach.new 'new test account'
+        assert_equal 'new test account', @act.name
+      end
+    end
+  end
+end

data/test/account_test.rb

@@ -0,0 +1,95 @@
+require 'helper'
+
+class AccountTest < Test::Unit::TestCase
+  context 'an Account' do
+    setup do
+      @client = stub
+      @acc = Bitcoind::Account.new @client, 'pi'
+    end
+
+    should 'have name' do
+      assert_equal 'pi', @acc.name
+    end
+
+    should 'have a short but useful inspect' do
+      assert_equal "#<Bitcoind::Account \"pi\" >", @acc.inspect
+    end
+
+    should 'ask the client for a balance' do
+      @client.expects(:request).
+        once.
+        with('getbalance', 'pi').
+        returns(3.14)
+
+      @balance = @acc.balance
+
+      assert_equal 3.14, @balance
+    end
+
+    should 'ask the client for an address' do
+      @client.expects(:request).
+        once.
+        with('getaccountaddress', 'pi').
+        returns('testaddress')
+
+      @address = @acc.address
+
+      assert_equal 'testaddress', @address
+    end
+
+    should 'have a list of transactions' do
+      @client.expects(:request).
+        once.
+        with('listtransactions', 'pi').
+        returns [
+                 {
+                   'account'=>'pi',
+                   'address'=>'testaddress',
+                   'category'=>'receive',
+                   'amount'=>3.10,
+                   'confirmations'=>310,
+                   'txid'=>'310',
+                   'time'=>1234567310
+                 },
+                 {
+                   'account'=>'pi',
+                   'address'=>'testaddress',
+                   'category'=>'receive',
+                   'amount'=>3.11,
+                   'confirmations'=>311,
+                   'txid'=>'311',
+                   'time'=>1234567311
+                 },
+                 {
+                   'account'=>'pi',
+                   'address'=>'testaddress',
+                   'category'=>'receive',
+                   'amount'=>3.12,
+                   'confirmations'=>312,
+                   'txid'=>'312',
+                   'time'=>1234567312
+                 },
+                ]
+
+      @txns = @acc.transactions
+
+      @txns.each do |t|
+        assert_kind_of Bitcoind::Transaction, t
+      end
+      assert_equal ['310', '311', '312'], @txns.map(&:id)
+    end
+
+    context 'transactions' do
+      should 'send money' do
+        @client.expects(:request).
+          once.
+          with('sendfrom', @acc.name, 'testdestinationaddress', 5).
+          returns('sentmoneytransactionid')
+
+        @txn = @acc.send_to('testdestinationaddress', 5)
+
+        assert_equal 'sentmoneytransactionid', @txn.id
+      end
+    end
+  end
+end

data/test/client_test.rb

@@ -0,0 +1,51 @@
+require 'helper'
+
+class ClientTest < Test::Unit::TestCase
+  context 'a Bitcoind client' do
+    setup do
+      @bcd = Bitcoind.new 'testuser', 'testpass'
+    end
+
+    should 'have a simple and useful inspect' do
+      assert_equal "#<Bitcoind::Client \"http://testuser:testpass@localhost:8332\" >", @bcd.inspect
+    end
+
+    context 'balance operation' do
+      setup do
+        RestClient.expects(:post).
+          returns("{\"result\":12.34000000,\"error\":null,\"id\":\"jsonrpc\"}\n").
+          with do |e, a|
+            e == 'http://testuser:testpass@localhost:8332' &&
+              JSON.parse(a) == {'method'=>'getbalance', 'id'=>'jsonrpc'}
+          end
+      end
+
+      should 'get the balance' do
+        @result = @bcd.balance
+        assert_equal 12.34, @result
+      end
+    end
+
+    context 'accounts operation' do
+      setup do
+        RestClient.expects(:post).
+          returns("{\"result\":{\"\":0.0,\"Your Address\":0.0,\"pi\":3.14,\"ben\":100.00},\"error\":null,\"id\":\"jsonrpc\"}\n").
+          with do |e, a|
+            e == 'http://testuser:testpass@localhost:8332' &&
+              JSON.parse(a) == {'method'=>'listaccounts', 'id'=>'jsonrpc'}
+          end
+      end
+
+      should 'return a hash of Account objects' do
+        @result = @bcd.accounts
+        assert_kind_of Hash, @result
+        @result.each do |k, a|
+          assert_kind_of Bitcoind::Account, a
+          assert_equal k, a.name
+        end
+
+        assert_equal 'pi', @result['pi'].name
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,3 @@
+require 'shoulda'
+require 'mocha'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'bitcoind')

data/test/transaction_test.rb

@@ -0,0 +1,54 @@
+require 'helper'
+
+class TransactionTest < Test::Unit::TestCase
+  context 'a transaction' do
+    setup do
+      @client = stub
+      @acc = Bitcoind::Account.new @client, 'pi'
+      @txn = Bitcoind::Transaction.new @client, @acc, 'testtxnid'
+    end
+
+    context 'with a detail_hash' do
+      setup do
+        @client.expects(:request).
+          once.
+          with('gettransaction', 'testtxnid').
+          returns('amount'=>3.14, 'confirmations'=>420, 'txid'=>'testtxnid',
+                  'time'=>1234567890, 'details'=>{
+                    'account'=> 'pi',
+                    'address'=>'testaddress',
+                    'category'=>'receive',
+                    'amount'=>3.14
+                  })
+      end
+
+      should 'have an amount and time' do
+        assert_equal 3.14, @txn.amount
+        assert_equal Time.at(1234567890), @txn.time
+      end
+
+      should 'have confirmations and be confirmed' do
+        assert_equal 420, @txn.confirmations
+        assert @txn.confirmed?
+      end
+    end
+
+    context 'without a detail_hash' do
+      setup do
+        @client.expects(:request).
+          at_least_once.
+          with('gettransaction', 'testtxnid').
+          raises(RestClient::InternalServerError)
+      end
+
+      should 'have a sane inspect' do
+        assert_equal "#<Bitcoind::Transaction testtxnid UNCONFIRMED>", @txn.inspect
+      end
+
+      should 'have zero confirmations and be unconfirmed' do
+        assert_equal 0, @txn.confirmations
+        assert !@txn.confirmed?
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification 
+name: bitcoind
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Bryce Kerley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-18 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 6
+        - 1
+        version: 1.6.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 6
+        version: 3.0.6
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: guard-test
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 6
+        version: 0.1.6
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 11
+        - 3
+        version: 2.11.3
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 12
+        version: 0.9.12
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 12
+        version: 1.0.12
+  type: :development
+  version_requirements: *id006
+description: Automate your Bitcoin transactions with this Ruby interface to the bitcoind JSON-RPC API.
+email: 
+- bkerley@brycekerley.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bitcoind.gemspec
+- lib/bitcoind.rb
+- lib/bitcoind/account.rb
+- lib/bitcoind/account_hash.rb
+- lib/bitcoind/client.rb
+- lib/bitcoind/transaction.rb
+- lib/bitcoind/version.rb
+- test/account_hash_test.rb
+- test/account_test.rb
+- test/client_test.rb
+- test/helper.rb
+- test/transaction_test.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: bitcoind
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Control the bitcoin nework client over JSON-RPC.
+test_files: 
+- test/account_hash_test.rb
+- test/account_test.rb
+- test/client_test.rb
+- test/helper.rb
+- test/transaction_test.rb