bitcoin 0.1.0 → 0.1.2

data/features/descriptions/satoshi_wallet/add_address.feature

@@ -0,0 +1,49 @@
+Feature: satoshi-wallet add-address
+  In order to reduce the risk of using RbCoin
+  As a Bitcoin owner
+  I want to be able to add new Addresses into a Satoshi Wallet
+
+  Scenario: Add new address
+    Given a new Satoshi Wallet "new_wallet.dat"
+    When I successfully run `rbcoin satoshi-wallet add-address new_wallet.dat 14Z1mazY4HfysZyMaKudFr63EwHqQT2njz "Bitcoin Monitor"`
+    Then the output should contain "Address added successfully"
+    When I successfully run `rbcoin satoshi-wallet show-addresses new_wallet.dat`
+    Then the output should contain:
+      """
+      # All addresses in new_wallet.dat
+      14Z1mazY4HfysZyMaKudFr63EwHqQT2njz Bitcoin Monitor
+      """
+
+  Scenario: Invalid address
+    Given a new Satoshi Wallet "new_wallet.dat"
+    When I run `rbcoin satoshi-wallet add-address new_wallet.dat 1thisisaninvalidaddress "Bitcoin Monitor"`
+    Then the command should fail
+    And the stderr should contain:
+      """
+      The address "1thisisaninvalidaddress" is not a valid Bitcoin address
+      The address was not added to the wallet
+      """
+
+  Scenario: Missing arguments
+    Given a new Satoshi Wallet "new_wallet.dat"
+    When I run `rbcoin satoshi-wallet add-address new_wallet.dat 14Z1mazY4HfysZyMaKudFr63EwHqQT2njz`
+    Then the command should fail
+    And the stderr should contain:
+      """
+      You must provide both a Bitcoin address and a name to add to a wallet
+      No changes were made to the wallet
+      """
+
+  Scenario: Too many arguments
+    Given a new Satoshi Wallet "new_wallet.dat"
+    When I run `rbcoin satoshi-wallet add-address new_wallet.dat 14Z1mazY4HfysZyMaKudFr63EwHqQT2njz My name without quotes`
+    Then the command should fail
+    And the stderr should contain:
+      """
+      Received too many arguments
+
+      To make sure the name is formatted correctly we ask you to use use quotes
+      around the name, e.g.: "My name without quotes"
+
+      No changes were made to the wallet
+      """

data/features/descriptions/satoshi_wallet/show_addresses.feature

@@ -0,0 +1,18 @@
+Feature: satoshi-wallet show-addresses
+  In order to enable easily transitioning from the Satoshi Client
+  As a Bitcoin owner
+  I want to inspect the contents of my Satoshi Wallet
+
+  Scenario: Viewing all addresses
+    # addressbook_wallet.dat is a wallet with some known addresses but no transactions
+    Given a new Satoshi Wallet "addressbook_wallet.dat"
+    When I successfully run `rbcoin satoshi-wallet show-addresses addressbook_wallet.dat`
+    # I don't know what drives the address book order yet - I think it's the address itself
+    Then the output should contain:
+      """
+      # All addresses in addressbook_wallet.dat
+      13f2t2WKnCZh1rZbDhdUKB6fY1rZNWZVzd Receiving address 2
+      14Z1mazY4HfysZyMaKudFr63EwHqQT2njz Bitcoin Monitor
+      16kzGRdP8LToECecna3EynghiApUM9duLw Receiving address 1
+      1Nqr3MqVyUp6k3o3QPePAdn4Yg4tzgB9kw Bitcoincharts
+      """

data/features/descriptions/satoshi_wallet/show_version.feature

@@ -0,0 +1,17 @@
+Feature: satoshi-wallet show-version
+  In order to enable easily transitioning from the Satoshi Client
+  As a Bitcoin owner
+  I want to inspect the contents of my Satoshi Wallet
+
+  Scenario: Valid wallet file
+    # Which just so happens to be a 0.3.24 file...
+    Given a new Satoshi Wallet "new_wallet.dat"
+    When I successfully run `rbcoin satoshi-wallet show-version new_wallet.dat`
+    Then the output should contain "0.3.24"
+
+  Scenario: Missing wallet file
+    When I run `rbcoin satoshi-wallet show-version this_wallet_does_not_exist.dat`
+    Then it should fail with:
+      """
+      Couldn't find wallet file: this_wallet_does_not_exist.dat
+      """

