base58 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ec389588355af34bfc88dd2fcf6e8c551461c546a8bf532413536885d6c0bf5e
+  data.tar.gz: 38755386088de0e65513c6ed888f4a6185cecc2168ba28145d207b4c71f80fb2
+SHA512:
+  metadata.gz: c5bfb539ec0b97fddb1c5ac616461959532fbfffdec768c30ba2c810795984a0a563c3f0fff83447ce1b0bb52d5dad1a6751905f9bee9a2d0bef13248a6b02e3
+  data.tar.gz: 4a2e0bbcbb5d1b95cd70b089080257d49666525d07666f415ae1641d047424cbb60096b1aa06f2dfd115ccd538b037337dae95d5a95877f707601f5b2141b192

data/CHANGELOG

@@ -1,11 +1,13 @@
-= 0.0.4
-- Gracefully deals with bad input. Thanks to isnotvalid on Github.
+= 0.2.0 [2017-01-05]
+- Bitcoin and Ripple alphabet support. Thanks to @joelnordell.
+- Binary encoding and decoding support. Thanks to @joelnordell.
 
-= 0.0.3
-- Removed accidental dependencies.
+= 0.1.0 [2010-02-05]
+- Better argument checking. Thanks to @jimeh.
+- Add `encode` and `decode` aliases.
 
-= 0.0.2
-- Fixed typos.
+= 0.0.4 [2009-11-27]
+- Gracefully deals with bad input. Thanks to @isnotvalid.
 
-= 0.0.1
-- Initial release.
+= 0.0.3 [2009-11-05]
+- Initial release.

data/MIT-LICENSE

@@ -1,5 +1,5 @@
-Copyright (c) 2009 Douglas F Shearer
- 
+Copyright (c) 2009 - 2017 Douglas F Shearer
+
 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
@@ -7,10 +7,10 @@ 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

data/README.md

