adequate_crypto_address 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 396151caf8361e74bf9686d4ec10c913c6ba5f3c16a695fdf1c2a33dc3886abb
-  data.tar.gz: 51131dea9686bab8c4ea4996b53735c7db13b5d6c94869d39935b5517710b11b
+  metadata.gz: 66e0b65abfe56eac0be65f3edf9659e2e01cff5bd0316dd351e0e67147ae7869
+  data.tar.gz: 6d5a85caa8ed1a1370ef7247d320e9e74ec08a1f2719b2ec712c99f8e5b4e078
 SHA512:
-  metadata.gz: d0bb08404d180ee04be259d804aa298009136b57bfe023c3296bc09c792dca7e292a50f87a481e472210dacde055c58aff88b8c4f69800eacd566dac25b5451b
-  data.tar.gz: 4c18a2e6cdd22d5ac0e66eeb5bfcf2583f0114e945ea20a84aab8ab40d968f01848229e8e2d731d4f8b9b7499ba5af52a7c08d270eca6d64cd9700506050211f
+  metadata.gz: b2bab1c6a29e339533aca606a1b16164367886b31b7ef42f3624760e4098c1c49b8fc7867edbc840b7bbce70995769c9c0dc7b743e419e0a273f23053c74f1dd
+  data.tar.gz: 964a58d65459a09d9d73881f823dbf3d6c820972b2ce944f1610f9799d3a89839f0115735eabf427e232a46f9ef62ef58ba77c9b4f8ea83e61023ad49b5fbb23

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 vtm
+
+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/README.md