data/features/descriptions/satoshi_wallet/subcommand_help.feature

@@ -0,0 +1,20 @@
+Feature: Subcommand help for `rbcoin satoshi-wallet`
+  In order to avoid being frustrated by being unable to interact with the application
+  As a user
+  I want to be told when I make a mistake
+
+  Scenario: `rbcoin satoshi-wallet unknown-subcommand`
+    When I run `rbcoin satoshi-wallet unknown-subcommand`
+    Then the command should fail
+    And the stderr should contain:
+      """
+      Unknown satoshi-wallet subcommand: "unknown-subcommand"
+      """
+
+  # Scenario: `rbcoin help satoshi-wallet`
+  #   When I successfully run `rbcoin satoshi-wallet help`
+  #   Then the output should contain "Usage: TODO"
+  #
+  # Scenario: `rbcoin satoshi-wallet --help`
+  #   When I successfully run `rbcoin satoshi-wallet --help`
+  #   Then the output should contain "Usage: TODO"

data/features/fixtures/ABOUT_FIXTURES.markdown

@@ -0,0 +1,6 @@
+# About the fixtures
+
+Fixtures are bad, mmmkay?
+
+But until we have a bulletproof means of writing a full and correct Satoshi Wallet
+file, it's safer to use fixtures than to rely on our unproven Berkeley DB code.

data/features/step_definitions/command_steps.rb

@@ -0,0 +1,3 @@
+Then %r/the command should fail/ do
+  Then "the exit status should be 1"
+end

data/features/step_definitions/wallet_steps.rb

@@ -0,0 +1,11 @@
+module Fixtures
+  def fixture_file_data(filename)
+    File.read(File.join(PROJECT_ROOT, "features", "fixtures", filename))
+  end
+end
+
+World(Fixtures)
+
+Given %r/^a new Satoshi Wallet "([^"]*)"$/ do |wallet_filename|
+  write_file(wallet_filename, fixture_file_data(wallet_filename))
+end

data/features/support/env.rb

@@ -1,2 +1,9 @@
 require 'bundler'
-Bundler.setup
+Bundler.setup
+
+PROJECT_ROOT = File.expand_path(File.join(File.dirname(__FILE__), "..", "..")).freeze
+
+# So Aruba can find the binary
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+
+require 'aruba/cucumber'

data/lib/bitcoin/cli.rb

@@ -0,0 +1,35 @@
+require 'bitcoin/commands'
+
+module Bitcoin
+  class CLI
+    class CommandError < RuntimeError; end
+
+    def initialize(stream_bundle)
+      @stream_bundle = stream_bundle
+    end
+
+    def run(args)
+      command_name, *remaining_args = *args
+      dispatch_command(command_name, remaining_args)
+    rescue CommandError => error
+      1
+    else
+      0
+    end
+
+    private
+
+    def dispatch_command(command_name, remaining_args)
+      case command_name
+      when nil, "help"
+        Commands::HelpCommand.new(@stream_bundle).show_help
+      when "satoshi-wallet"
+        command_environment = Commands::SatoshiWalletCommandEnvironment.new(@stream_bundle)
+        Commands::SatoshiWalletCommand.new(@stream_bundle, command_environment).run(remaining_args)
+      else
+        Commands::HelpCommand.new(@stream_bundle).show_unknown_command_help(command_name)
+        raise CommandError.new
+      end
+    end
+  end
+end

data/lib/bitcoin/commands.rb

@@ -0,0 +1,3 @@
+require_relative 'commands/help_command'
+require_relative 'commands/satoshi_wallet_command'
+require_relative 'commands/satoshi_wallet_command_environment'

data/lib/bitcoin/commands/help_command.rb

