token_checksum 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35778c0c9930ef13a6ac8031d9e062ba7743448ecbd41688fc4d23285c28090e
-  data.tar.gz: 136963fe3894f9fd3aab73329ed6156404ef656551083706c7dc30ef59b1d616
+  metadata.gz: 5d02519bdc03d7564d8124e87f6edf9cc4a08224106a4ae61aec54544359bccf
+  data.tar.gz: 761527a34c232bef1dd5ed5cda3423dbc9bd1c2f9adb63517e06c9adb3e92488
 SHA512:
-  metadata.gz: 87107d68ddbcc35b987ca39b76e369932bb5b670d56f7638773d6770432eb4a0cd55e39c6e6c7644939c0661de7489b0d18fd9335a9fb4349f822898d75645d9
-  data.tar.gz: f93b72fdd81da6fb06aac30fefe81c9192e125725ce0b9d23878d328e53872067986cfe6144ac85d5e34907c0aa5956c25aff622af2c635cffb0f22d4e01be6a
+  metadata.gz: 68732d45c34fee24ad191a1176cb7de463ec4a944d7807241b20b5720c715f69596bd4fdae2bde9eaf0cf3a63a66d823ee01645c84b1bba88ef1e0d9a5d53c5e
+  data.tar.gz: ce6e771a605a4cf88dbbd5939720a0cfa98a793f41b5e44ca3fe4f1da18bc1f492c2e693dee2abb58cb146b015c56458cc5f82aa37c2152f227a128c9a5f8900

data/README.md

@@ -36,6 +36,16 @@ TokenChecksum.valid?(token_two, secret: "foo")
 
 TokenChecksum.valid?(token_two, secret: "bleh")
 # FALSE
+
+# can also validate on prefix
+TokenChecksum.valid?(token_one)
+# true
+
+TokenChecksum.valid?(token_one, valid_prefixes: ["xoxo"])
+# true
+
+TokenChecksum.valid?(token_one, valid_prefixes: ["abcd"])
+# FALSE
 ```
 
 ## License

data/lib/token_checksum/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TokenChecksum
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/token_checksum.rb

@@ -16,20 +16,23 @@ module TokenChecksum
 
   class << self
     def generate(prefix, secret: "")
-      suffix = (random_base62 + random_base62)[0...30]
+      suffix = random_token
       first_part = "#{prefix}_#{suffix}"
       checksum = generate_checksum("#{first_part}#{secret}")
       "#{first_part}#{checksum}"
     end
 
-    def valid?(token, secret: "")
+    def valid?(token, valid_prefixes: [], secret: "")
       return false if token.empty?
 
-      provided_checksum = token[-6..-1]
+      provided_prefix = prefix(token)
+      return false if !valid_prefixes.empty? && !valid_prefixes.include?(provided_prefix)
+
+      provided_checksum = checksum(token)
       return false if provided_checksum.empty?
 
       # This is the token without the final checksum
-      checksumless_string = token[0..-7]
+      checksumless_string = wo_checksum(token)
       return false if checksumless_string.empty?
 
       calculated_checksum = generate_checksum("#{checksumless_string}#{secret}")
@@ -37,6 +40,22 @@ module TokenChecksum
       SecureCompare.compare(calculated_checksum, provided_checksum)
     end
 
+    def prefix(token)
+      token[0...token.index("_")]
+    end
+
+    def checksum(token)
+      token[-6..-1]
+    end
+
+    def wo_checksum(token)
+      token[0..-7]
+    end
+
+    private def random_token
+      (random_base62 + random_base62)[0...30]
+    end
+
     private def generate_checksum(string)
       checksum = Zlib.crc32(string)
       Base62.encode(checksum, min_length: 6)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: token_checksum
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Garen J. Torikian