globalid 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 452599d0406bd5fac9219973222368f7de7760a1
-  data.tar.gz: 0204d5224c0a299a96db75bf9d16beb39bbc9e26
+  metadata.gz: 82142d7e95abab35aacc3b0a9aed4e6d44308834
+  data.tar.gz: e21a62ca151b606aa6639d8cd58110d40e3de2ef
 SHA512:
-  metadata.gz: 12eff4acebdd4026d34cf7bd13a04670d0e6e8d639cb0102bb06e48e1171d75a161566b0fed51f0636daa67722f226374a76cd6b1a812d01fc23fdbdce5b695a
-  data.tar.gz: 1b8039217e3f7b7735a51fbe09159334192dedc424535c4738e16a5870db1480eb82941f50284b01c4dffca12ce85db2a06a77d29f17feadeba7fe250e9f4915
+  metadata.gz: 488500c69b84eafbfea3e445b8c96c01716438cdd1fa894d038869e823cbbca6ce84cbda829bc7a5f4722f42779d3c82aa6b12f10b5b4d7152e7120fc7611c2a
+  data.tar.gz: 5280cee5f515c54f3625bb407a297f48b685104895181d9b98ce282762aa18f0160e570aa6987e4cac756f741dac62fa738df4262f64477ae9c89a7a6ca551ce

data/lib/global_id/global_id.rb

@@ -8,19 +8,32 @@ class GlobalID
   class << self
     attr_accessor :app
 
-    def create(model)
-      new URI("gid://#{GlobalID.app}/#{model.class.name}/#{model.id}")
+    def create(model, options = {})
+      app = options.fetch :app, GlobalID.app
+      raise ArgumentError, "An app is required to create a GlobalID. Pass the :app option or set the default GlobalID.app." unless app
+      new URI("gid://#{app}/#{model.class.name}/#{model.id}")
     end
 
-    def find(gid)
-      parse(gid).try :find
+    def find(gid, options = {})
+      parse(gid).try(:find, options)
     end
 
     def parse(gid)
       gid.is_a?(self) ? gid : new(gid)
     rescue URI::Error
-      nil
+      parse_encoded_gid(gid)
     end
+
+    def parse_encoded_gid(gid)
+      new Base64.urlsafe_decode64(repad_gid(gid)) rescue nil
+    end
+    
+    private
+      # We removed the base64 padding character = during #to_param, now we're adding it back so decoding will work
+      def repad_gid(gid)
+        padding_chars = 4 - gid.length % 4
+        gid + '=' * padding_chars
+      end
   end
 
   attr_reader :uri, :app, :model_name, :model_id
@@ -29,8 +42,8 @@ class GlobalID
     extract_uri_components gid
   end
 
-  def find
-    model_class.find model_id
+  def find(options = {})
+    model_class.find model_id if find_allowed?(options[:only])
   end
 
   def model_class
@@ -45,6 +58,11 @@ class GlobalID
     @uri.to_s
   end
 
+  def to_param
+    # remove the = padding character for a prettier param -- it'll be added back in parse_encoded_gid
+    Base64.urlsafe_encode64(to_s).sub(/=+$/, '')
+  end
+
   private
     PATH_REGEXP = %r(\A/([^/]+)/([^/]+)\z)
 
@@ -61,4 +79,8 @@ class GlobalID
         raise URI::InvalidURIError, "Expected a URI like gid://app/Person/1234: #{@uri.inspect}"
       end
     end
+
+    def find_allowed?(only = nil)
+      only ? Array(only).any? { |c| model_class <= c } : true
+    end
 end

data/lib/global_id/locator.rb

@@ -2,13 +2,27 @@ class GlobalID
   module Locator
     class << self
       # Takes either a GlobalID or a string that can be turned into a GlobalID
-      def locate(gid)
-        GlobalID.find gid
+      #
+      # Options:
+      # * <tt>:only</tt> - A class, module or Array of classes and/or modules that are
+      #   allowed to be located.  Passing one or more classes limits instances of returned
+      #   classes to those classes or their subclasses.  Passing one or more modules in limits
+      #   instances of returned classes to those including that module.  If no classes or
+      #   modules match, +nil+ is returned.
+      def locate(gid, options = {})
+        GlobalID.find gid, options
       end
 
       # Takes either a SignedGlobalID or a string that can be turned into a SignedGlobalID
-      def locate_signed(sgid)
-        SignedGlobalID.find sgid
+      #
+      # Options:
+      # * <tt>:only</tt> - A class, module or Array of classes and/or modules that are
+      #   allowed to be located.  Passing one or more classes limits instances of returned
+      #   classes to those classes or their subclasses.  Passing one or more modules in limits
+      #   instances of returned classes to those including that module.  If no classes or
+      #   modules match, +nil+ is returned.
+      def locate_signed(sgid, options = {})
+        SignedGlobalID.find sgid, options
       end
     end
   end

data/lib/global_id/railtie.rb

@@ -2,19 +2,22 @@ begin
 require 'rails/railtie'
 rescue LoadError
 else
+require 'global_id'
 
 class GlobalID
+  # = GlobalID Railtie
   # Set up the signed GlobalID verifier and include Active Record support.
   class Railtie < Rails::Railtie # :nodoc:
-    initializer 'global_id' do
-      require 'global_id'
+    config.global_id = ActiveSupport::OrderedOptions.new
 
-      # TODO: expose as app config.global_id.app = 'name'
-      GlobalID.app = Rails.application.railtie_name.remove('_application')
+    initializer 'global_id' do |app|
 
-      # TODO: expose as app config.global_id.verifier = custom_verifier
-      config.after_initialize do |app|
-        SignedGlobalID.verifier = app.message_verifier(:signed_global_ids)
+      app.config.global_id.app ||= app.railtie_name.remove('_application')
+      GlobalID.app = app.config.global_id.app
+
+      config.after_initialize do
+        app.config.global_id.verifier ||= app.message_verifier(:signed_global_ids)
+        SignedGlobalID.verifier = app.config.global_id.verifier
       end
 
       ActiveSupport.on_load(:active_record) do

data/lib/global_id/signed_global_id.rb

@@ -15,4 +15,5 @@ class SignedGlobalID < GlobalID
   def to_s
     @sgid ||= self.class.verifier.generate(super)
   end
+  alias to_param to_s
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: globalid
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -14,28 +14,28 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: URIs for your models makes it easy to pass references around.
@@ -45,12 +45,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
+- lib/global_id.rb
 - lib/global_id/global_id.rb
 - lib/global_id/identification.rb
 - lib/global_id/locator.rb
 - lib/global_id/railtie.rb
 - lib/global_id/signed_global_id.rb
-- lib/global_id.rb
 - lib/globalid.rb
 homepage: http://www.rubyonrails.org
 licenses:
@@ -62,17 +62,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: 'Refer to any model with a URI: gid://app/class/id'