vanitygen-wrapper 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 413a2d4a3858258fe5778cc45e10b2719e56d662
-  data.tar.gz: 6db5b7f020f2a48d2f5486444a154d1e323cbc77
+  metadata.gz: 7acb4fcb9c91d2780d7fd860a8fc77fc029e059b
+  data.tar.gz: 946aad92bb08fac89a0129d2303c30625c61e832
 SHA512:
-  metadata.gz: a7715ee966b9a2821844df51b9df2eb85a5c063b6d79363e6759a167580215ee21635e3b018fb91c7f5c1e1bea79eafba0faf251971ac499c7eb7707b3e07f4c
-  data.tar.gz: 32dd98358eabe88a4e847c1426389b684f2f9234da83bf8d452c5245b908e1ac6694e367a6b3b550023e9de37c9ee2c60fc2e916dbf666bf10e0751a23025572
+  metadata.gz: 7fe174885c90d8653dbfca10fa42cc8fa55b01f22e19222f88aff97e8d1d9ea2ca0283a67fcef7cee7288fd0b3b6d770e753eb97cf958d4133efd3d50ef05e27
+  data.tar.gz: 861a9d35b6be688a67e4d4426c998b068578287b20fb7962fa312dabf48b31ac1f07142c97fcd80e7bb633648e679db73b1f0bc73af65d72c7e5927a97c26c02

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+0.0.1 - 2014-12-02
+=====
+Mostly feature complete:
+* Vanitygen.network
+* Vanitygen.valid?
+* Vanitygen.difficulty
+* Vanitygen.generate
+* Vanitygen.continuous
+
+Options supported:
+* case_insensitive
+* regex patterns
+* that's about it...

data/README.md

@@ -2,6 +2,16 @@
 
 Thin ruby wrapper around vanitygen executable. Sibling project of <https://github.com/bitvain/vanitygen-ruby>.
 
+## Warning
+
+Due to rampant use of pipes, signals, and subprocesses, this gem probably does
+not work in JRuby or Windows.
+
+This also cannot be effectively tested in CI due to depending on an external
+executable.
+
+Discretion is advised.
+
 ## Installation
 
 Download and install <https://github.com/samr7/vanitygen>
