sixarm_ruby_xid 3.4.1 → 3.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e04d2554f5e0367d86cef868442e8b447666d243
-  data.tar.gz: 3ce100cfeffc29ec7b550d4758730f1901c4d292
+  metadata.gz: 2f5b6519a9ac4fad507d584b4e79e3a8acd07052
+  data.tar.gz: ae6ae65995d3091262ce3444951ede3437335a4e
 SHA512:
-  metadata.gz: 251fa94b70e8f7cae7b5c401e9373d4de82ab423668e9b37ae73b94ddc12904e30a2d654fe56f0144c30c3347e8090e0ca30d8b82459a03ca8592c69d36bac21
-  data.tar.gz: 6c63340b6c8b3992c0c80d8abc9482361ac3e3af2e8db0c756149e30c19614f3cc52cb2220e771b19aad7fef556c73fc14b3068074d3ada879dd448d65d9df67
+  metadata.gz: ddce1beb9a306f2b3f5c95a836eff8aba4aa12a723f91102f6cde20cd353990dc028b6d06b3a5515f0738195dffa7fa1449a997080f0954b4deae3fe354203bf
+  data.tar.gz: 10012f4d5b4a0f1a51e16a35ab2a1c0f98dd80903cfff4cac3709c68bc13b5187f866e8f2015da018c85cdb639d764cce4f141c36aaa4f11ae39fc6eb616bb6a

data/Rakefile

@@ -3,8 +3,15 @@ require "rake"
 require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib' << 'test'
-  t.pattern = 'test/*.rb'
+  t.libs.push("lib", "test")
+  t.pattern = "test/**/*.rb"
 end
 
 task :default => [:test]
+task :default => [:test]
+task :default => [:test]
+task :default => [:test]
+task :default => [:test]
+task :default => [:test]
+task :default => [:test]
+task :default => [:test]

data/lib/sixarm_ruby_xid.rb

@@ -3,34 +3,4 @@
 Please see README
 =end
 
-require "securerandom"
-require "digest/sha2"
-
-class XID < String
-
-  def initialize(s = nil)
-    s and (XID.valid?(s) or raise ArgumentError)
-    super(s || SecureRandom.hex)
-  end
-
-  def valid?
-    XID.valid?(self)
-  end
-
-  def self.valid?(s)
-    !!(s && s.is_a?(String) && s.size == 32 && s =~ /\A[0-9a-f]{32}\Z/)
-  end
-
-  def digest
-    XID.digest(self)
-  end
-
-  def self.digest(s)
-    Digest::SHA256.new.update(s).to_s
-  end
-
-  def self.parse(s)
-    XID.new(s.downcase.gsub(/[^0-9a-f]/,'')[0...32])
-  end
-
-end
+require_relative "sixarm_ruby_xid/xid"

data/lib/sixarm_ruby_xid/xid.rb

