globalid 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3de819ff2f02d59893c4a4fd90539488ff7179e9
-  data.tar.gz: e2e16efbcff7df37e004aa3102fb4f0fafa52dfa
+!binary "U0hBMQ==":
+  metadata.gz: d325de1fd4887ed3e91ebb2ec6d58d4ed0d552d0
+  data.tar.gz: e7d0091c1cc92b20c682093faa424b528c32940f
 SHA512:
-  metadata.gz: 6c822d9f0ba64363ed40ecea47d85e36bd16a84c4fb171cc547dc510c886143217c58c403a5d8f8c37c259f60c34f631761c50ed005f9d7e9cfc57c3b0098ff8
-  data.tar.gz: 00d2640d7e991dcee6fa4f69ea2d56a1aeae047aa0505864dea88b7f2de9aa4ef0892357c53902a433846750db5899209f1d5cfa7bea6881780da909fed90384
+  metadata.gz: 98f92c4c3fa1e9a127abcc44f1eb51ca529f5388dec8529aacce43c18a9fc9cc9aa947854620abe0bd609ebb46dfcee22a1d81089bffb83d106d29967c457147
+  data.tar.gz: 989269225c2d49d7a25cb6bb5e7f9bca1087268d5688d27558bb8d2fa1d1062360bbf72f2d8004cb764c886217f4d6a7eed73da1e0a1fe190b1ba250f1026bcb

data/lib/global_id/global_id.rb

@@ -6,7 +6,7 @@ require 'uri'
 
 class GlobalID
   class << self
-    attr_accessor :app
+    attr_reader :app
 
     def create(model, options = {})
       app = options.fetch :app, GlobalID.app
@@ -15,7 +15,7 @@ class GlobalID
     end
 
     def find(gid, options = {})
-      parse(gid).try(:find, options)
+      parse(gid, options).try(:find, options)
     end
 
     def parse(gid, options = {})
@@ -24,6 +24,17 @@ class GlobalID
       parse_encoded_gid(gid, options)
     end
 
+    def app=(app)
+      @app = validate_app(app)
+    end
+
+    def validate_app(app)
+      URI.parse('gid:///').hostname = app
+    rescue URI::InvalidComponentError
+      raise ArgumentError, 'Invalid app name. ' \
+        'App names must be valid URI hostnames: alphanumeric and hyphen characters only.'
+    end
+
     private
       def parse_encoded_gid(gid, options)
         new(Base64.urlsafe_decode64(repad_gid(gid)), options) rescue nil
@@ -43,7 +54,7 @@ class GlobalID
   end
 
   def find(options = {})
-    model_class.find model_id if find_allowed?(options[:only])
+    Locator.locate self, options
   end
 
   def model_class
@@ -79,8 +90,4 @@ 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/identification.rb

@@ -4,14 +4,14 @@ class GlobalID
   module Identification
     extend ActiveSupport::Concern
 
-    def global_id
+    def to_global_id
       @global_id ||= GlobalID.create(self)
     end
-    alias gid global_id
+    alias to_gid to_global_id
 
-    def signed_global_id
-      @signed_global_id ||= SignedGlobalID.create(self)
+    def to_signed_global_id(options = {})
+      @signed_global_id ||= SignedGlobalID.create(self, options)
     end
-    alias sgid signed_global_id
+    alias to_sgid to_signed_global_id
   end
 end

data/lib/global_id/locator.rb

@@ -10,7 +10,9 @@ class GlobalID
       #   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
+        if gid = GlobalID.parse(gid)
+          locator_for(gid).locate gid if find_allowed?(gid.model_class, options[:only])
+        end
       end
 
       # Takes either a SignedGlobalID or a string that can be turned into a SignedGlobalID
@@ -24,6 +26,68 @@ class GlobalID
       def locate_signed(sgid, options = {})
         SignedGlobalID.find sgid, options
       end
+
+      # Tie a locator to an app.
+      # Useful when different apps collaborate and reference each others' Global IDs.
+      #
+      # The locator can be either a block or a class.
+      #
+      # Using a block:
+      #
+      #   GlobalID::Locator.use :foo do |gid|
+      #     FooRemote.const_get(gid.model_name).find(gid.model_id)
+      #   end
+      #
+      # Using a class:
+      #
+      #   GlobalID::Locator.use :bar, BarLocator.new
+      #
+      #   class BarLocator
+      #     def locate(gid)
+      #       @search_client.search name: gid.model_name, id: gid.model_id
+      #     end
+      #   end
+      def use(app, locator = nil, &locator_block)
+        raise ArgumentError, 'No locator provided. Pass a block or an object that responds to #locate.' unless locator || block_given?
+
+        GlobalID.validate_app(app)
+
+        @locators[normalize_app(app)] = locator || BlockLocator.new(locator_block)
+      end
+
+      private
+        def locator_for(gid)
+          @locators.fetch(normalize_app(gid.app)) { default_locator }
+        end
+
+        def find_allowed?(model_class, only = nil)
+          only ? Array(only).any? { |c| model_class <= c } : true
+        end
+
+        def normalize_app(app)
+          app.to_s.downcase
+        end
     end
