bitcoin 0.1.0 → 0.1.2

data/.rvmrc

@@ -1 +1 @@
-rvm use 1.9.2@bitcoin
+rvm use 1.9.2@bitcoin --create

data/Gemfile.lock

@@ -1,12 +1,27 @@
 PATH
   remote: .
   specs:
-    bitcoin (0.0.1)
+    bitcoin (0.1.1)
+      lstrip-on-steroids (>= 1.0.0)
+      sbdb (>= 0.0.12.2)
 
 GEM
   remote: http://rubygems.org/
   specs:
+    aruba (0.4.6)
+      bcat (>= 0.6.1)
+      childprocess (>= 0.2.0)
+      cucumber (>= 1.0.2)
+      rdiscount (>= 1.6.8)
+      rspec (>= 2.6.0)
+    awesome_print (0.4.0)
+    bcat (0.6.1)
+      rack (~> 1.0)
+    bdb (0.2.6.5)
+      tuple (>= 0.1.2)
     builder (3.0.0)
+    childprocess (0.2.1)
+      ffi (~> 1.0.6)
     cucumber (1.0.2)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.2)
@@ -14,14 +29,36 @@ GEM
       json (>= 1.4.6)
       term-ansicolor (>= 1.0.5)
     diff-lcs (1.1.2)
-    gherkin (2.4.5)
+    fakefs (0.3.2)
+    ffi (1.0.9)
+    fuubar (0.0.6)
+      rspec (~> 2.0)
+      rspec-instafail (~> 0.1.8)
+      ruby-progressbar (~> 0.0.10)
+    gherkin (2.4.14)
       json (>= 1.4.6)
     growl (1.0.3)
-    guard (0.5.1)
+    growl_notify (0.0.1)
+      rb-appscript
+    guard (0.6.2)
       thor (~> 0.14.6)
+    guard-bundler (0.1.3)
+      bundler (>= 1.0.0)
+      guard (>= 0.2.2)
+    guard-cucumber (0.6.1)
+      cucumber (>= 0.10)
+      guard (>= 0.4.0)
+    guard-rspec (0.4.2)
+      guard (>= 0.4.0)
     json (1.5.3)
+    looksee (1.0.2)
+    lstrip-on-steroids (1.0.0)
+    rack (1.3.2)
     rake (0.9.2)
-    rb-fsevent (0.4.1)
+    rb-appscript (0.6.1)
+    rb-fsevent (0.4.3.1)
+    rdiscount (1.6.8)
+    ref (1.0.0)
     rspec (2.6.0)
       rspec-core (~> 2.6.0)
       rspec-expectations (~> 2.6.0)
@@ -29,18 +66,33 @@ GEM
     rspec-core (2.6.4)
     rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
+    rspec-instafail (0.1.8)
     rspec-mocks (2.6.0)
+    ruby-progressbar (0.0.10)
+    sbdb (0.0.12.2)
+      bdb (>= 0.2.6.5)
+      ref
     term-ansicolor (1.0.6)
     thor (0.14.6)
+    tuple (0.1.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  aruba
+  awesome_print
   bitcoin!
   cucumber
+  fakefs
+  fuubar
   growl
+  growl_notify
   guard
+  guard-bundler
+  guard-cucumber
+  guard-rspec
+  looksee
   rake
   rb-fsevent
   rspec

data/Guardfile

@@ -0,0 +1,38 @@
+# Signal to interested subprocesses that they are being run from Guard
+ENV["GUARD"] = "fast"
+
+guard 'bundler' do
+  watch('Gemfile')
+  # Uncomment next line if Gemfile contain `gemspec' command
+  watch(/^.+\.gemspec/)
+end
+
+guard 'rspec', version: 2, cli: "--color --format Fuubar" do
+  watch(%r{^spec/.+_spec\.rb})
+  watch(%r{^lib/(.+)\.rb})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec" }
+end
+
+# Only run this once to stop Guardfile re-evaluation making a hash of things
+unless ::Guard::RSpec.instance_methods.include?(:run_on_change_orig)
+  # There's a "hook" branch of Guard that will make this class patch
+  # unnecessary: https://github.com/guard/guard/tree/hook
+  class ::Guard::RSpec
+    # Monkey-patch to indicate to RSpec that it can run slow tests if
+    # only one file was changed
+    alias_method :run_on_change_orig, :run_on_change
+    def run_on_change(paths)
+      if paths.length == 1 && File.read(paths.first).include?("adapter: :slow")
+        ENV["GUARD"] = "all"
+      end
+      run_on_change_orig(paths)
+    ensure
+      ENV["GUARD"] = "fast"
+    end
+  end
+end
+
+guard 'cucumber' do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$}) { 'features' }
+end

