globalid 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 67df636d5882a415108166f9dcb39e6f92a7f5e7
-  data.tar.gz: 5fe46ff2503cf37219c26e94e42187299523996c
+SHA256:
+  metadata.gz: 4cfa513116ef143c878f8b6eefc242f9df668572c0ed3f3b4f5f5f87736e143f
+  data.tar.gz: 72e073ae2eec42a6038cda7bbf77bbeed3f72899eafe801bac1aca6c6bb24079
 SHA512:
-  metadata.gz: f9b26b5c02b4102befdd6da829ca5e56fa0eeec953e755c2a69f77d563b3b0355c9d8ed0477e22e6230a99d851d5878c0d31b58eafc08bdcee7a8a54cd67526e
-  data.tar.gz: c27ffc78e6679bd1c799df5c72494d77ca3106ce9c44eff7004c9e38da7749651041cf03958437f5ec41d6c3499174cc87753486193a494a4f13aaa884e233c3
+  metadata.gz: f3527628dfa02f3099b1c4ac0f99260f9187d83702e2cca96fab261592466fba1caa82e3dc936a54660ac9c4c0a2da087ebdabfb0d21444928979dd5cc983a34
+  data.tar.gz: 460c643ca0f4d0a51dc9e218da9a891f05904d75e9106692d38a46fa7cc9ad1ace229e5bce37703e2f4e62aa049246628d61de9be444a32cd2a3e6a1452d0ff3

data/README.md

@@ -24,17 +24,17 @@ Mix `GlobalID::Identification` into any model with a `#find(id)` class method.
 Support is automatically included in Active Record.
 
 ```ruby
->> person_gid = Person.find(1).to_global_id
-=> #<GlobalID ...
+person_gid = Person.find(1).to_global_id
+# => #<GlobalID ...
 
->> person_gid.uri
-=> #<URI ...
+person_gid.uri
+# => #<URI ...
 
->> person_gid.to_s
-=> "gid://app/Person/1"
+person_gid.to_s
+# => "gid://app/Person/1"
 
->> GlobalID::Locator.locate person_gid
-=> #<Person:0x007fae94bf6298 @id="1">
+GlobalID::Locator.locate person_gid
+# => #<Person:0x007fae94bf6298 @id="1">
 ```
 
 ### Signed Global IDs
@@ -42,79 +42,125 @@ Support is automatically included in Active Record.
 For added security GlobalIDs can also be signed to ensure that the data hasn't been tampered with.
 
 ```ruby
->> person_sgid = Person.find(1).to_signed_global_id
-=> #<SignedGlobalID:0x007fea1944b410>
+person_sgid = Person.find(1).to_signed_global_id
+# => #<SignedGlobalID:0x007fea1944b410>
 
->> person_sgid = Person.find(1).to_sgid
-=> #<SignedGlobalID:0x007fea1944b410>
+person_sgid = Person.find(1).to_sgid
+# => #<SignedGlobalID:0x007fea1944b410>
 
->> person_sgid.to_s
-=> "BAhJIh5naWQ6Ly9pZGluYWlkaS9Vc2VyLzM5NTk5BjoGRVQ=--81d7358dd5ee2ca33189bb404592df5e8d11420e"
-
->> GlobalID::Locator.locate_signed person_sgid
-=> #<Person:0x007fae94bf6298 @id="1">
+person_sgid.to_s
+# => "BAhJIh5naWQ6Ly9pZGluYWlkaS9Vc2VyLzM5NTk5BjoGRVQ=--81d7358dd5ee2ca33189bb404592df5e8d11420e"
 
+GlobalID::Locator.locate_signed person_sgid
+# => #<Person:0x007fae94bf6298 @id="1">
 ```
-You can even bump the security up some more by explaining what purpose a Signed Global ID is for.
-In this way evildoers can't reuse a sign-up form's SGID on the login page. For example.
 
-```ruby
->> signup_person_sgid = Person.find(1).to_sgid(for: 'signup_form')
-=> #<SignedGlobalID:0x007fea1984b520
-
->> GlobalID::Locator.locate_signed(signup_person_sgid.to_s, for: 'signup_form')
-=> #<Person:0x007fae94bf6298 @id="1">
-```
+**Expiration**
 