@@ -0,0 +1,126 @@
+# Base58
+
+Ruby gem for encoding/decoding integers to/from Base58. Supports Flickr, Bitcoin, and Ripple alphabets.
+
+
+## Usage
+
+Converting an integer into a Base58 string:
+
+```ruby
+Base58.int_to_base58(12345) # => "4ER"
+```
+
+Converting a Base58 string to the represented integer:
+
+```ruby
+Base58.base58_to_int("A2Ph") # => 6639914
+```
+
+Converting a binary into a Base58 string:
+
+```ruby
+Base58.binary_to_base58("\xCE\xE99\x86".force_encoding('BINARY')) # => "6hKMCS"
+```
+
+Converting a Base58 string to the represented binary:
+
+```ruby
+Base58.base58_to_binary("6hKMCS") # => "\xCE\xE99\x86"
+```
+
+
+## Installation
+
+The package can be installed by adding scatter_swap to your list of dependencies in mix.exs:
+
+```bash
+gem install base58
+```
+
+Or add it to your Gemfile
+
+```ruby
+gem 'base58'
+```
+
+The run `bundle install`.
+
+
+## What is Base58?
+
+From [Wikipedia](https://en.wikipedia.org/wiki/Base58):
+
+> Base58 is a group of binary-to-text encoding schemes used to represent large integers as alphanumeric text. It is similar to Base64 but has been modified to avoid both non-alphanumeric characters and letters which might look ambiguous when printed. It is therefore designed for human users who manually enter the data, copying from some visual source, but also allows easy copy and paste because a double-click will usually select the whole string.
+
+Base58 alphabets are made up of the characters a-z, A-Z, and 0-9, with visually ambiguous characters (0, O, I, l) removed.
+
+
+## Supported Alphabets
+
+This library supports three of the most common Base58 alphabets, which have identical, but differently sorted characters.
+
+Alphabets can be selected by passing a symbol to the second argument of `Base58.int_to_base58` and `Base58.base58_to_int`.
+
+```ruby
+Base58.int_to_base58(12345, :bitcoin)
+```
+
+`:flickr` is the default if no second argument is passed.
+
+
+### Flickr
+
+Identifier: `:flickr`
+
+This is the default alphabet. Used to generate [Flickr short URLs](https://www.flickr.com/groups/api/discuss/72157616713786392/). The order of it's characters is numeric, lowercase-alpha, uppercase-alpha.
+
+    123456789abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ
+
+
+### Bitcoin
+
+Identifier: `:bitcoin`
+
+The alphabet used by the [Bitcoin](https://en.wikipedia.org/wiki/Bitcoin) protocol. The order of it's characters is numeric, uppercase-alpha, lowercase-alpha.
+
+    123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz
+
+
+### Ripple
+
+Identifier: `:ripple`
+
+The alphabet used by the [Ripple protocol](https://en.wikipedia.org/wiki/Ripple_(payment_protocol)). The order of the characters were chosen such that the [low values match the primitives of the protocol](http://bitcoin.stackexchange.com/questions/14124/why-is-ripples-base58-alphabet-so-weird).
+
+    rpshnaf39wBUDNEGHJKLM4PQRST7VWXYZ2bcdeCg65jkm8oFqi1tuvAxyz
+
+
+## Contributing
+
+Source repository is on [Github](https://github.com/dougal/base58), please file issues and pull requests there.
+
+
+## Documentation
+
+Documentation can be found online at [RubyDoc.info](http://www.rubydoc.info/github/dougal/base58).
+
+Alternatively, you can generate docs from the project root with:
+
+```bash
+rake rdoc
+```
+
+
+## Credits
+
+  * [Joel Nordell](https://github.com/joelnordell) for Bitcoin and Ripple alphabet support. Also binary encoding support.
+  * [Jim Myhrberg](https://github.com/jimeh) for argument checking and method aliases.
+
+
+## Copyright and Licence
+
+Copyright (c) 2009-2018, Douglas F Shearer.
+
+Base58 is licensed under the MIT Licence.
+

data/Rakefile

@@ -1,7 +1,7 @@
 require 'rake'
 require 'rake/testtask'
-require 'rake/rdoctask'
- 
+require 'rdoc/task'
+
 desc 'Default: run unit tests.'
 task :default => :test
 
@@ -17,7 +17,7 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'base58'
   rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('README.md')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
@@ -25,11 +25,11 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gemspec|
     gemspec.name = "base58"
-    gemspec.summary = "Base58 is a Ruby library for converting ints to and from base58."
+    gemspec.summary = "Base58 is a Ruby library for converting ints or binaries to and from base58."
     gemspec.description = gemspec.summary
     gemspec.email = "dougal.s@gmail.com"
     gemspec.homepage = "http://github.com/dougal/base58"
-    gemspec.authors = ["Douglas F Shearer"]  
+    gemspec.authors = ["Douglas F Shearer"]
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/base58.gemspec

@@ -1,48 +1,34 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+# stub: base58 0.2.0 ruby lib
 
 Gem::Specification.new do |s|
-  s.name = %q{base58}
-  s.version = "0.1.0"
+  s.name = "base58".freeze
+  s.version = "0.2.0"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Douglas F Shearer"]
-  s.date = %q{2010-02-05}
-  s.description = %q{Base58 is a Ruby library for converting ints to and from base58.}
-  s.email = %q{dougal.s@gmail.com}
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Douglas F Shearer".freeze]
+  s.date = "2018-01-05"
+  s.description = "Base58 is a Ruby library for converting ints or binaries to and from base58.".freeze
+  s.email = "dougal.s@gmail.com".freeze
   s.extra_rdoc_files = [
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
-    ".gitignore",
-     "CHANGELOG",
-     "MIT-LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "base58.gemspec",
-     "lib/base58.rb",
-     "test/test_base58.rb"
-  ]
-  s.homepage = %q{http://github.com/dougal/base58}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Base58 is a Ruby library for converting ints to and from base58.}
-  s.test_files = [
+    "CHANGELOG",
+    "MIT-LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "base58.gemspec",
+    "lib/base58.rb",
     "test/test_base58.rb"
   ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
+  s.homepage = "http://github.com/dougal/base58".freeze
+  s.rubygems_version = "2.7.3".freeze
+  s.summary = "Base58 is a Ruby library for converting ints or binaries to and from base58.".freeze
 end
 

data/lib/base58.rb

@@ -1,38 +1,61 @@
 # Base58
-# Copyright (c) 2009 Douglas F Shearer.
+# Copyright (c) 2009 - 2017 Douglas F Shearer.
 # http://douglasfshearer.com
 # Distributed under the MIT license as included with this plugin.
 
 class Base58
 
-  ALPHABET = "123456789abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ"
-  BASE = ALPHABET.length
+  # See https://en.wikipedia.org/wiki/Base58
+  ALPHABETS = {
+    flickr:  "123456789abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ", # This is the default
+    bitcoin: "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz", # Also used for IPFS
+    ripple:  "rpshnaf39wBUDNEGHJKLM4PQRST7VWXYZ2bcdeCg65jkm8oFqi1tuvAxyz"
+  }
+
+  # NOTE: If adding new alphabets of non-standard length, this should become a method.
+  BASE = ALPHABETS[:flickr].length
 
   # Converts a base58 string to a base10 integer.
-  def self.base58_to_int(base58_val)
+  def self.base58_to_int(base58_val, alphabet = :flickr)
+    raise ArgumentError, 'Invalid alphabet selection.' unless ALPHABETS.include?(alphabet)
     int_val = 0
     base58_val.reverse.split(//).each_with_index do |char,index|
-      raise ArgumentError, 'Value passed not a valid Base58 String.' if (char_index = ALPHABET.index(char)).nil?
+      raise ArgumentError, 'Value passed not a valid Base58 String.' if (char_index = ALPHABETS[alphabet].index(char)).nil?
       int_val += (char_index)*(BASE**(index))
     end
     int_val
   end
 
   # Converts a base10 integer to a base58 string.
-  def self.int_to_base58(int_val)
+  def self.int_to_base58(int_val, alphabet = :flickr)
     raise ArgumentError, 'Value passed is not an Integer.' unless int_val.is_a?(Integer)
+    raise ArgumentError, 'Invalid alphabet selection.' unless ALPHABETS.include?(alphabet)
     base58_val = ''
     while(int_val >= BASE)
       mod = int_val % BASE
-      base58_val = ALPHABET[mod,1] + base58_val
+      base58_val = ALPHABETS[alphabet][mod,1] + base58_val
       int_val = (int_val - mod)/BASE
     end
-    ALPHABET[int_val,1] + base58_val
+    ALPHABETS[alphabet][int_val,1] + base58_val
+  end
+
+  # Converts a ASCII-8BIT (binary) encoded string to a base58 string.
+  def self.binary_to_base58(binary_val, alphabet = :flickr)
+    raise ArgumentError, 'Value passed is not a String.' unless binary_val.is_a?(String)
+    raise ArgumentError, 'Value passed is not binary.' unless binary_val.encoding == Encoding::BINARY
+    raise ArgumentError, 'Invalid alphabet selection.' unless ALPHABETS.include?(alphabet)
+    int_to_base58(binary_val.bytes.inject{|a,b|(a<<8)+b}, alphabet)
   end
-  
+
+  # Converts a base58 string to an ASCII-8BIT (binary) encoded string.
+  def self.base58_to_binary(base58_val, alphabet = :flickr)
+    raise ArgumentError, 'Invalid alphabet selection.' unless ALPHABETS.include?(alphabet)
+    [base58_to_int(base58_val, alphabet).to_s(16)].pack('H*')
+  end
+
   class << self
     alias_method :encode, :int_to_base58
     alias_method :decode, :base58_to_int
   end
-  
+
 end

data/test/test_base58.rb

@@ -3,7 +3,9 @@ require 'base58'
 
 class TestBase58 < Test::Unit::TestCase
 
-EXAMPLES =  { "6hKMCS" => 3471391110,
+EXAMPLES =  {
+  :flickr => {
+              "6hKMCS" => 3471391110,
               "6hDrmR" => 3470152229,
               "6hHHZB" => 3470988633,
               "6hHKum" => 3470993664,
@@ -502,16 +504,93 @@ EXAMPLES =  { "6hKMCS" => 3471391110,
               "6hGMH7" => 3470806020,
               "6hGp5L" => 3470729904,
               "6hFfRV" => 3470507135,
-              "6hESHt" => 3470432637 }
+              "6hESHt" => 3470432637
+    },
+    :bitcoin => {
+              "6Hknds" => 3471391110,
+              "6HeSMr" => 3470152229,
+              "6Hiizc" => 3470988633,
+              "6HikVM" => 3470993664,
+              "6HmGgw" => 3471485480,
+              "6Hcrkr" => 3469844075
+    },
+    :ripple => {
+              "aHk8d1" => 3471391110,
+              "aHeSMi" => 3470152229,
+              "aH55zc" => 3470988633,
+              "aH5kVM" => 3470993664,
+              "aHmGgA" => 3471485480,
+              "aHciki" => 3469844075
+    }
+  }
 
-  def test_int_to_base58
-    EXAMPLES.each do |expected, integer|
+  BINARY_STRING_EXAMPLES = {
+    :flickr => {
+              "6hKMCS" => "\xCE\xE99\x86".force_encoding('BINARY'),
+              "6hDrmR" => "\xCE\xD6R%".force_encoding('BINARY'),
+              "6hHHZB" => "\xCE\xE3\x15Y".force_encoding('BINARY'),
+              "6hHKum" => "\xCE\xE3)\x00".force_encoding('BINARY'),
+              "6hLgFW" => "\xCE\xEA\xAA(".force_encoding('BINARY'),
+              "6hBRKR" => "\xCE\xD1\x9Ek".force_encoding('BINARY')
+    },
+    :bitcoin => {
+              "6Hknds" => "\xCE\xE99\x86".force_encoding('BINARY'),
+              "6HeSMr" => "\xCE\xD6R%".force_encoding('BINARY'),
+              "6Hiizc" => "\xCE\xE3\x15Y".force_encoding('BINARY'),
+              "6HikVM" => "\xCE\xE3)\x00".force_encoding('BINARY'),
+              "6HmGgw" => "\xCE\xEA\xAA(".force_encoding('BINARY'),
+              "6Hcrkr" => "\xCE\xD1\x9Ek".force_encoding('BINARY')
+    },
+    :ripple => {
+              "aHk8d1" => "\xCE\xE99\x86".force_encoding('BINARY'),
+              "aHeSMi" => "\xCE\xD6R%".force_encoding('BINARY'),
+              "aH55zc" => "\xCE\xE3\x15Y".force_encoding('BINARY'),
+              "aH5kVM" => "\xCE\xE3)\x00".force_encoding('BINARY'),
+              "aHmGgA" => "\xCE\xEA\xAA(".force_encoding('BINARY'),
+              "aHciki" => "\xCE\xD1\x9Ek".force_encoding('BINARY')
+    }
+  }
+
+  def test_binary_to_base58_all_alphabets
+    BINARY_STRING_EXAMPLES.each do |alphabet, examples|
+      examples.each do |expected, integer|
+        assert_equal expected, Base58.binary_to_base58(integer, alphabet)
+      end
+    end
+  end
+
+  def test_base58_to_binary_all_alphabets
+    BINARY_STRING_EXAMPLES.each do |alphabet, examples|
+      examples.each do |base_58, expected|
+        assert_equal expected, Base58.base58_to_binary(base_58, alphabet)
+      end
+    end
+  end
+
+  def test_int_to_base58_all_alphabets
+    EXAMPLES.each do |alphabet, examples|
+      examples.each do |expected, integer|
+        assert_equal expected, Base58.int_to_base58(integer, alphabet)
+      end
+    end
+  end
+
+  def test_base58_to_int_all_alphabets
+    EXAMPLES.each do |alphabet, examples|
+      examples.each do |base_58, expected|
+        assert_equal expected, Base58.base58_to_int(base_58, alphabet)
+      end
+    end
+  end
+
+  def test_int_to_base58_default_alphabet
+    EXAMPLES[:flickr].each do |expected, integer|
       assert_equal expected, Base58.int_to_base58(integer)
     end
   end  
 
-  def test_base58_to_int
-    EXAMPLES.each do |base_58, expected|
+  def test_base58_to_int_default_alphabet
+    EXAMPLES[:flickr].each do |base_58, expected|
       assert_equal expected, Base58.base58_to_int(base_58)
     end
   end

metadata

@@ -1,63 +1,52 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: base58
-version: !ruby/object:Gem::Version 
-  version: 0.1.0
+version: !ruby/object:Gem::Version
+  version: 0.2.0
 platform: ruby
-authors: 
+authors:
 - Douglas F Shearer
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-02-05 00:00:00 +00:00
-default_executable: 
+date: 2018-01-05 00:00:00.000000000 Z
 dependencies: []
-
-description: Base58 is a Ruby library for converting ints to and from base58.
+description: Base58 is a Ruby library for converting ints or binaries to and from
+  base58.
 email: dougal.s@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README.rdoc
-files: 
-- .gitignore
+extra_rdoc_files:
+- README.md
+files:
 - CHANGELOG
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - base58.gemspec
 - lib/base58.rb
 - test/test_base58.rb
-has_rdoc: true
 homepage: http://github.com/dougal/base58
 licenses: []
-
+metadata: {}
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_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"
-  version: 
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 2.7.3
 signing_key: 
-specification_version: 3
-summary: Base58 is a Ruby library for converting ints to and from base58.
-test_files: 
-- test/test_base58.rb
+specification_version: 4
+summary: Base58 is a Ruby library for converting ints or binaries to and from base58.
+test_files: []

data/.gitignore

@@ -1,3 +0,0 @@
-rdoc
-*.gem
-.DS_Store

data/README.rdoc

@@ -1,39 +0,0 @@
-= Base58
-
-If you find this library useful, please consider a donation to show your support!
-
-http://www.paypal.com/cgi-bin/webscr?cmd=_send-money
-  
-Paypal address: mailto:dougal.s@gmail.com
-
-=== Install
-  
-Base58 is hosted by http://gemcutter.com. Please make sure you have added them to your gem sources.
-
-  $ sudo gem install base58
-
-== Usage
-
-  require 'rubygems'
-  require 'base58'
-  
-  # Int to Base58
-  Base58.encode(12345) # => 4ER
-  
-  # Base58 to Int
-  Base58.decode('A2Ph') # => 6639914
-
-== RDoc Documentation
-
-You can view the rdoc documentation online[http://rdoc.info/projects/dougal/acts_as_indexed/].
-
-== Problems, Comments, Suggestions?
-
-All of the above are most welcome. mailto:dougal.s@gmail.com
-
-
-== Credits
-
-Douglas F Shearer - http://douglasfshearer.com
-
-Test examples courtesy Fraser Speirs' Base58Encoder Objective-C class, http://gist.github.com/101674.