data/README.markdown

@@ -1,5 +1,24 @@
 # Bitcoin
 
-A Bitcoin client written in Ruby
+A [Bitcoin][bitcoin] client written in Ruby
 
-This is currently just a stub project
+This is very early stages - I haven't yet spent much time on it, but I
+have explored the Bitcoin Berkeley DB database format to some extent,
+and the first phase is to be able to read (and write) enough from standard
+wallets to be a useful management tool.
+
+For licence and other documentation, see the "doc" folder
+
+## Installation
+
+You need Berkeley DB 4.7 installed. To get this through MacPorts:
+
+    sudo port install db47
+
+The BDB gem dependency should then compile.
+
+## Contact
+
+I can be reached by email at <ash.moran@patchspace.co.uk>
+
+[bitcoin]: http://www.bitcoin.org/

data/bin/rbcoin

@@ -1 +1,8 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env ruby
+
+$:.unshift(File.dirname(__FILE__) + '/../lib') unless $:.include?(File.dirname(__FILE__) + '/../lib')
+
+require 'bitcoin/cli'
+require 'bitcoin/console/stream_bundle'
+
+exit Bitcoin::CLI.new(Bitcoin::Console::StreamBundle.new(STDIN, STDOUT, STDERR)).run(ARGV.dup)

data/bitcoin.gemspec

@@ -5,22 +5,34 @@ require "bitcoin/version"
 Gem::Specification.new do |s|
   s.name        = "bitcoin"
   s.version     = Bitcoin::VERSION
-  s.authors     = ["Ash Moran"]
-  s.email       = ["ash.moran@patchspace.co.uk"]
-  s.homepage    = "http://bitcoinrb.info/"
-  s.summary     = "kwoon-#{Bitcoin::VERSION}"
+  s.authors     = [ "Ash Moran", "Andy Shipman" ]
+  s.email       = %w[ ash.moran@patchspace.co.uk andy@cllearview.com ]
+  s.homepage    = "http://rbcoin.org/"
+  s.summary     = "bitcoin-#{Bitcoin::VERSION}"
   s.description = "Bitcoin client"
 
   # s.rubyforge_project = "bitcoin"
 
+  s.add_dependency("sbdb", ">= 0.0.12.2")
+  s.add_dependency("lstrip-on-steroids", ">= 1.0.0")
+
   s.add_development_dependency("rake")
   s.add_development_dependency("cucumber")
+  s.add_development_dependency("aruba")
   s.add_development_dependency("rspec")
+  s.add_development_dependency("fuubar")
   s.add_development_dependency("guard")
+  s.add_development_dependency("guard-rspec")
+  s.add_development_dependency("guard-cucumber")
+  s.add_development_dependency("guard-bundler")
   s.add_development_dependency("rb-fsevent")
   s.add_development_dependency("growl")
+  s.add_development_dependency("fakefs")
+  s.add_development_dependency("awesome_print")
+  s.add_development_dependency("looksee")
+  s.add_development_dependency("growl_notify")
 
