globalid 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 452599d0406bd5fac9219973222368f7de7760a1
+  data.tar.gz: 0204d5224c0a299a96db75bf9d16beb39bbc9e26
+SHA512:
+  metadata.gz: 12eff4acebdd4026d34cf7bd13a04670d0e6e8d639cb0102bb06e48e1171d75a161566b0fed51f0636daa67722f226374a76cd6b1a812d01fc23fdbdce5b695a
+  data.tar.gz: 1b8039217e3f7b7735a51fbe09159334192dedc424535c4738e16a5870db1480eb82941f50284b01c4dffca12ce85db2a06a77d29f17feadeba7fe250e9f4915

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2014 David Heinemeier Hansson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/lib/global_id.rb

@@ -0,0 +1,7 @@
+require 'global_id/global_id'
+autoload :SignedGlobalID, 'global_id/signed_global_id'
+
+class GlobalID
+  autoload :Locator, 'global_id/locator'
+  autoload :Identification, 'global_id/identification'
+end

data/lib/global_id/global_id.rb

@@ -0,0 +1,64 @@
+require 'active_support'
+require 'active_support/core_ext/string/inflections'  # For #model_class constantize
+require 'active_support/core_ext/array/access'
+require 'active_support/core_ext/object/try'          # For #find
+require 'uri'
+
+class GlobalID
+  class << self
+    attr_accessor :app
+
+    def create(model)
+      new URI("gid://#{GlobalID.app}/#{model.class.name}/#{model.id}")
+    end
+
+    def find(gid)
+      parse(gid).try :find
+    end
+
+    def parse(gid)
+      gid.is_a?(self) ? gid : new(gid)
+    rescue URI::Error
+      nil
+    end
+  end
+
+  attr_reader :uri, :app, :model_name, :model_id
+
+  def initialize(gid)
+    extract_uri_components gid
+  end
+
+  def find
+    model_class.find model_id
+  end
+
+  def model_class
+    model_name.constantize
+  end
+
+  def ==(other)
+    other.is_a?(GlobalID) && @uri == other.uri
+  end
+
+  def to_s
+    @uri.to_s
+  end
+
+  private
+    PATH_REGEXP = %r(\A/([^/]+)/([^/]+)\z)
+
+    # Pending a URI::GID to handle validation
+    def extract_uri_components(gid)
+      @uri = gid.is_a?(URI) ? gid : URI.parse(gid)
+      raise URI::BadURIError, "Not a gid:// URI scheme: #{@uri.inspect}" unless @uri.scheme == 'gid'
+
+      if @uri.path =~ PATH_REGEXP
+        @app = @uri.host
+        @model_name = $1
+        @model_id = $2
+      else
+        raise URI::InvalidURIError, "Expected a URI like gid://app/Person/1234: #{@uri.inspect}"
+      end
+    end
+end

data/lib/global_id/identification.rb

@@ -0,0 +1,17 @@
+require 'active_support/concern'
+
+class GlobalID
+  module Identification
+    extend ActiveSupport::Concern
+
+    def global_id
+      @global_id ||= GlobalID.create(self)
+    end
+    alias gid global_id
+
+    def signed_global_id
+      @signed_global_id ||= SignedGlobalID.create(self)
+    end
+    alias sgid signed_global_id
+  end
+end

data/lib/global_id/locator.rb

@@ -0,0 +1,15 @@
+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
+      end
+
+      # Takes either a SignedGlobalID or a string that can be turned into a SignedGlobalID
+      def locate_signed(sgid)
+        SignedGlobalID.find sgid
+      end
+    end
+  end
+end

data/lib/global_id/railtie.rb

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

data/lib/global_id/signed_global_id.rb

@@ -0,0 +1,18 @@
+require 'global_id'
+require 'active_support/message_verifier'
+
+class SignedGlobalID < GlobalID
+  class << self
+    attr_accessor :verifier
+  end
+
+  def self.parse(sgid)
+    sgid.is_a?(self) ? sgid : super(verifier.verify(sgid))
+  rescue ActiveSupport::MessageVerifier::InvalidSignature
+    nil
+  end
+
+  def to_s
+    @sgid ||= self.class.verifier.generate(super)
+  end
+end

data/lib/globalid.rb

@@ -0,0 +1,2 @@
+require 'global_id'
+require 'global_id/railtie'

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: globalid
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- David Heinemeier Hansson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-18 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.
+email: david@loudthinking.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- 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:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: 'Refer to any model with a URI: gid://app/class/id'
+test_files: []