@@ -0,0 +1,32 @@
+require 'lstrip-on-steroids'
+
+module Bitcoin
+  module Commands
+    class HelpCommand
+      def initialize(stream_bundle)
+        @stream_bundle = stream_bundle
+      end
+
+      def show_help
+        @stream_bundle.puts_output(
+          -%{
+            Usage: rbcoin COMMAND ...
+
+            Commands:
+              help            Display help about rbcoin and rbcoin commands
+              satoshi-wallet  Manipulate the wallet.dat file of the original client
+
+            Use "rbcoin COMMAND --help" or "rbcoin help COMMAND" for help on a single command
+            Use "rbcoin --version" to see the rbcoin version number
+            Use "rbcoin --exact-version" to see the all version details (with dependencies)
+          }
+        )
+      end
+
+      def show_unknown_command_help(command_name)
+        @stream_bundle.puts_output(%'rbcoin failed:  No such command "#{command_name}"')
+        @stream_bundle.puts_output("Try: `rbcoin help`")
+      end
+    end
+  end
+end

data/lib/bitcoin/commands/satoshi_wallet.rb

@@ -0,0 +1,11 @@
+module Bitcoin
+  module Commands
+    module SatoshiWallet
+      
+    end
+  end
+end
+
+require_relative 'satoshi_wallet/add_address_command'
+require_relative 'satoshi_wallet/show_addresses_command'
+require_relative 'satoshi_wallet/show_version_command'

data/lib/bitcoin/commands/satoshi_wallet/add_address_command.rb

@@ -0,0 +1,61 @@
+require 'bitcoin/cli' # For CommandError
+
+require 'bitcoin/domain/bitcoin_address'
+
+module Bitcoin
+  module Commands
+    module SatoshiWallet
+      class AddAddressCommand
+        def initialize(stream_bundle)
+          @stream_bundle = stream_bundle
+        end
+
+        def run(wallet, options)
+          assert_valid_args(options[:args])
+
+          address, name = *options[:args]
+
+          assert_valid_name(name)
+
+          wallet.add_address(Domain::BitcoinAddress.new(address), name: name)
+          @stream_bundle.puts_output("Address added successfully")
+        rescue Domain::BitcoinAddress::InvalidBitcoinAddressError => error
+          @stream_bundle.puts_error(error.message)
+          @stream_bundle.puts_error("The address was not added to the wallet")
+          raise CLI::CommandError.new
+        end
+
+        private
+
+        def assert_valid_args(args)
+          if args.length < 2
+            @stream_bundle.puts_error("You must provide both a Bitcoin address and a name to add to a wallet")
+            @stream_bundle.puts_error("No changes were made to the wallet")
+            raise CLI::CommandError.new
+          elsif args.length > 2
+            @stream_bundle.puts_error(
+              -%{
+                Received too many arguments
+
+                To make sure the name is formatted correctly we ask you to use use quotes
+                around the name, e.g.: "#{args.drop(1).join(" ")}"
+
+                No changes were made to the wallet
+              }
+            )
+            raise CLI::CommandError.new
+          end
+
+          def assert_valid_name(name)
+            if name.bytesize > 252
+              @stream_bundle.puts_error(%'The address name "#{name}" is too long\n')
+              @stream_bundle.puts_error("Currently we do not allow address names over 252 bytes long\n")
+              @stream_bundle.puts_error("The address was not added to the wallet\n")
+              raise CLI::CommandError.new
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bitcoin/commands/satoshi_wallet/show_addresses_command.rb

@@ -0,0 +1,16 @@
+module Bitcoin
+  module Commands
+    module SatoshiWallet
+      class ShowAddressesCommand
+        def initialize(stream_bundle)
+          @stream_bundle = stream_bundle
+        end
+
+        def run(wallet, options)
+          @stream_bundle.puts_output("# All addresses in #{options[:wallet_filename]}")
+          @stream_bundle.puts_output(wallet.addresses)
+        end
+      end
+    end
+  end
+end

data/lib/bitcoin/commands/satoshi_wallet/show_version_command.rb