-  # `darcs show files` lists directories unlike `git ls-files`, so we exclude them here 
+  # `darcs show files` lists directories unlike `git ls-files`, so we exclude them here
   s.files         = `darcs show files`.split("\n").select { |file| File.file?(file) }
   s.test_files    = `darcs show files {features,spec}/*`.split("\n").select { |file| File.file?(file) }
   s.executables   = `darcs show files bin/*`.split("\n").select { |file| File.file?(file) }.map { |file| File.basename(file) }

data/config/cucumber.yml

@@ -1,5 +1,5 @@
 <%
-std_opts = "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} --strict --tags ~@wip"
+std_opts = "--require features/support/env.rb --require features/step_definitions --format #{ENV['CUCUMBER_FORMAT'] || 'pretty'}"
 %>
-default: <%= std_opts %> features
-wip: --tags @wip:3 --wip features
+default: <%= std_opts %> --tags ~@wip --strict
+wip: <%= std_opts %> --tags @wip:3 --wip

data/config/darcs.boring

@@ -0,0 +1,121 @@
+# Boring file regexps:
+
+### compiler and interpreter intermediate files
+# haskell (ghc) interfaces
+\.hi$
+\.hi-boot$
+\.o-boot$
+# object files
+\.o$
+\.o\.cmd$
+# profiling haskell
+\.p_hi$
+\.p_o$
+# haskell program coverage resp. profiling info
+\.tix$
+\.prof$
+# fortran module files
+\.mod$
+# linux kernel
+\.ko\.cmd$
+\.mod\.c$
+(^|/)\.tmp_versions($|/)
+# *.ko files aren't boring by default because they might
+# be Korean translations rather than kernel modules
+# \.ko$
+# python, emacs, java byte code
+\.py[co]$
+\.elc$
+\.class$
+# objects and libraries; lo and la are libtool things
+\.(obj|a|exe|so|lo|la)$
+# compiled zsh configuration files
+\.zwc$
+# Common LISP output files for CLISP and CMUCL
+\.(fas|fasl|sparcf|x86f)$
+
+### build and packaging systems
+# cabal intermediates
+\.installed-pkg-config
+\.setup-config
+# standard cabal build dir, might not be boring for everybody
+# ^dist(/|$)
+# autotools
+(^|/)autom4te\.cache($|/)
+(^|/)config\.(log|status)$
+# microsoft web expression, visual studio metadata directories
+\_vti_cnf$
+\_vti_pvt$
+# gentoo tools
+\.revdep-rebuild.*
+# generated dependencies
+^\.depend$
+
+### version control systems
+# cvs
+(^|/)CVS($|/)
+\.cvsignore$
+# cvs, emacs locks
+^\.#
+# rcs
+(^|/)RCS($|/)
+,v$
+# subversion
+(^|/)\.svn($|/)
+# mercurial
+(^|/)\.hg($|/)
+# git
+(^|/)\.git($|/)
+# bzr
+\.bzr$
+# sccs
+(^|/)SCCS($|/)
+# darcs
+(^|/)_darcs($|/)
+(^|/)\.darcsrepo($|/)
+^\.darcs-temp-mail$
+-darcs-backup[[:digit:]]+$
+# gnu arch
+(^|/)(\+|,)
+(^|/)vssver\.scc$
+\.swp$
+(^|/)MT($|/)
+(^|/)\{arch\}($|/)
+(^|/).arch-ids($|/)
+# bitkeeper
+(^|/)BitKeeper($|/)
+(^|/)ChangeSet($|/)
+
+### miscellaneous
+# backup files
+~$
+\.bak$
+\.BAK$
+# patch originals and rejects
+\.orig$
+\.rej$
+# X server
+\..serverauth.*
+# image spam
+\#
+(^|/)Thumbs\.db$
+# vi, emacs tags
+(^|/)(tags|TAGS)$
+#(^|/)\.[^/]
+# core dumps
+(^|/|\.)core$
+# partial broken files (KIO copy operations)
+\.part$
+# waf files, see http://code.google.com/p/waf/
+(^|/)\.waf-[[:digit:].]+-[[:digit:]]+($|/)
+(^|/)\.lock-wscript$
+# mac os finder
+(^|/)\.DS_Store$
+
+### Bitcoin gem additions
+pkg$
+^tmp/.*
+^bitcoinrb_db_tmp$
+^scratch\.rb$
+^features/fixtures/real_wallet.dat$
+^.*\.gem$

