prefixed_ids 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e306f564334470e61f4181b498ace781d12d7d06d1763dfa72a1b8a5f464ecaf
-  data.tar.gz: 79118c8868ffd9244eccc1929aef505c73d79d85df8de9e1a3a07b07225e4c1a
+  metadata.gz: b5a5f802c0838ffb2538b43212061d569d0920356aed91e313865799c570d573
+  data.tar.gz: 6488ec773ddb3f15dfb48a9bc07ce4d39262feabb89eb8d3a5168e5ffdf52017
 SHA512:
-  metadata.gz: 66299e3e87f3495ddc7cb973da3cfa60104a6b1d0418f1a9c66e5ae9a2c0311689fa40aa0376e239ac8489a034a2b9fcb503e5aa11def29d818660615fbed958
-  data.tar.gz: 13f65f23972ca2a38038f00007802ce4d65b163e15b990b15d4b1fdb8f9421d032167722bf181810cfaa281527b321cd4fec0317855f68ca8726aad8461e3244
+  metadata.gz: 8b62b64c158bd670e814fbe92b7306a046b9f4e7933f494e5312ddb44f7a068fe9baaa579a11ad45b635aed0ec1dc83bec5b1699471ad550ed5e846a9125e446
+  data.tar.gz: a5233cee0e3fb432b1ff4e01bc60f6c33cc670df756bb09e315f26fd5d22c6b7325bc2fde0eb1369be21196d4b23e65850dadf10f0fc2ee927aa636b8067670b

data/README.md

@@ -13,6 +13,8 @@ user_12345abcd
 acct_23lksjdg3
 ```
 
+This gem works by hashing the record's original `:id` attribute using [`Hashids`](https://hashids.org/ruby/), which transforms numbers like 347 into a string like yr8. It uses the table's name and an optional additional salt to hash values, returning a string like `tablename_hashedvalue`.
+
 Inspired by [Stripe's prefixed IDs](https://stripe.com/docs/api) in their API.
 
 ## 🚀 Installation
@@ -50,13 +52,16 @@ User.prefix_id
 
 ##### Query by Prefixed ID
 
-To query using the prefixed ID, you can use either `find` or `find_by_prefix_id`:
+To query using the prefixed ID, you can use either `find`, `find_by_prefix_id`, or `find_by_prefix_id!`:
 
 ```ruby
 User.find("user_5vJjbzXq9KrLEMm32iAnOP0xGDYk6dpe")
 User.find_by_prefix_id("user_5vJjbzXq9KrLEMm32iAnOP0xGDYk6dpe")
 ```
 
+⚠️ Note that `find` still finds records by the primary key. Eg. `localhost/users/1` still works. 
+If you're targeting security issues by masking the ID, make sure to use `find_by_prefix_id` and [add a salt](#salt).
+
 We also override `to_param` by default so it'll be used in URLs automatically.
 
 To disable find and to_param overrides, simply pass in the options:
@@ -75,7 +80,7 @@ A salt is a secret value that makes it impossible to reverse engineer IDs. We re
 
 ```ruby
 # config/initializers/prefixed_ids.rb
-PrefixID.salt = "salt"
+PrefixedIds.salt = "salt"
 ```
 
 ###### Per Model Salt
@@ -103,7 +108,7 @@ You can customize the prefix, length, and attribute name for PrefixedIds.
 
 ```ruby
 class Account < ApplicationRecord
-  has_prefix_id :acct, minimum_length: 32, override_find: false, to_param: false, salt: ""
+  has_prefix_id :acct, minimum_length: 32, override_find: false, override_param: false, salt: ""
 end
 ```
 

data/lib/prefixed_ids/version.rb

@@ -1,3 +1,3 @@
 module PrefixedIds
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

data/lib/prefixed_ids.rb

@@ -61,6 +61,14 @@ module PrefixedIds
       def find_by_prefix_id!(id)
         find_by!(id: _prefix_id.decode(id))
       end
+
+      def decode_prefix_id(id)
+        _prefix_id.decode(id)
+      end
+
+      def decode_prefix_ids(ids)
+        ids.map { |id| decode_prefix_id(id) }
+      end
     end
 
     def prefix_id

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prefixed_ids
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Chris Oliver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-25 00:00:00.000000000 Z
+date: 2023-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.7
 signing_key:
 specification_version: 4
 summary: Prefixed IDs generates IDs with friendly prefixes for your models