-You can also have SGIDs that expire some time in the future. Useful if there's a resource,
+Signed Global IDs can expire some time in the future. This is useful if there's a resource
 people shouldn't have indefinite access to, like a share link.
 
 ```ruby
->> expiring_sgid = Document.find(5).to_sgid(expires_in: 2.hours, for: 'sharing')
-=> #<SignedGlobalID:0x008fde45df8937 ...>
+expiring_sgid = Document.find(5).to_sgid(expires_in: 2.hours, for: 'sharing')
+# => #<SignedGlobalID:0x008fde45df8937 ...>
 
 # Within 2 hours...
->> GlobalID::Locator.locate_signed(expiring_sgid.to_s, for: 'sharing')
-=> #<Document:0x007fae94bf6298 @id="5">
+GlobalID::Locator.locate_signed(expiring_sgid.to_s, for: 'sharing')
+# => #<Document:0x007fae94bf6298 @id="5">
 
 # More than 2 hours later...
->> GlobalID::Locator.locate_signed(expiring_sgid.to_s, for: 'sharing')
-=> nil
+GlobalID::Locator.locate_signed(expiring_sgid.to_s, for: 'sharing')
+# => nil
+```
 
->> explicit_expiring_sgid = SecretAgentMessage.find(5).to_sgid(expires_at: Time.now.advance(hours: 1))
-=> #<SignedGlobalID:0x008fde45df8937 ...>
+**In Rails, an auto-expiry of 1 month is set by default.** You can alter that deal
+in an initializer with:
 
-# 1 hour later...
->> GlobalID::Locator.locate_signed explicit_expiring_sgid.to_s
-=> nil
+```ruby
+# config/initializers/global_id.rb
+Rails.application.config.global_id.expires_in = 3.months
+```
+
+You can assign a default SGID lifetime like so:
 
+```ruby
+SignedGlobalID.expires_in = 1.month
+```
+
+This way any generated SGID will use that relative expiry.
+
+It's worth noting that _expiring SGIDs are not idempotent_ because they encode the current timestamp; repeated calls to `to_sgid` will produce different results. For example, in Rails
+
+```ruby
+Document.find(5).to_sgid.to_s == Document.find(5).to_sgid.to_s
+# => false
+```
+
+You need to explicitly pass `expires_in: nil` to generate a permanent SGID that will not expire,
+
+```ruby
 # Passing a false value to either expiry option turns off expiration entirely.
->> never_expiring_sgid = Document.find(5).to_sgid(expires_in: nil)
-=> #<SignedGlobalID:0x008fde45df8937 ...>
+never_expiring_sgid = Document.find(5).to_sgid(expires_in: nil)
+# => #<SignedGlobalID:0x008fde45df8937 ...>
 
 # Any time later...
->> GlobalID::Locator.locate_signed never_expiring_sgid
-=> #<Document:0x007fae94bf6298 @id="5">
+GlobalID::Locator.locate_signed never_expiring_sgid
+# => #<Document:0x007fae94bf6298 @id="5">
 ```
 
+It's also possible to pass a specific expiry time
+
+```ruby
+explicit_expiring_sgid = SecretAgentMessage.find(5).to_sgid(expires_at: Time.now.advance(hours: 1))
+# => #<SignedGlobalID:0x008fde45df8937 ...>
+
+# 1 hour later...
+GlobalID::Locator.locate_signed explicit_expiring_sgid.to_s
+# => nil
+```
 Note that an explicit `:expires_at` takes precedence over a relative `:expires_in`.
 
-You can assign a default SGID lifetime like so:
+**Purpose**
+
+You can even bump the security up some more by explaining what purpose a Signed Global ID is for.
+In this way evildoers can't reuse a sign-up form's SGID on the login page. For example.
 
 ```ruby
-SignedGlobalID.expires_in = 1.month
+signup_person_sgid = Person.find(1).to_sgid(for: 'signup_form')
+# => #<SignedGlobalID:0x007fea1984b520
+
+GlobalID::Locator.locate_signed(signup_person_sgid.to_s, for: 'signup_form')
+# => #<Person:0x007fae94bf6298 @id="1">
 ```
 
-This way any generated SGID will use that relative expiry.
+### Locating many Global IDs
 
-In Rails, an auto-expiry of 1 month is set by default. You can alter that deal
-in an initializer with:
+When needing to locate many Global IDs use `GlobalID::Locator.locate_many` or `GlobalID::Locator.locate_many_signed` for Signed Global IDs to allow loading
+Global IDs more efficiently.
+
+For instance, the default locator passes every `model_id` per `model_name` thus
+using `model_name.where(id: model_ids)` versus `GlobalID::Locator.locate`'s `model_name.find(id)`.
+
+In the case of looking up Global IDs from a database, it's only necessary to query
+once per `model_name` as shown here:
 
 ```ruby
-# config/initializers/global_id.rb
-Rails.application.config.global_id.expires_in = 3.months
+gids = users.concat(people).sort_by(&:id).map(&:to_global_id)
+# => [#<GlobalID:0x00007ffd6a8411a0 @uri=#<URI::GID gid://app/User/1>>,
+#<GlobalID:0x00007ffd675d32b8 @uri=#<URI::GID gid://app/Student/1>>,
+#<GlobalID:0x00007ffd6a840b10 @uri=#<URI::GID gid://app/User/2>>,
+#<GlobalID:0x00007ffd675d2c28 @uri=#<URI::GID gid://app/Student/2>>,
+#<GlobalID:0x00007ffd6a840480 @uri=#<URI::GID gid://app/User/3>>,
+#<GlobalID:0x00007ffd675d2598 @uri=#<URI::GID gid://app/Student/3>>]
+
+GlobalID::Locator.locate_many gids
+# SELECT "users".* FROM "users" WHERE "users"."id" IN ($1, $2, $3)  [["id", 1], ["id", 2], ["id", 3]]
+# SELECT "students".* FROM "students" WHERE "students"."id" IN ($1, $2, $3)  [["id", 1], ["id", 2], ["id", 3]]
+# => [#<User id: 1>, #<Student id: 1>, #<User id: 2>, #<Student id: 2>, #<User id: 3>, #<Student id: 3>]
 ```
 