@@ -0,0 +1,101 @@
+# -*- coding: utf-8 -*-
+=begin rdoc
+XID class.
+=end
+
+require "securerandom"
+require "digest/sha2"
+
+class XID < String
+
+  # Initialize a new XID, optionally with a string.
+  #
+  # Example:
+  #
+  #     xid = XID.new
+  #
+  #     xid = XID.new("4bb88af57d4ddc224fecad688442423d")
+  #
+  # Return: [XID] A new XID
+  #
+  def initialize(s = nil)
+    s and (XID.valid?(s) or raise ArgumentError)
+    super(s || SecureRandom.hex)
+  end
+
+  # Is this XID valid?
+  #
+  # Example:
+  #
+  #     xid = XID.new
+  #     xid.valid? #=> true
+  #
+  # Return: [true/false]
+  #
+  def valid?
+    XID.valid?(self)
+  end
+
+  # Is a given XID string valid?
+  #
+  # Example:
+  #
+  #     XID.valid?("4bb88af57d4ddc224fecad688442423d") #=> true
+  #     XID.valid?("hello") #=> false
+  #
+  # Return: [true/false]
+  #
+  def self.valid?(s)
+    !!(s && s.is_a?(String) && s.size == 32 && s =~ /\A[0-9a-f]{32}\Z/)
+  end
+
+  # Compute the XID digest of this XID.
+  #
+  # This is useful for proving knowledge of the XID,
+  # without needed to expose the XID.
+  #
+  # Example:
+  #
+  #     xid = XID.new("4bb88af57d4ddc224fecad688442423d")
+  #     xid.digest
+  #     #=> 4d648be0ca9dbb9e3a1b6b30b9d13c79ecbc0818dfca4125cc7961e32d61112c
+  #
+  def digest
+    XID.digest(self)
+  end
+
+  # Compute the XID digest of a given string.
+  #
+  # This is useful for proving knowledge of the XID,
+  # without needed to expose the XID.
+  #
+  # Example:
+  #
+  #     xid = XID.new("4bb88af57d4ddc224fecad688442423d")
+  #     xid.digest
+  #     #=> 4d648be0ca9dbb9e3a1b6b30b9d13c79ecbc0818dfca4125cc7961e32d61112c
+  #
+  def self.digest(s)
+    Digest::SHA256.new.update(s).to_s
+  end
+
+  # Parse a string to an XID.
+  #
+  # This does three steps:
+  #
+  #   * downcase
+  #   * delete any non-hex characters
+  #   * take the first 32 characters
+  #
+  # Example:
+  #
+  #     xid = XID.parse("***FFAD30A1-BE5E-B511-9ED8-976CAB0281B6***")
+  #     #=> "ffad30a1be5eb5119ed8976cab0281b6"
+  #
+  # Return: [XID] A new XID
+  #
+  def self.parse(s)
+    XID.new(s.downcase.gsub(/[^0-9a-f]/,'')[0...32])
+  end
+
+end

data/test/sixarm_ruby_xid_test.rb

@@ -1,120 +1,11 @@
 # -*- coding: utf-8 -*-
 require "minitest/autorun"
-Minitest::Test ||= MiniTest::Unit::TestCase
+require "coveralls"
 require "simplecov"
+Coveralls.wear!
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
 SimpleCov.start
 require "sixarm_ruby_xid"
-
-describe XID do
-
-  describe "#new" do
-
-    describe "with initialize defaults" do
-
-      it "is a string with the correct length and characters" do
-        xid = XID.new
-        xid.must_match /\A[0-9a-f]{32}\z/
-      end
-
-      it "is always different" do
-        seen = Set.new
-        99999.times.each{
-          xid = XID.new
-          seen.include?(xid).must_equal false
-          seen.add(xid)
-        }
-      end
-
-    end
-
-    describe "with valid initialize string" do
-
-      it "sets" do
-        s = "1cf2a839c0890bb9be7e9d56b7405a54"
-        xid = XID.new(s)
-        xid.must_equal(s)
-      end
-
-    end
-
-    describe "with invalid initialize string" do
-
-      it "raises" do
-        proc { XID.new("invalid") }.must_raise ArgumentError
-      end
-
-    end
-
-  end
-
-  describe ".valid" do
-
-    describe "with valid string" do
-      it "is true" do
-        xid = XID.new("c3d010bbfec046f59c7fe843d32dab32")
-        xid.valid?.must_equal true
-      end
-    end
-
-    describe "with invalid string" do
-      it "never gets called because it fails to create an xid" do
-        proc { XID.new("abc") }.must_raise ArgumentError
-      end
-    end
-
-  end
-
-  describe "#valid" do
-
-    describe "with valid string" do
-      it "is true" do
-        XID.valid?("c3d010bbfec046f59c7fe843d32dab32").must_be_same_as true
-      end
-    end
-
-    describe "with invalid string" do
-      it "is false" do
-        XID.valid?("abc").must_be_same_as false
-      end
-    end
-
-  end
-
-  describe "#digest" do
-
-    it "digests" do
-      xid  = XID.new
-      xid.digest.must_match /\A[0-9a-f]{64}\z/
-    end
-
-  end
-
-  describe ".digest" do
-
-    it "digests" do
-      XID.digest("foo").must_match /\A[0-9a-f]{64}\z/
-    end
-
-  end
-
-  describe ".parse" do
-
-    it "converts to lower case" do
-      XID.parse("C3D010BBFEC046F59C7FE843D32DAB32").must_equal "c3d010bbfec046f59c7fe843d32dab32"
-    end
-
-    it "deletes non-hex characters" do
-      XID.parse("!!c3d010bb-fec0-46f59c7f-e843d32dab32!!").must_equal "c3d010bbfec046f59c7fe843d32dab32"
-    end
-
-    it "chops at 32 characters" do
-      XID.parse("c3d010bbfec046f59c7fe843d32dab32aaaaaaaaa").must_equal "c3d010bbfec046f59c7fe843d32dab32"
-    end
-
-    it "raises if the string is invalid" do
-      proc { XID.parse("abc") }.must_raise ArgumentError
-    end
-
-  end
-
-end

