base58_gmp 0.0.7 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad881e2554d4a1b511183a4d9a90581bbe692ee0
+  data.tar.gz: 2fe8884cff6b04ea68dfe24c31915d15d11f2234
+SHA512:
+  metadata.gz: ede65bd022cc60e16d30f5cf656931a9f09a06f0d7fe3af72c2a0b13179f62628da9f82d694c60f1dd34030f71b9f25dd8dc85efe795de11ed1c60436882265f
+  data.tar.gz: b18e889d95ae7c44d31b5efde4c4ac45ffdaf57ab8d70084fd6f93ca4da88ad90cc390f2bde6fa0c781c70eaf180b1ac7e9e7d6e2471397988ead12feb15d2c3

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+CHANGELOG
+---------
+- **1.0.0** - 2016-09-27**
+  - Add `md5_base58` method `pad:` option
+  - Add alphabet parameter as symbol support
+  - Add Ripple alphabet
+  - Add `normalize_alphabet` and `alphabet_digits` methods
+- **0.0.7** - 2011-11-21
+  - Add Bitcoin suppport
+  - Refactor API
+- **0.0.6** - 2011-11-14
+  - Update encode API
+- **0.0.5** - 2011-11-06
+  - Add Base58 decoding to `GMP::Z` integer
+  - Add Base58 encoding of `GMP::Z` integer
+  - Add Base58 encoding of arbitrary base strings
+  - Add Base58 encoding using `gmp` alphabet
+  - Add MD5 using `gmp` alphabet
+  - More tests
+- **0.0.4** - 2011-11-06
+  - Add `flickr_to_gmp` transcoding
+  - Document Flickr and GMP transcoding
+- **0.0.3** - 2011-11-06
+  - Minor fixes.
+- **0.0.2** - 2011-11-06
+  - Documentation update.
+- **0.0.1** - 2011-11-06
+  - Initial release including encode and md5 capabilities.
+  - Does not include decode due to current limitation in GMP binding. For now, the `base58` gem can be used for decoding.

data/{MIT-LICENSE → LICENSE.txt}