+Note the order is maintained in the returned results.
+
 ### Custom App Locator
 
 A custom locator can be set for an app by calling `GlobalID::Locator.use` and providing an app locator to use for that app.

data/lib/global_id/fixture_set.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class GlobalID
+  module FixtureSet
+    def signed_global_id(fixture_set_name, label, column_type: :integer, **options)
+      identifier = identify(label, column_type)
+      model_name = default_fixture_model_name(fixture_set_name)
+      uri = URI::GID.build([GlobalID.app, model_name, identifier, {}])
+
+      SignedGlobalID.new(uri, **options)
+    end
+  end
+end

data/lib/global_id/global_id.rb

@@ -63,6 +63,11 @@ class GlobalID
   def ==(other)
     other.is_a?(GlobalID) && @uri == other.uri
   end
+  alias_method :eql?, :==
+
+  def hash
+    self.class.hash | @uri.hash
+  end
 
   def to_param
     # remove the = padding character for a prettier param -- it'll be added back in parse_encoded_gid

data/lib/global_id/identification.rb

@@ -1,11 +1,7 @@
-require 'active_support/concern'
-
 class GlobalID
   module Identification
-    extend ActiveSupport::Concern
-
     def to_global_id(options = {})
-      @global_id ||= GlobalID.create(self, options)
+      GlobalID.create(self, options)
     end
     alias to_gid to_global_id
 

data/lib/global_id/railtie.rb

@@ -5,6 +5,7 @@ else
 require 'global_id'
 require 'active_support'
 require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/integer/time'
 
 class GlobalID
   # = GlobalID Railtie
@@ -14,14 +15,16 @@ class GlobalID
     config.eager_load_namespaces << GlobalID
 
     initializer 'global_id' do |app|
+      default_expires_in = 1.month
+      default_app_name = app.railtie_name.remove('_application').dasherize
 
-      app.config.global_id.app ||= app.railtie_name.remove('_application').dasherize
-      GlobalID.app = app.config.global_id.app
-
-      app.config.global_id.expires_in ||= 1.month
-      SignedGlobalID.expires_in = app.config.global_id.expires_in
+      GlobalID.app = app.config.global_id.app ||= default_app_name
+      SignedGlobalID.expires_in = app.config.global_id.fetch(:expires_in, default_expires_in)
 
       config.after_initialize do
+        GlobalID.app = app.config.global_id.app ||= default_app_name
+        SignedGlobalID.expires_in = app.config.global_id.fetch(:expires_in, default_expires_in)
+
         app.config.global_id.verifier ||= begin
           GlobalID::Verifier.new(app.key_generator.generate_key('signed_global_ids'))
         rescue ArgumentError
@@ -34,6 +37,11 @@ class GlobalID
         require 'global_id/identification'
         send :include, GlobalID::Identification
       end
+
+      ActiveSupport.on_load(:active_record_fixture_set) do
+        require 'global_id/fixture_set'
+        send :extend, GlobalID::FixtureSet
+      end
     end
   end
 end

data/lib/global_id/uri/gid.rb

@@ -173,5 +173,9 @@ module URI
       end
   end
 
-  @@schemes['GID'] = GID
+  if respond_to?(:register_scheme)
+    register_scheme('GID', GID)
+  else
+    @@schemes['GID'] = GID
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: globalid
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-24 00:00:00.000000000 Z
+date: 2021-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -47,6 +47,7 @@ files:
 - MIT-LICENSE
 - README.md
 - lib/global_id.rb
+- lib/global_id/fixture_set.rb
 - lib/global_id/global_id.rb
 - lib/global_id/identification.rb
 - lib/global_id/locator.rb
@@ -67,15 +68,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: 'Refer to any model with a URI: gid://app/class/id'