data/test/sixarm_ruby_xid_test/xid_test.rb

@@ -0,0 +1,116 @@
+# -*- coding: utf-8 -*-
+require "sixarm_ruby_xid_test"
+
+describe XID do
+
+  describe "#new" do
+
+    describe "with initialize defaults" do
+
+      it "is a string with the correct length and characters" do
+        xid = XID.new
+        xid.must_match /\A[0-9a-f]{32}\z/
+      end
+
+      it "is always different" do
+        seen = Set.new
+        99999.times.each{
+          xid = XID.new
+          seen.include?(xid).must_equal false
+          seen.add(xid)
+        }
+      end
+
+    end
+
+    describe "with valid initialize string" do
+
+      it "sets" do
+        s = "1cf2a839c0890bb9be7e9d56b7405a54"
+        xid = XID.new(s)
+        xid.must_equal(s)
+      end
+
+    end
+
+    describe "with invalid initialize string" do
+
+      it "raises" do
+        proc { XID.new("invalid") }.must_raise ArgumentError
+      end
+
+    end
+
+  end
+
+  describe ".valid" do
+
+    describe "with valid string" do
+      it "is true" do
+        xid = XID.new("c3d010bbfec046f59c7fe843d32dab32")
+        xid.valid?.must_equal true
+      end
+    end
+
+    describe "with invalid string" do
+      it "never gets called because it fails to create an xid" do
+        proc { XID.new("abc") }.must_raise ArgumentError
+      end
+    end
+
+  end
+
+  describe "#valid" do
+
+    describe "with valid string" do
+      it "is true" do
+        XID.valid?("c3d010bbfec046f59c7fe843d32dab32").must_be_same_as true
+      end
+    end
+
+    describe "with invalid string" do
+      it "is false" do
+        XID.valid?("abc").must_be_same_as false
+      end
+    end
+
+  end
+
+  describe "#digest" do
+
+    it "digests" do
+      xid  = XID.new
+      xid.digest.must_match /\A[0-9a-f]{64}\z/
+    end
+
+  end
+
+  describe ".digest" do
+
+    it "digests" do
+      XID.digest("foo").must_match /\A[0-9a-f]{64}\z/
+    end
+
+  end
+
+  describe ".parse" do
+
+    it "converts to lower case" do
+      XID.parse("C3D010BBFEC046F59C7FE843D32DAB32").must_equal "c3d010bbfec046f59c7fe843d32dab32"
+    end
+
+    it "deletes non-hex characters" do
+      XID.parse("!!c3d010bb-fec0-46f59c7f-e843d32dab32!!").must_equal "c3d010bbfec046f59c7fe843d32dab32"
+    end
+
+    it "chops at 32 characters" do
+      XID.parse("c3d010bbfec046f59c7fe843d32dab32aaaaaaaaa").must_equal "c3d010bbfec046f59c7fe843d32dab32"
+    end
+
+    it "raises if the string is invalid" do
+      proc { XID.parse("abc") }.must_raise ArgumentError
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sixarm_ruby_xid
 version: !ruby/object:Gem::Version
-  version: 3.4.1
+  version: 3.4.2
 platform: ruby
 authors:
 - SixArm
@@ -44,24 +44,100 @@ cert_chain:
   2AC9FOGkybW6DJEFSFFMlNk0IILsa/gNp8ufGuTVLWF9FUUdMNK+TMbghnifT8/1
   n+ES/gQPOnvmVkLDGw==
   -----END CERTIFICATE-----
-date: 2015-07-08 00:00:00.000000000 Z
-dependencies: []
-description: XID generates a new string suitable for security, authentication, tracking,
-  etc.
+date: 2015-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.7.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.7.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '11'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: XID generates a new random id, suitable for foreign keys, security authentication,
+  unique tracking, etc.
 email: sixarm@sixarm.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gemtest"
