bitcoin 0.1.0 → 0.1.2

data/spec/bitcoin/commands/satoshi_wallet_command_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+require 'bitcoin/commands/satoshi_wallet_command'
+
+# Dependencies only used in the spec
+require 'bitcoin/domain/address_book'
+require 'bitcoin/console/capturing_stream_bundle'
+require 'bitcoin/commands/satoshi_wallet_command_environment'
+
+module Bitcoin
+  module Commands
+    describe SatoshiWalletCommand do
+      let(:stream_bundle) { Console::CapturingStreamBundle.test_bundle }
+      let(:command_environment) { mock(SatoshiWalletCommandEnvironment, run_command: nil) }
+
+      subject { SatoshiWalletCommand.new(stream_bundle, command_environment) }
+
+      describe "#run" do
+        shared_examples_for "SatoshiWalletCommand#run" do |options|
+          let(:command) { mock(options[:command_class]) }
+
+          before(:each) do
+            options[:command_class].stub(new: command)
+          end
+
+          it "makes a command" do
+            options[:command_class].should_receive(:new).with(stream_bundle)
+            subject.run([ options[:command_name], "wallet.dat", "foo", "bar" ])
+          end
+
+          it "runs the command" do
+            command_environment.should_receive(:run_command).with(command, %w[ wallet.dat foo bar ])
+            subject.run([ options[:command_name], "wallet.dat", "foo", "bar" ])
+          end
+        end
+
+        context "show-version" do
+          it_behaves_like "SatoshiWalletCommand#run",
+            command_name: "show-version",
+            command_class: Commands::SatoshiWallet::ShowVersionCommand
+        end
+
+        context "show-addresses" do
+          it_behaves_like "SatoshiWalletCommand#run",
+            command_name: "show-addresses",
+            command_class: Commands::SatoshiWallet::ShowAddressesCommand
+        end
+
+        context "add-address" do
+          it_behaves_like "SatoshiWalletCommand#run",
+            command_name: "add-address",
+            command_class: Commands::SatoshiWallet::AddAddressCommand
+        end
+
+        context "<unknown subcommand>" do
+          it "prints an error" do
+            expect {
+              subject.run(%w[ unknown-subcommand wallet.dat foo bar ])
+            }.to raise_error
+
+            stream_bundle.captured_error.should eq %'Unknown satoshi-wallet subcommand: "unknown-subcommand"\n'
+          end
+
+          it "raises an error" do
+            expect {
+              subject.run(%w[ unknown-subcommand wallet.dat foo bar ])
+            }.to raise_error(CLI::CommandError)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/bitcoin/console/_contracts/stream_bundle_contract.rb

@@ -0,0 +1,29 @@
+contract "StreamBundle" do
+  let(:input)   { StringIO.new }
+  let(:output)  { StringIO.new }
+  let(:error)   { StringIO.new }
+
+  let(:subject) { described_class.new(input, output, error) }
+
+  describe "#puts_output" do
+    it "writes a line to the output" do
+      subject.puts_output("foo")
+      subject.puts_output("bar")
+      subject.puts_output("baz")
+
+      output.rewind
+      output.read.should eq "foo\nbar\nbaz\n"
+    end
+  end
+
+  describe "#puts_error" do
+    it "writes a line to the output" do
+      subject.puts_error("foo")
+      subject.puts_error("bar")
+      subject.puts_error("baz")
+
+      error.rewind
+      error.read.should eq "foo\nbar\nbaz\n"
+    end
+  end
+end