@@ -0,0 +1,15 @@
+module Bitcoin
+  module Commands
+    module SatoshiWallet
+      class ShowVersionCommand
+        def initialize(stream_bundle)
+          @stream_bundle = stream_bundle
+        end
+
+        def run(wallet, options = { })
+          @stream_bundle.puts_output(wallet.version)
+        end
+      end
+    end
+  end
+end

data/lib/bitcoin/commands/satoshi_wallet_command.rb

@@ -0,0 +1,37 @@
+require 'tmpdir'
+
+require 'bitcoin/cli' # circular dependency on CLI for CommandError
+require 'bitcoin/commands/satoshi_wallet'
+require 'bitcoin/data_access/satoshi/satoshi_wallet'
+require 'bitcoin/domain/bitcoin_address'
+require 'bitcoin/filesystem/empty_temp_dir'
+
+module Bitcoin
+  module Commands
+    class SatoshiWalletCommand
+      TEMP_DB_PATH = "bitcoinrb_db_tmp"
+
+      def initialize(stream_bundle, command_environment)
+        @stream_bundle = stream_bundle
+        @command_environment = command_environment
+      end
+
+      def run(args)
+        command_name, *remaining_args = *args
+        command_class =
+          case command_name
+          when "add-address"
+            SatoshiWallet::AddAddressCommand
+          when "show-addresses"
+            SatoshiWallet::ShowAddressesCommand
+          when "show-version"
+            SatoshiWallet::ShowVersionCommand
+          else
+            @stream_bundle.puts_error(%'Unknown satoshi-wallet subcommand: "#{command_name}"')
+            raise CLI::CommandError.new
+          end
+        @command_environment.run_command(command_class.new(@stream_bundle), remaining_args)
+      end
+    end
+  end
+end

data/lib/bitcoin/commands/satoshi_wallet_command_environment.rb

@@ -0,0 +1,28 @@
+require 'bitcoin/filesystem/empty_temp_dir'
+
+module Bitcoin
+  module Commands
+    class SatoshiWalletCommandEnvironment
+      def initialize(stream_bundle)
+        @stream_bundle = stream_bundle
+      end
+
+      def run_command(command, arguments)
+        wallet_filename, *remaining_args = *arguments
+
+        if !File.exist?(wallet_filename)
+          @stream_bundle.puts_error("Couldn't find wallet file: #{wallet_filename}")
+          raise CLI::CommandError.new
+        end
+
+        absolute_wallet_path = File.expand_path(wallet_filename)
+        
+        FileSystem::EmptyTempDir.open(with_name: "bitcoinrb_db_tmp", parallel_to: absolute_wallet_path) do |temp_dir|
+          DataAccess::Satoshi::SatoshiWallet.open(wallet_filename: absolute_wallet_path, db_dirname: temp_dir.absolute_path) do |wallet|
+            command.run(wallet, wallet_filename: wallet_filename, args: remaining_args)
+          end
+        end        
+      end
+    end
+  end
+end

data/lib/bitcoin/console/capturing_stream_bundle.rb

@@ -0,0 +1,42 @@
+require_relative 'stream_bundle'
+
+module Bitcoin
+  module Console
+    # CapturingStreamBundles are StreamBundles that record the data written to them
+    # for easy inspection later. They are useful for testing purposes.
+    class CapturingStreamBundle
+      class << self
+        def test_bundle
+          new(StringIO.new, StringIO.new, StringIO.new)
+        end
+      end
+
+      def initialize(input, output, error)
+        @stream_bundle = StreamBundle.new(input, output, error)
+
+        @captured_output = StringIO.new
+        @captured_error = StringIO.new
+      end
+
+      def puts_output(stringlike)
+        @stream_bundle.puts_output(stringlike)
+        @captured_output.puts(stringlike)
+      end
+
+      def puts_error(stringlike)
+        @stream_bundle.puts_error(stringlike)
+        @captured_error.puts(stringlike)
+      end
+
+      def captured_output
+        @captured_output.rewind
+        @captured_output.read
+      end
+
+      def captured_error
+        @captured_error.rewind
+        @captured_error.read
+      end
+    end
+  end
+end