btc_address_validator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1cb2caf8a58e0813579ab784a47223982a4bb579
+  data.tar.gz: 836c5ab1a99a71188233fb93f6096ac4b8851e53
+SHA512:
+  metadata.gz: 35f605941abebe1f2da8eb16d11d18d37c2c39f74ab32c023f417809e55cd864023c4165b0178a7d94d725f4f7923373f1663d87592c8d243340bfd3c72046f1
+  data.tar.gz: 37f9438a7d5334b0ec8abbf883ae381de20f477f08564b38ace4582b49b324f7898b6bfe9ed0e451bfc80c08a0b59afaccc36fd7e13af70de181656f49742446

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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/Rakefile

@@ -0,0 +1,30 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'BtcAddressValidator'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/btc_address_validator.rb

@@ -0,0 +1,54 @@
+class BtcAddressValidator < ActiveModel::EachValidator
+  
+  def validate_each(record, attribute, value)
+    if value.present? && !valid_address?(value)
+      record.errors[attribute] << (options[:message] || "is not a valid BTC address")
+    end
+  end
+
+  private
+
+  # check if given +address+ is valid.
+  # this means having a correct version byte, length and checksum.
+  def valid_address?(address)
+    # FOR BITCOINS
+    address_version = "00"
+    p2sh_version = "05"
+
+    hex = decode_base58(address) rescue nil
+    return false unless hex && hex.bytesize == 50
+    return false unless [address_version, p2sh_version].include?(hex[0...2])
+    base58_checksum?(address)
+  end
+
+  def decode_base58(base58_val)
+    s = base58_to_int(base58_val).to_s(16); s = (s.bytesize.odd? ? '0'+s : s)
+    s = '' if s == '00'
+    leading_zero_bytes = (base58_val.match(/^([1]+)/) ? $1 : '').size
+    s = ("00"*leading_zero_bytes) + s  if leading_zero_bytes > 0
+    s
+  end
+
+  def base58_to_int(base58_val)
+    alpha = "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz"
+    int_val, base = 0, alpha.size
+    base58_val.reverse.each_char.with_index do |char,index|
+      raise ArgumentError, 'Value not a valid Base58 String.' unless char_index = alpha.index(char)
+      int_val += char_index*(base**index)
+    end
+    int_val
+  end
+
+  # verify base58 checksum for given +base58+ data.
+  def base58_checksum?(base58)
+    hex = decode_base58(base58) rescue nil
+    return false unless hex
+    checksum( hex[0...42] ) == hex[-8..-1]
+  end
+
+  # checksum is a 4 bytes sha256-sha256 hexdigest.
+  def checksum(hex)
+    b = [hex].pack("H*") # unpack hex
+    Digest::SHA256.hexdigest( Digest::SHA256.digest(b) )[0...8]
+  end 
+end

data/test/btc_address_validator_test.rb

@@ -0,0 +1,31 @@
+require "test_helper"
+
+class Validatable
+  include ActiveModel::Validations
+  attr_accessor :btc_address
+  validates :btc_address, btc_address: {message: "your copy pasting skills are not so good"}
+end
+
+class BtcAddressValidatorTest < ActiveSupport::TestCase
+
+  def setup
+    @model = Validatable.new 
+  end
+
+  test "without address" do
+    assert @model.valid?, "Should not be checking presence, only validity of address"
+  end
+
+  test "with valid address" do
+    @model.btc_address = "1C1NCedACSukWyKEjgSUYpVuiXQEtYwez4"
+    assert @model.valid?
+  end
+
+  test "with invalid address" do
+    @model.btc_address = "1234567890"
+    refute @model.valid?
+  end
+
+
+end
+

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'minitest/autorun'
+require 'active_model'
+
+# Coloring 
+require "minitest/reporters"
+Minitest::Reporters.use!
+
+
+require 'btc_address_validator'

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: btc_address_validator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Michael Elfassy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Check if a BTC address looks valid.
+email:
+- michaelelfassy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- lib/btc_address_validator.rb
+- test/btc_address_validator_test.rb
+- test/test_helper.rb
+homepage: https://github.com/elfassy/btc_address_validator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Simple BTC address validator
+test_files:
+- test/btc_address_validator_test.rb
+- test/test_helper.rb