sixarm_ruby_xid 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4eb5fb0a077dc0f211a20f10c65c65b5f6a7745e
+  data.tar.gz: d2f7fb50c2a0363c308e31d054338ccfc696fdb6
+SHA512:
+  metadata.gz: 63f43cd85cf5c7ae3a0a53dad2605494dece765a44bbaab1c0b5116d7dcf1a52360fa2d24c1ae20223a64962bafdde768cae64ab50b064ce80e5a0eb5a95437b
+  data.tar.gz: 7bbbf160d7499466bad2e12e4e52fc73a7be39184c884732a7c653797fd85263bb98126bef6a736723d60ea464f9b22fe7d268d5571bd7af5701b1fb32a89ac7

data/CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# 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/README.md

@@ -0,0 +1,113 @@
+# SixArm.com » Ruby » <br> SecureToken to generate a random string
+
+[![Code Climate](https://codeclimate.com/github/SixArm/xid.png)](https://codeclimate.com/github/SixArm/xid)
+[![Build Status](https://travis-ci.org/SixArm/xid.png)](https://travis-ci.org/SixArm/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 a secure identifier string. It is much like a UUID (Universally Unique Identifier). The XID has a more-specific specfication, faster creation algorithms, faster comparison algorithms, and is fully translatable to a UUID if necessary.
+
+XID specification:
+
+  * 128 bit.
+  * Completely random.
+  * Generated with a secure random generator.
+  * The string representation is entirely hexidecimal: digits 0-9 and lowercase a-f.
+
+Comparison with UUID:
+
+  * The XID and UUID are both 128 bit.
+  * The XID has one form. The UUID has multiple forms, called 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.
+  * The XID uses digits 0-9 and lowecase a-f. The UUID canoncical form uses dashes to separate sequencies, and can use uppercase or lowercase.
+
+Example:
+
+    XID.new
+    #=> "90f44e35a062479289ff75ab2abc0ed3"
+
+
+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.0.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
+
+This uses Ruby's SecureRandom methods for strong security.
+
+SecureToken is a string, so you can do any string methods on it.
+
+
+## Changes
+
+* 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
+
+
+## License
+
+You may choose any of these open source licenses:
+
+  * Apache License
+  * BSD License
+  * CreativeCommons License, Non-commercial Share Alike
+  * GNU General Public License Version 2 (GPL 2)
+  * 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 do take precedence over the SixArm license.
+
+Copyright (c) 2005-2015 Joel Parker Henderson

data/Rakefile

@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/*.rb'
+end
+
+task :default => [:test]

data/VERSION

@@ -0,0 +1 @@
+3.0.0

data/lib/sixarm_ruby_xid.rb

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+=begin rdoc
+Please see README
+=end
+
+require 'securerandom'
+
+class XID < String
+
+  def initialize
+    super(SecureRandom.hex(16))
+  end
+
+end

data/test/sixarm_ruby_xid_test.rb

@@ -0,0 +1,28 @@
+# -*- coding: utf-8 -*-
+require 'minitest/autorun'
+Minitest::Test ||= MiniTest::Unit::TestCase
+require 'simplecov'
+SimpleCov.start
+require 'xid'
+
+describe XID do
+
+  describe "#new" do
+
+    it "is a string with the correct length and characters" do
+      xid = XID.new
+      xid.must_match /\A[0-9a-z]{32}\Z/
+    end
+
+    it "is always different" do
+      seen = Set.new
+      999999.times.each{
+        xid = XID.new
+        seen.include?(xid).must_equal false
+        seen.add(xid)
+      }
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: sixarm_ruby_xid
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+platform: ruby
+authors:
+- SixArm
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDbDCCAlSgAwIBAgIBATANBgkqhkiG9w0BAQUFADA+MQ8wDQYDVQQDDAZzaXhh
+  cm0xFjAUBgoJkiaJk/IsZAEZFgZzaXhhcm0xEzARBgoJkiaJk/IsZAEZFgNjb20w
+  HhcNMTQwMzEzMDQyMjE4WhcNMTUwMzEzMDQyMjE4WjA+MQ8wDQYDVQQDDAZzaXhh
+  cm0xFjAUBgoJkiaJk/IsZAEZFgZzaXhhcm0xEzARBgoJkiaJk/IsZAEZFgNjb20w
+  ggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC5MZYB72Amo9DyeqBdJeEx
+  r4togM0+diNuL1nCH2FSO/+LX5L9mTPEEW5gexYCasmlOfmk5255EToJNtu1JUM/
+  dMqUbNS5LZ1srFVcyDzIe/wQ9f2OSmb+lAGmlnFLfYSpduMv9fPNISlcs5nFYSR9
+  mpS0kTWcXQPLNDl2cfnkYYjDsuyJ8FmDyG7TTF0c4OWJNLxNDE8To2n8GmmDSwr3
+  0K71F278CJlFoIaSSjnhKxkH8/l+z/Vs58KkjX/7M6nwNgNZMQaFBIO02UDtCi2F
+  ICVtDuWdK0YLv3JnIzvSQPQsfArrw2s8RVKjXlelPMeHJIcCEZcS4K6HIg7vQCkP
+  AgMBAAGjdTBzMAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBQrbLvF
+  TNv9r72z+hpCl3BkTPbzwTAcBgNVHREEFTATgRFzaXhhcm1Ac2l4YXJtLmNvbTAc
+  BgNVHRIEFTATgRFzaXhhcm1Ac2l4YXJtLmNvbTANBgkqhkiG9w0BAQUFAAOCAQEA
+  H08J7cTJyfm4mXpdM0FFr/f/syQSl2ymJWtcosuKA79A/vYMZ+n9B1gpuJmegjNt
+  lmYByeU50jJJ7JNdkvkTagHCZaxtzclWx6AR5gTd8V/sBKbTWtHe72pOWz/stQs2
+  xD8tQZvdAuBtRXx4ys6e3vigvYjdmTHUR9tT/NGCwmWj7KTk3mwNKBmuQGWTVWrV
+  h6r4cFMt3X5Zu+euYxHqDuwWyub9hp4s30/ea38CoYNdIZcSFtpGuvhwVDU0x5dg
+  sWRVEyjnjnNuAeLP9zv43IDXjS22L2efhap7IOinYjcecpfXJgQaU+6BFAY4sdkQ
+  S1STYSfs3qySBxxAeEyZTw==
+  -----END CERTIFICATE-----
+date: 2015-02-11 00:00:00.000000000 Z
+dependencies: []
+description: XID.new generates a new string suitable for security, authentication,
+  tracking, etc.
+email: sixarm@sixarm.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gemtest"
+- CONTRIBUTING.md
+- README.md
+- Rakefile
+- VERSION
+- lib/sixarm_ruby_xid.rb
+- test/sixarm_ruby_xid_test.rb
+homepage: http://sixarm.com/
+licenses:
+- BSD
+- GPL
+- MIT
+- PAL
+- Various
+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.4.5
+signing_key: 
+specification_version: 4
+summary: SixArm.com » Ruby » XID secure identifier
+test_files:
+- test/sixarm_ruby_xid_test.rb
+has_rdoc: true