data/doc/DEFINITION_OF_DONE.markdown

@@ -0,0 +1,12 @@
+# Bitcoin Definition of Done
+
+A feature in the Bitcoin client will be considered done under normal
+circumstances if it meets the following criteria:
+
+* There is a Cucumber feature describing it
+  * The feature covers the command line interface
+* There is a command-line interface for it
+  * The command-line interface is documented in the internal help
+  * All realistic input-related error conditions are handled
+* All realistic runtime errors are handled
+* The feature behaves in a suitably similar way to the Satoshi client

data/doc/HISTORY.markdown

@@ -0,0 +1,19 @@
+# Bitcoin gem history
+
+## 0.1.2 (2011-08-29)
+
+### New features
+
+* `rbcoin satoshi-wallet add-address` command
+* `rbcoin satoshi-wallet show-addresses` command
+
+## 0.1.1 (2011-08-22)
+
+### New features
+
+* `rbcoin satoshi-wallet show-version` command
+* `rbcoin help` command shows WIP help, not everything described is implemented
+
+## 0.1.0 (2011-07-21)
+
+Initial "release". Doesn't actually do anything yet :-)

data/{LICENCE.markdown → doc/LICENCE.markdown}

@@ -1,4 +1,4 @@
-Copyright 2011 Ash Moran ("the copyright holder"). All rights reserved.
+Copyright 2011 Ash Moran <ash.moran@patchspace.co.uk>. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are
 permitted provided that the following conditions are met:

data/doc/TODO.markdown

@@ -0,0 +1,31 @@
+# TODO
+
+## Satoshi code
+
+* Investigate `read_compact_size`
+
+## Features
+
+* Flags to `rbcoin satoshi-wallet show-addresses`: --all, --sending --receiving
+
+## Usability
+
+* Berkeley DB error handling
+* Character encoding (assuming UTF8 everywhere)
+* Zsh command completion
+* Handle mismatched wallet versions
+* Offer a read-only mode for satoshi-wallet commands
+* Subcommand help for `rbcoin satoshi-wallet`
+
+## Design
+
+* OCP-compliant command system
+
+## Specs
+
+* A contract that commands return 0/1 on success/failure
+* A contract that commands terminate with a newline
+
+## Security
+
+* Prevent data being written to swap

data/doc/UBIQUITOUS_LANGUAGE.markdown

@@ -0,0 +1,15 @@
+# RbCoin Ubiquitous Language
+
+## Bitcoin
+
+Terms defined here should be used consistently throughout the application user
+interface, documentation and code
+
+* Satoshi Client: The original Bitcoin client, referred to as the "Satoshi client" for clarity
+* Satoshi Wallet: The wallet.dat file used by the Satoshi Client (a Berkeley DB file)
+* Address: A Bitcoin address
+* Tip Jar: A Bitcoin address published onymously, usually to collect anonymous tips
+
+## Technical
+
+* Value Object: an immutable object (Domain Driven Design sense)

data/features/descriptions/command_help.feature

@@ -0,0 +1,31 @@
+Feature: Command help
+  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`
+    When I successfully run `rbcoin`
+    Then the output should contain:
+      """
+      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)
+      """
+
+    Scenario: `rbcoin help`
+      When I successfully run `rbcoin help`
+      Then the output should contain "Usage: rbcoin COMMAND ..."
+
+    Scenario: Invalid command
+      When I run `rbcoin thiscommanddoesnotexist`
+      Then it should fail with:
+        """
+        rbcoin failed:  No such command "thiscommanddoesnotexist"
+        Try: `rbcoin help`
+        """