-- CHANGES.md
-- CONTRIBUTING.md
-- LICENSE.md
-- README.md
 - Rakefile
-- VERSION
 - lib/sixarm_ruby_xid.rb
+- lib/sixarm_ruby_xid/xid.rb
 - test/sixarm_ruby_xid_test.rb
+- test/sixarm_ruby_xid_test/xid_test.rb
 homepage: http://sixarm.com/
 licenses:
 - BSD
@@ -89,7 +165,8 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: SixArm.com » Ruby » XID excellent identifier
+summary: 'SixArm.com » Ruby » XID: Xeno Identifier'
 test_files:
 - test/sixarm_ruby_xid_test.rb
+- test/sixarm_ruby_xid_test/xid_test.rb
 has_rdoc: true

data/CHANGES.md

@@ -1,13 +0,0 @@
-# Changes
-
-* 2015-07-07 3.4.1 Update gemspec to use file manifest
-* 2015-04-01 3.4.0 Add XID.parse and XID.valid?
-* 2015-02-12 3.3.0 Add XID.digest(s)
-* 2015-02-12 3.2.0 Add XID.new(s) to initialize with a given string.
-* 2015-02-12 3.1.0 Add #digest.
-* 2015-02-11 3.0.0 Upgrade to XID.
-* 2013-08-20 2.1.0 Add #next to enable using this as an enumeration.
-* 2013-08-18 2.0.0 Upgrade for Ruby 2.0.0; add .length and .choices methods.
-* 2012-03-21 1.4.0 Upgrade for Ruby 1.9.3, minitest/spec, and improved docs.
-* 2011-04-22 1.3.0 Update to 32 characters
-* 2011-04-21 1.2.2 End support for Ruby 1.8.6

data/CONTRIBUTING.md

@@ -1,28 +0,0 @@
-# Contributing
-
-Thank you for contributing!
-
-If you would like to contribute a donation, an easy way is to use PayPal to sixarm@sixarm.com.
-
-If you would like to contribute help, the next section is for you.
-
-
-## Contributing to the source
-
-We love pull requests for improvments to the source code and documentation.
-
-There are three easy steps:
-
-1. Fork the repo. 
-
-  * Before you do any work please run our existing tests to make sure the code runs cleanly.
-
-2. Work as you like. 
-
-   * Please create tests. This helps us know that all your code runs cleanly.
-
-3. Push to your fork and submit a pull request.
-
-   * We'll take a look as soon as we can; this is typically within a business day.
-
-Thank you again!

data/LICENSE.md

@@ -1,28 +0,0 @@
-# License
-
-You may choose any of these open source licenses:
-
-  * Apache License
-  * BSD License
-  * CreativeCommons License, Non-commercial Share Alike
-  * GNU Affero General Public License (AGPL)
-  * GNU General Public License Version (GPL)
-  * GNU Lesser General Public License (LGPL)
-  * MIT License
-  * Perl Artistic License
-  * Ruby License
-
-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.
-
-This license is for the included software that is created by SixArm.
-Some of the included software may have its own licenses, copyrights,
-authors, etc. and these may take precedence over the SixArm license.
-
-Copyright (c) Joel Parker Henderson

data/README.md