+
+    private
+      @locators = {}
+
+      class ActiveRecordFinder
+        def locate(gid)
+          gid.model_class.find gid.model_id
+        end
+      end
+
+      mattr_reader(:default_locator) { ActiveRecordFinder.new }
+
+      class BlockLocator
+        def initialize(block)
+          @locator = block
+        end
+
+        def locate(gid)
+          @locator.call(gid)
+        end
+      end
   end
 end

data/lib/global_id/railtie.rb

@@ -3,6 +3,8 @@ require 'rails/railtie'
 rescue LoadError
 else
 require 'global_id'
+require 'active_support'
+require 'active_support/core_ext/string/inflections'
 
 class GlobalID
   # = GlobalID Railtie
@@ -12,9 +14,12 @@ class GlobalID
 
     initializer 'global_id' do |app|
 
-      app.config.global_id.app ||= app.railtie_name.remove('_application')
+      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
+
       config.after_initialize do
         app.config.global_id.verifier ||= begin
           app.message_verifier(:signed_global_ids)

data/lib/global_id/signed_global_id.rb

@@ -1,7 +1,10 @@
 require 'global_id'
 require 'active_support/message_verifier'
+require 'time'
 
 class SignedGlobalID < GlobalID
+  class ExpiredMessage < StandardError; end
+
   class << self
     attr_accessor :verifier
 
@@ -9,7 +12,7 @@ class SignedGlobalID < GlobalID
       if sgid.is_a? self
         sgid
       else
-        super verify(sgid, pick_verifier(options))
+        super verify(sgid, options), options
       end
     end
 
@@ -21,23 +24,66 @@ class SignedGlobalID < GlobalID
       end
     end
 
+    attr_accessor :expires_in
+
+    DEFAULT_PURPOSE = "default"
+
+    def pick_purpose(options)
+      options.fetch :for, DEFAULT_PURPOSE
+    end
+
     private
-      def verify(sgid, verifier)
-        verifier.verify(sgid)
-      rescue ActiveSupport::MessageVerifier::InvalidSignature
+      def verify(sgid, options)
+        metadata = pick_verifier(options).verify(sgid)
+
+        raise_if_expired(metadata['expires_at'])
+
+        metadata['gid'] if pick_purpose(options) == metadata['purpose']
+      rescue ActiveSupport::MessageVerifier::InvalidSignature, ExpiredMessage
         nil
       end
+
+      def raise_if_expired(expires_at)
+        if expires_at && Time.now.utc > Time.iso8601(expires_at)
+          raise ExpiredMessage, 'This signed global id has expired.'
+        end
+      end
   end
 
-  attr_reader :verifier
+  attr_reader :verifier, :purpose, :expires_at
 
   def initialize(gid, options = {})
     super
     @verifier = self.class.pick_verifier(options)
+    @purpose = self.class.pick_purpose(options)
+    @expires_at = pick_expiration(options)
   end
 
   def to_s
-    @sgid ||= @verifier.generate(super)
+    @sgid ||= @verifier.generate(to_h)
   end
   alias to_param to_s
+
+  def to_h
+    # Some serializers decodes symbol keys to symbols, others to strings.
+    # Using string keys remedies that.
+    { 'gid' => @uri.to_s, 'purpose' => purpose, 'expires_at' => encoded_expiration }
+  end
+
+  def ==(other)
+    super && @purpose == other.purpose
+  end
+
+  private
+    def encoded_expiration
+      expires_at.utc.iso8601(3) if expires_at
+    end
+
+    def pick_expiration(options)
+      return options[:expires_at] if options.key?(:expires_at)
+
+      if expires_in = options.fetch(:expires_in) { self.class.expires_in }
+        expires_in.from_now
+      end
+    end
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: globalid
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-19 00:00:00.000000000 Z
+date: 2014-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   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.
@@ -62,12 +62,12 @@ 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: []
@@ -75,5 +75,5 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: 'Refer to any model with a URI: gid://app/class/id'
+summary: ! 'Refer to any model with a URI: gid://app/class/id'
 test_files: []