data/spec/bitcoin/console/capturing_stream_bundle_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+require 'bitcoin/console/capturing_stream_bundle'
+
+require_relative '_contracts/stream_bundle_contract'
+
+module Bitcoin
+  module Console
+    describe CapturingStreamBundle do
+      it_satisfies_contract "StreamBundle"
+
+      let(:input)   { StringIO.new }
+      let(:output)  { StringIO.new }
+      let(:error)   { StringIO.new }
+
+      let(:subject) { CapturingStreamBundle.new(input, output, error) }
+
+      describe ".test_bundle" do
+        it "creates a CapturingStreamBundle with three StringIO streams", because: "we only care about captured output" do
+          # Really should be a separate factory object, but not for the sake of one method
+          CapturingStreamBundle.should_receive(:new).with(
+            an_instance_of(StringIO), an_instance_of(StringIO), an_instance_of(StringIO)
+          ).and_return(:stream_bundle)
+          CapturingStreamBundle.test_bundle.should eq :stream_bundle
+        end
+      end
+
+      # The output and error streams are effectively the same with different names,
+      # but the duplication is only textual and I don't see a neat way to remove it yet
+
+      describe "#captured_output" do
+        before(:each) do
+          subject.puts_output("foo")
+          subject.puts_output("bar")
+          subject.puts_output("baz")
+        end
+
+        its(:captured_output) { should eq "foo\nbar\nbaz\n" }
+
+        it "doesn't manipulate the output stream" do
+          output.stub(:rewind).and_raise(RuntimeError.new)
+          expect { subject.captured_output }.to_not raise_error
+        end
+
+        it "accumulates output across reads" do
+          subject.captured_output
+          subject.puts_output("quux")
+          subject.captured_output.should eq "foo\nbar\nbaz\nquux\n"
+        end
+      end
+
+      describe "#captured_error" do
+        before(:each) do
+          subject.puts_error("foo")
+          subject.puts_error("bar")
+          subject.puts_error("baz")
+        end
+
+        its(:captured_error) { should eq "foo\nbar\nbaz\n" }
+
+        it "doesn't manipulate the error stream" do
+          error.stub(:rewind).and_raise(RuntimeError.new)
+          expect { subject.captured_error }.to_not raise_error
+        end
+
+        it "accumulates output across reads" do
+          subject.captured_error
+          subject.puts_error("quux")
+          subject.captured_error.should eq "foo\nbar\nbaz\nquux\n"
+        end
+      end
+    end
+  end
+end

data/spec/bitcoin/console/stream_bundle_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+require 'bitcoin/console/stream_bundle'
+
+require_relative '_contracts/stream_bundle_contract'
+
+module Bitcoin
+  module Console
+    describe StreamBundle do
+      it_satisfies_contract "StreamBundle"
+    end
+  end
+end