@@ -11,7 +21,7 @@ Make sure `vanitygen` is available in your `$PATH`.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'vanitygen-wrapper', require 'vanitygen'
+gem 'vanitygen-wrapper', require: 'vanitygen'
 ```
 
 And then execute:

data/lib/vanitygen.rb

@@ -9,8 +9,15 @@ module Vanitygen
     NETWORKS = {
       bitcoin:  nil,
       testnet3: '-T',
+      namecoin: '-N',
+      litecoin: '-L',
     }
 
+    attr_accessor :executable
+    def executable
+      @executable ||= 'vanitygen'
+    end
+
     def network
       @network ||= :bitcoin
     end
@@ -25,7 +32,7 @@ module Vanitygen
       flags = flags_from({simulate: true,
                           patterns: [pattern]
                          }.merge(options))
-      pid = Process.spawn('vanitygen', *flags, out: '/dev/null', err: '/dev/null')
+      pid = Process.spawn(executable, *flags, out: '/dev/null', err: '/dev/null')
       pid, status = Process.wait2(pid)
       status == 0
     end
@@ -35,7 +42,7 @@ module Vanitygen
                           patterns: [pattern]
                          }.merge(options))
       msg = ''
-      Open3.popen3('vanitygen', *flags) do |stdin, stdout, stderr, wait_thr|
+      Open3.popen3(executable, *flags) do |stdin, stdout, stderr, wait_thr|
         stdin.close
         stdout.close
         while !stderr.eof?
@@ -52,7 +59,7 @@ module Vanitygen
                          }.merge(options))
 
       msg = ''
-      Open3.popen3('vanitygen', *flags) do |stdin, stdout, stderr, wait_thr|
+      Open3.popen3(executable, *flags) do |stdin, stdout, stderr, wait_thr|
         stdin.close
         while !stdout.eof?
           msg << stdout.read
@@ -85,23 +92,16 @@ module Vanitygen
                           patterns: patterns,
                          }.merge(options))
 
-      thread = Thread.new do
-        # FIXME: ignore EOF instead of reopening
-        loop do
-          File.open(tmp_pipe, 'r') do |file|
-            while !file.eof? and (msg = file.read)
-              parse(msg).each do |data|
-                block.call(data)
-              end
-            end
+      # Unfortunately, vanitygen spams stdout with progress
+      pid_vanitygen = Process.spawn(executable, *flags, out: '/dev/null', err: '/dev/null')
+      while child_alive?(pid_vanitygen)
+        File.open(tmp_pipe, 'r') do |file|
+          while !file.eof? and (msg = file.read)
+            parse(msg).each(&block)
           end
         end
       end
-
-      pid_vanitygen = Process.spawn('vanitygen', *flags, out: '/dev/null', err: '/dev/null')
-      Process.wait(pid_vanitygen)
     ensure
-      thread && thread.kill
       if pid_vanitygen
         begin
           Process.kill('TERM', pid_vanitygen)
@@ -120,6 +120,15 @@ module Vanitygen
 
     private
 
+    def child_alive?(pid)
+      # Very unix like
+      # Unfortunately, not very ruby like :(
+      Process.kill(0, pid)
+      true
+    rescue Errno::ESRCH
+      false
+    end
+
     def flags_from(options)
       [].tap do |flags|
         patterns =

data/lib/vanitygen/version.rb

@@ -1,3 +1,3 @@
 module Vanitygen
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'wrong/adapters/rspec'
+
+RSpec.configure do |c|
+  c.include Wrong
+end

data/spec/vanitygen_spec.rb

@@ -1,7 +1,8 @@
+require 'spec_helper'
+
 require 'vanitygen'
 
 require 'bitcoin'
-require 'devnull'
 require 'timeout'
 
 describe Vanitygen do
@@ -16,16 +17,16 @@ describe Vanitygen do
       subject { Vanitygen.generate(pattern_string_a) }
 
       it 'has valid address' do
-        expect(subject[:address]).to satisfy { |addr| Bitcoin.valid_address?(addr) }
+        assert{ Bitcoin.valid_address?(subject[:address]) }
       end
 
       it 'has address starting with pattern' do
-        expect(subject[:address]).to start_with(pattern_string_a)
+        assert{ subject[:address].start_with?(pattern_string_a) }
       end
 
       it 'has correct private_key to unlock pattern' do
         bkey = Bitcoin::Key.from_base58(subject[:private_key])
-        expect(subject[:address]).to eq(bkey.addr)
+        assert{ subject[:address] == bkey.addr }
       end
     end
 
@@ -33,23 +34,25 @@ describe Vanitygen do
       subject { Vanitygen.generate(pattern_regex_ab) }
 
       it 'has valid address' do
-        expect(subject[:address]).to satisfy { |addr| Bitcoin.valid_address?(addr) }
+        assert{ Bitcoin.valid_address?(subject[:address]) }
       end
 
       it 'has address matching pattern' do
-        expect(subject[:address]).to match(pattern_regex_ab)
+        assert{ subject[:address] =~ pattern_regex_ab }
       end
     end
   end
 
   describe '.continuous' do
     it 'requires a block' do
-      expect{Vanitygen.continuous([pattern_any])}.to raise_error(LocalJumpError)
+      error = rescuing{ Vanitygen.continuous([pattern_any]) }
+      assert{ error.is_a?(LocalJumpError) }
     end
 
     it 'requires same type' do
       noop = proc{}
-      expect{Vanitygen.continuous([pattern_regex_ab, pattern_string_a], &noop)}.to raise_error(TypeError)
+      error = rescuing{ Vanitygen.continuous([pattern_regex_ab, pattern_string_a], &noop) }
+      assert{ error.is_a?(TypeError) }
     end
 
     context 'threaded with capture block' do
@@ -80,42 +83,39 @@ describe Vanitygen do
         end
 
         it 'runs a lot' do
-          expect(captured.count).to be > 10
+          assert{ captured.count > 10 }
         end
 
         it 'returns valid addresses' do
-          expect(captured).to all(satisfy { |addr| Bitcoin.valid_address?(addr) })
+          assert{ captured.all? { |addr| Bitcoin.valid_address?(addr) } }
         end
       end
 
       context 'with string' do
         it 'starts with matching pattern' do
           continuous_with_timeout([pattern_string_a], &capture(:address))
-          expect(captured.size).to be > 1
-          expect(captured).to all(start_with(pattern_string_a))
+          assert{ captured.size > 1 }
+          assert{ captured.all? { |addr| addr.start_with?(pattern_string_a) } }
         end
 
         it 'matches with case insensitivity' do
           continuous_with_timeout([pattern_string_ab], case_insensitive: true, &capture(:address))
           prefixes = captured.map { |addr| addr[0..2] }
-          expect(prefixes.uniq.size).to be > 1
+          assert{ prefixes.uniq.size > 1 }
         end
 
         it 'matches multiple patterns' do
           continuous_with_timeout([pattern_string_a, pattern_string_b], &capture(:address))
-          # should be
-          # expect(captured).to any(addr.start_with?(pattern_string_a))
-          # expect(captured).to any(addr.start_with?(pattern_string_b))
-          expect(captured).to satisfy { |a| a.any? { |addr| addr.start_with?(pattern_string_a) } }
-          expect(captured).to satisfy { |a| a.any? { |addr| addr.start_with?(pattern_string_b) } }
+          assert{ captured.any? { |addr| addr.start_with?(pattern_string_a) } }
+          assert{ captured.any? { |addr| addr.start_with?(pattern_string_b) } }
         end
       end
 
       context 'with regex' do
         it 'matches the regex' do
           continuous_with_timeout([pattern_regex_ab], &capture(:address))
-          expect(captured.size).to be > 1
-          expect(captured).to all(match(pattern_regex_ab))
+          assert{ captured.size > 1 }
+          assert{ captured.all? { |addr| addr =~ pattern_regex_ab } }
         end
       end
     end
@@ -123,28 +123,51 @@ describe Vanitygen do
 
   describe '.difficulty' do
     it 'returns difficulty in Numeric' do
-      expect(Vanitygen.difficulty(pattern_string_a)).to be_a Numeric
+      assert{ Vanitygen.difficulty(pattern_string_a).is_a?(Numeric) }
     end
   end
 
   describe '.valid?' do
     it 'is true for starting with 1' do
-      expect(Vanitygen.valid?('1abc')).to be(true)
+      assert{ Vanitygen.valid?('1abc') }
     end
 
     it 'is false for starting with something else' do
-      expect(Vanitygen.valid?('abc')).to be(false)
+      assert{ not Vanitygen.valid?('abc') }
     end
 
     it 'is false for really long strings' do
-      expect(Vanitygen.valid?('1abcdefghijklmnopqrstuvwxyz')).to be(false)
+      assert{ not Vanitygen.valid?('1abcdefghijklmnopqrstuvwxyz') }
     end
 
     it 'is false for illegal characters' do
-      expect(Vanitygen.valid?('10')).to be(false)
-      expect(Vanitygen.valid?('1O')).to be(false)
-      expect(Vanitygen.valid?('1I')).to be(false)
-      expect(Vanitygen.valid?('1l')).to be(false)
+      assert{ not Vanitygen.valid?('10') }
+      assert{ not Vanitygen.valid?('1O') }
+      assert{ not Vanitygen.valid?('1I') }
+      assert{ not Vanitygen.valid?('1l') }
+    end
+  end
+
+  describe '.network' do
+    it 'switches to :testnet3' do
+      assert{ not Vanitygen.valid?('mm') }
+      Vanitygen.network = :testnet3
+      assert{ Vanitygen.valid?('mm') }
+    end
+
+    it 'switches to "testnet3"' do
+      Vanitygen.network = 'testnet3'
+      assert{ Vanitygen.valid?('mm') }
+    end
+
+    it 'stays on :bitcoin' do
+      Vanitygen.network = :bitcoin
+      assert{ Vanitygen.valid?('1a') }
+    end
+
+    it 'dies for missing network' do
+      error = rescuing{ Vanitygen.network = :foobar }
+      assert{ error.message =~ /not supported/ }
     end
   end
 end

data/vanitygen-wrapper.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'ffi', '~> 1.9'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'wrong', '~> 0.7.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vanitygen-wrapper
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Benjamin Feng
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-02 00:00:00.000000000 Z
+date: 2014-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mkfifo
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: wrong
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
 description: Thin ruby wrapper around vanitygen executable. Sibling project of <https://github.com/bitvain/vanitygen-ruby>.
 email:
 - contact@fengb.info
@@ -102,12 +116,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/vanitygen.rb
 - lib/vanitygen/version.rb
+- spec/spec_helper.rb
 - spec/vanitygen_spec.rb
 - vanitygen-wrapper.gemspec
 homepage: https://github.com/bitvain/vanitygen-wrapper
@@ -135,4 +151,5 @@ signing_key:
 specification_version: 4
 summary: Thin ruby wrapper around vanitygen executable
 test_files:
+- spec/spec_helper.rb
 - spec/vanitygen_spec.rb