@@ -1,124 +0,0 @@
-# SixArm.com » Ruby » <br> XID excellent identifier
-
-[![Code Climate](https://codeclimate.com/github/SixArm/sixarm_ruby_xid.png)](https://codeclimate.com/github/SixArm/sixarm_ruby_xid)
-[![Build Status](https://travis-ci.org/SixArm/sixarm_ruby_xid.png)](https://travis-ci.org/SixArm/sixarm_ruby_xid)
-
-* Doc: <http://sixarm.com/sixarm_ruby_xid/doc>
-* Gem: <http://rubygems.org/gems/sixarm_ruby_xid>
-* Repo: <http://github.com/sixarm/sixarm_ruby_xid>
-* Email: Joel Parker Henderson, <joel@sixarm.com>
-
-
-## Introduction
-
-XID is an excellent identifier. The XID much like a UUID (Universally Unique Identifier) or GUID (Globally Unique Identifer).
-
-Example:
-
-    XID.new
-    #=> "90f44e35a062479289ff75ab2abc0ed3"
-
-What makes the XID excellent: a streamlined specfication, stronger security, speedier algorithms, and simple string comparisons.
-
-XID specification:
-
-  * 128 bit.
-  * Completely random and generated with a secure random generator.
-  * The string representation is entirely hexidecimal: digits 0-9 and lowercase a-f.
-
-For docs go to <http://sixarm.com/sixarm_ruby_xid/doc>
-
-Want to help? We're happy to get pull requests.
-
-
-## Install quickstart
-
-Install:
-
-    gem install sixarm_ruby_xid
-
-Bundler:
-
-    gem "sixarm_ruby_xid", ">=3.4.0", "<4"
-
-Require:
-
-    require "sixarm_ruby_xid"
-
-
-## Install with security (optional)
-
-To enable high security for all our gems:
-
-    wget http://sixarm.com/sixarm.pem
-    gem cert --add sixarm.pem
-    gem sources --add http://sixarm.com
-
-To install with high security:
-
-    gem install sixarm_ruby_xid --trust-policy HighSecurity
-
-
-## Details
-
-Methods:
-
-  * `XID.new`: create an XID and initialize to a random string.
-  * `XID.new(s)`: create an XID and initialize to a given string.
-  * `XID.valid?`: is this XIDa valid, i.e. the correct format?
-  * `XID#valid?(s)`: is a string a valid XID, i.e. the correct format?
-  * `XID#digest`: return a SHA256 digest as a 64-character string.
-  * `XID.digest(s)`: return a SHA256 digest as a 64-character string.
-  * `XID.parse(s)`: parse any string with enough data to a new XID.
-
-Notes:
-
-  * XID uses Ruby's SecureRandom methods for strong security.
-  * An XID is a Ruby string, so you can do any string methods on it.
-
-
-## UUID comparison
-
-The XID is much like a UUID:
-
-  * The XID and UUID are both 128 bit.
-  * The XID has one form. The UUID has multiple forms, known as variants and versions.
-  * The XID is completely random. The UUID may have non-random pieces, such as a MAC sequence, and a fixed bit for the variant and version.
-  * The XID specification requires the use of a secure random generator. The UUID has no guarantee, and some forms use predicatable sequences.
-  * The XID uses digits 0-9 and lowecase a-f. The UUID canoncical form uses dashes to separate sequencies, and may use uppercase or lowercase.
-
-To format an XID in the style of a UUID canonical representation:
-
-    xid = "90f44e35a062479289ff75ab2abc0ed3"
-    xid.sub(/(.{8})(.{4})(.{4})(.{16})/,"#$1-#$2-#$3-#$4")
-    #=> "90f44e35-a062-4792-89ff75ab2abc0ed3"
-
-Note: the result string is formatted like a UUID, but is not guaranteed to be valid UUID. This is because the XID is random, whereas the UUID specification requires a specific bit that indicates the UUID is random.
-
-To format a UUID in the style of an XID:
-
-    uuid = "14fFE137-2DB2-4A37-A2A4-A04DB1C756CA"
-    uuid.gsub(/-/,"").downcase
-    #=> ""14f7e1372db24a37a2a4a04db1c756ca"
-
-Note: the result string is formatted like a XID, but is not a valid XID. This is because there's no guarantee that the UUID was randomly generated using a secure random generator, and also because the UUID-4 specification requires a random UUID to set the third section's first digit to 4.
-
-
-## Unix tooling
-
-To generate an XID on a typical Unix system, one way is the hexdump command:
-
-    $ hexdump -n 16 -v -e '16/1 "%02x" "\n"' /dev/random
-    b29dd48b7040f788fd926ebf1f4eddd0
-
-To digest an XID by using SHA256:
-
-    $ echo -n "b29dd48b7040f788fd926ebf1f4eddd0" | shasum -a 256
-    afdfb0400e479285040e541ee87d9227d5731a7232ecfa5a07074ee0ad171c64
-
-
-## Database tooling
-
-To store an XID in a database, one way is using a string field that is 32 characters long.
-
-Some databases have specialize fields for 128 bit values, such as PostgreSQL and its UUID extensions. PostgreSQL states that a UUID field will accept a string that is lowercase and that omits dashes. PostgreSQL does not do any validity-checking on the UUID value. Thus it is viable to store an XID in a UUID field. Our team has a goal to create a PostgreSQL extension for the XID data type.

data/VERSION

@@ -1 +0,0 @@
-3.4.1