data/spec/bitcoin/data_access/satoshi/bdb_satoshi_wallet_repository_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+require 'bitcoin/data_access/satoshi/bdb_satoshi_wallet_repository'
+require 'bitcoin/rspec/directory_helpers'
+
+module Bitcoin
+  module DataAccess
+    module Satoshi
+      describe BDBSatoshiWalletRepository, adapter: :slow do
+        include Bitcoin::RSpec::DirectoryHelpers
+
+        TEMP_DB_DIR = File.join(PROJECT_ROOT, "tmp", "db").freeze
+        ensure_empty_test_dir(TEMP_DB_DIR)
+
+        # Temporary means to get a copy of the fixture file
+        before(:each) do
+          FileUtils.cp(File.join(PROJECT_ROOT, "features", "fixtures", wallet_fixture_filename), TEMP_DB_DIR)
+        end
+
+        def wallet_filename
+          File.join(PROJECT_ROOT, "tmp", "db", wallet_fixture_filename)
+        end
+
+        let(:wallet_fixture_filename) { "addressbook_wallet.dat" }
+
+        subject { BDBSatoshiWalletRepository.new(wallet_filename, db_dirname: TEMP_DB_DIR) }
+
+        it "has a less naive write_compact_size"
+
+        describe "4-byte unsigned little endian integers stored immediately (no compact length in the value)" do
+          specify {
+            subject.get_value_immediate_uint32le("version").should eq 32400
+          }
+
+          specify {
+            expect {
+              subject.set_value_immediate_uint32le("version", 32500)
+            }.to change {
+              subject.get_value_immediate_uint32le("version")
+            }.from(32400).to(32500)
+          }
+        end
+
+        describe "string key data, string value data" do
+          it "lets you read all values" do
+            subject.get_key_and_value_data_string_utf8("name").should eq [
+              [ "13f2t2WKnCZh1rZbDhdUKB6fY1rZNWZVzd", "Receiving address 2" ],
+              [ "14Z1mazY4HfysZyMaKudFr63EwHqQT2njz", "Bitcoin Monitor" ],
+              [ "16kzGRdP8LToECecna3EynghiApUM9duLw", "Receiving address 1" ],
+              [ "1Nqr3MqVyUp6k3o3QPePAdn4Yg4tzgB9kw", "Bitcoincharts" ]
+            ]
+          end
+
+          it "lets you read individual values" do
+            subject.get_value_with_key_data_string_utf8("name", "14Z1mazY4HfysZyMaKudFr63EwHqQT2njz").should eq "Bitcoin Monitor"
+          end
+
+          it "lets you create" do
+            expect {
+              subject.set_value_with_key_data_string_utf8("name", "1ThisIsAMadeUpKeyKudFr63EwHqQT2njz", "New Value")
+            }.to change {
+              subject.get_value_with_key_data_string_utf8("name", "1ThisIsAMadeUpKeyKudFr63EwHqQT2njz")
+            }.from(nil).to("New Value")
+          end
+
+          it "lets you update" do
+            expect {
+              subject.set_value_with_key_data_string_utf8("name", "14Z1mazY4HfysZyMaKudFr63EwHqQT2njz", "Really is Bitcoin Monitor")
+            }.to change {
+              subject.get_value_with_key_data_string_utf8("name", "14Z1mazY4HfysZyMaKudFr63EwHqQT2njz")
+            }.from("Bitcoin Monitor").to("Really is Bitcoin Monitor")
+          end
+        end
+      end
+    end
+  end
+end
+

data/spec/bitcoin/data_access/satoshi/satoshi_version_spec.rb