@@ -1,13 +1,19 @@
-# AdequateCryptoAddress
+
+AdequateCryptoAddress
+===============
+
+[![Gem Version][gem-version-svg]][gem-version-link]
+[![Build Status][build-status-svg]][build-status-link]
+[![Code Climate][codeclimate-status-svg]][codeclimate-status-link]
+[![Coverage Status][coverage-status-svg]][coverage-status-link]
+[![Downloads][downloads-svg]][downloads-link]
+[![Docs][docs-rubydoc-svg]][docs-rubydoc-link]
+[![License][license-svg]][license-link]
+
 Simple wallet address validator and normalizer for cryptocurrencies addresses in Ruby.
 
 Inspired by [ognus/wallet-address-validator](https://github.com/ognus/wallet-address-validator).
 
-[![Gem Version](https://badge.fury.io/rb/adequate_crypto_address.svg)](https://rubygems.org/gems/adequate_crypto_address)
-[![Build Status](https://travis-ci.org/vtm9/adequate_crypto_address.svg?branch=master)](https://travis-ci.org/vtm9/adequate_crypto_address)
-[![Code Climate](https://codeclimate.com/github/vtm9/adequate_crypto_address.svg)](https://codeclimate.com/github/vtm9/adequate_crypto_address)
-[![Coverage Status](https://coveralls.io/repos/vtm9/adequate_crypto_address/badge.svg?branch=master)](https://coveralls.io/r/vtm9/adequate_crypto_address?branch=master)
-[![License](https://img.shields.io/github/license/RubyMoney/money.svg)](https://opensource.org/licenses/MIT)
 
 ## Installation
 
@@ -25,7 +31,7 @@ gem install adequate_crypto_address
 
 ## Main API
 
-##### .valid? (address [, currency = 'BTC'[, type = :prod]])
+##### .valid? (address, currency [, type = :prod])
 
 ###### Parameters
 * address - Wallet address to validate.
@@ -62,6 +68,7 @@ AdequateCryptoAddress.valid?('de709f2102306220921060314715629080e2fb77', :ethere
 ```
 
 ### Normalization
+###### *Not all currencies support this feature.
 ``` ruby
 require 'adequate_crypto_address'
 
@@ -78,7 +85,49 @@ addr.address #=> "bitcoincash:qrtj3rd8524cndt2eew3s6wljqggmne00sgh4kfypk"
 # ETH
 AdequateCryptoAddress.address('D1220A0cf47c7B9Be7A2E6BA89F429762e7b9aDb', 'eth').address #=> "0xD1220A0cf47c7B9Be7A2E6BA89F429762e7b9aDb"
 ```
-*Not all currencies support this feature.
+
+
+### ActiveRecord validation example
+``` ruby
+class Model < ActiveRecord::Base
+  attribute :address, :string
+  attribute :dest_tag, :string
+  attribute :currency, :string
+
+  validate  :validate_address_type
+  validate  :validate_destination_tag
+
+  def validate_address_type
+    errors.add(:address, 'invalid address') unless AdequateCryptoAddress.valid?(address, currency)
+  end
+
+  # for Ripple
+  def validate_destination_tag
+    errors.add(:dest_tag, 'invalid destination tag') if dest_tag.present? && !(dest_tag =~ /\A\d{1,10}\z/)
+  end
+end
+
+```
+### Add your currnecy
+``` ruby
+# frozen_string_literal: true
+# for Rails /config/initializers/adequate_crypto_address.rb
+module AdequateCryptoAddress
+  class Coin
+    attr_reader :address
+
+    def initialize(address_sring)
+      @address = address_sring
+    end
+
+    def valid?(_type)
+      address.present?
+    end
+  end
+end
+
+AdequateCryptoAddress.valid?('addr', :coin) #=> true
+```
 
 ## Development
 
@@ -97,3 +146,19 @@ Run `rake spec` to run the tests. You can also run `bin/console` for an interact
 ## Notes
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/vtm9/adequate_crypto_address/issues
+
+ [gem-version-svg]: https://badge.fury.io/rb/adequate_crypto_address.svg
+ [gem-version-link]: https://rubygems.org/gems/adequate_crypto_address
+ [downloads-svg]: http://ruby-gem-downloads-badge.herokuapp.com/adequate_crypto_address
+ [downloads-link]: https://rubygems.org/gems/adequate_crypto_address
+ [build-status-svg]: https://travis-ci.org/vtm9/adequate_crypto_address.svg?branch=master
+ [build-status-link]:https://travis-ci.org/vtm9/adequate_crypto_address
+ [coverage-status-svg]: https://coveralls.io/repos/vtm9/adequate_crypto_address/badge.svg?branch=master
+ [coverage-status-link]: https://coveralls.io/r/vtm9/adequate_crypto_address?branch=master
+ [codeclimate-status-svg]: https://codeclimate.com/github/vtm9/adequate_crypto_address.svg
+ [codeclimate-status-link]: https://codeclimate.com/github/vtm9/adequate_crypto_address
+ [docs-rubydoc-svg]: https://img.shields.io/badge/docs-rubydoc-blue.svg
+ [docs-rubydoc-link]: http://www.rubydoc.info/gems/adequate_crypto_address/
+ [license-svg]: https://img.shields.io/badge/license-MIT-blue.svg
+ [license-link]: https://github.com/vtm9/adequate_crypto_address/blob/master/LICENSE.txt
+

data/lib/adequate_crypto_address.rb

@@ -8,6 +8,7 @@ require 'adequate_crypto_address/btc'
 require 'adequate_crypto_address/xrp'
 require 'adequate_crypto_address/dash'
 require 'adequate_crypto_address/zec'
+require 'adequate_crypto_address/ltc'
 
 module AdequateCryptoAddress
   class UnknownCurrency < StandardError; end

data/lib/adequate_crypto_address/ltc.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module AdequateCryptoAddress
+  class Ltc < Altcoin
+    ADDRESS_TYPES = { prod: %w[30 05 32], test: %w[6f c4 3a] }.freeze
+  end
+  Litecoin = Ltc
+end

data/lib/adequate_crypto_address/version.rb

@@ -1,3 +1,3 @@
 module AdequateCryptoAddress
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.1.4'.freeze
 end

data/spec/adequate_crypto_address_spec.rb

@@ -93,6 +93,7 @@ RSpec.describe(AdequateCryptoAddress) do
       end
 
       it 'validates wrong addresses' do
+        expect(described_class).not_to be_valid('wrong', :ETH)
         expect(described_class).not_to be_valid('0xD1110A0cf47c7B9Be7A2E6BA89F429762e7b9aDb', 'ETH')
         expect(described_class).not_to be_valid('a10354276d2fC74ee91e37D085d35748613f4748', :ethereum)
       end
@@ -109,6 +110,7 @@ RSpec.describe(AdequateCryptoAddress) do
       end
 
       it 'validates wrong addresses' do
+        expect(described_class).not_to be_valid('wrong', :xrp)
         expect(described_class).not_to be_valid('r3kmLJN5D28dHuH8vZNUZpMC43pEHpaoc1', :xrp)
         expect(described_class).not_to be_valid('r1kmLJN5D28dHuH8vZNUZpMC43pEHpaocV', 'ripple')
       end
@@ -123,6 +125,7 @@ RSpec.describe(AdequateCryptoAddress) do
       end
 
       it 'validates wrong addresses' do
+        expect(described_class).not_to be_valid('wrong', :dash)
         expect(described_class).not_to be_valid('yPv7h2i8v3dJ1fSH4L3x91JSJszjdbsJJA', :dash)
         expect(described_class).not_to be_valid('XqMkVUZnqe3w4xvgdZRtZoe7gMitDudGs4', 'dash', :test)
         expect(described_class).not_to be_valid('yPv7h2i8v3dJjfSH4L3x91JSJszjdbsJJA', :DASH, :prod)
@@ -137,6 +140,29 @@ RSpec.describe(AdequateCryptoAddress) do
       end
 
       it 'validates wrong addresses' do
+        expect(described_class).not_to be_valid('wrong', :zec)
+        expect(described_class).not_to be_valid('t1Y9yhDa5XEjgfnTgZoKddeSiEN1aoLkQxq', :zcash)
+        expect(described_class).not_to be_valid('t3Yz22vK5z2LcKEdg16Yv4FFneEL1zg9ojd', :ZEC)
+        expect(described_class).not_to be_valid('t2YNzUUx8mWBCRYPRezvA363EYXyEpHokyi', :zcash, :test)
+      end
+    end
+
+    context 'Litecoin' do
+      it 'validates addresses' do
+        expect(described_class).to be_valid('LVg2kJoFNg45Nbpy53h7Fe1wKyeXVRhMH9', :ltc)
+        expect(described_class).to be_valid('LVg2kJoFNg45Nbpy53h7Fe1wKyeXVRhMH9', 'ltc', :prod)
+        expect(described_class).to be_valid('LTpYZG19YmfvY2bBDYtCKpunVRw7nVgRHW', 'LTC')
+        expect(described_class).to be_valid('Lb6wDP2kHGyWC7vrZuZAgV7V4ECyDdH7a6', 'Litecoin')
+        expect(described_class).to be_valid('mzBc4XEFSdzCDcTxAgf6EZXgsZWpztRhef', 'Litecoin', :test)
+
+        expect(described_class).to be_valid('3NJZLcZEEYBpxYEUGewU4knsQRn1WM5Fkt', 'LTC')
+        expect(described_class).to be_valid('2MxKEf2su6FGAUfCEAHreGFQvEYrfYNHvL7', 'LTC', :test)
+        expect(described_class).to be_valid('QW2SvwjaJU8LD6GSmtm1PHnBG2xPuxwZFy', 'LTC', :test)
+        expect(described_class).to be_valid('QjpzxpbLp5pCGsCczMbfh1uhC3P89QZavY', 'LTC', :test)
+      end
+
+      it 'validates wrong addresses' do
+        expect(described_class).not_to be_valid('wrong', :zec)
         expect(described_class).not_to be_valid('t1Y9yhDa5XEjgfnTgZoKddeSiEN1aoLkQxq', :zcash)
         expect(described_class).not_to be_valid('t3Yz22vK5z2LcKEdg16Yv4FFneEL1zg9ojd', :ZEC)
         expect(described_class).not_to be_valid('t2YNzUUx8mWBCRYPRezvA363EYXyEpHokyi', :zcash, :test)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adequate_crypto_address
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - vtm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-21 00:00:00.000000000 Z
+date: 2019-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base58
@@ -93,6 +93,7 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - adequate_crypto_address.gemspec
@@ -103,6 +104,7 @@ files:
 - lib/adequate_crypto_address/btc.rb
 - lib/adequate_crypto_address/dash.rb
 - lib/adequate_crypto_address/eth.rb
+- lib/adequate_crypto_address/ltc.rb
 - lib/adequate_crypto_address/utils/bch.rb
 - lib/adequate_crypto_address/utils/bech32.rb
 - lib/adequate_crypto_address/version.rb
@@ -130,8 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: A Ruby Library for dealing with validation cryptocurrency adresses.