@@ -1,4 +1,6 @@
-Copyright (c) 2011 John Wang
+The MIT License (MIT)
+
+Copyright (c) 2011-2016 John Wang
  
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,164 @@
+
+Base58 GMP Ruby
+===============
+
+[![Gem Version][gem-version-svg]][gem-version-link]
+[![Build Status][build-status-svg]][build-status-link]
+[![Coverage Status][coverage-status-svg]][coverage-status-link]
+[![Dependency Status][dependency-status-svg]][dependency-status-link]
+[![Code Climate][codeclimate-status-svg]][codeclimate-status-link]
+[![Scrutinizer Code Quality][scrutinizer-status-svg]][scrutinizer-status-link]
+[![Downloads][downloads-svg]][downloads-link]
+[![Docs][docs-rubydoc-svg]][docs-rubydoc-link]
+[![License][license-svg]][license-link]
+
+[![Stories in Ready][story-status-svg]][story-status-link]
+
+High speed Base58 encoding using [GMP](https://gmplib.org/) with MD5 support and transcoding between Flickr, Bitcoin, Ripple and GMP alphabets.
+
+## Installation
+
+### Via Bundler
+
+Add `base58_gmp` to `Gemfile` and then run `bundle`:
+
+```sh
+$ echo "gem 'base58_gmp'" >> Gemfile
+$ bundle
+```
+
+### Via RubyGems
+
+```sh
+$ gem install base58_gmp
+```
+
+## Usage
+
+Alphabet can be specified using symbol or string.
+
+```ruby
+require 'base58_gmp'
+
+# Encode Int as Base58
+Base58GMP.encode 12345                          # => 4ER
+
+# Encode GMP::Z Int as Base58
+Base58GMP.encode GMP::Z(12345)                  # => 4ER
+
+# Encode as Base58 using alternate alphabets
+Base58GMP.encode 12345, :bitcoin                # => 4fr
+Base58GMP.encode 12345, :gmp                    # => 3cn
+
+# Encode as Base58 using alternate alphabets using string
+Base58GMP.encode 12345, 'bitcoin'               # => 4fr
+Base58GMP.encode 12345, 'gmp'                   # => 3cn
+
+# Decode Base58 as GMP::Z Integer
+Base58GMP.decode '4ER'                          # => 12345
+
+# Decode Base58 as GMP::Z Integer using alternate alphabets
+Base58GMP.decode '4fr', :bitcoin                # => 12345
+Base58GMP.decode '3cn', :gmp                    # => 12345
+
+# MD5 Base58 Digest
+Base58GMP.md5 'foo@bar.com'                     # => w6fdCRXnUXyz7EtDn5TgN9
+
+# MD5 Base58 Digest with left padding for consistent length
+Base58GMP.md5 'foo@bar.com', :flickr, pad: true # => w6fdCRXnUXyz7EtDn5TgN9
+
+# Convert between alphabets
+Base58GMP.from_to '123456789abcdefghijk', :flickr, :gmp # => 0123456789ABCDEFGHIJ
+Base58GMP.from_to '0123456789ABCDEFGHIJ', :gmp, :flickr # => 123456789abcdefghijk
+```
+
+## Notes
+
+### Base58 Implementations - Flickr, Bitcoin and GMP
+
+This class supports the Base58 alphabets used by Flickr, Bitcoin and GMP. The Flickr alphabet is the default and used when no alphabet is provided.
+
+| Alphabet | Character Set |
+|----------|---------------|
+| Flickr   | `[0-9a-zA-Z]` excluding `[0OIl]` |
+| Bitcoin  | `[0-9A-Za-z]` excluding `[0OIl]` |
+| Ripple   | `rpshnaf39wBUDNEGHJKLM4PQRST7VWXYZ2bcdeCg65jkm8oFqi1tuvAxyz` |
+| GMP      | `[0-9A-Za-v]` |
+
+The encode, decode and md5 methods support an alphabet parameter which can be set to the supported alphabets `['bitcoin', 'flickr', 'gmp']` to indicate the value to be encoded or decoded.
+
+### GMP
+
+This class requires GMP 4.2.0 or above. Prior versions are limited to Base36.
+
+## Supported Ruby Versions
+
+This library supports and is [tested against](https://travis-ci.org/grokify/ringcentral-sdk-ruby) the following Ruby implementations:
+
+1. Ruby 2.3.0
+2. Ruby 2.2.0
+3. Ruby 2.1.0
+4. Ruby 2.0.0
+
+### Change Log
+
+See [CHANGELOG.md](CHANGELOG.md)
+
+## Links
+
+Project Repo
+
+* https://github.com/grokify/base58-gmp-ruby
+
+Flickr post introducing Base58:
+
+* http://www.flickr.com/groups/api/discuss/72157616713786392/
+
+Bitcoin wiki Base58 article:
+
+* https://en.bitcoin.it/wiki/Base58Check_encoding
+
+GMP:
+
+* https://gmplib.org/
+
+## Credits
+
+John Wang - http://johnwang.com
+
+Some test examples courtesy Fraser Speirs' Base58Encoder Objective-C class, http://gist.github.com/101674.
+
+## Contributing
+
+1. Fork it (http://github.com/grokify/base58-gmp-ruby/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Base58 GMP Ruby is available under an MIT-style license. See [LICENSE.txt](LICENSE.txt) for details.
+
+Base58 GMP Ruby © 2011-2016 by John Wang
+
+ [gem-version-svg]: https://badge.fury.io/rb/base58_gmp.svg
+ [gem-version-link]: http://badge.fury.io/rb/base58_gmp
+ [downloads-svg]: http://ruby-gem-downloads-badge.herokuapp.com/base58_gmp
+ [downloads-link]: https://rubygems.org/gems/base58_gmp
+ [build-status-svg]: https://api.travis-ci.org/grokify/base58-gmp-ruby.svg?branch=master
+ [build-status-link]: https://travis-ci.org/grokify/base58-gmp-ruby
+ [coverage-status-svg]: https://coveralls.io/repos/grokify/base58-gmp-ruby/badge.svg?branch=master
+ [coverage-status-link]: https://coveralls.io/r/grokify/base58-gmp-ruby?branch=master
+ [dependency-status-svg]: https://gemnasium.com/grokify/base58-gmp-ruby.svg
+ [dependency-status-link]: https://gemnasium.com/grokify/base58-gmp-ruby
+ [codeclimate-status-svg]: https://codeclimate.com/github/grokify/base58-gmp-ruby/badges/gpa.svg
+ [codeclimate-status-link]: https://codeclimate.com/github/grokify/base58-gmp-ruby
+ [scrutinizer-status-svg]: https://scrutinizer-ci.com/g/grokify/base58-gmp-ruby/badges/quality-score.png?b=master
+ [scrutinizer-status-link]: https://scrutinizer-ci.com/g/grokify/base58-gmp-ruby/?branch=master
+ [story-status-svg]: https://badge.waffle.io/grokify/base58-gmp-ruby.svg?label=ready&title=Ready
+ [story-status-link]: https://waffle.io/grokify/base58-gmp-ruby
+ [docs-rubydoc-svg]: https://img.shields.io/badge/docs-rubydoc-blue.svg
+ [docs-rubydoc-link]: http://www.rubydoc.info/gems/base58_gmp/
+ [license-svg]: https://img.shields.io/badge/license-MIT-blue.svg
+ [license-link]: https://github.com/grokify/base58-gmp-ruby/blob/master/LICENSE.txt

data/base58_gmp.gemspec

@@ -1,27 +1,24 @@
+lib = 'base58_gmp'
+lib_file = File.expand_path("../lib/#{lib}.rb", __FILE__)
+File.read(lib_file) =~ /\bVERSION\s*=\s*["'](.+?)["']/
+version = $1
+
 Gem::Specification.new do |s|
   s.name        = 'base58_gmp'
-  s.version     = '0.0.7'
-  s.date        = '2011-11-21'
+  s.version     = version
+  s.date        = '2016-09-27'
   s.summary     = 'High speed Base58 encoding using GMP with MD5 support'
   s.description = 'High speed Base58 encoding using GMP with MD5 support and transcoding between Flickr, Bitcoin and GMP alphabets.'
   s.authors     = ['John Wang']
   s.email       = 'johncwang@gmail.com'
-  s.homepage    =
-    'http://rubygems.org/gems/base58_gmp'
-  s.extra_rdoc_files = [
-    'README.rdoc'
-  ]
-  s.files = [
-     'CHANGELOG',
-     'MIT-LICENSE',
-     'README.rdoc',
-     'Rakefile',
-     'VERSION',
-     'base58_gmp.gemspec',
-     'lib/base58_gmp.rb',
-     'test/test_base58_gmp.rb',
-     'test/test_encode-decode-multi.rb',
-     'test/test_alphabets.rb'
-  ]
-
+  s.homepage    = 'https://github.com/grokify/'
+  s.licenses    = ['MIT']
+  s.files       = %w(CHANGELOG.md LICENSE.txt README.md base58_gmp.gemspec) + Dir['lib/**/*.rb']
+  s.required_ruby_version = '>= 2.0.0'
+  s.add_dependency 'gmp', '~> 0', '>= 0'
+  s.add_development_dependency 'bundler', '~> 1.0'
+  s.add_development_dependency 'coveralls', '~> 0'
+  s.add_development_dependency 'rake', '~> 11'
+  s.add_development_dependency 'simplecov', '~> 0'
+  s.add_development_dependency 'test-unit', '~> 3'
 end

data/lib/base58_gmp.rb

@@ -1,39 +1,41 @@
 # Base58GMP
-# Copyright (c) 2011 John Wang
+# Copyright (c) 2011-2016 John Wang
 # http://johnwang.com
-# Distributed under the MIT license as included with this plugin.
+# Distributed under the MIT license as included with this gem.
 
-require 'rubygems'
 require 'digest/md5'
 require 'gmp'
 
 class Base58GMP
+  VERSION = '1.0.0'
 
-  ALPHABETS   = {
-    'bitcoin' => '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz',
-    'flickr'  => '123456789abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ',
-    'gmp'     => '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuv'
+  ALPHABETS = {
+    bitcoin: '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz',
+    flickr:  '123456789abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ',
+    ripple:  'rpshnaf39wBUDNEGHJKLM4PQRST7VWXYZ2bcdeCg65jkm8oFqi1tuvAxyz',
+    gmp:     '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuv'
   }
-  
-  DEFAULT_ALPHABET = 'flickr'
-  GMP_ALPHABET     = 'gmp'
-
-  def self.integer_to_base58(integer, alphabet=DEFAULT_ALPHABET)
-    base58 = integer.is_a?(GMP::Z)     ?
-               integer.to_s(base = 58) :
-               GMP::Z(integer).to_s(base = 58)
-
-    alphabet.is_a?(String) && alphabet.downcase == GMP_ALPHABET ?
-      base58 :
-      from_to(base58, GMP_ALPHABET, alphabet)
+
+  DEFAULT_ALPHABET = :flickr
+  GMP_ALPHABET = :gmp
+  BASE58_LENGTH_MD5 = 22
+
+  def self.integer_to_base58(integer, alphabet = DEFAULT_ALPHABET)
+    base58 = integer.is_a?(GMP::Z) \
+           ? integer.to_s(58) \
+           : GMP::Z(integer).to_s(58)
+
+    normalize_alphabet(alphabet) == GMP_ALPHABET \
+      ? base58 \
+      : from_to(base58, GMP_ALPHABET, alphabet)
   end
 
-  def self.base58_to_integer(base58, alphabet=DEFAULT_ALPHABET)
-    unless base58.is_a?(String)
-      raise ArgumentError, 'Base58 argument is not a string.'
+  def self.base58_to_integer(base58, alphabet = DEFAULT_ALPHABET)
+    unless base58.is_a? String
+      fail ArgumentError, 'Base58 argument is not a string.'
     end
 
-    unless alphabet.is_a?(String) && alphabet.downcase == GMP_ALPHABET
+    unless normalize_alphabet(alphabet) == GMP_ALPHABET
       base58 = from_to(base58, alphabet, GMP_ALPHABET)
     end
 
@@ -41,31 +43,38 @@ class Base58GMP
   end
 
   def self.from_to(base58, from_alphabet, to_alphabet)
-    unless base58.is_a?(String)
-      raise ArgumentError, 'Base58 argument is not a string.'
+    unless base58.is_a? String
+      fail ArgumentError, 'Base58 argument is not a string.'
     end
 
-    unless (
-      from_alphabet.is_a?(String) &&
-      from_digits = ALPHABETS[from_alphabet.downcase]
-    )
-      raise ArgumentError, 'From encoding is not valid.'
-    end
+    from_digits = alphabet_digits from_alphabet
+    to_digits = alphabet_digits to_alphabet
+
+    from_digits != to_digits \
+      ? base58.tr(from_digits, to_digits) \
+      : base58
+  end
 
-    unless (
-      to_alphabet.is_a?(String) &&
-      to_digits = ALPHABETS[to_alphabet.downcase]
-    )
-      raise ArgumentError, 'To encoding is not valid.'
+  def self.normalize_alphabet(alphabet)
+    alphabet.to_sym.downcase
+  end
+
+  def self.alphabet_digits(alphabet)
+    alphabet = normalize_alphabet alphabet
+
+    unless ALPHABETS.key? alphabet
+      fail ArgumentError, "Alphabet is invalid: #{alphabet}"
     end
 
-    from_digits != to_digits ?
-      base58.tr(from_digits, to_digits) :
-      base58
+    return ALPHABETS[alphabet]
   end
 
-  def self.md5_base58(data, alphabet=DEFAULT_ALPHABET)
-    integer_to_base58(Digest::MD5.hexdigest(data).hex, alphabet)
+  def self.md5_base58(data, alphabet = DEFAULT_ALPHABET, opts = {})
+    base58 = integer_to_base58(Digest::MD5.hexdigest(data).hex, alphabet)
+
+    opts.key?(:pad) && opts[:pad] \
+      ? base58.rjust(BASE58_LENGTH_MD5, alphabet_digits(alphabet)[0]) \
+      : base58
   end
 
   class << self
@@ -73,5 +82,4 @@ class Base58GMP
     alias_method :decode, :base58_to_integer
     alias_method :md5, :md5_base58
   end
-
 end

metadata

@@ -1,76 +1,139 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: base58_gmp
-version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 7
-  version: 0.0.7
+version: !ruby/object:Gem::Version
+  version: 1.0.0
 platform: ruby
-authors: 
+authors:
 - John Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-11-21 00:00:00 -08:00
-default_executable: 
-dependencies: []
-
-description: High speed Base58 encoding using GMP with MD5 support and transcoding between Flickr, Bitcoin and GMP alphabets.
+date: 2016-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gmp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !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::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: High speed Base58 encoding using GMP with MD5 support and transcoding
+  between Flickr, Bitcoin and GMP alphabets.
 email: johncwang@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README.rdoc
-files: 
-- CHANGELOG
-- MIT-LICENSE
-- README.rdoc
-- Rakefile
-- VERSION
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
 - base58_gmp.gemspec
 - lib/base58_gmp.rb
-- test/test_base58_gmp.rb
-- test/test_encode-decode-multi.rb
-- test/test_alphabets.rb
-has_rdoc: true
-homepage: http://rubygems.org/gems/base58_gmp
-licenses: []
-
+homepage: https://github.com/grokify/
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: High speed Base58 encoding using GMP with MD5 support
 test_files: []
-