@@ -0,0 +1,112 @@
+require 'spec_helper'
+
+require 'bitcoin/data_access/satoshi/satoshi_version'
+
+module Bitcoin
+  module DataAccess
+    module Satoshi
+      describe SatoshiVersion do
+        describe ".from_wallet_bytes" do
+          it "supports the data format as extracted from the BDB database" do
+            SatoshiVersion.from_wallet_bytes([144, 126, 0, 0]).should eq SatoshiVersion.new(0, 3, 24)
+          end
+        end
+
+        describe ".from_wallet_int" do
+          it "supports the data format as extracted from the BDB database" do
+            SatoshiVersion.from_wallet_int(32400).should eq SatoshiVersion.new(0, 3, 24)
+          end
+        end
+
+        describe "three-part form" do
+          it "compares equality" do
+            SatoshiVersion.new(0, 3, 24).should eq SatoshiVersion.new(0, 3, 24)
+
+            SatoshiVersion.new(0, 3, 24).should_not eq SatoshiVersion.new(0, 3, 25)
+            SatoshiVersion.new(0, 3, 24).should_not eq SatoshiVersion.new(0, 4, 24)
+            SatoshiVersion.new(0, 3, 24).should_not eq SatoshiVersion.new(1, 3, 24)
+          end
+
+          it "has a total ordering" do
+            SatoshiVersion.new(0, 3, 24).should be < SatoshiVersion.new(0, 3, 25)
+            SatoshiVersion.new(0, 3, 24).should be > SatoshiVersion.new(0, 3, 23)
+
+            SatoshiVersion.new(0, 3, 24).should be < SatoshiVersion.new(0, 4, 23)
+            SatoshiVersion.new(0, 3, 24).should be > SatoshiVersion.new(0, 2, 25)
+
+            SatoshiVersion.new(1, 3, 24).should be < SatoshiVersion.new(2, 2, 23)
+            SatoshiVersion.new(1, 3, 24).should be > SatoshiVersion.new(0, 4, 25)
+          end
+        end
+
+        describe "four-part form" do
+          # We cheat slightly here and make assumptions about the implementation
+          # (by not re-specifying every conceivable possibility)
+
+          it "compares equality" do
+            SatoshiVersion.new(0, 3, 24, 0).should eq SatoshiVersion.new(0, 3, 24, 0)
+            SatoshiVersion.new(0, 3, 24, 0).should_not eq SatoshiVersion.new(0, 3, 24, 1)
+          end
+
+          it "has a total ordering" do
+            SatoshiVersion.new(0, 3, 24, 1).should be < SatoshiVersion.new(0, 3, 25, 2)
+            SatoshiVersion.new(0, 3, 24, 1).should be > SatoshiVersion.new(0, 3, 23, 0)
+
+            SatoshiVersion.new(0, 3, 24, 1).should be < SatoshiVersion.new(0, 3, 25, 0)
+            SatoshiVersion.new(0, 3, 24, 1).should be > SatoshiVersion.new(0, 3, 23, 2)
+
+            # etc, for the rest of the components...
+          end
+        end
+
+        describe "-beta version suffixes" do
+          it "are not supported", because: "this is hardcoded into the Satoshi client" do
+            # As of 0.3.24, the "beta" status is determined in the C++ code with this value:
+            # static const bool VERSION_IS_BETA = true;
+            false.should be_false
+          end
+        end
+
+        describe "comparing three- and four-part forms" do
+          # This is not explicit in the Satoshi code, but seems a reasonable assumption for now,
+          # until it breaks...
+          it "assumes an implicit 0 at the end of the three-part form" do
+            SatoshiVersion.new(0, 3, 24).should eq SatoshiVersion.new(0, 3, 24, 0)
+            SatoshiVersion.new(0, 3, 24, 0).should eq SatoshiVersion.new(0, 3, 24)
+            # it seems safe to assume the rest of the comparisons work by induction
+          end
+        end
+
+        describe "conversion" do
+          describe "to strings" do
+            it "supports #to_s", because: "we need to be usable with IO#<<" do
+              SatoshiVersion.new(0, 3, 24).to_s.should eq "0.3.24"
+              SatoshiVersion.new(0, 3, 24, 1).to_s.should eq "0.3.24.1"
+            end
+
+            it "truncates a fourth zero", because: "the standard client does this (semantic versioning?)" do
+              SatoshiVersion.new(0, 3, 24, 0).to_s.should eq "0.3.24"
+            end
+
+            it "does not truncate a third version", because: "the standard client does this (semantic versioning?)" do
+              SatoshiVersion.new(0, 4, 0).to_s.should eq "0.4.0"
+            end
+
+            it "supports #to_str as an alias of :to_s" do
+              version = SatoshiVersion.new(0, 3, 24)
+              to_s_method = version.method(:to_s)
+              to_str_method = version.method(:to_str)
+              to_str_method.should eq to_s_method
+            end
+          end
+
+          describe "to Satoshi-format wallet bytes" do
+            it "creates the same bytes as came from the BDB database" do
+              SatoshiVersion.new(0, 3, 24).to_wallet_bytes.should eq [144, 126, 0, 0]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/bitcoin/data_access/satoshi/satoshi_wallet_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+require 'bitcoin/data_access/satoshi/satoshi_wallet'
+
+module Bitcoin
+  module DataAccess
+    module Satoshi
+      describe SatoshiWallet do
+        describe ".open" do
+          let(:satoshi_wallet_repository) { mock(BDBSatoshiWalletRepository) }
+          let(:satoshi_wallet) { mock(SatoshiWallet) }
+
+          before(:each) do
+            BDBSatoshiWalletRepository.stub(new: satoshi_wallet_repository)
+            SatoshiWallet.stub(new: satoshi_wallet)
+          end
+
+          it "makes a BDBSatoshiWalletRepository" do
+            BDBSatoshiWalletRepository.should_receive(:new).with("wallet.dat", db_dirname: "/db/dir")
+            SatoshiWallet.open(wallet_filename: "wallet.dat", db_dirname: "/db/dir", & ->(wallet) { :noop })
+          end
+
+          it "makes a SatoshiWallet with the BDBSatoshiWalletRepository" do
+            SatoshiWallet.should_receive(:new).with(satoshi_wallet_repository)
+            SatoshiWallet.open(wallet_filename: "wallet.dat", db_dirname: "/db/dir", & ->(wallet) { :noop })
+          end
+
+          it "yields the wallet" do
+            SatoshiWallet.open(wallet_filename: "wallet.dat", db_dirname: "/db/dir") do |wallet|
+              wallet.should eq satoshi_wallet
+            end
+          end
+
+          it "returns the value of the block" do
+            SatoshiWallet.open(wallet_filename: "wallet.dat", db_dirname: "/db/dir") { |wallet|
+              :block_value
+            }.should eq :block_value
+          end
+
+          it "raises an error if no block is given", because: "we use blocks to manage the opening and closing of the BDB database" do
+            expect {
+              SatoshiWallet.open(wallet_filename: "wallet.dat", db_dirname: "/db/dir")
+            }.to raise_error(ArgumentError) { |error|
+              error.message.should =~ /you must provide a block to SatoshiWallet\.new/i
+            }
+          end
+        end
+
+        describe "instance methods" do
+          let(:satoshi_wallet_repository) { mock(BDBSatoshiWalletRepository) }
+
+          before(:each) do
+            BDBSatoshiWalletRepository.stub(new: satoshi_wallet_repository)
+          end
+
+          subject { SatoshiWallet.new(satoshi_wallet_repository) }
+
+          describe "#version" do
+            it "returns the version from the wallet" do
+              satoshi_wallet_repository.should_receive(:get_value_immediate_uint32le).with("version").and_return(32400)
+              subject.version.should eq SatoshiVersion.new(0, 3, 24)
+            end
+          end
+
+          describe "#addresses" do
+            before(:each) do
+              satoshi_wallet_repository.stub(
+                get_key_and_value_data_string_utf8: [
+                  [ "14Z1mazY4HfysZyMaKudFr63EwHqQT2njz", "Bitcoin Monitor" ],
+                  [ "1Nqr3MqVyUp6k3o3QPePAdn4Yg4tzgB9kw", "Bitcoincharts" ]
+                ]
+              )
+            end
+
+            it "fetches the data" do
+              satoshi_wallet_repository.should_receive(:get_key_and_value_data_string_utf8).with("name")
+              subject.addresses
+            end
+
+            it "returns an AddressBook with the wallet addresses" do
+              subject.addresses.should be_a Domain::AddressBook
+              expected_addresses = Domain::AddressBook.new([
+                { address: Domain::BitcoinAddress.new("14Z1mazY4HfysZyMaKudFr63EwHqQT2njz"), name: "Bitcoin Monitor" },
+                { address: Domain::BitcoinAddress.new("1Nqr3MqVyUp6k3o3QPePAdn4Yg4tzgB9kw"), name: "Bitcoincharts" }
+              ]).to_a
+              subject.addresses.to_a.should =~ expected_addresses
+            end
+          end
+
+          describe "#add_address" do
+            it "adds the BitcoinAddress to the Wallet" do
+              satoshi_wallet_repository.should_receive(:set_value_with_key_data_string_utf8).with(
+                "name", "14Z1mazY4HfysZyMaKudFr63EwHqQT2njz", "Bitcoin Monitor"
+              )
+              subject.add_address(Domain::BitcoinAddress.new("14Z1mazY4HfysZyMaKudFr63EwHqQT2njz"), name: "Bitcoin Monitor")
+            end
+          end
+        end
+      end
+    end
+  end
+end