ulid-ruby 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f27c1f9f3fee9102f8c53b8ba84a345ddc549c09
-  data.tar.gz: 53310f5d7c8704de8655f05adb40b42ca59e3215
+  metadata.gz: c8396615efbd1df02008002962daa558d35055a4
+  data.tar.gz: f941d284e3b2016ff39beb8cabf1f8f278e7adf1
 SHA512:
-  metadata.gz: 6ea6845c4f1acd02f8252dd3e1918bc5d08039a0c44a923a6675ab096c5d800cda8e295383d81dc777d51645897754fb40e42d6be9a9744a9fe993ac555cf273
-  data.tar.gz: 8789d36731cddf75cdeb30c5c6176ef6f2b1c770c026c2019b2fcc747529c0cc38be89ca54ba3d7e1c7db1ed5bbe847004fd3db963737668618ab06090183f37
+  metadata.gz: dcf9a90061bb217099b723dc60045f709d261697f76deef858b5397def088b7ce0c21ae1ab33bf77aae9a08287223d5e6b7b6a519d0bc0aa5ba666b6561d510e
+  data.tar.gz: 2c09e47a2e235835fe1588dbeba56f7e89de60dfd00660a4ef348c6bd819df78d53ea4b5e73f5aa06a717fe3c3b15605d2e19fadfccf3a51e20330f5931d2da3

data/README.md

@@ -11,11 +11,13 @@
 
 # ULID
 
-A ULID is a "Universally Unique Lexicographically-sortable Identifier." This is a thin Ruby library for generating and parsing ULID values. This code is based on the original concept presented at https://github.com/alizain/ulid and in part based on code from the C# and Go projects at https://github.com/RobThree/NUlid and https://github.com/oklog/ulid  respectively.
+A ULID is a "Universally Unique Lexicographically-sortable Identifier." In its string form, a ULID is a compact, URL-friendly, Base32, unique ID string that encodes its time of creation and sorts according the time value it encodes. [Crockford's Base32](https://en.wikipedia.org/wiki/Base32#Crockford.27s_Base32) alphabet is used in encoding because it's easy to sort, unambiguous in its choice of letters, and like most Base32 encoding schemes is case-insensitive.
 
-**NOTE:** while the ULID values generated are compatible with the existing Ruby ULID library located at https://github.com/rafaelsales/ulid, this library is not code-compatible. I needed some additional features for a project and it was easier to just rebuild the functionality. May not be useful for anyone else but it's working for us in production at https://io.adafruit.com.
 
-In its string representation, it's a compact, URL-friendly, Base32, unique ID string that encodes its time of creation and sorts according the time value it encodes.
+This is a thin Ruby library for generating and parsing ULID values. This code is based on the original concept presented at https://github.com/alizain/ulid and in part based on code from the C# and Go projects at https://github.com/RobThree/NUlid and https://github.com/oklog/ulid respectively.
+
+**NOTE:** while the ULID values generated are compatible with the existing Ruby ULID library located at https://github.com/rafaelsales/ulid, this library is not code-compatible and it provides additinal features. While working on Adafruit IO, we needed to generate time-based, lexicographically sortable IDs _and_ we needed to be able to get the time value back out. At one point we used Cassandra and its native Time UUID type, but that didn't translate well to DynamoDB and its use of sort keys. ULIDs were found to be an acceptable choice and it was easier to just rebuild the existing functionality of [rafaelsales/ulid](https://github.com/rafaelsales/ulid) while adding parsing. This tool may not be useful for anyone else but it's working for us in production at https://io.adafruit.com.
+
 
 A ULID string looks like this:
 
@@ -33,6 +35,7 @@ The two parts of a ULID are **Timestamp** and **Entropy**.
      Timestamp            Entropy
        48bits             80bits
 
+
 ### Timestamp
 
 - Encoded in first 48 bits of ULID. In Base32 it's the first 10 ASCII characters.

data/lib/ulid.rb

@@ -19,8 +19,8 @@ module ULID
   # @example Generate a ULID
   #   ULID.new #=> #<ULID::Identifier:0x007f83f90aecc0 ....>
   #
-  def self.new
-    Identifier.new
+  def self.new(*args)
+    Identifier.new(*args)
   end
 
   # Get a new, randomized ULID string at the current time.

data/lib/ulid/version.rb

@@ -1,4 +1,4 @@
 module ULID
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end
 

data/ulid-ruby.gemspec

@@ -6,11 +6,16 @@ require 'ulid/version'
 Gem::Specification.new do |spec|
   spec.name          = "ulid-ruby"
   spec.version       = ULID::VERSION
-  spec.authors       = ["adam bachman"]
+  spec.authors       = ["Adam Bachman"]
   spec.email         = ["adam.bachman@gmail.com"]
 
-  spec.summary       = %q{ruby library providing support for universally unique lexicographically sortable identifiers}
-  spec.description   = %q{todo: write a longer description or delete this line.}
+  spec.summary       = %q{Ruby library providing support for Universally unique Lexicographically sortable IDentifiers}
+  spec.description   = %q{
+    Ruby library providing support for Universally unique Lexicographically
+    Sortable Identifiers. ULIDs are helpful in systems where you need to
+    generate ID values that are absolutely lexicographically sortable by time,
+    regardless of where they were generated.
+  }
   spec.homepage      = "https://github.com/abachman/ulid-ruby"
   spec.license       = "mit"
 

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: ulid-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
-- adam bachman
+- Adam Bachman
 autorequire: 
 bindir: exe
 cert_chain: []
@@ -66,7 +66,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: 'todo: write a longer description or delete this line.'
+description: "\n    Ruby library providing support for Universally unique Lexicographically\n
+  \   Sortable Identifiers. ULIDs are helpful in systems where you need to\n    generate
+  ID values that are absolutely lexicographically sortable by time,\n    regardless
+  of where they were generated.\n  "
 email:
 - adam.bachman@gmail.com
 executables: []
@@ -116,6 +119,6 @@ rubyforge_project:
 rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: ruby library providing support for universally unique lexicographically sortable
-  identifiers
+summary: Ruby library providing support for Universally unique Lexicographically sortable
+  IDentifiers
 test_files: []